認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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