Aprovar ou cancelar uma pré-fatura
status = approved congela o total e emite o boleto; a resposta diz em approval.result se ficou cobrada, com pendência no Asaas ou sem cobrança — a aprovação vale nos três. status = cancelled, com reason, cancela a que está em revisão e anula a aprovada junto com o boleto não pago. Uma paga não se cancela (devolve-se com nota de crédito) e uma cancelada é terminal: os dois são 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 pré-fatura
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/pre-invoices/{pre_invoice_id}.
Corpo da resposta
application/json
application/json
curl -X PATCH "https://example.com/billing/pre-invoices/string" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \ -H "Content-Type: application/json" \ -d '{ "status": "approved" }'{ "approval": null, "pre_invoice": { "adjustments_cents": 0, "approved_at": "2019-08-24T14:15:22Z", "competence": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "dealer_id": 0, "dealer_name": "string", "due_date": "2019-08-24", "excess_cents": 0, "frozen_total_cents": 0, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "issued_by_dealer_id": 0, "issued_by_dealer_name": "string", "prorata_applied": true, "recurring_cents": 0, "status": "in_review", "tenant_deleted_at": "2019-08-24T14:15:22Z", "tenant_id": 0, "tenant_name": "string", "total_cents": 0, "adjustments": [ { "actor_email": "string", "created_at": "2019-08-24T14:15:22Z", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "reason": "string", "value_cents": 0 } ], "asaas_pending_reason": "string", "cancel_reason": "string", "delivery_warning": "string", "fx_rate": "string", "fx_rate_at": "2019-08-24T14:15:22Z", "lines": [ { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "allowance_cents": 0, "classification": "string", "commercial_cents": 0, "cost_usd_micros": 0, "days": 0, "description": "string", "excess_cents": 0, "family": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "prorated": true, "quantity": 0, "reference_competence": "string", "total_cents": 0, "unit_cents": 0, "usage": null } ], "markup_percent": "string" }}