agency-invoicing

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

Void an invoice.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن agency.invoicing.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

التفاصيل

⛔ 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