A lista de acordos, renegociações, pagamentos avulsos e promessas feitas pela assessoria pode ser obtida pelo método Acordos API - Listar acordos. Como pode retornar muitos registros, atente para a Paginação.
Parâmetros para filtrar negociações incluem: cliente (ID do cliente), numeroAcordo (número do acordo), idExterno (ID externo para integração), situacao (ex.: BLOQUEADO, CANCELADO, ABERTO, etc.), tipo (ACORDO, PAGAMENTO_AVULSO, PROMESSA, RENEGOCIACAO), e filtros por datas de inclusão (dataInclusaoInicio, dataInclusaoFim) e modificação (dataHoraModificacaoInicio, dataHoraModificacaoFim).
Para incluir parcelas, pagamentos, origens, pendências e informações adicionais no retorno, use o parâmetro selector com as opções correspondentes. É obrigatório usar o modo de paginação CONTINUABLE no parâmetro mode. Caso contrário, retorna erro 400 com a mensagem "A consulta deve ser realizada com continuable para usar selector".
O método Acordos API - Buscar acordo retorna dados de uma negociação específica pelo seu id na URL.
As informações só são retornadas se a negociação foi criada pela assessoria que consulta ou se ela tem permissão para acessar negociações de outras assessorias. Caso contrário, retorna erro 400 com a mensagem "Você não tem permissão para visualizar esse acordo".
Exemplos de chamadas e de retornos destes métodos constam no arquivo Assessorias - Acordos 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.