Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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`.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
invoiceId (path) | Uuid | Ya | 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… |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
document_type | InvoiceDocumentType | Ya | 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 i… |
order_id | object | Tidak | The order this document bills; null for a document raised without one. |
credits_invoice_id | object | Tidak | For a `credit_note`, the invoice it un-bills. Always null on an `invoice`. |
number | string | Ya | 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 | Ya | 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; `r… |
currency | CurrencyCode | Ya | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Ya | — |
tax_minor | integer | Ya | — |
discount_minor | integer | Ya | — |
total_minor | integer | Ya | — |
issued_at | object | Tidak | When the document was issued and its number allocated. |
pdf_url | object | Ya | A short-lived PDF link once rendered (docs/34 §4.2); null until then. |
lines | InvoiceLine[] | Ya | — |
payments | Payment[] | Ya | 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 | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 429