agency-invoicing

PATCH /v1/agency-invoicing/profile

Change your invoicing identity or defaults.

सर्व agency-invoicing एंडपॉइंट्स

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये agency.invoicing.manage परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल

हे एंडपॉइंट org_id ला क्वेरी पॅरामीटर म्हणून स्वीकारते. ते वगळल्यास कॉल तुमच्या संपूर्ण टेनन्सी सबट्रीला कव्हर करतो; ते एका संस्थेपुरता कॉल मर्यादित करण्यासाठी पाठवा.

तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील 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_namestringनाही
addressstringनाही
emailstringनाही
phonestringनाही
websitestringनाही
tax_number_labelstringनाही
tax_numberstringनाही
payment_instructionsstringनाही
logo_sha256stringनाही
accent_colourstringनाही
default_currencystringनाही
default_payment_terms_daysintegerनाही
default_footerstringनाही
default_notesstringनाही
number_prefixstringनाही
number_paddingintegerनाही

प्रतिसाद

नावप्रकारआवश्यकहे काय आहे
business_namestringनाही
addressstringनाहीThe registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
emailstringनाही
phonestringनाही
websitestringनाही
tax_number_labelstringनाही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_numberstringनाही
payment_instructionsstringनाही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_sha256stringनाही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_colourstringनाही
default_currencystringहोय
default_payment_terms_daysintegerनाही
default_footerstringनाही
default_notesstringनाही
number_prefixstringहोय
number_paddingintegerनाही
next_numberintegerहोयThe next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands.
next_number_previewstringनाहीWhat the next invoice will be called, e.g. `INV-0042`.

ही एंडपॉइंट परत करू शकेल अशा त्रुटी

401 · 403 · 404 · 422 · 429