Retorna uma lista paginada de cobranças possíveis de negativação em conjunto com uma simulação de valores para cada tipo de negativação.
Endpoint responsável por consultar as cobranças elegíveis para negativação.
Essa chamada retorna uma lista paginada de cobranças que podem ser negativadas, juntamente com uma simulação de valores para cada tipo de negativação disponível.
Funcionamento da listagem
A resposta desse endpoint é paginada.
Além de identificar quais cobranças podem seguir para negativação, essa chamada também é útil para apoiar a tomada de decisão antes da solicitação efetiva, já que apresenta uma simulação dos valores envolvidos.
Parâmetros de paginação
offset - Define o elemento inicial da lista.
limit - Define a quantidade máxima de elementos retornados por chamada.
Quando utilizar este endpoint
Esse endpoint é útil em cenários como:
- identificar cobranças aptas para negativação
- montar filas operacionais de análise
- exibir oportunidades de negativação em telas administrativas
- validar previamente o custo ou tipo aplicável antes da criação
Regra importante para requisições GET
GETChamadas GET devem ser enviadas com o body vazio.
Caso a integração envie conteúdo no corpo da requisição, a API poderá retornar erro 403 Forbidden.
403Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.
