billing
GET /v1/invoices
List the organization's billing documents.
認証
ベアラー トークンとして API キーを送信します。キーには billing.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/invoices \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The organization's billing history — every invoice and credit note issued to it, newest first, with its lines, its payment summaries and the captured amounts. Cursor-paginated, filterable by status; RLS-scoped; requires billing.view. These are the real legal documents (docs/34 §1). Each is an immutable snapshot with a gapless, per-entity ZD-INV-YYYY-NNNNNN number, a captured tax treatment and its own frozen FX rates. document_type separates an invoice from a credit note; credits_invoice_id says which invoice a credit note un-bills. ⚠️ The document is issued by a sweep, a couple of minutes after payment, not synchronously at checkout (docs/34 §4.1). Render a pending state for a just-placed order rather than assuming the document is there the moment checkout returns. pdf_url stays null until PDF rendering lands (#708).
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
X-Zinn-Org (header) | string | いいえ | Which organisation this call acts for. Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | いいえ | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | いいえ | Maximum items to return (page size). |
status (query) | InvoiceStatus | いいえ | Filter by billing-document status. |
org_id (query) | Uuid | いいえ | Restrict to one organization in scope. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | Invoice[] | はい | — |
page | PageMeta | はい | — |
このエンドポイントが返すエラー
401 · 403 · 422 · 429