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}