Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
invoiceId (path) | Uuid | Có | 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… |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
document_type | InvoiceDocumentType | Có | 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 | Không | The order this document bills; null for a document raised without one. |
credits_invoice_id | object | Không | For a `credit_note`, the invoice it un-bills. Always null on an `invoice`. |
number | string | Có | 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 | Có | 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 | Có | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Có | — |
tax_minor | integer | Có | — |
discount_minor | integer | Có | — |
total_minor | integer | Có | — |
issued_at | object | Không | When the document was issued and its number allocated. |
pdf_url | object | Có | A short-lived PDF link once rendered (docs/34 §4.2); null until then. |
lines | InvoiceLine[] | Có | — |
payments | Payment[] | Có | 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 | Có | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 429