A consulta de restrições de clientes é feita pelo método Restrições API - Listar restrições, que pode retornar múltiplos registros e exige atenção à paginação. O método permite filtrar resultados por cliente, situação da restrição, período de inclusão, alteração ou exclusão, status ativo/inativo e tipo de birô (SERASA, SPC, PROTESTO e QUOD).
Filtros disponíveis
- Cliente (ID)
- Situação (ex: PENDENTE, ATIVO, CANCELADO)
- Períodos de inclusão, alteração, exclusão e modificação
- Status ativo/inativo (padrão: ativo = true)
- Tipo de ação (SERASA, SPC, PROTESTO, QUOD)
Detalhamento de retorno (selector)
Para incluir informações adicionais (ação, cliente, contrato, parcela, estratégia e workflow), deve-se usar o parâmetro selector junto com o modo de paginação CONTINUABLE. Sem isso, a API retorna erro.
Consulta específica
Também é possível usar o método Restrições API - Buscar restrições informando o ID da restrição.
Retorno da API
As restrições incluem dados como:
- Datas de inclusão, alteração e exclusão
- Situação atual
- Informações da dívida vinculada
- Detalhes completos da restrição
Permissões
Se não houver permissão, a API retorna erro 400 com mensagem de autorização negada para visualizar a restrição.
Exemplos de chamadas e de retornos destes métodos constam no arquivo Assessorias - Restrições 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.