agency-invoicing

PATCH `/v1/agency-invoicing/invoices/{invoiceId}`

Edit a draft invoice.

प्रमाणन

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

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

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

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

इसे आज़माएँ

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

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

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

विवरण

⛔ A `409` means the invoice has been issued and its figures are frozen. A sent invoice is a document your client is holding — void it and issue a replacement rather than restating it. Requires `agency.invoicing.manage`.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`invoiceId (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…

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`currency`	`string`	नहीं	—
`issue_date`	`string`	नहीं	—
`due_date`	`string`	नहीं	—
`reference`	`string`	नहीं	—
`notes`	`string`	नहीं	—
`footer`	`string`	नहीं	—
`lines`	`AgencyInvoiceLineWrite[]`	नहीं	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`number`	`string`	नहीं	The agency's own number. ⛔ Empty until issue: a number allocated to something that may never be sent leaves a hole in a sequence.
`status`	`string<draft, sent, partially_paid, paid, void>`	हाँ	—
`is_overdue`	`boolean`	नहीं	⭐ DERIVED from the due date and the status, never stored — so there is no sweep to maintain a flag and nothing to go stale. A draft is never overdue however old it is: nobody ha…
`client_id`	`Uuid`	नहीं	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`client_name`	`string`	नहीं	—
`currency`	`string`	हाँ	—
`issue_date`	`string`	हाँ	—
`due_date`	`string`	नहीं	—
`reference`	`string`	नहीं	—
`notes`	`string`	नहीं	—
`footer`	`string`	नहीं	—
`subtotal_minor`	`integer`	नहीं	—
`discount_minor`	`integer`	नहीं	—
`tax_minor`	`integer`	नहीं	—
`total_minor`	`integer`	हाँ	—
`amount_paid_minor`	`integer`	नहीं	—
`amount_due_minor`	`integer`	नहीं	—
`tax_breakdown`	`AgencyInvoiceTaxGroup[]`	नहीं	—
`source`	`string`	नहीं	Where the invoice came from — `time_tracking` when it was generated from tracked hours, empty when an agency typed it.
`sent_at`	`string`	नहीं	—
`last_sent_to`	`string`	नहीं	—
`paid_at`	`string`	नहीं	—
`void_reason`	`string`	नहीं	—
`created_at`	`string`	नहीं	—
`lines`	`AgencyInvoiceLine[]`	नहीं	—
`payments`	`AgencyInvoicePayment[]`	नहीं	—
`portal_url`	`string`	नहीं	The payment link to send to the client. ⛔ Returned on a SINGLE-invoice read only, never in a list: a list is the thing that gets logged, cached and pasted into a support ticket,…

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

401 · 403 · 404 · 409 · 422 · 429

PATCH /v1/agency-invoicing/invoices/{invoiceId}