Autentifikatsiya
API kalitini bearer token sifatida yuboring. Ushbu yakuniy nuqta spetsifikatsiyada ma'lum bir ruxsatni ko'rsatmaydi, shuning uchun kalitingizga eng kam kerakli huquqni bering va taxmin qilish o'rniga javobni tekshiring.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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`.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
invoiceId (path) | Uuid | Ha | 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… |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
document_type | InvoiceDocumentType | Ha | 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 | Yo'q | The order this document bills; null for a document raised without one. |
credits_invoice_id | object | Yo'q | For a `credit_note`, the invoice it un-bills. Always null on an `invoice`. |
number | string | Ha | 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 | Ha | 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 | Ha | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Ha | — |
tax_minor | integer | Ha | — |
discount_minor | integer | Ha | — |
total_minor | integer | Ha | — |
issued_at | object | Yo'q | When the document was issued and its number allocated. |
pdf_url | object | Ha | A short-lived PDF link once rendered (docs/34 §4.2); null until then. |
lines | InvoiceLine[] | Ha | — |
payments | Payment[] | Ha | 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 | Ha | — |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 429