As negociações no CobranSaaS podem ser integradas a sistemas legados via pooling, consumindo a API para obter apenas atualizações recentes.
A lista de acordos, renegociações e pagamentos está disponível pelo método Acordos API - Listar acordos (GET /api/acordos), com documentação em seudominio.cobransaas.com.br/#/docs-api/acordos/api-acordos (substitua "seudominio" pelo domínio da sua empresa).
Como o método pode retornar muitos registros, use a Paginação, conforme descrito em seudominio.cobransaas.com.br/#/docs-api/introducao/paginacao.
Consulte Integrando Negociações e Pagamentos através das APIs do CobranSaaS para detalhes essenciais à integração.
Parâmetros de entrada permitem filtrar negociações, como dataHoraModificacaoInicio e dataHoraModificacaoFim (formato "YYYY-MM-DDTHH:mm:ss") para obter atualizações em um período específico.
Use o parâmetro situacao (ex.: BLOQUEADO, CANCELADO, ABERTO, etc.) para filtrar por status, e tipo (ex.: ACORDO, PAGAMENTO_AVULSO, RENEGOCIACAO) para filtrar por modalidade.
Para incluir parcelas, pagamentos, origens, pendências e informações adicionais, utilize o parâmetro selector com valores como parcelas, pagamentos, origens, pendencias e informacoesAdicionais. É obrigatório usar o modo de paginação CONTINUABLE com o parâmetro mode=CONTINUABLE, conforme a documentação de Paginação.
Se selector for usado sem mode, o erro 400 será retornado com a mensagem "A consulta deve ser realizada com continuable para usar selector". Veja Tratamento de Erros para mais detalhes.
Exemplos de chamadas e respostas estão no arquivo Negociações.postman_collection.json, disponível em Integrando Negociações e Pagamentos através das APIs do CobranSaaS.
Comentários
0 comentário
Artigo fechado para comentários.