agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग agency.invoicing.manage अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोइन्टले org_id लाई क्वेरी प्यारामिटरको रूपमा लिन्छ। यसलाई छुटाउनुभयो भने कलले तपाईंको सम्पूर्ण टेनेन्सी सबट्रीलाई समेट्छ; यसलाई एउटा संस्थामा मात्र सीमित गर्न पठाउनुहोस्।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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

PATCH /v1/agency-invoicing/profile