Resumo financeiro de um mês
Um mês do alcance do chamador, nos grupos do relatório: plataforma e agentes, telefonia, consumo de IA (por família e por agente), totais, documentos por estado e cobrança, mais o que pede ação — fechamentos que não aconteceram, crédito em aberto, e-mails que voltaram. Os filtros só estreitam: revenda ou cliente fora do alcance é 404. Com um cliente só, traz a identificação do documento vivo do mês.
Autorização
bearer billing:readCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: billing:read
Parâmetros de consulta
AAAA-MM, obrigatória.
Uma revenda do alcance; fora dele, 404.
int64Um cliente do alcance; fora dele, 404.
int64Corpo da resposta
application/json
application/json
curl -X GET "https://example.com/billing/reports/summary?competence=string"{ "bounced_dispatch_count": 0, "by_status": [ { "count": 0, "status": "in_review", "total_cents": 0 } ], "cancelled_count": 0, "charges": { "blocked_tenants": 0, "overdue_count": 0, "paid_cents": 0, "partially_paid_cents": 0, "partially_paid_count": 0, "pending_cents": 0, "refunded_cents": 0 }, "competence": "string", "consumption": [ { "agents": 0, "allowance_cents": 0, "allowance_used_cents": 0, "commercial_cents": 0, "cost_usd_micros": 0, "excess_cents": 0, "family": "string", "units": { "billed_seconds": 0, "calls": 0, "messages": 0, "studio_sessions": 0, "tokens": 0 } } ], "consumption_by_agent": [ { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "agent_name": "string", "allowance_cents": 0, "allowance_used_cents": 0, "commercial_cents": 0, "cost_usd_micros": 0, "excess_cents": 0, "family": "string", "tenant_id": 0, "tenant_name": "string", "units": { "billed_seconds": 0, "calls": 0, "messages": 0, "studio_sessions": 0, "tokens": 0 } } ], "consumption_competence": "string", "currency": "string", "dealer_count": 0, "identification": null, "open_backlog_count": 0, "open_credit_cents": 0, "pending_close_count": 0, "recurring": { "agents_cents": 0, "platform_cents": 0, "prorated_lines": 0, "recovery_cents": 0, "text_additional": 0, "text_principal": 0, "total_cents": 0, "voice_additional": 0, "voice_principal": 0 }, "scope": { "dealer_id": 0, "tenant_id": 0 }, "telephony": { "active_sip_trunks": 0, "channel_unit_cents": 0, "channels_cents": 0, "channels_quantity": 0 }, "tenant_count": 0, "totals": { "adjustments_cents": 0, "approved_count": 0, "excess_cents": 0, "frozen_total_cents": 0, "pending_asaas_count": 0, "recurring_cents": 0, "total_cents": 0, "under_review_count": 0 }}