Webservice (Comercial Contratos - Buscar dados de cliente, contrato e fatura por CPF CNPJ): mudanças entre as edições
Ir para navegação
Ir para pesquisar
(Criou página com ' Voltar ao menu Webservice Comercial Contratos') |
Sem resumo de edição |
||
Linha 1: | Linha 1: | ||
'''Descrição:''' Busca dados gerais dos contratos ativos e faturas de um cliente | |||
'''URL:''' https://[URL]/ws/comercial/cliente/dados?dataInicioVencFatura={dataInicioVencFatura}&dataFimVencFatura={dataFimVencFatura} | |||
'''Método:''' GET | |||
'''Entrada:''' JSON contendo o cpf ou cnpj, Query Param(“dataInicioVencFatura”) (opcional) e Query Param(“dataFimVencFatura”) (opcional) para limitar quais vencimentos de fatura trará. | |||
'''OBS.:''' Caso não queira limitar os vencimentos das faturas na resposta, é só não enviar o parâmetro os parâmetros de data. | |||
'''Saída:''' JSON contendo os dados do cliente. | |||
'''Campos JSON de entrada:''' | |||
{| class="wikitable" | |||
|'''Tag''' | |||
|'''Tipo Parâmetro''' | |||
|'''Tipo''' | |||
|'''Obrigatório''' | |||
|'''Observação''' | |||
|- | |||
|dataInicioVencFatura | |||
|Query Param | |||
|String | |||
|SIM | |||
|dd-mm-yyyy | |||
|- | |||
|dataFimVencFatura | |||
|Query Param | |||
|String | |||
|SIM | |||
|dd-mm-yyyy | |||
|- | |||
|cpfcnpj | |||
|Body | |||
|String | |||
|SIM | |||
| | |||
|} | |||
'''Exemplo:''' | |||
* '''Envio:''' | |||
** https://[URL]/ws/comercial/cliente/dados?dataInicioVencFatura={dataInicioVencFatura}&dataFimVencFatura={dataFimVencFatura} | |||
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"cpfcnpj":"12312312312" | |||
} | |||
</syntaxhighlight> | |||
* '''Retorno:''' | |||
** '''Sucesso:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"TipoPessoa":"PessoaFisica", | |||
"ClienteEncontrato":true, | |||
"NomeCliente":"CLIENTE TESTE", | |||
"ExisteFaturaSemPagamento":true, | |||
"IDCliente":81593, | |||
"Contratos":[ | |||
{ | |||
"ValorContrato":105.49, | |||
"StatusContrato":"HABILITADO", | |||
"IDContrato":1283299, | |||
"DescricaoPlano":"FIBRA RES 10MBPS FRANQUIA 360GB", | |||
"TipoContrato":"RESIDENCIAL", | |||
"TipoTecnologia":"INTERNET", | |||
"IDVencimento":4 | |||
}, | |||
{ | |||
"ValorContrato":9.9, | |||
"StatusContrato":"HABILITADO EM CONFIANCA", | |||
"IDContrato":1283303, | |||
"DescricaoPlano":"LOCACAO DE EQUIPAMENTOS", | |||
"TipoContrato":"RESIDENCIAL", | |||
"TipoTecnologia":"INTERNET", | |||
"IDVencimento":4 | |||
} | |||
], | |||
"ExisteAtendimentoAberto":true, | |||
"Faturas":[ | |||
{ | |||
"idsContratos":[ | |||
1283299, | |||
1283303 | |||
], | |||
"DebitoAutomatico":false, | |||
"CodigoCliente":81593, | |||
"ValorMulta":0.0, | |||
"linhaDigitavel":"11111.11111 11111.111111 11111.111111 1 11111111111111", | |||
"IDFatura":90, | |||
"ValorJuros":0.0, | |||
"nroBoleto":"00000085425P", | |||
"Valor":315.98, | |||
"nroDocumento":"0320283295", | |||
"codigoBarras":"1111111111111111111111111111111111111111111", | |||
"VencimentoFormatado":"09/03/2021", | |||
"Vencimento":"2021-03-09" | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | |||
** '''Erro:'''<syntaxhighlight lang="json"> | |||
{ | |||
"ClienteEncontrato":false | |||
} | |||
</syntaxhighlight> | |||
[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]] | |||
Voltar ao menu Webservice Comercial Contratos |
Edição atual tal como às 19h43min de 19 de maio de 2023
Descrição: Busca dados gerais dos contratos ativos e faturas de um cliente
URL: https://[URL]/ws/comercial/cliente/dados?dataInicioVencFatura={dataInicioVencFatura}&dataFimVencFatura={dataFimVencFatura}
Método: GET
Entrada: JSON contendo o cpf ou cnpj, Query Param(“dataInicioVencFatura”) (opcional) e Query Param(“dataFimVencFatura”) (opcional) para limitar quais vencimentos de fatura trará.
OBS.: Caso não queira limitar os vencimentos das faturas na resposta, é só não enviar o parâmetro os parâmetros de data.
Saída: JSON contendo os dados do cliente.
Campos JSON de entrada:
Tag | Tipo Parâmetro | Tipo | Obrigatório | Observação |
dataInicioVencFatura | Query Param | String | SIM | dd-mm-yyyy |
dataFimVencFatura | Query Param | String | SIM | dd-mm-yyyy |
cpfcnpj | Body | String | SIM |
Exemplo:
- Envio:
- https://[URL]/ws/comercial/cliente/dados?dataInicioVencFatura={dataInicioVencFatura}&dataFimVencFatura={dataFimVencFatura}
- Parâmetros adicionais:
{ "cpfcnpj":"12312312312" }
- Parâmetros adicionais:
- https://[URL]/ws/comercial/cliente/dados?dataInicioVencFatura={dataInicioVencFatura}&dataFimVencFatura={dataFimVencFatura}
- Retorno:
- Sucesso:
{ "TipoPessoa":"PessoaFisica", "ClienteEncontrato":true, "NomeCliente":"CLIENTE TESTE", "ExisteFaturaSemPagamento":true, "IDCliente":81593, "Contratos":[ { "ValorContrato":105.49, "StatusContrato":"HABILITADO", "IDContrato":1283299, "DescricaoPlano":"FIBRA RES 10MBPS FRANQUIA 360GB", "TipoContrato":"RESIDENCIAL", "TipoTecnologia":"INTERNET", "IDVencimento":4 }, { "ValorContrato":9.9, "StatusContrato":"HABILITADO EM CONFIANCA", "IDContrato":1283303, "DescricaoPlano":"LOCACAO DE EQUIPAMENTOS", "TipoContrato":"RESIDENCIAL", "TipoTecnologia":"INTERNET", "IDVencimento":4 } ], "ExisteAtendimentoAberto":true, "Faturas":[ { "idsContratos":[ 1283299, 1283303 ], "DebitoAutomatico":false, "CodigoCliente":81593, "ValorMulta":0.0, "linhaDigitavel":"11111.11111 11111.111111 11111.111111 1 11111111111111", "IDFatura":90, "ValorJuros":0.0, "nroBoleto":"00000085425P", "Valor":315.98, "nroDocumento":"0320283295", "codigoBarras":"1111111111111111111111111111111111111111111", "VencimentoFormatado":"09/03/2021", "Vencimento":"2021-03-09" } ] }
- Erro:
{ "ClienteEncontrato":false }
- Sucesso: