agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
Authentication
Send an API key as a bearer token. The key must carry the agency.invoicing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⭐ 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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
clientId (path) | Uuid | Yes | — |
org_id (query) | Uuid | No | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
contact_name | string | No | — |
email | string | No | — |
phone | string | No | — |
address | string | No | — |
tax_number_label | string | No | — |
tax_number | string | No | — |
currency | string | Yes | — |
locale | string | No | 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 | No | — |
archived | boolean | No | — |
created_at | string | No | — |
invoices | AgencyInvoice[] | No | — |
outstanding_minor | integer | No | What this client still owes, in minor units. |
invoiced_total_minor | integer | No | Everything ever billed to them, void invoices excluded. |
Errors this endpoint can return
401 · 403 · 404 · 429