agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението agency.invoicing.view; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
⭐ 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`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
clientId (path) | Uuid | Да | — |
org_id (query) | Uuid | Не | 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… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Да | — |
contact_name | string | Не | — |
email | string | Не | — |
phone | string | Не | — |
address | string | Не | — |
tax_number_label | string | Не | — |
tax_number | string | Не | — |
currency | string | Да | — |
locale | string | Не | 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 | Не | — |
archived | boolean | Не | — |
created_at | string | Не | — |
invoices | AgencyInvoice[] | Не | — |
outstanding_minor | integer | Не | What this client still owes, in minor units. |
invoiced_total_minor | integer | Не | Everything ever billed to them, void invoices excluded. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429