v1
latestOpenAPI 3.1.02026-07-26232644.9 KBBills
Retorna o resumo da fatura atual do(s) cartão(ões) de crédito do usuário: limite total, limite disponível, período considerado e o valor aproximado da fatura. Requer API key para autenticação e assinatura ativa.
get/tools/api/get-bill-summary
Query parameters
accountIdstring
ID da conta de cartão de crédito para filtrar o cálculo (opcional)
closingDayinteger
Dia de fechamento manual (1–31). Se informado junto com accountId, será usado no cálculo deste cartão.
startDatestring date-time
Data de início do período para cálculo da fatura (formato ISO 8601). Sobrescreve o cálculo automático baseado no closing day.
endDatestring date-time
Data de fim do período para cálculo da fatura (formato ISO 8601). Sobrescreve o cálculo automático baseado no closing day.
Response
Resumo da fatura corrente
Example response
{
"success": true,
"transactionsInfo": "Este cálculo considerou 25 transação(ões) no período da fatura atual.",
"notice": "O valor da fatura é aproximado. Algumas transações podem ainda não ter sido lançadas e o banco pode demorar para sincronizar.",
"guidance": "Para faturas já fechadas/atrasadas use o endpoint get-bills. O get-bill-summary é para a fatura corrente (ainda não fechada).",
"timestamp": "2024-05-15T10:30:00Z"
}