billing
GET /v1/invoices/{invoiceId}
Get one billing document.
प्रमाणीकरण
एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।
यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।
प्रयास गर्नुहोस्
कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।
curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्
विवरणहरू
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.
प्यारामिटरहरू
| नाम | प्रकार | आवश्यक | यो के हो |
|---|---|---|---|
invoiceId (path) | Uuid | हुन्छ | 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… |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यो के हो |
|---|---|---|---|
id | Uuid | हुन्छ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
document_type | InvoiceDocumentType | हुन्छ | 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 | हैन | The order this document bills; null for a document raised without one. |
credits_invoice_id | object | हैन | For a credit_note, the invoice it un-bills. Always null on an invoice. |
number | string | हुन्छ | 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 | हुन्छ | 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 | हुन्छ | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | हुन्छ | — |
tax_minor | integer | हुन्छ | — |
discount_minor | integer | हुन्छ | — |
total_minor | integer | हुन्छ | — |
issued_at | object | हैन | When the document was issued and its number allocated. |
pdf_url | object | हुन्छ | A short-lived PDF link once rendered (docs/34 §4.2); null until then. |
lines | InvoiceLine[] | हुन्छ | — |
payments | Payment[] | हुन्छ | 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 | हुन्छ | — |
यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू
401 · 403 · 404 · 429