אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה reseller.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/reseller/brand/invoice \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
The footer, payment terms, remittance details and support contact printed on invoices you issue to your clients. Requires `reseller.view`. ⛔ `configured: false` means your clients are still invoiced under Zinn Digital®, so there is nothing to personalise yet.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
org_id (query) | Uuid | לא | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
configured | boolean | כן | False when your clients are still invoiced under Zinn Digital®, in which case there is nothing here to set. |
legal_entity_name | string | כן | The company these invoices are issued by. |
footer_text | string | כן | — |
payment_terms | string | כן | — |
payment_details | string | כן | — |
support_contact | string | כן | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 429