agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
Doğrulama
API açarını bearer token kimi göndərin. Açar agency.invoicing.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
⭐ 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`.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
clientId (path) | Uuid | Bəli | — |
org_id (query) | Uuid | Xeyr | 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… |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Bəli | — |
contact_name | string | Xeyr | — |
email | string | Xeyr | — |
phone | string | Xeyr | — |
address | string | Xeyr | — |
tax_number_label | string | Xeyr | — |
tax_number | string | Xeyr | — |
currency | string | Bəli | — |
locale | string | Xeyr | 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 | Xeyr | — |
archived | boolean | Xeyr | — |
created_at | string | Xeyr | — |
invoices | AgencyInvoice[] | Xeyr | — |
outstanding_minor | integer | Xeyr | What this client still owes, in minor units. |
invoiced_total_minor | integer | Xeyr | Everything ever billed to them, void invoices excluded. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 429