Registrar uma nota de crédito
Registra dinheiro que a plataforma deve a um cliente, com motivo; o próximo fechamento abate uma vez. A pré-fatura de origem, quando informada, precisa ser do mesmo cliente. Repetir registra outro crédito: use Idempotency-Key numa retentativa.
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 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 POST /billing/credit-notes.
Corpo da resposta
application/json
application/json
curl -X POST "https://example.com/billing/credit-notes" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \ -H "Content-Type: application/json" \ -d '{ "amount_cents": 0, "reason": "string", "tenant_id": 0 }'{ "amount_cents": 0, "consumed_at": "2019-08-24T14:15:22Z", "consumed_by_pre_invoice_id": "2873431e-bd20-4991-bee4-baf659fcb59d", "created_at": "2019-08-24T14:15:22Z", "created_by_email": "string", "currency": "string", "dealer_id": 0, "dealer_name": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "origin_pre_invoice_id": "cb172c77-d948-4423-8cf3-0a87fe4c6bdc", "reason": "string", "split_from_id": "5b2be705-c96c-46b0-a576-ddecd95a4019", "status": "open", "tenant_deleted_at": "2019-08-24T14:15:22Z", "tenant_id": 0, "tenant_name": "string"}