Listar notas de crédito
As notas de crédito dos clientes do alcance, da mais nova para a mais antiga: as abertas esperam o próximo fechamento, que as abate uma vez; as consumidas dizem em que pré-fatura.
Autorização
bearer billing:readCredencial 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
Um cliente do alcance; fora dele, 404.
int64Os clientes que a revenda tem agora.
int64Se a nota ainda espera o próximo fechamento ou já foi abatida.
Valor em
- "open"
- "consumed"
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/billing/credit-notes"{ "data": [ { "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" } ], "page": { "has_more": true, "next_cursor": "string" }}