DOM360
Financeiro

Listar os e-mails de cobrança

GET
/billing/dispatches

O que saiu para os clientes do alcance — a cobrança e os avisos da régua —, do mais novo para o mais antigo, com o destino, o remetente, o que houve e quem mandou. charge_id responde "o que saiu sobre este boleto".

Autorização

bearer billing:read
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:read

Parâmetros de consulta

charge_id?string

O que saiu sobre este boleto.

Formatouuid
tenant_id?integer

Um cliente do alcance; fora dele, 404.

Formatoint64
dealer_id?integer

Os clientes que a revenda tem agora.

Formatoint64
competence?string

AAAA-MM.

cursor?string

Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.

limit?integer

Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.

Formatoint32
Intervalo0 <= value

Corpo da resposta

application/json

application/json

curl -X GET "https://example.com/billing/dispatches"
{  "data": [    {      "charge_id": "cf8b747b-a752-4d0a-9a4d-7d19fc1769f3",      "competence": "string",      "dealer_id": 0,      "dealer_name": "string",      "error": "string",      "from_email": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "charge",      "message_id": "string",      "sent_at": "2019-08-24T14:15:22Z",      "sent_by_email": "string",      "status": "sent",      "tenant_id": 0,      "tenant_name": "string",      "to_email": "string"    }  ],  "page": {    "has_more": true,    "next_cursor": "string"  }}