agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão agency.invoicing.view; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
⭐ Every invoice you have raised against them, what they still owe and what they have been billed in total — the "all client history" screen in one request rather than a filtered list. Requires `agency.invoicing.view`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
clientId (path) | Uuid | Sim | — |
org_id (query) | Uuid | Não | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Sim | — |
contact_name | string | Não | — |
email | string | Não | — |
phone | string | Não | — |
address | string | Não | — |
tax_number_label | string | Não | — |
tax_number | string | Não | — |
currency | string | Sim | — |
locale | string | Não | Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice. |
notes | string | Não | — |
archived | boolean | Não | — |
created_at | string | Não | — |
invoices | AgencyInvoice[] | Não | — |
outstanding_minor | integer | Não | What this client still owes, in minor units. |
invoiced_total_minor | integer | Não | Everything ever billed to them, void invoices excluded. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429