Obtendo os Contratos de Clientes

Um contrato (dívida) pode corresponder a faturas de cartão, operações de empréstimo, de CDC ou de carnês.

A lista de contratos de clientes distribuídos para a assessoria pode ser obtida através do método Contratos API - Listar contratos 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 contratos retornados. O parâmetro cliente pode ser utilizado para pesquisar contratos de clientes específicos, através do ID (identificador único) do cliente.

Para que nas informações sejam retornadas também as listas das parcelas, garantias, participantes, liquidações, informações adicionais, marcadores, parcelamentos e notas fiscais do contrato, o parâmetro de entrada selector pode ser utilizado com uma ou mais opções (parcelas, garantias, participantes, liquidacoes, informacoesAdicionais, marcadores, parcelamentos e notasFiscais), conforme consta na documentação deste método. Para utilizar o parâmetro de entrada selector é necessário utilizar também o modo de paginação CONTINUABLE, informando o parâmetro de entrada mode com a opção CONTINUABLE, conforme descrito em Paginação. Se for informado o parâmetro selector e não for informado o parâmetro mode, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "A consulta deve ser realizada com continuable para usar selector".

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

Somente são retornadas as informações se o contrato estiver distribuído 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 esse contrato".

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