billing

GET `/v1/invoices/{invoiceId}`

Get one billing document.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

One billing document — an invoice or a credit note — with its own lines and the payment summaries of the order it bills. RBAC + RLS scoped; an out-of-scope or unknown id is a 404.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`invoiceId (path)`	`Uuid`	Так	The billing document's id. This is the `Invoice`/`CreditNote` id — not the order's. It was the order's id while `/v1/invoices` projected orders (docs/34 §7); the projection…

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`Uuid`	Так	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`document_type`	`InvoiceDocumentType`	Так	Which kind of legal document this is (docs/34 §1.3). An `invoice` is what we bill; a `credit_note` is what we un-bill — it carries its own `ZD-CRN` series number and names the…
`order_id`	`object`	Ні	The order this document bills; null for a document raised without one.
`credits_invoice_id`	`object`	Ні	For a `credit_note`, the invoice it un-bills. Always null on an `invoice`.
`number`	`string`	Так	The gapless legal document number (docs/34 §1.2), allocated per legal entity, series and year. Credit notes use the separate `ZD-CRN` series.
`status`	`InvoiceStatus`	Так	A billing document's payment state, read off the document itself (docs/34 §4.1). `paid` — money captured; `due` — issued and still owed; `overdue` — past its due date unpaid;…
`currency`	`CurrencyCode`	Так	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	Так	—
`tax_minor`	`integer`	Так	—
`discount_minor`	`integer`	Так	—
`total_minor`	`integer`	Так	—
`issued_at`	`object`	Ні	When the document was issued and its number allocated.
`pdf_url`	`object`	Так	A short-lived PDF link once rendered (docs/34 §4.2); null until then.
`lines`	`InvoiceLine[]`	Так	—
`payments`	`Payment[]`	Так	Payment attempts against the order this document bills, so a customer can see how an invoice was settled. Empty for a document with no order.
`created_at`	`string`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429

GET /v1/invoices/{invoiceId}