Fechar uma competência
Gera as pré-faturas de uma competência que já terminou: para um cliente, para os clientes de uma revenda que devem o mês, ou para a plataforma inteira. Antes de aceitar, o que já se sabe responde na hora: competência em curso é 422 e cliente ou revenda fora do alcance é 404. Aceito, responde 202 com a operação em Location; o resultado (forma de ClosingReportDto) diz o que houve com cada cliente — criada, já fechada, sem nada a cobrar ou falhou, com o motivo. Um cliente que falha não para os outros, e fechar de novo não cria outra.
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/closings: fechar uma competência para um
cliente, para os clientes de uma revenda ou para a plataforma inteira.
Corpo da resposta
application/json
application/json
curl -X POST "https://example.com/billing/closings" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \ -H "Content-Type: application/json" \ -d '{ "competence": "string" }'{ "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}