Prorrogar ou dar baixa numa cobrança
Com due_date, prorroga o mesmo boleto no Asaas; a tolerância anda junto, de propósito. Com status = received e paid_on (e value_cents, se foi parcial), registra um pagamento feito fora do boleto, pelo Asaas, para a próxima conciliação concordar. Motivo obrigatório nos dois; os dois juntos são 422. Uma cobrança paga, cancelada ou estornada não muda (409).
Autorização
bearer billing:executeCredencial 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:execute
Parâmetros de caminho
Id da cobrança
Parâmetros de cabeçalho
Chave opcional de 1 a 255 caracteres ASCII visíveis; quando enviada, vale o mesmo contrato da §8.
Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
O corpo de PATCH /billing/charges/{charge_id}: prorrogar (due_date)
ou dar baixa manual (status = received com paid_on), com motivo. Os
dois juntos são 422.
Corpo da resposta
application/json
application/json
curl -X PATCH "https://example.com/billing/charges/string" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \ -H "Content-Type: application/json" \ -d '{ "reason": "string" }'{ "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}