Tabela financeira de um mês, por cliente
O documento de cada cliente do alcance na competência, com os valores por grupo e a cobrança corrente (uma por linha, quantas 2ª vias houver). Por cliente, na ordem do id do cliente; para exportar, siga o cursor até o fim.
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 tabela somada entre meses não é o
fechamento de ninguém.
Um cliente do alcance; fora dele, 404.
int64Os clientes que a revenda tem agora.
int64Onde a pré-fatura está: em revisão, aprovada, aprovada com pendência no Asaas, ou cancelada (terminal).
Valor em
- "in_review"
- "approved"
- "asaas_pending"
- "cancelled"
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/billing/reports/tenants?competence=string"{ "data": [ { "active_sip_trunks": 0, "adjustments_cents": 0, "agents_cents": 0, "agents_count": 0, "allowance_cents": 0, "approved_at": "2019-08-24T14:15:22Z", "channels_cents": 0, "channels_quantity": 0, "charge": null, "cnpj": "string", "commercial_cents": 0, "competence": "string", "consumption_competence": "string", "cost_usd_micros": 0, "currency": "string", "dealer_id": 0, "dealer_name": "string", "due_date": "2019-08-24", "excess_cents": 0, "frozen_total_cents": 0, "platform_cents": 0, "pre_invoice_id": "933bcfab-2ed2-4773-b261-5b80b56dd8c6", "prorata_applied": true, "recovery_cents": 0, "recurring_cents": 0, "status": "in_review", "tenant_id": 0, "tenant_name": "string", "total_cents": 0 } ], "page": { "has_more": true, "next_cursor": "string" }}