agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה agency.invoicing.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
⛔ `next_number` is deliberately NOT settable. Rewinding a sequence would mint a duplicate number for a document already in a client's hands; advancing it leaves a gap a tax authority will ask about. Requires `agency.invoicing.manage`.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
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… |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
business_name | string | לא | — |
address | string | לא | — |
email | string | לא | — |
phone | string | לא | — |
website | string | לא | — |
tax_number_label | string | לא | — |
tax_number | string | לא | — |
payment_instructions | string | לא | — |
logo_sha256 | string | לא | — |
accent_colour | string | לא | — |
default_currency | string | לא | — |
default_payment_terms_days | integer | לא | — |
default_footer | string | לא | — |
default_notes | string | לא | — |
number_prefix | string | לא | — |
number_padding | integer | לא | — |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
business_name | string | לא | — |
address | string | לא | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | לא | — |
phone | string | לא | — |
website | string | לא | — |
tax_number_label | string | לא | What the agency calls its tax registration — "VAT number", "ABN", "GSTIN", "EIN". ⛔ Printed only when the number is set too: a label with no number is an empty row, and a number… |
tax_number | string | לא | — |
payment_instructions | string | לא | Bank details or a "PayPal me at …" line, printed on the document verbatim and shown on the payment page. ⭐ Never translated — translating a payment instruction is not a safe act. |
logo_sha256 | string | לא | A digest into the content-addressed logo store, never a URL. That is what lets the PDF inline the mark with no network call at render time. |
accent_colour | string | לא | — |
default_currency | string | כן | — |
default_payment_terms_days | integer | לא | — |
default_footer | string | לא | — |
default_notes | string | לא | — |
number_prefix | string | כן | — |
number_padding | integer | לא | — |
next_number | integer | כן | The next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands. |
next_number_preview | string | לא | What the next invoice will be called, e.g. `INV-0042`. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429