agency-invoicing

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

Void an invoice.

ማረጋገጫ

የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የagency.invoicing.manage ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።

የድርጅትዎ መታወቂያ የሚገባበት ቦታ

ይህ ማቆሚያ ነጥብ org_id እንደ ጥያቄ መለኪያ ይወስዳል። እሱን ይተውት እና ጥሪው አጠቃላይ የኪራይ ንዑስ ዛፍዎን ይሸፍናል፤ ጥሪውን ወደ አንድ ድርጅት ለማጥበብ ይላኩት።

የድርጅትዎ መለያ ቁጥር (ID) በዳሽቦርድዎ ላይ በሚገኙት የኤፒአይ ቁልፎች (API keys) ማያ ገጽ ላይ ከቁልፉ አጠገብ ይገኛል። በሚያደርጉት እያንዳንዱ ጥያቄ ላይ የሚጠቀሙበት መለያ ቁጥር አንድ አይነት ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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