agency-invoicing

POST `/v1/agency-invoicing/invoices/{invoiceId}/void`

Void an invoice.

प्रमाणीकरण

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

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

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

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

प्रयत्न करा

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

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

साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील API कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह API विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

⛔ The number is KEPT — a voided invoice is a document that says VOID on it, not an absence, and deleting the number would leave the gap the sequence exists to prevent. ⛔ Refused when payments have been recorded: that is a refund, which is a different act. 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…

विनंती मुख्य भाग

नाव	प्रकार	आवश्यक	हे काय आहे
`reason`	`string`	नाही	—

प्रतिसाद

नाव	प्रकार	आवश्यक	हे काय आहे
`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 · 429

POST /v1/agency-invoicing/invoices/{invoiceId}/void