agency-invoicing

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

Void an invoice.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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 конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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,…

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 409 · 429

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