Uwierzytelnianie
Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
invoiceId (path) | Uuid | Tak | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
document_type | InvoiceDocumentType | Tak | 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 | Nie | The order this document bills; null for a document raised without one. |
credits_invoice_id | object | Nie | For a credit_note, the invoice it un-bills. Always null on an invoice. |
number | string | Tak | 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 | Tak | 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 | Tak | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Tak | — |
tax_minor | integer | Tak | — |
discount_minor | integer | Tak | — |
total_minor | integer | Tak | — |
issued_at | object | Nie | When the document was issued and its number allocated. |
pdf_url | object | Tak | A short-lived PDF link once rendered (docs/34 §4.2); null until then. |
lines | InvoiceLine[] | Tak | — |
payments | Payment[] | Tak | 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 | Tak | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 429