Obter métricas e indicadores de cobrança
POST
/api/CashIn/ConsultarResumoBoletos
CashIn
Funcionalidade principal
A consulta é realizada com base na data de geração dos boletos, utilizando os campos DataInicialGeracaoeDataFinalGeracao. A API agrupa os resultados por status (ex: "Pagos", "Pendentes", "Vencidos") e retorna a contagem total de boletos em cada uma dessas categorias.
Casos de uso comuns
1.
2.
3.
Nota importante: Este endpoint foi projetado para retornar dados agregados. Para obter os detalhes de boletos individuais (como o NossoNumeroou os dados do sacado), utilize os endpoints "Consultar boletos em lote" ou "Consultar o status de um boleto".
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/CashIn/ConsultarResumoBoletos' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"Data": {
"CodigoCanal": 0,
"CodigoCliente": 0,
"DataInicialGeracao": "string",
"DataFinalGeracao": "string"
}
}'Response Response Example
{
"Data": [
{
"QtdeRegistros": 0,
"Status": "string",
"ValorTotal": 0
}
],
"ResultCode": 0,
"Message": "string",
"ValidationData": {
"ResultCode": 0,
"Message": "string",
"Errors": [
{
"ErrorMessage": "string",
"FieldName": "string"
}
]
}
}Modificado em 2026-03-03 14:58:18