見積書(Quotations)
見積書の作成・送付・受諾/辞退・請求書への変換を管理します。
|
エンドポイント
| GET | /api/v1/quotations | 見積書一覧を取得 |
| POST | /api/v1/quotations | 見積書を作成 |
| GET | /api/v1/quotations/{id} | 見積書を取得 |
| PATCH | /api/v1/quotations/{id} | 見積書を更新 |
| DELETE | /api/v1/quotations/{id} | 見積書を削除 |
| POST | /api/v1/quotations/{id}/send | 見積書を送付済みにする |
| POST | /api/v1/quotations/{id}/accept | 受諾 |
| POST | /api/v1/quotations/{id}/reject | 辞退 |
| POST | /api/v1/quotations/{id}/convert | 請求書に変換 |
| GET | /api/v1/quotations/{id}/pdf | PDF を取得 |
| POST | /api/v1/quotations/{id}/send-email | メールで送付 |
GET
/api/v1/quotations見積書一覧を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
クエリパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
status | string | 任意 | ステータスで絞り込み(draft / sent / accepted / rejected) |
company_id | string | 任意 | 取引先 ID で絞り込み |
search | string | 任意 | 見積書番号・件名で検索 |
limit | integer | 任意 | 取得件数(デフォルト: 20, 最大: 100) |
offset | integer | 任意 | 取得開始位置(デフォルト: 0) |
コード例
curl "https://api.blueai.jp/api/v1/quotations" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/quotations見積書を作成
認証が必要です— セッション Cookie または Bearer トークンを含めてください
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
company_id | string | 必須 | 取引先 ID |
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) |
| object[] | 必須 | 明細行 |
コード例
curl -X POST "https://api.blueai.jp/api/v1/quotations" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/quotations/{id}見積書を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/quotations/{id}見積書を更新
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
company_id | string | 任意 | 取引先 ID |
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) |
| object[] | 任意 | 明細行 |
コード例
curl -X PATCH "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/quotations/{id}見積書を削除
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/quotations/{id}/send見積書を送付済みにする
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000/send" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/quotations/{id}/accept受諾
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000/accept" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/quotations/{id}/reject辞退
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000/reject" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/quotations/{id}/convert請求書に変換
受諾済みの見積書を請求書に変換します。
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000/convert" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/quotations/{id}/pdfPDF を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000/pdf" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/quotations/{id}/send-emailメールで送付
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 見積書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/quotations/quo_123e4567e89b12d3a456426614174000/send-email" \
-H "Cookie: better-auth.session_token=<token>"