Após obter o lote ATIVO com as dívidas distribuídas para a assessoria conforme descrito em Obtendo o Lote Ativo de Dívidas, a lista de dívidas que passaram a estar contidas no lote atual ou das dívidas que deixaram de estar contidas no lote atual em relação ao lote anterior, ou seja, o lote parcial, poderá ser obtido, por incremento/decremento (delta), através do método Lotes API - Listar registros.
Quando o parâmetro de entrada dataInclusao é informado com a data do lote ativo, são retornadas apenas as novas dívidas que passaram a estar contidas no lote ATIVO.
Quando o parâmetro de entrada dataExclusao é informado com a data do lote ativo, são retornadas apenas as dívidas que deixaram de estar contidas no lote ATIVO.
Os parâmetros de entrada dataInclusao e dataExclusao não deverão ser informados simultaneamente, ou seja, apenas um deles deverá ser informado por vez pois, caso contrário, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "A data exclusão não pode ser utilizada quando a data de inclusão for utilizada".
Quando nenhum dos parâmetros de entrada dataInclusao e dataExclusao é informado, este método retorna todas as dívidas contidas no lote ATIVO.
Por este método retornar múltiplos registros, é importante observar as questões relativas à Paginação ao fazer chamadas a este método. Para cada dívida, são retornadas por este método as principais informações do cliente, do contrato e da parcela correspondentes à dívida. No caso de dívidas não parceladas como faturas de cartão, por exemplo, será retornada apenas uma dívida para cada cliente, relativa a apenas um contrato e uma parcela. No caso de dívidas parceladas como operações de Empréstimo, CDC ou de Carnês, por exemplo, será retornada uma dívida para cada parcela de cada operação de crédito do cliente.
Para que nas informações sejam retornadas também as listas dos telefones, e-mails, endereços, referências, participantes, informações adicionais, marcadores e parcelamentos, o parâmetro de entrada selector pode ser utilizado com uma ou mais opções (telefones, emails, enderecos, referencias, participantes, informacoesAdicionais, marcadores e parcelamentos), 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".
Exemplos de chamadas e de retornos deste método constam no arquivo Assessorias - Lotes API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.
Comentários
0 comentário
Artigo fechado para comentários.