agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास agency.invoicing.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
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