billing

GET `/v1/invoices/{invoiceId}`

Get one billing document.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`invoiceId (path)`	`Uuid`	Ano	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…

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`document_type`	`InvoiceDocumentType`	Ano	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`	Ne	The order this document bills; null for a document raised without one.
`credits_invoice_id`	`object`	Ne	For a `credit_note`, the invoice it un-bills. Always null on an `invoice`.
`number`	`string`	Ano	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`	Ano	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`	Ano	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	Ano	—
`tax_minor`	`integer`	Ano	—
`discount_minor`	`integer`	Ano	—
`total_minor`	`integer`	Ano	—
`issued_at`	`object`	Ne	When the document was issued and its number allocated.
`pdf_url`	`object`	Ano	A short-lived PDF link once rendered (docs/34 §4.2); null until then.
`lines`	`InvoiceLine[]`	Ano	—
`payments`	`Payment[]`	Ano	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`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429

GET /v1/invoices/{invoiceId}