Webservice (Comercial Contratos - Buscar dados de cliente, contrato e fatura por ID de cliente)

Descrição: Busca dados gerais dos contratos e faturas de um cliente

URL: https://[URL]/ws/comercial/cliente/{idCliente}/dados?dataInicioVencFatura={dataInicioVencFatura}&dataFimVencFatura={dataFimVencFatura}

Método: GET

Entrada: PathParam contendo ID do cliente, QueryParam(“dataInicioVencFatura”) (opcional) e QueryParam(“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.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
idCliente	Path Param	String	SIM

Exemplo:

• Envio:
  • https://[URL]/ws/comercial/cliente/{idCliente}/dados?dataInicioVencFatura={dataInicioVencFatura}&dataFimVencFatura={dataFimVencFatura}
    • Parâmetros adicionais: Não Possui.
• 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",
             "Vencimento":"2021-03-09",
             "VencimentoFormatado":"09/03/2021"
          }
       ]
    }
    

  • Erro:

    {
       "ClienteEncontrato":false
    }
    

Voltar ao menu Webservice Comercial Contratos