Listar cobranças
As cobranças do alcance do chamador, da competência mais nova para a mais antiga, depois a mais recente, com a situação do cliente (bloqueio, tolerância e liberação em vigor). O alcance é o da revenda que tem o cliente agora.
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.
Um cliente do alcance; fora dele, 404.
int64Os clientes que a revenda tem agora.
int64Onde o boleto está no Asaas.
Valor em
- "pending"
- "overdue"
- "partially_paid"
- "confirmed"
- "received"
- "refunded"
- "canceled"
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/charges"{ "data": [ { "asaas_customer_id": "string", "asaas_environment": "string", "asaas_payment_id": "string", "balance_carried_at": "2019-08-24T14:15:22Z", "billing_type": "boleto", "boleto_url": "string", "competence": "string", "currency": "string", "dealer_id": 0, "dealer_name": "string", "due_date": "2019-08-24", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoice_url": "string", "issued_by_dealer_id": 0, "issued_by_dealer_name": "string", "issued_by_email": "string", "last_event_at": "2019-08-24T14:15:22Z", "paid_at": "2019-08-24T14:15:22Z", "paid_value_cents": 0, "pre_invoice_id": "933bcfab-2ed2-4773-b261-5b80b56dd8c6", "pre_invoice_status": "in_review", "replaces_charge_id": "ce6e7040-d923-42a8-bf74-d3eb39dd18c8", "sent_at": "2019-08-24T14:15:22Z", "situation": { "open_release": null, "tenant_admin_blocked_at": "2019-08-24T14:15:22Z", "tenant_blocked_at": "2019-08-24T14:15:22Z", "tolerance_until": "2019-08-24" }, "status": "pending", "tenant_deleted_at": "2019-08-24T14:15:22Z", "tenant_id": 0, "tenant_name": "string", "value_cents": 0 } ], "page": { "has_more": true, "next_cursor": "string" }}