Enviar cobranças por e-mail
Manda o e-mail de cada cobrança da lista ao cliente dela, pelo remetente da revenda. Sem resend, uma cobrança já enviada não sai de novo; com resend = true, sai uma cópia, até 10 por cobrança. Antes de aceitar, cada cobrança é conferida: uma que não existe ou está fora do alcance é 404. Aceito, responde 202 com a operação em Location; o resultado (forma de DispatchReportDto) diz, cobrança a cobrança, se saiu, se já tinha saído ou por que falhou.
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 de 1 a 255 caracteres ASCII visíveis, estável por intenção do usuário: a mesma chave numa retentativa devolve a primeira resposta em vez de repetir o efeito.
Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
O corpo de POST /billing/dispatches: mandar cobranças por e-mail.
Corpo da resposta
application/json
application/json
curl -X POST "https://example.com/billing/dispatches" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \ -H "Content-Type: application/json" \ -d '{ "charge_ids": [ "7543532a-5a62-4c4a-aaeb-f2a0cc916aa9" ] }'{ "completed_after_interruption": true, "created_at": "2019-08-24T14:15:22Z", "dealer_id": 0, "error": null, "finished_at": "2019-08-24T14:15:22Z", "kind": "billing_closing", "operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52", "progress": { "done": 0, "total": 0 }, "required_capability": "string", "result": {}, "result_location": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "tenant_id": 0}