Skip to main content

GET Relatório de Conversão da Cobrança

Relatório de conversão da cobrança. Cobrados no período, quantos pagaram depois, valor recuperado e tempo até pagar, por atendente e por origem.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão read_budgets_report.


Endpoint​

GET https://api-dev.imagemais.com.br/api/budgets/unpaid/report

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
dateInitialstring❌data ISO 8601Cobranças a partir do início deste dia. Omitido, o primeiro dia do mês de dateFinal
dateFinalstring❌data ISO 8601Cobranças até o fim deste dia. Omitido, hoje

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/budgets/unpaid/report' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": {
"charged": 2,
"converted": 1,
"rate": 50,
"recovered": 200,
"avgDays": 0,
"byAttendant": [
{
"name": "Nome Exemplo",
"charged": 2,
"converted": 1,
"rate": 50,
"recovered": 200,
"avgDays": 0
}
],
"byOrigin": {
"queue": {
"charged": 1,
"converted": 0,
"rate": 0,
"recovered": 0,
"avgDays": null
},
"counter": {
"charged": 1,
"converted": 1,
"rate": 100,
"recovered": 200,
"avgDays": 0
}
},
"timeBuckets": {
"sameDay": 1,
"upToTwo": 0,
"upToSeven": 0,
"overSeven": 0
}
}
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}