agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
Doğrulama
API açarını bearer token kimi göndərin. Açar agency.invoicing.manage 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 PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
⛔ `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`.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
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… |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
business_name | string | Xeyr | — |
address | string | Xeyr | — |
email | string | Xeyr | — |
phone | string | Xeyr | — |
website | string | Xeyr | — |
tax_number_label | string | Xeyr | — |
tax_number | string | Xeyr | — |
payment_instructions | string | Xeyr | — |
logo_sha256 | string | Xeyr | — |
accent_colour | string | Xeyr | — |
default_currency | string | Xeyr | — |
default_payment_terms_days | integer | Xeyr | — |
default_footer | string | Xeyr | — |
default_notes | string | Xeyr | — |
number_prefix | string | Xeyr | — |
number_padding | integer | Xeyr | — |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
business_name | string | Xeyr | — |
address | string | Xeyr | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | Xeyr | — |
phone | string | Xeyr | — |
website | string | Xeyr | — |
tax_number_label | string | Xeyr | 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 | Xeyr | — |
payment_instructions | string | Xeyr | 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 | Xeyr | 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 | Xeyr | — |
default_currency | string | Bəli | — |
default_payment_terms_days | integer | Xeyr | — |
default_footer | string | Xeyr | — |
default_notes | string | Xeyr | — |
number_prefix | string | Bəli | — |
number_padding | integer | Xeyr | — |
next_number | integer | Bəli | 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 | Xeyr | What the next invoice will be called, e.g. `INV-0042`. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422 · 429