GMP - Manual Tcnico - Clientes Novos v15 3 PDF

Manual – Novos Clientes
Authi Soluções em TI
Página 1
Última Atualização 17/03/2021
1. Sumário
1. SUMÁRIO .............................................................................................................................. 2
2. INTRODUÇÃO ...................................................................................................................... 3
3. GLOSSÁRIO ......................................................................................................................... 3
4. AMBIENTES .......................................................................................................................... 4
4.1 AMBIENTE WEBSERVICE .................................................................................................. 4

4.2 AMBIENTE ARQUIVO ......................................................................................................... 4
5. AUXILIARES DE RETORNO (WEBSERVICE) .................................................................... 5
5.1 PRODUTO DETALHES ....................................................................................................... 5

5.2 PRODUTO ........................................................................................................................ 5
5.3 PARCELA DETALHE .......................................................................................................... 6
5.4 PARCELA EXCLUSAO........................................................................................................ 6
6. INTEGRAÇÃO WEBSERVICE ............................................................................................. 7
6.1 CONSULTA CONSUMIDOR (WEBSERVICE) .......................................................................... 7

6.2 CONSULTA PRODUTOS (WEBSERVICE) ............................................................................. 8
6.3 CONSULTA PARCELAMENTO DE DÉBITOS (WEBSERVICE)................................................... 9
6.4 CONSULTA STATUS INSTALAÇÃO (WEBSERVICE) ............................................................. 10
6.5 CADASTRO CLIENTE (WEBSERVICE) ............................................................................... 11
6.6 INCLUSÃO COBRANÇA (WEBSERVICE) ............................................................................ 12
6.7 EXCLUSÃO COBRANÇA (WEBSERVICE) ........................................................................... 14
7. INTEGRAÇÃO ARQUIVO ................................................................................................... 15
7.1 CADASTRO CONSUMIDOR (ARQUIVO).............................................................................. 15

7.2 CADASTRO COBRANÇA (ARQUIVO) ................................................................................. 18
7.3 CANCELAMENTO VIA ARQUIVO ........................................................................................ 21
7.4 ARQUIVOS DE RETORNO ................................................................................................ 23
7.5 CÓDIGOS DE RETORNO .................................................................................................. 26
7.6 DESCRIÇÃO DAS PASTAS DO FTP ................................................................................... 28
8. CONTROLE DE VERSÕES ................................................................................................ 29
Página 2
2. Introdução
Este documento tem por objetivo, fornecer informações técnicas sobre as funcionalidades do
WebService e troca de arquivos, detalhando parâmetros de entrada, saída e formato de arquivos.
3. Glossário
Esta seção visa esclarecer termos utilizados neste documento.
Carga Passivo = vendas realizadas antes do início de operação do GMP.

Cliente = parceiro de negócios da CPFL TOTAL.
Consumidor = consumidor responsável pela aceitação da cobrança e titular ou cônjuge da fatura de
energia.
Página 3
4. Ambientes
4.1 Ambiente WebService
Para o ambiente de Produção, deverá ser utilizado o serviço disponível em:

https://gmp.cpfl.com.br/webservice/gmpwebservices.svc
Para o ambiente de Homologação, deverá ser utilizado o serviço disponível em:

https://gmpqa.cpfl.com.br/webservice/gmpwebservices.svc
O sistema GMP apenas aceita integração com sistemas nas linguagens: Delphi, Java e .Net
(C#/VB Net).
4.2 Ambiente Arquivo
O caminho do arquivo FTP será disponibilizado individualmente por parceiro de negócio.
Página 4
5. Auxiliares de Retorno (WebService)
5.1 Produto Detalhes
Campo Tamanho Formato

Valor 7
QtdParcelas 2
DataCobranca 8 DDMMYYYY (apenas números)
DataCancelamentoCobranca 8 DDMMYYYY (apenas números)
Status 1 1 = cancelado / 2 = ativo / 3 = vencido / 4
= não conforme / 5 = Finalizada / 6 = Erro
NomeAnexos Array de string
DescMotCancelamento 50
CanceladoPor 50
Identificação 20
DetalheParcelas Array do tipo ParcelaDetalhe
Detalhamento parâmetros de retorno:
Valor – Retorna o valor do produto (cobrança);

QtdParcelas – Retorna a quantidade de parcelas da cobrança (caso já exista uma cobrança
para o consumidor);
DataCobrança – Retorna a data da cobrança (caso já exista uma cobrança para o consumidor);
DataCancelamentoCobrança – Retorna a data do cancelamento da cobrança (caso exista uma cobrança
cancelada);
Status – Retorna o status;
NomeAnexos – Retorna os nomes do anexos referentes a cobrança;
DescMotCancelamento – Retorna a descrição do motivo de cancelamento (caso exista uma cobrança
cancelada);
CanceladoPor – Retorna o nome do usuário que cancelou a cobrança (caso exista uma
cobrança cancelada);
Identificacao – Retorna a identificação informada da cobrança (caso exista uma cobrança e
tenha sido informado uma identificação para a cobrança);
DetalheParcelas – Retorna um array do tipo ParcelaDetalhe contendo as informações por
parcela.
5.2 Produto

CodigoProduto 6
DescricaoProduto 30
CodigoProduto – Retorna o código do produto (cobrança);

DescricaoProduto – Retorna a descrição do produto (cobrança).
Página 5
5.3 Parcela Detalhe

Valor 7
NumeroParcela 2
DataVencimento 8 DDMMYYYY (apenas números)
MesReferencia 7 MM/YYYY
DataCancelamentoCobranca 8 DDMMYYYY (apenas números)
Status 1 1 – Cancelado / 2 – Ativo / 3 – Irregular
/ 4 – Faturado / 5 – Arrecadado / 6 –
Estornado
DescMotCancelamento 50
CanceladoPor 50
Valor – Retorna o valor do produto (cobrança);

NumeroParcela – Retorna o número da parcela detalhada;
DataVencimento – Retorna a data de vencimento da parcela (caso já exista uma para a parcela
em questão);
MesReferencia – Retorna o mês de referencia da parcela;
DataCancelamentoCobrança – Retorna a data do cancelamento da cobrança (caso exista uma cobrança
cancelada);
Status – Retorna o status da parcela (1 – Cancelado / 2 – Ativo / 3 – Irregular / 4 –
Faturado / 5 – Arrecadado / 6 – Estornado);
DescMotCancelamento – Retorna a descrição do motivo de cancelamento (caso exista uma cobrança
cancelada);
CanceladoPor – Retorna o nome do usuário que cancelou a cobrança (caso exista uma
cobrança cancelada).
5.4 Parcela Exclusao

NumeroParcela 2
NumeroParcela – Numero da parcela a ser excluída.
Página 6
6. Integração WebService
6.1 Consulta consumidor (WebService)
Esta interface permite consultar nome e endereço do consumidor, informando Instalação, PN e

CPF/CNPJ.
Método: ValidarConsulta
Parâmetros de entrada:
Campo Tipo Obrigatório Tamanho Observação
Usuario Texto Sim 15

Senha Texto Sim 10
Parceiro Texto Sim 10 Sem separador e com “0” a esquerda até 10 posições
PN Texto Sim 10 Sem separador e com “0” a esquerda até 10 posições
Instalacao Texto Sim 10 Sem separador e com “0” a esquerda até 10 posições
PF_PJ Inteiro Sim 1 1 = PF / 2 = PJ
CPF Texto Sim (se PF_PJ = 1) 11 Sem separador
CNPJ Texto Sim (se PF_PJ = 2) 14 Sem separador
Detalhamento parâmetros de entrada:
Usuario – Usuário cadastrado no GMP (CPF);

Senha – Senha do usuário no GMP;
Parceiro – Código (PN) do parceiro;
PN – PN da instalação;
Instalacao – Código da instalação;
PF_PJ – Informa se o consumidor é Pessoa Física ou Pessoa Jurídica;
CPF – CPF do consumidor;
CNPJ – CNPJ do consumidor;
Parâmetros de retorno:
Campo Tipo Tamanho Formato

Nome Texto 50
UF Texto 2
Cidade Texto 50
Bairro Texto 50
Logradouro Texto 50
Numero Texto 10
Complemento Texto 30
CEP Texto 9 Sem separador
DataInclusaoCadastro Texto 8 DDMMYYYY (apenas números)
Resultado Texto 25
Produtos ProdutoDetalhes
PN Texto 10
Página 7
Nome – Retorna o nome do consumidor;

UF – Retorna a sigla do estado para o PN/INSTALAÇÃO cadastrado;
Cidade – Retorna a cidade para o PN/INSTALAÇÃO cadastrado;
Bairro – Retorna o bairro para o PN/INSTALAÇÃO cadastrado;
Logradouro – Retorna o logradouro para o PN/INSTALAÇÃO cadastrado;
Numero – Retorna o número da residência para o PN/INSTALAÇÃO cadastrado;
Complemento – Retorna o complemento da residência para o PN/INSTALAÇÃO cadastrado;
CEP – Retorna o CEP da residência para o PN/INSTALAÇÃO cadastrado;
DataInclusaoCadastro – Retorna a data de inclusão do cadastro do consumidor, para o parceiro;
Produtos – Array do tipo ProdutoDetalhes;
PN – Retorna o código PN;
Resultado – Retorna sucesso ou código de erro da transação. Exemplos de retorno.
Sucesso: “Sucesso”
Permissão de Usuário: “Usuário não possui permissão para executar a operação solicitada.”
Demais erros: “Mensagens de erro separadas por “|”. Ex: “Mensagem 01|Mensagem 02”.
6.2 Consulta Produtos (WebService)
Esta interface permite a consulta dos produtos disponíveis para comercialização.
Método: ConsultarProdutoParceiro
Campo Tipo Obrigatório Tamanho Formato
Usuário Texto Sim 15

Senha Texto Sim 10
Usuario – Usuário cadastrado no GMP;

Parceiro – Código do parceiro;

ArrayProdutos Produto
Resultado Texto 25
Detalhamento parâmetros de Retorno:
ArrayProdutos – Array do tipo Produto

Demais erros: Mensagens de erro separadas por “|”. Ex: “Mensagem 01|Mensagem 02”.
Página 8
6.3 Consulta Parcelamento de Débitos (WebService)
Esta interface permite verificar se o consumidor possui parcelamento de débitos com a

distribuidora de energia ou não.
Método: ConsultaParcelamento

Senha Texto Sim 10
Conta Contrato Texto Não 10
Usuario – Usuário cadastrado no GMP (CPF);

PN – PN da instalação;
Conta Contrato – Número da conta contrato da instalação do consumidor.

CPF Texto 11
Instalação Texto 10
PN Texto 10
Quantidade de Parcelamentos Inteiro 100
Valor Total de Parcelamentos Décimo 10000 Formato de Reais
Quantidade de Parcelamento Em Aberto Inteiro 100
Valor Total de Parcelamentos Em Aberto Décimo 10000 Formato de Reais
Quantidade de Parcelamento Vencidos Inteiro 100
Valor Total de Parcelamentos Vencidos Décimo 10000 Formato de Reais
Existe Parcelamento Texto 1 “S” – Existe Parcelamento / “N” – Não existe
parcelamento
CPF – Retorna o CPF do consumidor;

Instalação – Código da Instalação do consumidor;
PN – Código PN do consumidor;
Quantidade de Parcelamentos – Retorna a quantidade total de parcelas que o consumidor possui;
Valor Total de Parcelamentos – Retorna o valor total em reais de parcelas que o consumidor possui;
Quantidade de Parcelamentos
Página 9
Em Aberto – Retorna a quantidade de parcelas em aberto do parcelamento que o
consumidor possui;
Valor Total de Parcelamento
Em Aberto – Retorna o valor total em reais de parcelas em aberto do parcelamento que
o consumidor possui;
Quantidade de Parcelamento
Vencidos – Retorna a quantidade de parcelas vencidas do parcelamento que o
consumidor possui;
Valor Total de Parcelamento
Vencidos – Retorna o valor total em reais de parcelas em aberto do parcelamento que
o consumidor possui;
Existe Parcelamento – Retorna “S” – Existe Parcelamento / “N” – Não existe parcelamento;
6.4 Consulta Status instalação (WebService)
Esta interface permite verificar se a instalação informada pelo consumidor se esta suspensa, ativa
ou com suspensão em andamento.
Método: ConsultaStatusInstalacao

Senha Texto Sim 10
Usuario – Usuário cadastrado no GMP (CNPJ);


CPF Texto 11
Instalação Texto 10
Parceiro Texto 10
Motivo Corte Texto 100 Suspensão por falta de pagamento, Suspensão por
irregularidade de padrão, entre outros.
Status Instalação Texto 100 Ativa, Instalação não encontrada, Solicitação de
Corte em andamento, Instalação completamente
suspensa.
CPF – Retorna o CPF do consumidor;

Instalação – Código da Instalação do consumidor;
Parceiro – Retorna o PN do parceiro;
Motivo do Corte – Retorna o motivo do corte;
Página 10
Status Instalação – Retorna os status das instalações;
6.5 Cadastro Cliente (WebService)
Esta interface permite o cadastro de consumidor, no GMP.
Método: CadastrarCliente

Senha Texto Sim 10
CPF Texto Sim 11 11111111111 (apenas números) - Sim (se PF_PJ = 2) o
CPF deve ser do responsável pela empresa
CNPJ Texto Sim (se PF_PJ = 2)
InscricaoEstadual Texto Sim (se PF_PJ = 2)
PF_PJ Inteiro Sim 1 1 = PF / 2 = PJ
RG Texto Sim 20
DataNascimento Texto Sim (se PF_PJ = 1) 8 DDMMYYYY (apenas números)
TelefoneFixo Texto Sim ou Celular 10 1911111111 (apenas números [DDD+Nº])
TelefoneCelular Texto Sim ou Celular 11 19111111111 (apenas números [DDD+Nº])
Email Texto Não 50 Formato valido
NomeResponsavel Texto Sim (se PF_PJ = 2) 50 Responsável pela empresa.
CPFResponsavel Texto Sim (se PF_PJ = 2) 11 CPF do responsável pela empresa
RGResponsavel Texto Sim (se PF_PJ = 2)
NomeConjuge Texto Não 50
CPFConjuge Texto Não 11 11111111111 (apenas números)
RGConjuge Texto Não 20
NomeContato Texto Não 50
TelefoneContato Texto Não 10 1911111111 (apenas números [DDD+Nº])
DataAbertura Texto Sim (se PF_PJ = 2) 8 DDMMYYYY (apenas números)
Operacao Inteiro Sim 1 1 = Inclusão / 2 = Edição

PN – Código do PN do consumidor;
CPF – CPF do consumidor;
CNPJ – CNPJ do consumidor (obrigatório para pessoa jurídica);
InscricaoEstadual – IE (Inscrição estatual) do consumidor (obrigatório para pessoa jurídica);
PF_PJ – 1 = pessoa física / 2 = pessoa jurídica;
RG – RG do consumidor;
DataNascimento – Data de nascimento do consumidor (obrigatório para pessoa fisica);
Página 11
TelefoneFixo – Telefone residencial do consumidor;
TelefoneCelular – Telefone celular do consumidor;
Email – E-mail do consumidor (opcional);
NomeResponsavel – Nome do responsável pela empresa consumidora (obrigatório para pessoa jurídica);
CPFResponsavel – CPF do responsável pela empresa consumidora (obrigatório para pessoa jurídica);
RGResponsavel – RG do responsável pela empresa consumidora (obrigatório para pessoa jurídica);
NomeConjuge – Nome do cônjuge do consumidor (opcional);
CPFConjuge – CPF do cônjuge do consumidor (opcional);
RGConjuge – RG do cônjuge do consumidor (opcional);
NomeContato – Nome de um contato do consumidor (opcional);
TelefoneContato – Telefone de um contato do consumidor (opcional);
DataAbertura – Data de abertura (obrigatório para pessoa jurídica);
Operacao – Operação a ser executada, sendo 1 = inclusão 2 = edição;

Resultado Texto 25

6.6 Inclusão Cobrança (WebService)
Esta interface permite o cadastro de cobrança.
Método: CadastrarCobranca
Observações: O arquivo informado no campo “NomeAnexo” deverá estar na pasta “Anexo” do FTP
do Parceiro de acordo com o item 4.2 e o Webservice só poderá ser chamado após o
upload do arquivo.
O anexo deve ter nome padrão para postagem (sempre com letras em minúsculo)
nnnnnnnnnn_dddddddddddddddddddd_iiiiiiiiii_ss, onde:
o nnnnnnnnnn: código numérico que identifica a empresa parceira (10 posições
com zeros a esquerda) ;
o dddddddddddddddddddd: código alfanumérico de identificação sem espaço (20
posições. O texto deve ser alinhado à direita e espaços vazios devem ser
preenchidos com zero à esquerda) ;
o iiiiiiiiii: código numérico que identifica a instalação do consumidor (10 posições
com zeros a esquerda);
o ss – código numérico sequencial (2 posições começando com 01).
Exemplo: 0712252964_00000000030123201606_0152646296_01.pdf
Página 12

Senha Texto Sim 10
Parceiro Texto Sim 10 Sem separador e com “0” a esquerda até 10
posições
Instalacao Texto Sim 10 Sem separador e com “0” a esquerda até 10
posições
PN Inteiro Sim 10 Sem separador e com “0” a esquerda até 10
posições
Valor Decimal Sim 5 999,99 (virgula como separador decimal)
QtdParcelas Inteiro Sim 2
Produto Texto Sim 6
NomeAnexo Texto Sim 50
Identificacao Texto Sim 20
ParcelaIndeterminada Inteiro Não 1 Deverá ser informado “1” para cobranças por
tempo indeterminado e “0” para cobranças
com tempo determinado.
AprovadoConjuge Inteiro Não 1 Deverá ser informado “0” para não aprovado
ou “1“ para sim aprovado.

Valor – Valor da cobrança (parcela);
QtdParcelas – Quantidade de parcelas em meses;
Produto – Produto de cobrança a ser inserido;
NomeAnexo – Nome do anexo que será disponibilizado via FTP;
Identificacao – Código de identificação;
ParcelaIndeterminada – Identifica se a cobrança possui tempo determinado ou indeterminado;
AprovadoConjuge – Identifica se a cobrança foi aprovado pelo cônjuge.

Resultado Texto 25
Página 13
6.7 Exclusão Cobrança (WebService)
Esta interface permite a exclusão de cobranças.
Método: ExcluirCobranca

Senha Texto Sim 10
Produto Texto Sim 6
Identificacao Texto Sim 20
MotivoCancelamento Texto Sim 50
ListaParcelasExcluir ParcelaExclusao Nao Parâmetro Opcional, senão passar nada seguirá o
fluxo de cancelamento da cobrança como um todo
Usuario – Usuário, cadastrado no GMP;

Senha – Senha do usuário, cadastrado no GMP;
Instalacao –Instalação do consumidor;
Produto – Produto/serviço de cobrança a ser inserido;
Identificacao – Identificação da cobrança;
MotivoCancelamento – Descrição do motivo do cancelamento da cobrança;
ListaParcelasExcluir – Array do tipo ParcelaExclusao contendo os números das parcelas a serem excluídas
(Parâmetro Opcional, senão passar nada seguirá o fluxo de cancelamento da cobrança como um todo).

Resultado Texto 25
Página 14
7. Integração Arquivo
7.1 Cadastro Consumidor (Arquivo)
Este layout permite o cadastro de consumidores em lote, através da leitura de arquivo,

disponibilizado em FTP (a ser informado pela CPFL Total).
Parâmetros:
Todos os campos do layout são de preenchimento obrigatório

Campo Número de Regra de Preenchimento
Posições
Instalação 10 Preencher as 10 posições apenas com números, completando o tamanho do campo com zeros à
esquerda.
Exemplo: 0001111111
PN Consumidor 10 Preencher as 10 posições apenas com números, completando o tamanho do campo com zeros à
esquerda.
Exemplo: 0011111111
PF_PJ 1 Informar o número correspondente ao tipo de cadastro:
1 = Pessoa Física
2 = Pessoa Jurídica
CPF/CNPJ 11/14 Preencher apenas com números 11 posições se for CPF e 14 se for CNPJ.
Exemplo: CPF = 11111111111 / CNPJ = 11111111000111
RG/IE 20 Preencher com 9 posições caso se trate de RG ou 12 se for IE, completando as 20 posições do
campo com zeros à esquerda.
Exemplos: RG = 111111111 /IE = 111111111111
Data Nascimento 8 Preencher apenas com números as 8 posições, deve ser uma data válida. Não pode ser preenchido
apenas com zeros ou deixar em branco. Exemplo: Data = 01012011
Telefone Fixo 10 Preencher apenas com números as 10 posições considerando o DDD. Caso a informação não
exista, preencher as 10 posições com zero.
Exemplo: Telefone = 1911111111
Telefone Celular 11 Preencher apenas com números as 11 posições. Caso a informação não exista, preencher as 11
posições com zero.
Exemplos: Celular = 15111111111
E-mail 50 Preencher as posições com o tamanho máximo de 50 caracteres. Caso a informação não exista,
preencher o total de posições com espaços em branco.
Exemplo: xxxxxxxxxx@xxxx.com.br
Nome Cônjuge / 50 Preencher as posições com o tamanho máximo de 50 caracteres, completando as 50 posições com
Responsável espaços em branco. Caso a informação não exista, preencher o total de posições com espaços em
branco. Para Pessoa Jurídica este campo deve ser preenchido.
CPF Cônjuge / 11 Preencher apenas com números as 11 posições. Caso a informação não exista, preencher as 11
Responsável posições com zero.
Exemplo: CPF = 11111111111
Página 15
RG Cônjuge / 20 Preencher as 20 posições apenas com números, completando o tamanho do campo com zeros à
Responsável esquerda. Caso a informação não exista, preencher as 20 posições com zero.
Exemplo: RG = 00000000011111111111
Nome Contato 50 Preencher as posições com tamanho máximo de 50 caracteres. Caso a informação não exista,
preencher o total de posições com espaços em branco. Para Pessoa Jurídica este campo deve ser
preenchido.
Telefone Contato 11 Preencher apenas com números as 11 posições. Caso a informação não exista, preencher as 11
posições com zero.
Exemplos: Telefone = 14111111111
Detalhamento parâmetros:
Instalação – Código da instalação do consumidor;
PF_PJ – Identificação de pessoa física = 1 ou pessoa jurídica = 2;
CPF/CNPJ – CPF ou CNPJ do consumidor;
RG/IE – RG (pessoa física) ou IE (pessoa jurídica);
Data Nascimento – Data de nascimento do consumidor;
Telefone Fixo – Telefone fixo do consumidor;
Telefone Celular – Telefone celular do consumidor;
E-mail – E-mail do consumidor;
Nome Cônjuge/Responsável - Nome do cônjuge ou responsável pela empresa;
CPF (Cônjuge/Responsável) – CPF do cônjuge ou responsável pela empresa;
RG (Cônjuge/Responsável) – RG do cônjuge ou responsável pela empresa;
Nome contato – Nome de um contato;
Telefone Contato – Telefone de um contato.
Regras de Negócio:
1. Deve ser gerado pelo parceiro, um arquivo .csv, separado por “;” respeitando a ordem dos
campos da seção “Dados”, bem como os tamanhos máximos informados na mesma seção
“Dados”;
2. O nome do arquivo (sempre com letras em minúsculo) deve ser a distribuidora, PN do parceiro,
seguido do sufixo “_ddmmyyyyhhmiss”, onde “_” é apenas um separador, “dd” é igual a dia,
“mm” é igual a mês e “yyyy” é igual ao ano, “hh” é igual a hora, “mi” é igual a minutos e “ss” é
igual a segundos. Exemplo:
cpfl_1234567890_01022016231059.csv
o cpfl = distribuidora
o 1234567890 = PN do parceiro
o 01 = dia 01
o 02 = mês 02
o 2016 = ano 2016
o 23 = hora 23
o 10 = minutos 10
o 59 = segundos 59
3. O parceiro deve disponibilizar no servidor FTP o (s) arquivo (s), obedecendo as regras dos itens 1
e 2;
Página 16
Página 17
7.2 Cadastro Cobrança (Arquivo)
Através desta interface, é possível cadastrar cobranças em lote, através da importação de arquivo.
Layout do registro “Header” (primeira linha):
Campo Atual Posição Posição Tamanho Tipo Obrigatório Descrição

Inicial Final
Tipo Registro 01 01 01 Numérico Sim Tipo do Registro = 1
Mês de Referência 02 07 06 Numérico Sim Mês de Referência (Mês atual).

(AAAAMM)
• AAAA = ano
• MM = Mes
Exemplo: 06/2016 = “201606”
PN do Parceiro 08 17 10 Numérico Sim Preencher as 10 posições com números,
completando o tamanho do campo com
zeros à esquerda.
Filler 18 150 125 Alfa Não Deixar em branco
Layout do registro “Detalhe” – Cadastramento de Serviço de Cobrança (segunda à

penúltima linha):
Campo Posiçã Posição Tamanho Tipo Obrigatório Descrição

o Final
Inicial
Instalação 02 11 10 Numérico Sim Preencher as 10 posições apenas com números,

completando o tamanho do campo com zeros à
esquerda.
Identificação 12 31 20 Alfanumérico Sim É de responsabilidade do parceiro, código único
utilizado para identificar internamente o contrato
ou serviço da cobrança cadastrada. Completar as
20 posições com zeros à esquerda.
Valor 32 46 15 Numérico Sim Não deve ser utilizado “,” nem “.”, sempre as duas
últimas posições são as casas decimais.
Exemplo: R$ 17,75
“000000000001775”
Cód. Serviço 47 52 06 Alfanumérico Sim Código que identifica o serviço a
Formato: “Y” + Código do Serviço (3 posições) + 2
Espaço em Branco
Exemplo: “Y043 “ – obrigatório “Y” Maiúsculo
Parcelas 53 82 30 Numérico Sim Exemplo:
“000000000000000000000000000010”
PN Consumidor 83 92 10 Numérico Sim Preencher as 10 posições com números,
completando o tamanho do campo com zeros à
esquerda.
CPF 93 114 22 Numérico Sim Informar o CPF do cliente (contendo 11 posições)
+ 11 espaços em branco para completar as 22
posições.
Não utilizar separadores (“.” Ou ”-” ou ”/”)
Página 18
Empresa 115 118 04 Alfanumérico Sim O nome da empresa deve ser digitado com letras
maiúsculas.
D003 Santa Cruz

D004 Leste Paulista de Energia
D005 Sul Paulista de Energia
D006 Jaguari de Energia
D007 Mococa
D008 RGE – Rio Grande Energia
D009 RGE Sul – Rio Grande Energia Sul
CPFL CPFL – Cia Paulista de Força e Luz
PIRA Piratininga de Força e Luz
Filler 119 150 32 Alfanumérico Sim Deixar em branco
Layout do registro “Trailler” (última linha):
Campo Posição Posição Tamanho Tipo Obrigatório Descrição

Inicial Final
Quantidade de 02 10 09 Numérico Sim Somente a quantidade de registros, "Header" e

Registros "Trailler" não são contabilizados.
Valor Total 11 25 15 Numérico Sim Não deve ser utilizado “,” nem “.”, sempre as
duas últimas posições são as casas decimais.
Exemplo: R$ 17,75
“000000000001775”
Detalhamento dos Campos Header (primeira linha)
Tipo Registro – Valor fixo 1;

Mês de Referência – Mês de geração do arquivo (obrigatório mês corrente);
PN do Parceiro – Código do PN do parceiro;
Filler – Espaço em branco (reservado para futuro).
Detalhamento dos Campos Detalhe – Cadastramento de Serviço de Cobrança (segunda à

penúltima linha):
Tipo Registro - Valor (1 = carga passivo / 2 = cadastro em lote);

Identificação – Código de identificação para a cobrança;
Valor – Valor da cobrança (parcela);
Cod. Serviço – Código do produto/serviço;
Parcelas – Quantidade de parcelas a ser inserida para cobrança;
CPF/CNPJ – CPF/CNPJ do consumidor;
Empresa – Empresa (distribuidora) do grupo, onde será inserida a cobrança;
Página 19
Detalhamento dos Campos Trailler (última linha):
Tipo Registro - Valor fixo “9”;

Quantidade de Registros – Quantidade de registros do arquivo;
Valor Total – Valor total das cobranças do arquivo;
Regras de Negócio:
Geral
1. A extensão do arquivo deverá ser “.txt”;

2. O campo “Tipo Registro” da seção Layout do registro “Detalhe”, identifica se o arquivo trata-se
de uma carga de passivo, valor 1 (não exige anexo) ou carga de cobrança em lote valor 2 (exige
anexo);
3. Deve ser possível cadastrar uma cobrança por um período indeterminado. Para isso, o campo
“Parcela” deverá ser informado com o valor 999.
Nomes de arquivos:
4. O padrão para o nome do arquivo de lote é cccc_nnnnnnnnnn_aaaammdd_hhmiss.txt

Onde:
• cccc: código da distribuidora com letras em minúsculo (cpfl, pira, d003, d004, d005, d006,
d007, d008 ou d009);
• nnnnnnnnnn: código numérico que identifica o Parceiro / PN Parceiro (10 posições com
zeros a esquerda);
• aaaammdd: data da geração do arquivo:
o aaaa – ano - numérico de 4 casas;
o mm – mês;
o dd – dia ;
• hhmmss – hora da geração do arquivo:
o hh – hora – numérico – 00 a 23;
o mi – minuto – numérico – 00 a 59;
o ss – segundos – numérico – 00 a 59;
Exemplo: cpfl_0712252964_20160302_172230.txt
5. O nome do anexo deve ter nome padrão para postagem (sempre com letras em minúsculo)
nnnnnnnnnn_dddddddddddddddddddd_iiiiiiiiii_ss onde:
o nnnnnnnnnn: código numérico que identifica a empresa parceira (10 posições com
zeros a esquerda) ;
o dddddddddddddddddddd: código único alfanumérico utilizado pelo Parceiro para
identificar internamente a cobrança. (20 posições. O texto deve ser alinhado à direita e
espaços vazios devem ser preenchidos com zero à esquerda);
o iiiiiiiiii: código numérico que identifica a instalação do consumidor (10 posições com
zeros a esquerda);
o ss – código numérico sequencial (2 posições começando com 01).
Exemplo: 0712252964_00000000030123201606_0152646296_01.pdf (O arquivo pode conter

outras extensões: .JPEG, .WAV, .MP3, .PNG, .DOCX, etc)
Página 20
Validações
6. O nome do arquivo deve ser único;

7. Cada linha do arquivo deve ter as seguintes validações:
O campo “Valor a Cobrar” pode ser no máximo de R$ 999,99 (a formatação do campo deve ser
conforme tabela: Layout do registro “Detalhe” – Cadastramento de Serviço de Cobrança);
a. O consumidor deve possuir cadastro no GMP;
b. Deve haver no mínimo um anexo para cada linha de cobrança (Tipo Registro = 2). Para
Tipo Registro = 1 não é necessário anexo
OBS: O nome do arquivo anexo deve ter o mesmo valor informado no campo
“identificação” e estar na pasta “Anexo” no FTP do parceiro de negócio disponibilizado
previamente.
8. Todos as linhas do arquivo no campo “Valor”, devem ser somados e o total deve ser igual ao
campo “Valor Total” do Trailler, e o total de cobranças (linhas fora o header e o trailler) deve ser
igual ao campo “Quantidade de Registros”;
9. O “Mês Referencia” do “Header”, deve indicar o mês corrente;
10. As linhas que estão com as informações corretas são cadastradas no sistema e as que tiverem
com algum tipo de erro não são cadastradas e são informadas ao consultar o log de erro;
7.3 Cancelamento via arquivo
Layout de arquivo para exclusão de cobranças (FTP):
Layout do registro “Header” (primeira linha):
Campo Atual Posição Posição Tama Tipo Obrigatório Descrição

Inicial Fim nho
Mês de Referência 02 07 06 Numérico Sim Mês de Referência do faturamento.

(AAAAMM)
• AAAA = ano
• MM = Mes
Exemplo: 06/2016 = “201606”
PN do Parceiro 08 17 10 Numérico Sim Preencher as 10 posições com números,
completando o tamanho do campo com
zeros à esquerda.
Filler 18 150 133 Alfa Não Deixar em branco
Layout do registro “Detalhe” – Cadastramento de Serviço de Cobrança (segunda à penúltima

linha):
Campo Posição Posição Tamanho Tipo Obrigató Descrição

Inicial Final rio
Tipo Registro 01 01 01 Numérico Sim Tipo do Registro = 2 carga cobrança em lote
Instalação 02 11 10 Numérico Sim Preencher as 10 posições com números,

completando o tamanho do campo com zeros
a esquerda.
Identificação 12 31 20 Alfanumérico Sim É de responsabilidade do parceiro, código
único utilizado para identificar internamente o
contrato ou serviço da cobrança cadastrada.
Completar as 20 posições com zero à
esquerda.
Página 21
Valor 32 46 15 Numérico Sim Deverá ser enviado com valor zerado quando
se tratar de cancelamento.
Exemplo: R$ 00,00
“000000000000000”
Cód. Serviço 47 52 06 Alfanumérico Sim Código que identifica o serviço a
Formato: “Y” + Código do Serviço (3 posições)
+ 2 Espaço em Branco
Exemplo: “Y043“ – obrigatório “Y” Maiúsculo
Parcelas 53 82 30 Numérico Sim Deverá ser enviado com a quantidade de
parcelas quando se tratar de inclusão;
Para exclusão, deverá enviar o número da
parcela como “0” para o caso de cancelamento
completo da cobrança.
Exemplo:
“000000000000000000000000000000”
OBS: Apenas uma instalação por linha no

arquivo realiza o cancelamento da cobrança
completa.
PN do Consumidor 83 92 10 Alfanumérico Sim Preencher as 10 posições com números,
completando o tamanho do campo com zeros
a esquerda.
CPF 93 114 22 Alfanumérico Sim Informar CPF do cliente (contendo 11
posições) + 11 espaços em branco para
completar as 22 posições. Não utilizar
separadores ("." ou "-" ou "/").
Empresa 115 118 04 Alfanumérico Sim
D003 Santa Cruz
D004 Leste Paulista de Energia
D005 Sul Paulista de Energia
D006 Jaguari de Energia
D007 Mococa
D008 RGE – Rio Grande Energia
D009 RGE Sul – Rio Grande Energia Sul
CPFL CPFL – Cia Paulista de Força e Luz
PIRA Piratininga de Força e Luz
O nome da empresa deve ser digitado com

letras maiúsculas.
Layout do registro “Trailler” (última linha):
Campo Posição Posição Tamanho Tipo Obrigatorio Descrição

Inicial Final
Página 22
Quantidade de 02 10 09 Numérico Sim Somente a quantidade de registros,
Registros "Header" e "Trailler" não são
contabilizados.
Valor Total 11 25 15 Numérico Sim Deverá ser informado tudo como “0”
para o cancelamento.
Detalhamento dos Campos Header (primeira linha)
Tipo Registro – Valor fixo 1;

Mês de Referência – Mês de geração do arquivo (obrigatório mês corrente);
PN do Parceiro – Código do PN do parceiro;
Detalhamento dos Campos Detalhe – Cadastramento de Serviço de Cobrança (segunda à penúltima linha):
Tipo Registro – Valor (1 = carga passivo / 2 = cadastro em lote);

Identificação – Código de identificação para a cobrança;
Valor – Valor da cobrança (parcela). Para cancelamento, informar “0”;
Cod. Serviço – Código do produto/serviço;
Parcelas – Parcela para cancelamento (informar 0 para cancelar todas);
CPF/CNPJ – CPF/CNPJ do consumidor;
Empresa – Empresa (distribuidora) do grupo, onde será inserida a cobrança;
Detalhamento dos Campos Trailler (última linha):
Tipo Registro – Valor fixo “9”;

Quantidade de Registros – Quantidade de registros do arquivo;
Valor Total – Valor total das cobranças do arquivo;
7.4 Arquivos de Retorno
Será disponibilizado, no servidor FTP, especifico (a ser informado).
Layout Header
Campo Descrição Tipo Posição Inicial Posição Final Tamanho

Tipo Registro Tipo de registro = 1 (fixo) Numérico 01 01 01
Mês Referência Mês de referencia Numérico 02 07 06
Cód. Correntista PN do parceiro Numérico 08 17 10
Filler Branco Alfanumérico 18 150 133
Layout Trailler
Campo Descrição Tipo Posição Inicial Posição Final Tamanho

Tipo Registro Tipo de registro = 9 (fixo) Numérico 01 01 01
Página 23
Quant. Registro Total de registro enviados Numérico 02 10 09
como detalhe
Valor Total Valor sumarizado a cobrar Numérico 11 25 15
Cobrar dos registros enviados (N13,2)
como detalhe
Filler Branco Alfanumérico 26 150 125
Exemplo retorno:
12016060060020285
2001243532500124353250097201606000000000001775Y043
CPFL201809
2001243551100124355110097201606000000000001775Y043
CPFL201809
.......
9000049999000000093951767
Regras de Negócio:
1. Deve ser gerado um arquivo com extensão .txt e nomeado no seguinte padrão:
eeee_nnnnnnnnnn_aaaammdd_hhmmss.txt (tamanho total = 31, caracteres, sem considerar a
extensão), onde:
o eeee = código da empresa (distribuidora, com 4 caracteres)
o nnnnnnnnnn = código numérico que identifica a empresa parceira (10 posições e zeros a
esquerda).
o aaaammdd = data da geração do arquivo (8 posições)
o hhmmss = hora de geração do arquivo (6 posições)
2. O corpo do arquivo é composto da seguinte forma:
o 1º linha = Layout Header
o 2º até a penúltima linha = layout RF029
o Última linha = Layout Trailler
3. O arquivo gerado nos itens 1 e 2, deve ser disponibilizado no servidor ftp, em diretório especifico.
LAYOUT
Layout Ocorrências da Irregularidade
Campos Inicio Fim Tamanho Formato Descrição

Tipo Registro 01 01 01 Numérico 3 (fixo)
Instalação 02 11 10 Numérico Número da instalação
Identificação 12 31 20 Alfanumérico Código único utilizado pelo parceiro para
identificar internamente a cobrança.
Valor cobrar 32 46 15 Numérico Valor a ser cobrado
Código do Item 47 52 06 Alfanumérico Código do item de cobrança
Código Irregularidade 53 54 02 Numérico Código de erro retornado
Data Vencimento 55 62 08 Numérico Preenchida somente quando código de
Irregularidade “03–Unidade Consumidora já
Faturada no mês”. Para demais
irregularidades este
Campo estará zerado.
Data Faturamento 63 70 08 Numérico Preenchida somente quando código de
Irregularidade “03–Unidade Consumidora já
Faturada no mês”. Para demais
irregularidades este
Página 24
Campo estará zerado.
Parcela 71 100 30 Alfanumérico Parcela a ser cobrada do Item, format0: ex:
01/99, com consistência nas 5 posições
PN do Parceiro 101 111 10 Alfanumérico Código do parceiro de negocio
Brancos 112 134 24 Alfanumérico
Empresa 135 138 04 Alfanumérico Código da empresa (distribuidora)
Mês Referencia 139 144 06 Numérico Mês referência do faturamento (AAAAMM)
Faturamento
Filler 139 150 12 Alfanumérico Filler – Reservado para futuro
Layout Ocorrências da Faturamento

Instalação 02 11 10 Numérico Número da instalação.
Identificação 12 31 20 Alfanumérico Identificação da cobrança
Valor Cobrado 32 46 15 Numérico Valor cobrado
Data Faturamento 53 60 08 Numérico Data em que ocorreu o faturamento da UC
(AAAAMMDD)
Data Vencimento 61 68 08 Numérico Data provável de vencimento da UC
(AAAAMMDD)
PN do Parceiro 73 82 10 Numérico Código do Parceiro de negócios
Mês referência 83 88 06 Numérico Mês referência do faturamento (AAAAMM)
faturamento
Parcela 89 118 30 Alfanumérico Parcela a ser cobrada do item. Ex: 01/50
PN do Consumidor 119 128 10 Alfanumérico Parceiro de negócio do consumidor
Layout Ocorrências da Arrecadação

Identificação 12 31 20 Alfanumérico Código único utilizado para identificar
internamente a cobrança
Valor Arrecadado 32 46 15 Numérico Valor arrecadado
Data Vencimento 53 60 08 Numérico Data Vencimento Fatura
Data Pagamento 61 68 08 Numérico Data pagamento da fatura
Código Serviço 69 69 01 Numérico Código do serviço.
1 – Arrecadação, 2 – estorno arrecadação
Dt Estorno 70 77 08 Numérico Data do estorno da arrecadação
Arrecadação
Página 25
Mês Faturamento 82 91 10 Alfanumérico Mês faturamento da conta (AAAA/MM)
Nº doc impressão 92 107 16 Alfanumérico Nº documento impressão da conta de energia
Parcela 108 137 30 Alfanumérico Parcela a ser cobrada do Item. Ex.: 02/50
(consistência nas 5 posições)
Layout Estornos Diários

Identificação 12 31 20 Alfanumérico Código único utilizado para
identificar internamente a cobrança
Valor Faturado 32 46 15 Numérico Valor Faturado
Data Estorno 53 60 08 Numérico Data do estorno
Empresa 61 64 04 Alfanumérico Empresa (distribuidora)
PN do Parceiro 65 74 10 Numérico Código do parceiro de negócio
Mês Referencia Faturamento 75 80 06 Numérico Mês de referência AAAAMM
Parcela 81 110 30 Alfanumérico Parcela a ser cobrada. Ex: 02/50
Regras de Negócio:
1. O GMP deve informar todos os parâmetros obrigatórios e receber como retorno

• Código de retorno:
o 1 = OK ou 2 = Erro
• Mensagem de retorno (sem uso)
• ResultSet – Recebe o layout, conforme seções:
o Layout Ocorrências da Irregularidade
o Layout Ocorrências da Faturamento
o Layout Ocorrências da Arrecadação
o Layout Estornos Diários
2. Toda interface SAP, deve ser consumida e tratada por um webservice, através do qual a aplicação
GMP, vai consumir os dados.
7.5 Códigos de Retorno
Núm.
Descrição Significado Ação GMP
Retorno Tipo
00 Numérico Registro sem erro Continua sequência de

Parcela programada com sucesso
parcelas
02 Numérico Instalação inativa Instalação não possui PN Continua sequência de
amarrado dentro do sistema SAP parcelas
Página 26
Cobrança por tempo
indeterminado:
Continua sequência de
parcelas
O faturamento já ocorreu no
03 Numérico Instalação já faturada no mês Cobrança por tempo
sistema e a cobrança será
determinado:
agendada para o próximo mês
Reprograma a parcela
01 e as demais, para
incluir a quantidade de
parcelas corretas.
04 Numérico Mês/ano de Referência Inválido Mês/ano de referência enviado é
Sem ação
inválido
05 Numérico Convênio de Cobrança encerrado Parceiro não é conveniado da CPFL Não permite a inclusão
Total da cobrança
Não é permitido a inclusão de
13 Numérico Instalação da classe “Governo” Não permite a inclusão
cobrança para instalações do tipo
da cobrança
governo
Possui sua fatura fechada a cada 3
meses, portanto não sendo
18 Numérico UC com cobrança trimestral Não permite a inclusão
possível incluir o serviço de da cobrança
terceiros
Mesma parcela com o mesmo ID
19 Numérico Duplicidade de registro enviado para o mesmo mês de Sem ação
faturamento
A instalação no mês anterior não
Item de cobrança não faturado no
21 Numérico teve faturamento de conta de Continua sequência de
mês anterior (estornado) energia, impossibilitando a parcelas
inserção da cobrança de terceiros.
Instalação com forma de
22 Numérico Instalação com forma de Não permite a inclusão
pagamento por duplicata pagamento por duplicata da cobrança
26 Numérico Instalação com liminar Instalação possui liminar, não Não permite a inclusão
sendo possível incluir a cobrança da cobrança
Houve uma alteração de
Cancela as parcelas
Instalação com troca de titularidade na instalação,
27 Numérico restantes, para não
portanto não é mais o PN
responsabilidade cobrar indevidamente
cadastrado o titular da conta de
do consumidor.
energia.
Parcela estornada antes do
33 Numérico Faturamento por solicitação do Consumidor solicitou o estorno da Continua sequência de
parcela antes do faturamento parcelas
consumidor
Realizado cancelamento, porém a
Estorno impossível, financeiro já parcela em questão não foi Parcela em questão irá
35 Numérico faturar na conta do
criado possível estornar e irá faturar na
consumidor.
conta do consumidor.
Parcela não encontrada no CCS
Parcela em questão foi estornada Parcela em questão irá
36 Numérico Solicitação de cancelamento,
e não está sendo encontrada para faturar na conta do
parcela não encontrada no CCS
cancelar novamente. consumidor.
feito pelo GMP
Cancela as parcelas
Bloqueio de cobrança: todos Consumidor solicitou o bloqueio e
não pode receber mais cobranças
conveniados cobrar indevidamente
de nenhum terceiro.
do consumidor
Cancela as parcelas
Bloqueio de cobrança: conveniado Consumidor solicitou o bloqueio e
específico cobrar indevidamente
de terceiro.
do consumidor
Instalação está cortada no mês
80 Numérico Marcado para recusa: corte Continua sequência de
atual. parcelas
Cancela as parcelas
Marcado para recusa: troca titularidade na instalação,
do consumidor.
energia.
Página 27
Cancela as parcelas
Consumidor solicitou o bloqueio e
82 Numérico Marcado para recusa: bloqueio restantes, para não
cobrar indevidamente
de terceiro.
do consumidor.
83 Numérico Recusado: corte Instalação está cortada no mês Continua sequência de
atual. parcelas
Cancela as parcelas
titularidade na instalação,
84 Numérico Recusado: troca responsabilidade restantes, para não
do consumidor
energia.
Cancela as parcelas
85 Numérico Recusado: bloqueio restantes, para não
de terceiro.
do consumidor
86 Numérico Erro na Recusa: corte Instalação está cortada no mês Continua sequência de
atual. parcelas
Cancela as parcelas
Erro na Recusa: troca titularidade na instalação,
do consumidor
energia.
Cancela as parcelas
88 Numérico Erro na Recusa: bloqueio restantes, para não
de terceiro.
do consumidor
7.6 Descrição das pastas do FTP
Seguem as descrições das pastas do FTP:
Anexo – Pasta onde o parceiro salva os arquivos para serem utilizados no anexo da venda
por WebService ou FTP.
BKP – Pasta onde os arquivos das pastas “Cliente” e “EnvioGMP” são enviados quando
processados com sucesso.
Cliente - Pasta para importação de cadastro do consumidor por arquivo FTP (Arquivo .csv)
EnvioGMP - Pasta para importação do cadastro de vendas por arquivo FTP (Arquivo .txt)
ErroAnexo – Pasta onde os arquivos da pasta “Anexo” são enviados caso haja algum erro.
ErroEnvio – Pasta onde os arquivos da pasta “EnvioGMP” são enviados caso haja algum
erro.
RetornoGMP – Pasta com os arquivos diários de retorno com ocorrências, faturamentos,
arrecadações, etc.
Página 28
8. Controle de versões
Versão Descrição Data

V7 Inclusão da empresa D009 06/08/2018
V8 Inclusão mês referência e ano no arquivo de retorno 31/08/2018
V9 • Ajuste nomenclatura empresas (Cadastro de 21/01/2019
Cobrança)
• Ajuste descrição campo RG/IE (Cadastro Cliente)
V10 • Correções nomenclaturas 04/02/2019
V11 • Ajuste de arquivo de cancelamento 30/10/2019
• Ordenação de retornos
V12 • Atualizações nos parâmetros de entrada/saída e suas 28/09/2020
respectivas informações das integrações por
WebServices
V13 • Atualizações nos parâmetros de entrada/saída e suas 17/03/2021
respectivas informações das integrações por
WebServices, retirada de ocorrência que não fazem
parte do processo e inclusão de informações
adicionais referente a ocorrências de retorno
(Significado e Ação GMP).
Página 29

GMP - Manual Tcnico - Clientes Novos v15 3 PDF

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

GMP - Manual Tcnico - Clientes Novos v15 3 PDF

Enviado por

Direitos autorais:

Formatos disponíveis

Manual – Novos Clientes

4.1 AMBIENTE WEBSERVICE .................................................................................................. 4

5. AUXILIARES DE RETORNO (WEBSERVICE) .................................................................... 5

5.1 PRODUTO DETALHES ....................................................................................................... 5

6. INTEGRAÇÃO WEBSERVICE ............................................................................................. 7

6.1 CONSULTA CONSUMIDOR (WEBSERVICE) .......................................................................... 7

7. INTEGRAÇÃO ARQUIVO ................................................................................................... 15

7.1 CADASTRO CONSUMIDOR (ARQUIVO).............................................................................. 15

8. CONTROLE DE VERSÕES ................................................................................................ 29

Esta seção visa esclarecer termos utilizados neste documento.

Carga Passivo = vendas realizadas antes do início de operação do GMP.

4.1 Ambiente WebService

Para o ambiente de Produção, deverá ser utilizado o serviço disponível em:

Para o ambiente de Homologação, deverá ser utilizado o serviço disponível em:

4.2 Ambiente Arquivo

O caminho do arquivo FTP será disponibilizado individualmente por parceiro de negócio.

5. Auxiliares de Retorno (WebService)

5.1 Produto Detalhes

Campo Tamanho Formato

Detalhamento parâmetros de retorno:

Valor – Retorna o valor do produto (cobrança);

Campo Tamanho Formato

Detalhamento parâmetros de retorno:

CodigoProduto – Retorna o código do produto (cobrança);

5.3 Parcela Detalhe

Campo Tamanho Formato

Detalhamento parâmetros de retorno:

Valor – Retorna o valor do produto (cobrança);

5.4 Parcela Exclusao

Campo Tamanho Formato

Detalhamento parâmetros de retorno:

NumeroParcela – Numero da parcela a ser excluída.

6.1 Consulta consumidor (WebService)

Esta interface permite consultar nome e endereço do consumidor, informando Instalação, PN e

Campo Tipo Obrigatório Tamanho Observação

Usuario Texto Sim 15

Detalhamento parâmetros de entrada:

Usuario – Usuário cadastrado no GMP (CPF);

Campo Tipo Tamanho Formato

Detalhamento parâmetros de retorno:

Nome – Retorna o nome do consumidor;

6.2 Consulta Produtos (WebService)

Esta interface permite a consulta dos produtos disponíveis para comercialização.

Campo Tipo Obrigatório Tamanho Formato

Usuário Texto Sim 15

Detalhamento parâmetros de entrada:

Usuario – Usuário cadastrado no GMP;

Campo Tipo Tamanho Formato

Detalhamento parâmetros de Retorno:

ArrayProdutos – Array do tipo Produto

6.3 Consulta Parcelamento de Débitos (WebService)

Esta interface permite verificar se o consumidor possui parcelamento de débitos com a

Campo Tipo Obrigatório Tamanho Observação

Usuario Texto Sim 15

Detalhamento parâmetros de entrada:

Usuario – Usuário cadastrado no GMP (CPF);

Campo Tipo Tamanho Formato

Detalhamento parâmetros de retorno:

CPF – Retorna o CPF do consumidor;

6.4 Consulta Status instalação (WebService)

Campo Tipo Obrigatório Tamanho Observação

Usuario Texto Sim 15

Detalhamento parâmetros de entrada: