請求書(Invoices)
請求書の作成・送付・承認・入金消込・取消を管理します。
|
エンドポイント
| GET | /api/v1/invoices | 請求書一覧を取得 |
| POST | /api/v1/invoices | 請求書を作成 |
| GET | /api/v1/invoices/dashboard | ダッシュボードを取得 |
| GET | /api/v1/invoices/{id} | 請求書を取得 |
| PATCH | /api/v1/invoices/{id} | 請求書を更新 |
| DELETE | /api/v1/invoices/{id} | 請求書を削除 |
| POST | /api/v1/invoices/{id}/approve | 請求書を承認 |
| POST | /api/v1/invoices/{id}/send | 請求書を送付済みにする |
| POST | /api/v1/invoices/{id}/mark-paid | 入金消込 |
| POST | /api/v1/invoices/{id}/cancel | 請求書を取消 |
| GET | /api/v1/invoices/{id}/pdf | PDF を取得 |
| POST | /api/v1/invoices/{id}/send-email | メールで送付 |
GET
/api/v1/invoices請求書一覧を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
クエリパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
status | string | 任意 | ステータスで絞り込み(draft / sent / paid / cancelled) |
company_id | string | 任意 | 取引先 ID で絞り込み |
search | string | 任意 | 請求書番号・件名で検索 |
limit | integer | 任意 | 取得件数(デフォルト: 20, 最大: 100) |
offset | integer | 任意 | 取得開始位置(デフォルト: 0) |
コード例
curl "https://api.blueai.jp/api/v1/invoices" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/invoices請求書を作成
認証が必要です— セッション Cookie または Bearer トークンを含めてください
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
company_id | string | 必須 | 取引先 ID |
invoice_number | string | 任意 | 請求書番号(未指定時は自動採番) |
issue_date | string | 必須 | 発行日(YYYY-MM-DD) |
due_date | string | 必須 | 支払期限(YYYY-MM-DD) |
subject | string | 任意 | 件名 |
issuer_name | string | 任意 | 発行者名 |
issuer_detail | string | 任意 | 発行者詳細 |
memo | string | 任意 | 備考 |
tax_display_mode | string | 任意 | 税表示モード(inclusive / exclusive) |
tax_rounding | string | 任意 | 端数処理(round / floor / ceil) |
withholding_tax_type | string | 任意 | 源泉徴収区分(none / type_1 / type_2) |
bank_name | string | 任意 | 振込先銀行名 |
bank_branch | string | 任意 | 振込先支店名 |
bank_account_type | string | 任意 | 口座種別(ordinary / current) |
bank_account_number | string | 任意 | 口座番号 |
bank_account_holder | string | 任意 | 口座名義 |
| object[] | 必須 | 明細行 |
コード例
curl -X POST "https://api.blueai.jp/api/v1/invoices" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/invoices/dashboardダッシュボードを取得
未送付件数・未入金件数・今月の売上サマリーなどを返します。
認証が必要です— セッション Cookie または Bearer トークンを含めてください
コード例
curl "https://api.blueai.jp/api/v1/invoices/dashboard" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/invoices/{id}請求書を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/invoices/{id}請求書を更新
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
company_id | string | 任意 | 取引先 ID |
invoice_number | string | 任意 | 請求書番号 |
issue_date | string | 任意 | 発行日(YYYY-MM-DD) |
due_date | string | 任意 | 支払期限(YYYY-MM-DD) |
subject | string | 任意 | 件名 |
issuer_name | string | 任意 | 発行者名 |
issuer_detail | string | 任意 | 発行者詳細 |
memo | string | 任意 | 備考 |
tax_display_mode | string | 任意 | 税表示モード(inclusive / exclusive) |
tax_rounding | string | 任意 | 端数処理(round / floor / ceil) |
withholding_tax_type | string | 任意 | 源泉徴収区分(none / type_1 / type_2) |
bank_name | string | 任意 | 振込先銀行名 |
bank_branch | string | 任意 | 振込先支店名 |
bank_account_type | string | 任意 | 口座種別(ordinary / current) |
bank_account_number | string | 任意 | 口座番号 |
bank_account_holder | string | 任意 | 口座名義 |
| object[] | 任意 | 明細行 |
コード例
curl -X PATCH "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/invoices/{id}請求書を削除
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/invoices/{id}/approve請求書を承認
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000/approve" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/invoices/{id}/send請求書を送付済みにする
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000/send" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/invoices/{id}/mark-paid入金消込
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000/mark-paid" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/invoices/{id}/cancel請求書を取消
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000/cancel" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/invoices/{id}/pdfPDF を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000/pdf" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/invoices/{id}/send-emailメールで送付
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 請求書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/invoices/inv_123e4567e89b12d3a456426614174000/send-email" \
-H "Cookie: better-auth.session_token=<token>"