Get payment dashboard
Returns aggregated counts, amounts, and breakdowns of payments for the specified period.
Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.
Parâmetros de consulta
Created-from date, inclusive.
"2026-01-01"
Created-to date, inclusive.
"2026-12-31"
Payment type filter.
BANKSLIP, UTILITIES, DARF "BANKSLIP"
Resposta
OK
Payments in the SCHEDULED state. This API version never creates one: payment scheduling is out of scope and no payment endpoint accepts a scheduling date, so a non-zero value can only be a scheduled payment reported by the provider — never one you requested. The same rows are also counted under byStatus.SCHEDULED.

