BlueAI 請求書発行 データ構造
請求書発行 API で返却される主要オブジェクトのフィールド定義です。
|
ID 形式
各リソースは prefix 付き public ID（例: deal_..., inv_..., form_..., ak_...）を利用します。
全プロダクト共通の ID 規約共通カラム
主要オブジェクトは共通して `object`, `external_id`, `source_system`, `metadata`, `livemode`, `version`, `system_updated_at`, `created_by`, `updated_by`, `deleted_at` を持ちます。
Invoice object
請求書を表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 請求書 ID |
object | string | 必須 | オブジェクト種別（`invoice.invoice`） |
organization_id | string | 必須 | 組織 ID |
external_id | string | null | 任意 | 外部連携ID |
source_system | "salesforce" | "import" | "api" | "manual" | 必須 | 登録元システム |
record_type | string | 必須 | レコード種別 |
company_id | string | 必須 | 会社 ID |
invoice_number | string | 必須 | 請求書番号 |
status | "draft" | "sent" | "paid" | "overdue" | "cancelled" | 必須 | ステータス |
issue_date | string | 必須 | 発行日 |
due_date | string | null | 任意 | 支払期限 |
subtotal | number | 必須 | 小計 |
tax | number | 必須 | 消費税 |
total | number | 必須 | 合計 |
notes | string | null | 任意 | 備考 |
metadata | object | null | 任意 | 拡張メタデータ |
livemode | boolean | 必須 | 本番モードフラグ |
version | number | 必須 | リビジョン番号 |
created_by | string | null | 任意 | 作成者 ID |
updated_by | string | null | 任意 | 更新者 ID |
deleted_at | string | null | 任意 | 削除日時 (ISO 8601) |
created_at | string | 必須 | 作成日時 (ISO 8601) |
system_updated_at | string | 必須 | システム更新日時 (ISO 8601) |
updated_at | string | 必須 | 更新日時 (ISO 8601) |
{
"id": "inv_01JQ3KXYZ",
"object": "invoice.invoice",
"organization_id": "org_01HZXYZ",
"external_id": "ext_org_01HZXYZ",
"source_system": "api",
"record_type": "default",
"company_id": "comp_01JQ3KABC",
"invoice_number": "INV-2026-0042",
"status": "sent",
"issue_date": "2026-02-15",
"due_date": "2026-03-15",
"subtotal": 100000,
"tax": 10000,
"total": 110000,
"notes": null,
"metadata": {
"source": "api"
},
"livemode": false,
"version": 5,
"created_by": "usr_99999999999999999999999999999999",
"updated_by": "usr_99999999999999999999999999999999",
"deleted_at": null,
"created_at": "2026-02-15T09:00:00Z",
"system_updated_at": "2026-02-15T09:00:00Z",
"updated_at": "2026-02-15T09:00:00Z"
}Quotation object
見積書を表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 見積書 ID |
object | string | 必須 | オブジェクト種別（`invoice.quotation`） |
organization_id | string | 必須 | 組織 ID |
external_id | string | null | 任意 | 外部連携ID |
source_system | "salesforce" | "import" | "api" | "manual" | 必須 | 登録元システム |
record_type | string | 必須 | レコード種別 |
company_id | string | 必須 | 会社 ID |
status | "draft" | "sent" | "accepted" | "rejected" | "expired" | 必須 | ステータス（draft: 下書き、sent: 送信済、accepted: 承認、rejected: 却下、expired: 期限切れ） |
issue_date | string | 必須 | 発行日 |
valid_until | string | null | 任意 | 有効期限 |
subtotal | number | 必須 | 小計 |
tax | number | 必須 | 消費税 |
total | number | 必須 | 合計 |
metadata | object | null | 任意 | 拡張メタデータ |
livemode | boolean | 必須 | 本番モードフラグ |
version | number | 必須 | リビジョン番号 |
created_by | string | null | 任意 | 作成者 ID |
updated_by | string | null | 任意 | 更新者 ID |
deleted_at | string | null | 任意 | 削除日時 (ISO 8601) |
created_at | string | 必須 | 作成日時 (ISO 8601) |
system_updated_at | string | 必須 | システム更新日時 (ISO 8601) |
updated_at | string | 必須 | 更新日時 (ISO 8601) |
{
"id": "quot_01JQ3KDEF",
"object": "invoice.quotation",
"organization_id": "org_01HZXYZ",
"external_id": "ext_org_01HZXYZ",
"source_system": "api",
"record_type": "default",
"company_id": "comp_01JQ3KABC",
"status": "sent",
"issue_date": "2026-02-01",
"valid_until": "2026-03-01",
"subtotal": 500000,
"tax": 50000,
"total": 550000,
"metadata": {
"source": "template"
},
"livemode": false,
"version": 2,
"created_by": "usr_99999999999999999999999999999999",
"updated_by": "usr_88888888888888888888888888888888",
"deleted_at": null,
"created_at": "2026-02-01T10:00:00Z",
"system_updated_at": "2026-02-01T10:00:00Z",
"updated_at": "2026-02-01T10:00:00Z"
}Tax Rate object
税率マスターを表すオブジェクトです。請求書明細の税率参照に使用します。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 税率 ID |
object | string | 必須 | オブジェクト種別（`invoice.tax_rate`） |
organization_id | string | 必須 | 組織 ID |
name | string | 必須 | 税率名（例: 消費税10%） |
rate | number | 必須 | 税率（パーセント、例: 10.0） |
category | string | null | 任意 | 税率カテゴリ（standard / reduced / exempt） |
description | string | null | 任意 | 説明 |
effective_from | string | null | 任意 | 適用開始日 (ISO 8601) |
effective_until | string | null | 任意 | 適用終了日 (ISO 8601) |
is_default | boolean | 必須 | デフォルト税率フラグ |
archived | boolean | 必須 | アーカイブ済みフラグ |
created_at | string | 必須 | 作成日時 (ISO 8601) |
updated_at | string | 必須 | 更新日時 (ISO 8601) |
{
"id": "taxrate_01JQ3KXYZ",
"object": "invoice.tax_rate",
"organization_id": "org_01HZXYZ",
"name": "消費税 10%",
"rate": 10,
"category": "standard",
"description": "標準税率",
"effective_from": "2019-10-01",
"effective_until": null,
"is_default": true,
"archived": false,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}