agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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 הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 429