reseller

PUT `/v1/reseller/legal-entity`

Save the company details your clients' invoices are issued under.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास reseller.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

curl -X PUT https://api.zinndigital.com/v1/reseller/legal-entity \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "country": <string>, "number_prefix": <string> }'

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

Creates the entity the first time and updates it afterwards — never a second row. `number_prefix` is **globally unique across every company on the platform** because it is what keeps two issuers' invoice numbers apart, so a value already in use is a 409; and it **freezes once an invoice has been issued** under this company, because releasing it would let the next taker mint numbers you have already issued. Everything else stays editable — a company that moves office must be able to say so. Requires `reseller.manage`.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`org_id (query)`	`Uuid`	नहीं	Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r…

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`id`	`Uuid`	नहीं	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	हाँ	—
`company_number`	`string`	नहीं	—
`address_line1`	`string`	नहीं	—
`address_line2`	`string`	नहीं	—
`city`	`string`	नहीं	—
`region`	`string`	नहीं	—
`postcode`	`string`	नहीं	—
`country`	`string`	हाँ	ISO 3166-1 alpha-2. Stored uppercase.
`vat_number`	`string`	नहीं	—
`footer_text`	`string`	नहीं	—
`number_prefix`	`string`	हाँ	The prefix in every invoice number you issue (`AG-INV-2026-000123`). Globally unique across all companies on the platform, and frozen once you have issued an invoice.
`number_prefix_locked`	`boolean`	नहीं	True once an invoice has been issued under this company.
`created_at`	`string`	नहीं	—
`updated_at`	`string`	नहीं	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`data`	`ResellerLegalEntity \| null`	हाँ	`null` when no company details are held yet.

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404 · 409 · 422 · 429

PUT /v1/reseller/legal-entity