billing

GET `/v1/invoices/{invoiceId}`

Get one billing document.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй 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}