Obtendo as Parcelas de Contratos de Clientes

As parcelas de um contrato correspondem às dívidas de um cliente. No caso de dívidas não parceladas como faturas de cartão, por exemplo, cada contrato geralmente possui apenas uma parcela correspondente. No caso de dívidas parceladas como operações de Empréstimo, CDC ou de Carnês, por exemplo, cada contrato geralmente possui mais de uma parcela.

A lista de parcelas de contratos (dívidas) de clientes distribuídos para a assessoria pode ser obtida através do método Parcelas API - Listar parcelas e, por poder retornar múltiplos registros, é importante observar as questões relativas à Paginação ao fazer chamadas a este método.

Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de parcelas de contratos retornadas. O parâmetro cliente pode ser utilizado para pesquisar parcelas de clientes específicos, através do ID (identificador único) do cliente. O parâmetro contrato pode ser utilizado para pesquisar parcelas de contratos específicos, através do ID (identificador único) do contrato.

Também está disponível o método Parcelas API - Buscar parcela que retorna as informações de apenas uma parcela específica, cuja identificação (id) deve ser informada na URL de chamada do método.

Somente são retornadas as informações se a parcela estiver distribuída para a assessoria. Caso contrário, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "Você não tem permissão para visualizar essa parcela".

Exemplos de chamadas e de retornos destes métodos constam no arquivo Assessorias - Parcelas API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.