DOM360
Financeiro

Aprovar pré-faturas em lote

POST
/billing/pre-invoice-approvals

Aprova cada pré-fatura da lista como PATCH com status = approved faria, na ordem e uma vez por id. Antes de aceitar, cada id é conferido: um que não existe ou está fora do alcance é 404. Aceito, responde 202 com a operação em Location; o resultado (forma de PreInvoiceApprovalsDto) diz, documento a documento, o que houve com o boleto ou por que não foi aprovado. Uma recusa nunca para o próximo cliente.

Autorização

bearer billing:execute
AutorizaçãoBearer <token>

Credencial 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

Idempotency-Key*string

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/pre-invoice-approvals: aprovar várias pré-faturas de uma vez.

Corpo da resposta

application/json

application/json

curl -X POST "https://example.com/billing/pre-invoice-approvals" \  -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \  -H "Content-Type: application/json" \  -d '{    "pre_invoice_ids": [      "6ea84e21-f3ef-45e1-8bfb-e912bba12a75"    ]  }'
{  "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}