agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen agency.invoicing.manage; një çelës pa të refuzohet me 403, jo 404.
Ku shkon id i organizatës suaj
Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.
ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
⛔ `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`.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
org_id (query) | Uuid | Jo | 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… |
Trupi i kërkesës
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
business_name | string | Jo | — |
address | string | Jo | — |
email | string | Jo | — |
phone | string | Jo | — |
website | string | Jo | — |
tax_number_label | string | Jo | — |
tax_number | string | Jo | — |
payment_instructions | string | Jo | — |
logo_sha256 | string | Jo | — |
accent_colour | string | Jo | — |
default_currency | string | Jo | — |
default_payment_terms_days | integer | Jo | — |
default_footer | string | Jo | — |
default_notes | string | Jo | — |
number_prefix | string | Jo | — |
number_padding | integer | Jo | — |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
business_name | string | Jo | — |
address | string | Jo | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | Jo | — |
phone | string | Jo | — |
website | string | Jo | — |
tax_number_label | string | Jo | 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 | Jo | — |
payment_instructions | string | Jo | 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 | Jo | 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 | Jo | — |
default_currency | string | Po | — |
default_payment_terms_days | integer | Jo | — |
default_footer | string | Jo | — |
default_notes | string | Jo | — |
number_prefix | string | Po | — |
number_padding | integer | Jo | — |
next_number | integer | Po | 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 | Jo | What the next invoice will be called, e.g. `INV-0042`. |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 422 · 429