agency-invoicing

PATCH `/v1/agency-invoicing/clients/{clientId}`

Change a client's details.

प्रमाणन

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

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

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

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

इसे आज़माएँ

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

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

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

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`clientId (path)`	`Uuid`	हाँ	—
`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…

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`name`	`string`	नहीं	—
`contact_name`	`string`	नहीं	—
`email`	`string`	नहीं	—
`phone`	`string`	नहीं	—
`address`	`string`	नहीं	—
`tax_number_label`	`string`	नहीं	—
`tax_number`	`string`	नहीं	—
`currency`	`string`	नहीं	—
`country`	`string`	नहीं	Two-letter ISO code, or empty or null to clear. Anything else is refused.
`locale`	`string`	नहीं	—
`notes`	`string`	नहीं	—
`archived`	`boolean`	नहीं	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	हाँ	—
`contact_name`	`string`	नहीं	—
`email`	`string`	नहीं	—
`phone`	`string`	नहीं	—
`address`	`string`	नहीं	—
`tax_number_label`	`string`	नहीं	—
`tax_number`	`string`	नहीं	—
`currency`	`string`	हाँ	—
`country`	`string`	नहीं	ISO-3166-1 alpha-2, optional. Required only to bill this client on Zinn®'s own checkout (the platform organisation, docs/670 §3), where the country decides the VAT on the bill and…
`locale`	`string`	नहीं	Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice.
`notes`	`string`	नहीं	—
`archived`	`boolean`	नहीं	—
`created_at`	`string`	नहीं	—

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

401 · 403 · 404 · 422 · 429

PATCH /v1/agency-invoicing/clients/{clientId}