agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie agency.invoicing.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
clientId (path) | Uuid | Ja | — |
org_id (query) | Uuid | Nee | 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… |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Ja | — |
contact_name | string | Nee | — |
email | string | Nee | — |
phone | string | Nee | — |
address | string | Nee | — |
tax_number_label | string | Nee | — |
tax_number | string | Nee | — |
currency | string | Ja | — |
locale | string | Nee | 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 | Nee | — |
archived | boolean | Nee | — |
created_at | string | Nee | — |
invoices | AgencyInvoice[] | Nee | — |
outstanding_minor | integer | Nee | What this client still owes, in minor units. |
invoiced_total_minor | integer | Nee | Everything ever billed to them, void invoices excluded. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 429