openapi: 3.0.1 info: title: freee販売 API version: '2026-02-16' termsOfService: https://app.secure.freee.co.jp/terms-freee-api.html contact: name: サポートデスクへのお問い合わせ url: https://accounts.secure.freee.co.jp/contacts?from=sales_management license: name: © Since 2013 freee K.K. description: |-

スタートガイド

freee API開発がはじめての方はfreee APIスタートガイドを参照してください。


仕様

APIエンドポイント

https://api.freee.co.jp/sm (httpsのみ)

認証について

OAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。

データフォーマット

リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄(application/jsonなど)を確認してください。

後方互換性ありの変更

freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。

共通レスポンスヘッダー

すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。

共通エラーレスポンス

APIリクエストでエラーが発生した場合は、エラー原因に応じたステータスコードおよびメッセージを返します。

一部のエラーレスポンスにはエラーコードが含まれます。
詳細は、HTTPステータスコード400台エラー時のチェックポイントを参照してください

ステータスコード 原因
400リクエストパラメータが不正
401アクセストークンが無効
403アクセス権限がない
404リソースが存在しない
429リクエスト回数制限を超えた
503システム内で予期しないエラーが発生

メッセージボディ内の errors.messages message にはエラー内容を説明する文字列が入ります。

  {
        "status_code" : 400,
        "errors" : [
          {
            "codes" : [
              "bad_request"
            ],
            "messages" : [
              "リクエストの形式が不正です。"
            ]
          }
        ]
      }  
  {
        "message" : "ログインをして下さい",
        "code" : "invalid_access_token"
      }  

API使用制限

APIリクエストは1分あたり30回、および1時間あたり1500回を上限としています。
API使用ステータスはレスポンスヘッダに付与されます。各ヘッダの意味は次のとおりです。

ヘッダ名 説明
X-RateLimit-Limit 1時間の使用回数の上限
X-RateLimit-Remaining 1時間の残り使用回数
X-RateLimit-Reset 1時間の使用回数がリセットされる時刻
X-RateLimit-Limit-Minute 1分間の使用回数の上限
X-RateLimit-Remaining-Minute 1分間の残り使用回数
X-RateLimit-Reset-Minute 1分間の使用回数がリセットされる時刻

この上限を超えた場合APIアクセスは制限され、http status codeは429となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。

また、上記に加えfreeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。
その際のhttp status codeは403となります。こちらも制限がかかってから10分程度が過ぎると再度使用することができるようになります。

プランごとの利用可能API

すべてのエンドポイントはfreee販売スタンダードプランをご契約の事業所でのみ利用可能です。

会計マスタ項目

freee請求書APIのリクエストパラメータに、会計マスタ項目があります。会計マスタ項目の詳細は会計マスタガイドラインを参照ください。

会計のマスタ項目はfreee会計APIのエンドポイントにて取得可能です(例:Partners 取引先)。freee会計APIのエンドポイントの詳細は会計APIリファレンスを参照ください。

servers: - url: https://api.freee.co.jp/sm security: - oauth2: - write - read tags: - name: businesses description: 案件 - name: cost_budgets description: 原価予算 - name: purchase_orders description: 発注 - name: quotations description: 見積 - name: sales_orders description: 受注 - name: deliveries description: 納品 - name: sales description: 売上 - name: other_costs description: その他原価 - name: procurements description: 仕入 - name: master description: 関連マスタ paths: /businesses: get: tags: - businesses summary: 案件一覧 description: |-

概要

案件の一覧を取得します。 登録されている案件情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する案件のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_businesses parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/start_business_date' - $ref: '#/components/parameters/end_business_date' - $ref: '#/components/parameters/start_last_updated_date' - $ref: '#/components/parameters/end_last_updated_date' - $ref: '#/components/parameters/sales_progression_ids' - $ref: '#/components/parameters/business_phase_ids' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/customer_ids' - $ref: '#/components/parameters/code' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/BusinessIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - businesses summary: 案件登録 description: |-

概要

新しい案件を登録します。 顧客との商談や受注案件を管理するための案件情報を登録できます。

定義

必須項目

任意項目

operationId: create_business requestBody: $ref: '#/components/requestBodies/BusinessCreateRequest' responses: '201': $ref: '#/components/responses/BusinessCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /businesses/{id}: get: tags: - businesses summary: 案件詳細取得 description: |-

概要

指定されたIDの案件の詳細情報を取得します。 案件の基本情報に加えて、粗利や売上情報などの詳細な集計情報も取得できます。

operationId: get_business parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 案件ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM responses: '200': $ref: '#/components/responses/BusinessShowResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' patch: tags: - businesses summary: 案件更新 description: |-

概要

指定されたIDの案件を更新します。 案件の基本情報、受注見込、完了予定日などを部分的に更新できます。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

※custom_fieldsを指定した場合、リクエストに含まれないカスタム項目はnullとして扱われます。必須のカスタム項目が指定されていない場合はバリデーションエラーになります。

operationId: update_business parameters: - name: id in: path required: true description: 案件ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/BusinessUpdateRequest' responses: '200': $ref: '#/components/responses/BusinessUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /businesses/{id}/cancellation: post: tags: - businesses summary: 案件取消 description: |-

概要

指定されたIDの案件を取消します。

operationId: cancel_business parameters: - name: id in: path required: true description: 案件ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/BusinessCancelRequest' responses: '200': $ref: '#/components/responses/BusinessCancelResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /businesses/{id}/close: post: tags: - businesses summary: 案件ロック description: |-

概要

指定されたIDの案件をロックします。

operationId: close_business parameters: - name: id in: path required: true description: 案件ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/BusinessCloseRequest' responses: '200': $ref: '#/components/responses/BusinessCloseResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /businesses/{id}/reopen: post: tags: - businesses summary: 案件ロック解除 description: |-

概要

指定されたIDの案件ロックを解除します。

operationId: reopen_business parameters: - name: id in: path required: true description: 案件ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/BusinessReopenRequest' responses: '200': $ref: '#/components/responses/BusinessReopenResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /cost_budgets: get: tags: - cost_budgets summary: 原価予算一覧 description: |-

概要

原価予算の一覧を取得します。 登録されている原価予算情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する原価予算のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_cost_budgets parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/type' - $ref: '#/components/parameters/start_amount_excluding_tax' - $ref: '#/components/parameters/end_amount_excluding_tax' - $ref: '#/components/parameters/start_date_period' - $ref: '#/components/parameters/end_date_period' - $ref: '#/components/parameters/master_item_ids' - $ref: '#/components/parameters/start_quantity' - $ref: '#/components/parameters/end_quantity' - $ref: '#/components/parameters/start_unit_price' - $ref: '#/components/parameters/end_unit_price' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/reporting_section_ids' - $ref: '#/components/parameters/supplier_ids' - $ref: '#/components/parameters/payment_partner_ids' - $ref: '#/components/parameters/accounting_reporting_section_ids' - $ref: '#/components/parameters/item_tag_ids' - $ref: '#/components/parameters/segment_tag_1_ids' - $ref: '#/components/parameters/segment_tag_2_ids' - $ref: '#/components/parameters/segment_tag_3_ids' - $ref: '#/components/parameters/business_ids' - $ref: '#/components/parameters/cost_budget_no' - $ref: '#/components/parameters/parameters-start_last_updated_date' - $ref: '#/components/parameters/parameters-end_last_updated_date' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/CostBudgetIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - cost_budgets summary: 原価予算登録 description: |-

概要

原価予算を新規登録します。 type で原価種別を指定してください。procurement(仕入)はリクエストスキーマが異なります。external_procurement(外部仕入)と other_cost(その他原価)は同じリクエストスキーマを使用します。

定義

全type共通フィールド

type=procurement 固有フィールド

type=external_procurement / type=other_cost 固有フィールド

operationId: create_cost_budget requestBody: $ref: '#/components/requestBodies/CostBudgetCreateRequest' responses: '201': $ref: '#/components/responses/CostBudgetCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /cost_budgets/{id}: get: tags: - cost_budgets summary: 原価予算詳細取得 description: |-

概要

指定されたIDの原価予算の詳細情報を取得します。

operationId: get_cost_budget parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 原価予算ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM responses: '200': $ref: '#/components/responses/CostBudgetShowResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' patch: tags: - cost_budgets summary: 原価予算更新 description: |-

概要

指定されたIDの原価予算を更新します。 原価種別に応じて使用可能なフィールドが異なります。 送信したフィールドのみ更新されます。 なお原価種別を変更することはできません。

定義

全type共通フィールド

type=procurement 固有フィールド(外部仕入・その他原価では送信不可)

type=external_procurement / type=other_cost 固有フィールド(仕入では送信不可)

operationId: update_cost_budget parameters: - name: id in: path required: true description: 原価予算ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/CostBudgetUpdateRequest' responses: '200': $ref: '#/components/responses/CostBudgetUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /cost_budgets/{id}/cancellation: post: tags: - cost_budgets summary: 原価予算取消 description: |-

概要

指定されたIDの原価予算を取り消します。

operationId: cancel_cost_budget parameters: - name: id in: path required: true description: 原価予算ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/CostBudgetCancelRequest' responses: '200': $ref: '#/components/responses/CostBudgetCancelResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /master/business_phases: get: tags: - master summary: 案件フェーズ一覧 description: |-

概要

案件フェーズ一覧を取得します。 使用可能なもののみを返却します。

operationId: get_master_business_phases parameters: - $ref: '#/components/parameters/company_id' responses: '200': $ref: '#/components/responses/BusinessPhasesIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /master/sales_progressions: get: tags: - master summary: 受注確度一覧 description: |-

概要

受注確度情報を取得します。 使用可能なもののみを返却します。

operationId: get_sales_progressions parameters: - $ref: '#/components/parameters/company_id' responses: '200': $ref: '#/components/responses/SalesProgressionIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /master/items: get: tags: - master summary: 商品一覧 description: |-

概要

商品情報を取得します。 使用可能なもののみを返却します。

operationId: get_master_items parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/offset' - name: limit description: 取得レコードの件数(デフォルト:100, 最小:1, 最大:500) in: query required: false schema: type: integer format: int32 minimum: 1 maximum: 500 default: 100 - name: type description: '業務区分 (sales: 販売系, procurement: 調達系)' in: query required: true schema: type: string enum: - sales - procurement responses: '200': $ref: '#/components/responses/ItemsIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /master/deal_line_types: get: tags: - master summary: 明細取引タイプ一覧 description: |-

概要

明細取引タイプ一覧を取得します。 使用停止中のものはレスポンスに含まれません。

operationId: get_master_deal_line_types parameters: - $ref: '#/components/parameters/company_id' - name: type description: '利用区分: 販売系、調達系どちらの明細取引タイプを取得するか' in: query required: true schema: type: string enum: - sales - procurement responses: '200': $ref: '#/components/responses/DealLineTypesIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /master/employees: get: tags: - master summary: 従業員一覧 description: |-

概要

従業員一覧を取得します。 使用可能なもののみを返却します。

operationId: get_master_employees parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/offset' - name: limit description: 取得レコードの件数(デフォルト:100, 最小:1, 最大:500) in: query required: false schema: type: integer format: int32 minimum: 1 maximum: 500 default: 100 responses: '200': $ref: '#/components/responses/EmployeesIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /master/custom_fields/business/definitions: get: tags: - master summary: 案件カスタム項目定義一覧 description: |-

概要

カスタム項目定義の一覧を取得します。 使用可能なもののみを返却します。

入力形式の一覧

operationId: get_master_custom_fields_business_definitions parameters: - $ref: '#/components/parameters/company_id' responses: '200': $ref: '#/components/responses/CustomFieldDefinitionsIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /purchase_orders: get: tags: - purchase_orders summary: 発注一覧 description: |-

概要

発注の一覧を取得します。 登録されている発注情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する発注のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_purchase_orders parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/purchase_order_start_registered_date' - $ref: '#/components/parameters/purchase_order_end_registered_date' - $ref: '#/components/parameters/purchase_order_start_last_updated_date' - $ref: '#/components/parameters/purchase_order_end_last_updated_date' - $ref: '#/components/parameters/start_purchase_order_date' - $ref: '#/components/parameters/end_purchase_order_date' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/supplier_ids' - $ref: '#/components/parameters/business_ids' - $ref: '#/components/parameters/purchase_order_no' - $ref: '#/components/parameters/payment_status' - $ref: '#/components/parameters/issued' - $ref: '#/components/parameters/procurement_status' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/PurchaseOrderIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - purchase_orders summary: 発注登録 description: |-

概要

新しい発注を登録します。 仕入先への発注情報を登録し、発注書の発行や仕入への引き継ぎに利用できます。

定義

必須項目

任意項目

注意点

適格請求書発行事業者該当フラグ(is_qualified_invoice_issuer)について

本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。

登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。

operationId: create_purchase_order requestBody: $ref: '#/components/requestBodies/PurchaseOrderCreateRequest' responses: '201': $ref: '#/components/responses/PurchaseOrderCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /purchase_orders/{id}: get: tags: - purchase_orders summary: 発注詳細取得 description: |-

概要

指定されたIDの発注の詳細情報を取得します。 発注の基本情報に加えて、明細情報や各種ステータスなどの詳細な情報も取得できます。

operationId: get_purchase_order parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 発注ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 responses: '200': description: 発注詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderDetail' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' patch: tags: - purchase_orders summary: 発注更新 description: |-

概要

指定されたIDの発注を更新します。 発注の基本情報を部分的に更新できます。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

※recipient_addressを指定した場合、リクエストに含まれない項目はnullとして扱われます。

注意点

適格請求書発行事業者該当フラグ(is_qualified_invoice_issuer)について

本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。

登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。

operationId: update_purchase_order parameters: - name: id in: path required: true description: 発注ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/PurchaseOrderUpdateRequest' responses: '200': $ref: '#/components/responses/PurchaseOrderUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /purchase_orders/{id}/cancellation: post: tags: - purchase_orders summary: 発注取消 description: |-

概要

指定されたIDの発注を取り消します。

定義

必須項目

operationId: cancel_purchase_order parameters: - name: id in: path required: true description: 発注ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/PurchaseOrderCancellationRequest' responses: '200': $ref: '#/components/responses/PurchaseOrderCancellationResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /quotations: get: tags: - quotations summary: 見積一覧 description: |-

概要

見積の一覧を取得します。 登録されている見積情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する見積のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_quotations parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/start_registered_date' - $ref: '#/components/parameters/end_registered_date' - $ref: '#/components/parameters/components-parameters-start_last_updated_date' - $ref: '#/components/parameters/components-parameters-end_last_updated_date' - $ref: '#/components/parameters/start_quotation_date' - $ref: '#/components/parameters/end_quotation_date' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/customer_ids' - name: business_ids[] description: 案件ID in: query required: false style: form explode: true schema: type: array items: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM - $ref: '#/components/parameters/quotation_no' - $ref: '#/components/parameters/quotation_status' - $ref: '#/components/parameters/billing_status' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/QuotationIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - quotations summary: 見積登録 description: |-

概要

新しい見積を登録します。 顧客への見積情報を登録し、見積書の発行や受注への引き継ぎに利用できます。

定義

必須項目

任意項目

operationId: create_quotation requestBody: $ref: '#/components/requestBodies/QuotationCreateRequest' responses: '201': $ref: '#/components/responses/QuotationCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /quotations/{id}: get: tags: - quotations summary: 見積詳細取得 description: |-

概要

指定されたIDの見積の詳細情報を取得します。 見積の基本情報に加えて、明細情報や各種ステータスなどの詳細な情報も取得できます。

operationId: get_quotation parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 見積ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 responses: '200': description: 見積詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/QuotationDetail' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' patch: tags: - quotations summary: 見積更新 description: |-

概要

指定されたIDの見積を更新します。 見積の基本情報を部分的に更新できます。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

※recipient_addressを指定した場合、リクエストに含まれない項目はnullとして扱われます。

注意点

明細行の金額再計算について

見積を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。

見積書への反映について

発行済みの見積書がある場合、見積情報を更新しても見積書の内容には自動で反映されません。見積書の内容を更新するには、再発行が必要です。

operationId: update_quotation parameters: - name: id in: path required: true description: 見積ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/QuotationUpdateRequest' responses: '200': $ref: '#/components/responses/QuotationUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /quotations/{id}/quotation_status: put: tags: - quotations summary: 見積ステータス変更 description: |-

概要

指定されたIDの見積のステータスを変更します。 見積のステータス(未受注/失注)を更新できます。

定義

※ステータス変更は取り消されていない見積に対してのみ可能です。

※受注済(order_received)への変更は本APIでは行えません。受注登録APIで対象の見積を指定して受注登録することで、見積ステータスが自動的に受注済へ更新されます。

operationId: update_quotation_status parameters: - name: id in: path required: true description: 見積ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: description: 見積ステータス変更リクエスト required: true content: application/json: schema: $ref: '#/components/schemas/QuotationStatusChangeRequest' responses: '200': description: 見積ステータス変更のレスポンス content: application/json: schema: $ref: '#/components/schemas/QuotationMinimalResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /quotations/{id}/cancellation: post: tags: - quotations summary: 見積取消 description: |-

概要

指定されたIDの見積を取り消します。

operationId: cancel_quotation parameters: - name: id in: path required: true description: 見積ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/QuotationCancellationRequest' responses: '200': $ref: '#/components/responses/QuotationCancellationResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /sales_orders: get: tags: - sales_orders summary: 受注一覧 description: |-

概要

受注の一覧を取得します。 登録されている受注情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する受注のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_sales_orders parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/parameters-start_last_updated_date' - $ref: '#/components/parameters/parameters-end_last_updated_date' - $ref: '#/components/parameters/start_sales_order_date' - $ref: '#/components/parameters/end_sales_order_date' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/customer_ids' - $ref: '#/components/parameters/sales_order_no' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/SalesOrderIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - sales_orders summary: 受注登録 description: |-

概要

新しい受注を登録します。 顧客からの注文情報を登録し、納品・請求・入金の予定情報を管理できます。

定義

必須項目

任意項目

operationId: create_sales_order requestBody: $ref: '#/components/requestBodies/SalesOrderCreateRequest' responses: '201': $ref: '#/components/responses/SalesOrderCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /sales_orders/{id}: get: tags: - sales_orders summary: 受注詳細取得 description: |-

概要

指定されたIDの受注の詳細情報を取得します。 受注の基本情報に加えて、納品・請求・入金情報などの詳細な進捗情報も取得できます。

operationId: get_sales_order parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 受注ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 responses: '200': description: 受注詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/SalesOrderDetail' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' patch: tags: - sales_orders summary: 受注更新 description: |-

概要

指定されたIDの受注を更新します。 受注の基本情報、納品・請求・入金情報などを部分的に更新できます。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

注意点

受注を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。

operationId: update_sales_order parameters: - name: id in: path required: true description: 受注ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/SalesOrderUpdateRequest' responses: '200': $ref: '#/components/responses/SalesOrderUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /sales_orders/{id}/cancellation: post: tags: - sales_orders summary: 受注取消 description: |-

概要

指定されたIDの受注を取消します。

operationId: cancel_sales_order parameters: - name: id in: path required: true description: 受注ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/SalesOrderCancelRequest' responses: '200': $ref: '#/components/responses/SalesOrderCancelResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /deliveries: get: tags: - deliveries summary: 納品一覧 description: |-

概要

納品の一覧を取得します。 登録されている納品情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する納品のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_deliveries parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/parameters-start_registered_date' - $ref: '#/components/parameters/parameters-end_registered_date' - $ref: '#/components/parameters/parameters-start_last_updated_date' - $ref: '#/components/parameters/parameters-end_last_updated_date' - $ref: '#/components/parameters/start_delivery_date' - $ref: '#/components/parameters/end_delivery_date' - $ref: '#/components/parameters/start_acceptance_date' - $ref: '#/components/parameters/end_acceptance_date' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/customer_ids' - $ref: '#/components/parameters/delivery_no' - $ref: '#/components/parameters/delivery_status' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/DeliveryIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - deliveries summary: 納品登録 description: |-

概要

新しい納品を登録します。 受注に紐づく納品、または独立した納品を登録できます。

定義

必須項目

任意項目

operationId: create_delivery requestBody: $ref: '#/components/requestBodies/DeliveryCreateRequest' responses: '201': $ref: '#/components/responses/DeliveryCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /deliveries/{id}: get: tags: - deliveries summary: 納品詳細取得 description: |-

概要

指定されたIDの納品の詳細情報を取得します。 納品の基本情報に加えて、売上・請求情報などの詳細な進捗情報も取得できます。

operationId: get_delivery parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 納品ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 responses: '200': description: 納品詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/DeliveryDetail' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' patch: tags: - deliveries summary: 納品更新 description: |-

概要

指定されたIDの納品を更新します。 納品の基本情報、請求・入金情報などを部分的に更新できます。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

※recipient_addressを指定した場合、リクエストに含まれない項目はnullとして扱われます。

注意点

明細行の金額再計算について

納品を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。

納品書への反映について

発行済みの納品書がある場合、納品情報を更新しても納品書の内容には自動で反映されません。納品書の内容を更新するには、再発行が必要です。

operationId: update_delivery parameters: - name: id in: path required: true description: 納品ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/DeliveryUpdateRequest' responses: '200': $ref: '#/components/responses/DeliveryUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /deliveries/{id}/cancellation: post: tags: - deliveries summary: 納品取消 description: |-

概要

指定されたIDの納品を取消します。

operationId: cancel_delivery parameters: - name: id in: path required: true description: 納品ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/DeliveryCancelRequest' responses: '200': $ref: '#/components/responses/DeliveryCancelResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /deliveries/{id}/delivery_status: put: tags: - deliveries summary: 納品ステータス変更 description: |-

概要

指定されたIDの納品の納品ステータスを変更します。

定義

operationId: update_delivery_status parameters: - name: id in: path required: true description: 納品ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: description: 納品ステータス変更リクエスト required: true content: application/json: schema: $ref: '#/components/schemas/DeliveryStatusChangeRequest' responses: '200': $ref: '#/components/responses/DeliveryUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /deliveries/{id}/acceptance_status: put: tags: - deliveries summary: 検収ステータス変更 description: |-

概要

指定されたIDの納品の検収ステータスを変更します。

定義

operationId: update_acceptance_status parameters: - name: id in: path required: true description: 納品ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: description: 検収ステータス変更リクエスト required: true content: application/json: schema: $ref: '#/components/schemas/AcceptanceStatusChangeRequest' responses: '200': $ref: '#/components/responses/DeliveryUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /sales: get: tags: - sales summary: 売上一覧 description: |-

概要

売上の一覧を取得します。 登録されている売上情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する売上のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_sales parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/components-parameters-start_registered_date' - $ref: '#/components/parameters/components-parameters-end_registered_date' - $ref: '#/components/parameters/start_revenue_recognition_date' - $ref: '#/components/parameters/end_revenue_recognition_date' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/customer_ids' - $ref: '#/components/parameters/parameters-billing_status' - $ref: '#/components/parameters/collection_status' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/SalesIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - sales summary: 売上登録 description: |-

概要

新しい売上を登録します。 受注や納品に紐づく売上、または独立した売上を登録できます。

定義

必須項目

任意項目

operationId: create_sale requestBody: $ref: '#/components/requestBodies/SaleCreateRequest' responses: '201': $ref: '#/components/responses/SaleCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /sales/{id}: get: tags: - sales summary: 売上詳細取得 description: |-

概要

指定されたIDの売上の詳細情報を取得します。 売上の基本情報に加えて、請求・入金情報などの詳細な進捗情報も取得できます。

operationId: get_sale parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 売上ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 responses: '200': description: 売上詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/SaleDetail' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' patch: tags: - sales summary: 売上更新 description: |-

概要

指定されたIDの売上を更新します。 売上の基本情報、請求・入金情報などを部分的に更新できます。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

注意点

明細行の金額再計算について

売上を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。

請求書への反映について

発行済みの請求書がある場合、売上情報を更新すると請求データは更新されますが、請求書の内容には自動で反映されません。請求書の内容を更新するには、再発行が必要です。

operationId: update_sale parameters: - name: id in: path required: true description: 売上ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/SaleUpdateRequest' responses: '200': $ref: '#/components/responses/SaleUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /sales/{id}/cancellation: post: tags: - sales summary: 売上取消 description: |-

概要

指定されたIDの売上を取消します。

operationId: cancel_sale parameters: - name: id in: path required: true description: 売上ID schema: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM requestBody: $ref: '#/components/requestBodies/SaleCancelRequest' responses: '200': $ref: '#/components/responses/SaleCancelResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /other_costs: get: tags: - other_costs summary: その他原価一覧 description: |-

概要

その他原価の一覧を取得します。 登録されているその他原価情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致するその他原価のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

operationId: get_other_costs parameters: - $ref: '#/components/parameters/company_id' - name: start_amount_excluding_tax description: 金額(税抜)で絞込:下限 in: query required: false schema: type: integer format: int64 maximum: 999999999999 minimum: -999999999999 - name: end_amount_excluding_tax description: 金額(税抜)で絞込:上限 in: query required: false schema: type: integer format: int64 maximum: 999999999999 minimum: -999999999999 - name: business_ids[] description: 案件ID in: query required: false style: form explode: true schema: type: array items: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM - $ref: '#/components/parameters/other_cost_no' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/parameters-start_last_updated_date' - $ref: '#/components/parameters/parameters-end_last_updated_date' - name: start_incurred_date description: 発生日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' - name: end_incurred_date description: 発生日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-12-31' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/OtherCostIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - other_costs summary: その他原価登録 description: |-

概要

新しいその他原価を登録します。 案件に紐づくその他原価、または案件に紐づかないその他原価を登録できます。

定義

必須項目

任意項目

operationId: create_other_cost requestBody: $ref: '#/components/requestBodies/OtherCostCreateRequest' responses: '201': $ref: '#/components/responses/OtherCostCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /other_costs/{id}: patch: tags: - other_costs summary: その他原価更新 description: |-

概要

指定されたIDのその他原価を更新します。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

注意点

freee会計の取引明細インポートから登録されたその他原価は本APIでは更新できません。該当データを更新しようとした場合はエラーになります。

operationId: update_other_cost parameters: - name: id in: path required: true description: その他原価ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/OtherCostUpdateRequest' responses: '200': $ref: '#/components/responses/OtherCostUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' get: tags: - other_costs summary: その他原価詳細取得 description: |-

概要

指定されたIDのその他原価の詳細情報を取得します。

operationId: get_other_cost parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: その他原価ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 responses: '200': description: その他原価詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/OtherCostDetail' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /other_costs/{id}/restoration: post: tags: - other_costs summary: その他原価復元 description: |-

概要

指定されたIDの取消済みその他原価を復元します。

operationId: restore_other_cost parameters: - name: id in: path required: true description: その他原価ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/OtherCostRestorationRequest' responses: '200': $ref: '#/components/responses/OtherCostRestorationResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /other_costs/{id}/cancellation: post: tags: - other_costs summary: その他原価取消 description: |-

概要

指定されたIDのその他原価を取り消します。

operationId: cancel_other_cost parameters: - name: id in: path required: true description: その他原価ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/OtherCostCancellationRequest' responses: '200': $ref: '#/components/responses/OtherCostCancellationResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /procurements: get: tags: - procurements summary: 仕入一覧 description: |-

概要

仕入の一覧を取得します。 登録されている仕入情報を一覧形式で取得できます。 各種フィルタ条件を指定することで、特定の条件に合致する仕入のみを取得することが可能です。

定義

`limit`と`offset`パラメータを使用してページネーションが可能です。 デフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。

注意点

business_ids による絞り込みについて

仕入は明細単位で複数の案件と紐付けることができます。複数の案件が紐づく仕入は本パラメータでは検索ヒットしません。

operationId: get_procurements parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/procurements_controller.openapi_components-parameters-start_registered_date' - $ref: '#/components/parameters/procurements_controller.openapi_components-parameters-end_registered_date' - $ref: '#/components/parameters/procurements_controller.openapi_components-parameters-start_last_updated_date' - $ref: '#/components/parameters/procurements_controller.openapi_components-parameters-end_last_updated_date' - $ref: '#/components/parameters/start_procurement_date' - $ref: '#/components/parameters/end_procurement_date' - $ref: '#/components/parameters/charge_employee_ids' - $ref: '#/components/parameters/supplier_ids' - $ref: '#/components/parameters/parameters-business_ids' - $ref: '#/components/parameters/procurement_no' - $ref: '#/components/parameters/parameters-payment_status' - $ref: '#/components/parameters/canceled' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/ProcurementIndexResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' post: tags: - procurements summary: 仕入登録 description: |-

概要

新しい仕入を登録します。 仕入先への仕入情報を登録し、支払管理や会計連携に利用できます。

定義

必須項目

任意項目

注意点

適格請求書発行事業者該当フラグ(is_qualified_invoice_issuer)について

本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。

登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。

案件・発注の複数紐付けについて

仕入は明細(lines)単位で案件(business_id)・発注(purchase_order_id)を紐付けることができます。レスポンスのヘッダーレベルの business / purchase_order_id は明細に紐づくものが単一の場合のみ値が設定され、複数紐づく場合は null になります。

operationId: create_procurement requestBody: $ref: '#/components/requestBodies/ProcurementCreateRequest' responses: '201': $ref: '#/components/responses/ProcurementCreateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /procurements/{id}: patch: tags: - procurements summary: 仕入更新 description: |-

概要

指定されたIDの仕入を更新します。 仕入の基本情報を部分的に更新できます。 送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。

定義

更新可能項目

※全ての項目は任意です。更新したい項目のみを送信してください。

注意点

明細行のpurchase_order_id(発注ID)について

linesを指定して明細を更新する場合、各明細行でpurchase_order_idを省略する、またはnullを指定すると発注との紐づけが解除されます。既存の発注との紐づけを維持したい場合は、必ずpurchase_order_idを指定してください。

適格請求書発行事業者該当フラグ(is_qualified_invoice_issuer)について

本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。

登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。

operationId: update_procurement parameters: - name: id in: path required: true description: 仕入ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/ProcurementUpdateRequest' responses: '200': $ref: '#/components/responses/ProcurementUpdateResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' get: tags: - procurements summary: 仕入詳細取得 description: |-

概要

指定されたIDの仕入の詳細情報を取得します。 仕入の基本情報に加えて、明細情報や各種ステータスなどの詳細な情報も取得できます。

operationId: get_procurement parameters: - $ref: '#/components/parameters/company_id' - name: id in: path required: true description: 仕入ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 responses: '200': description: 仕入詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/ProcurementDetail' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' /procurements/{id}/cancellation: post: tags: - procurements summary: 仕入取消 description: |-

概要

指定されたIDの仕入を取り消します。

定義

必須項目

operationId: cancel_procurement parameters: - name: id in: path required: true description: 仕入ID schema: type: string example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 requestBody: $ref: '#/components/requestBodies/ProcurementCancellationRequest' responses: '200': $ref: '#/components/responses/ProcurementCancellationResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' components: securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://accounts.secure.freee.co.jp/public_api/authorize tokenUrl: https://accounts.secure.freee.co.jp/public_api/token scopes: write: データの書き込み read: データの読み取り parameters: company_id: name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 1 start_business_date: name: start_business_date description: 案件登録日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date end_business_date: name: end_business_date description: 案件登録日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date start_last_updated_date: name: start_last_updated_date description: 案件更新日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' end_last_updated_date: name: end_last_updated_date description: 案件更新日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' sales_progression_ids: name: sales_progression_ids[] description: 受注確度ID in: query required: false style: form explode: true schema: type: array items: type: string maxLength: 26 minLength: 26 example: 01K35WX4YTCRD5KG58GGWEV8JT business_phase_ids: name: business_phase_ids[] description: 案件フェーズID in: query required: false style: form explode: true schema: type: array items: type: string maxLength: 26 minLength: 26 example: 01K35WX4YTCRD5KG58GGWEV8JT charge_employee_ids: name: charge_employee_ids[] description: 社内担当者の従業員ID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 1001 customer_ids: name: customer_ids[] description: 顧客の取引先ID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 12345 code: name: code description: 案件コードで絞込 in: query required: false schema: type: string example: B-0000000003 canceled: name: canceled description: 取消状態 in: query required: false schema: type: boolean default: false limit: name: limit description: 取得レコードの件数(デフォルト:20, 最小:1, 最大:100) in: query required: false schema: type: integer format: int32 minimum: 1 maximum: 100 default: 20 offset: name: offset description: 取得レコードのオフセット(デフォルト:0) in: query required: false schema: type: integer format: int32 minimum: 0 maximum: 2147483647 default: 0 type: name: type description: '原価種別 (仕入: procurement, 外部仕入: external_procurement, その他原価: other_cost)' in: query required: false schema: type: string enum: - procurement - external_procurement - other_cost example: procurement start_amount_excluding_tax: name: start_amount_excluding_tax description: 金額(税抜):下限 in: query required: false schema: type: integer format: int64 example: 100 maximum: 999999999999 minimum: -999999999999 end_amount_excluding_tax: name: end_amount_excluding_tax description: 金額(税抜):上限 in: query required: false schema: type: integer format: int64 example: 1000 maximum: 999999999999 minimum: -999999999999 start_date_period: name: start_date_period description: 発生予定期間:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-04-01' end_date_period: name: end_date_period description: 発生予定期間:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-06-30' master_item_ids: name: master_item_ids[] description: 商品ID in: query required: false style: form explode: true schema: type: array items: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM start_quantity: name: start_quantity description: 数量:下限 in: query required: false schema: type: integer format: int64 maximum: 99999999 minimum: -99999999 example: 1 end_quantity: name: end_quantity description: 数量:上限 in: query required: false schema: type: integer format: int64 maximum: 99999999 minimum: -99999999 example: 100 start_unit_price: name: start_unit_price description: 単価:下限 in: query required: false schema: type: integer format: int64 maximum: 999999999999 minimum: -999999999999 example: 100 end_unit_price: name: end_unit_price description: 単価:上限 in: query required: false schema: type: integer format: int64 maximum: 999999999999 minimum: -999999999999 example: 10000 reporting_section_ids: name: reporting_section_ids[] description: 担当部門ID in: query required: false style: form explode: true schema: allOf: - $ref: '#/components/schemas/ReportingSectionIds' supplier_ids: name: supplier_ids[] description: 仕入先の取引先ID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 1001 payment_partner_ids: name: payment_partner_ids[] description: 支払先の取引先ID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 1002 accounting_reporting_section_ids: name: accounting_reporting_section_ids[] description: 会計計上部門ID in: query required: false style: form explode: true schema: allOf: - $ref: '#/components/schemas/ReportingSectionIds' item_tag_ids: name: item_tag_ids[] description: 会計品目タグID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 2001 segment_tag_1_ids: name: segment_tag_1_ids[] description: セグメントタグ1 ID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 12345 segment_tag_2_ids: name: segment_tag_2_ids[] description: セグメントタグ2 ID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 12345 segment_tag_3_ids: name: segment_tag_3_ids[] description: セグメントタグ3 ID in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 12345 business_ids: name: business_ids[] description: 案件ID in: query required: false style: form explode: true schema: type: array items: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM cost_budget_no: name: cost_budget_no description: 原価予算No.で絞込 in: query required: false schema: type: string example: CB-2024-0001 parameters-start_last_updated_date: name: start_last_updated_date description: 更新日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' parameters-end_last_updated_date: name: end_last_updated_date description: 更新日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' purchase_order_start_registered_date: name: start_registered_date description: 発注登録日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' purchase_order_end_registered_date: name: end_registered_date description: 発注登録日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' purchase_order_start_last_updated_date: name: start_last_updated_date description: 発注更新日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' purchase_order_end_last_updated_date: name: end_last_updated_date description: 発注更新日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' start_purchase_order_date: name: start_purchase_order_date description: 発注日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' end_purchase_order_date: name: end_purchase_order_date description: 発注日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' purchase_order_no: name: purchase_order_no description: 発注No.で絞込 in: query required: false schema: type: string example: PO-2024-0001 payment_status: name: payment_status description: '支払ステータス (なし: none, 未決済: not_settled, 一部決済済: partially_settled, 決済済: settled)' in: query required: false schema: type: string enum: - none - not_settled - partially_settled - settled example: not_settled issued: name: issued description: 送付ステータス in: query required: false schema: type: boolean procurement_status: name: procurement_status description: '仕入ステータス (未計上: not_sold, 一部計上済: partially_sold, 計上済: sold)' in: query required: false schema: type: string enum: - not_sold - partially_sold - sold example: not_sold start_registered_date: name: start_registered_date description: 見積登録日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' end_registered_date: name: end_registered_date description: 見積登録日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' components-parameters-start_last_updated_date: name: start_last_updated_date description: 見積更新日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' components-parameters-end_last_updated_date: name: end_last_updated_date description: 見積更新日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' start_quotation_date: name: start_quotation_date description: 見積日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' end_quotation_date: name: end_quotation_date description: 見積日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' quotation_no: name: quotation_no description: 見積No.で絞込 in: query required: false schema: type: string example: Q-2024-0001 quotation_status: name: quotation_status description: '見積ステータス (未受注: unanswered, 受注済: order_received, 失注: order_lost)' in: query required: false schema: type: string enum: - unanswered - order_received - order_lost example: unanswered billing_status: name: billing_status description: '請求書送付ステータス (未請求: not_billed, 一部請求済: partially_billed, 請求済: billed, なし: none)' in: query required: false schema: type: string enum: - not_billed - partially_billed - billed - none example: not_billed start_sales_order_date: name: start_sales_order_date description: 受注日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2024-01-01' end_sales_order_date: name: end_sales_order_date description: 受注日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2024-12-31' sales_order_no: name: sales_order_no description: 受注No.で絞込 in: query required: false schema: type: string example: SO-2024-0001 parameters-start_registered_date: name: start_registered_date description: 登録日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' parameters-end_registered_date: name: end_registered_date description: 登録日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' start_delivery_date: name: start_delivery_date description: 納品日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' end_delivery_date: name: end_delivery_date description: 納品日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' start_acceptance_date: name: start_acceptance_date description: 検収日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' end_acceptance_date: name: end_acceptance_date description: 検収日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' delivery_no: name: delivery_no description: 納品No.で絞込 in: query required: false schema: type: string example: D-2024-0001 delivery_status: name: delivery_status description: '納品ステータス (未納品: not_delivered, 納品済: delivered)' in: query required: false schema: type: string enum: - not_delivered - delivered example: not_delivered components-parameters-start_registered_date: name: start_registered_date description: 売上登録日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2024-01-01' components-parameters-end_registered_date: name: end_registered_date description: 売上登録日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2024-12-31' start_revenue_recognition_date: name: start_revenue_recognition_date description: 売上日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2024-01-01' end_revenue_recognition_date: name: end_revenue_recognition_date description: 売上日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2024-12-31' parameters-billing_status: name: billing_status description: '請求書送付ステータス (未送付: not_billed, 送付済: billed, 対象外: none)' in: query required: false schema: type: string enum: - not_billed - billed - none example: not_billed collection_status: name: collection_status description: '決済ステータス (未決済: not_settled, 一部決済済: partially_settled, 決済済: settled, 対象外: none)' in: query required: false schema: type: string enum: - not_settled - partially_settled - settled - none example: not_settled other_cost_no: name: other_cost_no description: その他原価No.で絞込 in: query required: false schema: type: string example: OC-2024-0001 procurements_controller.openapi_components-parameters-start_registered_date: name: start_registered_date description: 仕入登録日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' procurements_controller.openapi_components-parameters-end_registered_date: name: end_registered_date description: 仕入登録日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' procurements_controller.openapi_components-parameters-start_last_updated_date: name: start_last_updated_date description: 仕入更新日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' procurements_controller.openapi_components-parameters-end_last_updated_date: name: end_last_updated_date description: 仕入更新日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' start_procurement_date: name: start_procurement_date description: 仕入日で絞込:開始日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-01-01' end_procurement_date: name: end_procurement_date description: 仕入日で絞込:終了日(yyyy-mm-dd) in: query required: false schema: type: string format: date example: '2025-05-01' parameters-business_ids: name: business_ids[] description: |- 案件ID
※ 複数の案件が紐づく仕入は本パラメータでヒットしません in: query required: false style: form explode: true schema: type: array items: type: string minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM procurement_no: name: procurement_no description: 仕入No.で絞込 in: query required: false schema: type: string example: PR-2024-0001 parameters-payment_status: name: payment_status description: '決済ステータス (未決済: not_settled, 一部決済済: partially_settled, 決済済: settled, 対象外: none)' in: query required: false schema: type: string enum: - not_settled - partially_settled - settled - none example: not_settled schemas: Employee: description: 社内担当者 type: object properties: id: type: integer format: int64 maximum: 9223372036854775807 description: 従業員ID example: 101 display_name: type: string description: 従業員名 example: 田中太郎 required: - id - display_name additionalProperties: false Partner: type: object properties: id: type: integer format: int64 maximum: 9223372036854775807 description: 取引先ID example: 1001 name: type: string description: 取引先名 example: 株式会社サンプル code: type: string description: 取引先コード nullable: true example: P-001 required: - id - name additionalProperties: false SalesProgression: description: 受注確度 type: object properties: id: type: string description: 受注確度ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: 受注確度名称 example: B nullable: true required: - id - name additionalProperties: false BusinessPhase: description: 案件フェーズ type: object properties: id: type: string description: フェーズID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: フェーズ名称 example: 引き合い nullable: true required: - id - name additionalProperties: false ReportingSection: description: 担当部門 type: object properties: id: type: integer format: int64 maximum: 9223372036854775807 description: 部門ID example: 67890 name: type: string description: 部門名 example: 開発部 required: - id - name nullable: true additionalProperties: false BusinessDigest: type: object properties: id: type: string description: 案件ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: 案件名称 example: サンプル案件 business_date: type: string format: date description: 案件登録日 nullable: true example: '2025-04-01' charge_employee: nullable: true allOf: - $ref: '#/components/schemas/Employee' code: type: string description: 案件コード example: B-0000000003 canceled: type: boolean description: 取消状態 example: false closed: type: boolean description: ロック状態 example: false customer: description: 顧客 nullable: true allOf: - $ref: '#/components/schemas/Partner' sales_progression: $ref: '#/components/schemas/SalesProgression' scheduled_completion_date: type: string format: date description: 完了予定日 nullable: true example: '2025-06-30' completion_date: type: string format: date description: 完了日 nullable: true example: '2025-06-15' business_phase: $ref: '#/components/schemas/BusinessPhase' reporting_section: $ref: '#/components/schemas/ReportingSection' registered_at: type: string format: date-time description: 登録日時 example: '2025-04-01T09:00:00+09:00' registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-04-15T14:30:00+09:00' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' required: - id - name - code - canceled - closed - registered_at - registered_by - last_updated_at - last_updated_by additionalProperties: false PaginationMeta: type: object properties: limit_value: type: integer format: int32 maximum: 2147483647 description: 現在の1ページあたりの件数 example: 50 current_offset: type: integer format: int32 maximum: 2147483647 description: 現在のオフセット件数 example: 0 next_offset: type: integer format: int32 maximum: 2147483647 description: 次のオフセット(存在しない場合はnull) nullable: true example: 50 prev_offset: type: integer format: int32 maximum: 2147483647 description: 前のオフセット(存在しない場合はnull) nullable: true example: 0 total_count: type: integer format: int32 maximum: 2147483647 description: 現在のフィルタ条件での総件数 example: 200 required: - limit_value - current_offset - total_count additionalProperties: false ProductError: type: object description: エラー properties: status_code: type: integer description: HTTPステータスコード minimum: 400 maximum: 599 example: 404 errors: type: array maxItems: 1 description: エラーの詳細 items: type: object additionalProperties: false properties: codes: type: array description: エラーコード maxItems: 1 items: type: string example: company_not_found messages: type: array description: エラーメッセージ items: type: string example: 事業所が見つかりませんでした。 required: - codes - messages additionalProperties: true required: - status_code - errors AuthError: type: object description: 認証エラー additionalProperties: false properties: message: type: string description: エラーメッセージ example: ログインをして下さい code: type: string description: エラーコード example: invalid_access_token WithCompanyId: type: object additionalProperties: false properties: company_id: type: integer format: int64 maximum: 9223372036854775807 description: 事業所ID example: 1 required: - company_id ChargeEmployeeId: description: 社内担当者の従業員ID type: integer format: int64 minimum: 0 maximum: 9223372036854775807 nullable: true example: 101 CustomerId: description: 顧客の取引先ID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 1001 ReportingSectionId: description: |- 担当部門ID
※ 親部門のIDは指定できません type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 67890 InternalMemo: description: 社内メモ type: string nullable: true maxLength: 2000 example: 重要案件のため優先対応 BusinessRequestBase: type: object properties: name: description: 案件名称 type: string example: サンプル案件 maxLength: 100 code: description: 案件コード(null・空文字での送信不可。POSTの自動採番ON時およびPATCHのキー省略時は省略可能) type: string example: B-0000000001 minLength: 1 maxLength: 50 business_date: description: 案件登録日 type: string format: date nullable: true example: '2025-04-01' charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' customer_id: $ref: '#/components/schemas/CustomerId' prospect_sales_order: description: 受注見込 type: integer format: int64 maximum: 9223372036854775807 default: 0 example: 6000000 sales_progression_id: description: 受注確度ID type: string nullable: true example: 01JPP4FD1CVQWCDSWA90VE1ZTM minLength: 26 maxLength: 26 scheduled_completion_date: description: 完了予定日 type: string format: date nullable: true example: '2025-06-30' completion_date: description: 完了日 type: string format: date nullable: true example: '2025-06-15' business_phase_id: type: string description: 案件フェーズID nullable: true example: 01JPP4FD1CVQWCDSWA90VE1ZTM minLength: 26 maxLength: 26 reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' custom_fields: type: array nullable: true description: カスタム項目 items: type: object properties: definition_id: type: string description: カスタム項目ID minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM value: description: カスタム項目の値 anyOf: - type: string - type: number nullable: true example: サンプル値 required: - definition_id - value example: - definition_id: 01JPP4FD1CVQWCDSWA90VE1ZTM value: PJ-123456 - definition_id: 01JPP4FD1CVQWCDSWA90VE1ZTN value: 234 additionalProperties: false BusinessMinimalResponse: type: object properties: id: type: string description: 案件ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-04-01T09:00:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-04-15T14:30:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false CustomFieldPartnerValue: type: object description: 取引先型カスタム項目の値 properties: type: type: string enum: - partner description: マスタ型の種別 example: partner id: type: integer format: int64 description: 取引先ID example: 1001 name: type: string description: 取引先名 example: サンプル取引先 code: type: string description: 取引先コード nullable: true example: P-001 required: - type - id - name additionalProperties: false CustomFieldEmployeeValue: type: object description: 従業員型カスタム項目の値 properties: type: type: string enum: - employee description: マスタ型の種別 example: employee id: type: integer format: int64 description: 従業員ID example: 101 name: type: string description: 従業員名 example: サンプル従業員 required: - type - id - name additionalProperties: false CustomFieldSectionValue: type: object description: 部門型カスタム項目の値 properties: type: type: string enum: - section description: マスタ型の種別 example: section id: type: integer format: int64 description: 部門ID example: 67890 name: type: string description: 部門名 example: サンプル部門 required: - type - id - name additionalProperties: false CustomFieldMasterItemValue: type: object description: 商品型カスタム項目の値 properties: type: type: string enum: - master_item description: マスタ型の種別 example: master_item id: type: string description: 商品ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: 商品名 example: サンプル商品 code: type: string nullable: true description: 商品コード example: I-001 required: - type - id - name additionalProperties: false CustomFieldMasterValue: description: マスタ型カスタム項目の値 oneOf: - $ref: '#/components/schemas/CustomFieldPartnerValue' - $ref: '#/components/schemas/CustomFieldEmployeeValue' - $ref: '#/components/schemas/CustomFieldSectionValue' - $ref: '#/components/schemas/CustomFieldMasterItemValue' discriminator: propertyName: type mapping: partner: '#/components/schemas/CustomFieldPartnerValue' employee: '#/components/schemas/CustomFieldEmployeeValue' section: '#/components/schemas/CustomFieldSectionValue' master_item: '#/components/schemas/CustomFieldMasterItemValue' CustomField: type: object description: カスタム項目 properties: value: description: |- カスタム項目の値 * 文字列型(text, textarea, date): 文字列 * 数値型(number, amount, quantity): 数値 * プルダウン型(enum): 選択肢の名称(文字列) * マスタ型(partner, employee, section, master_item): マスタ情報オブジェクト nullable: true anyOf: - type: string - type: number - $ref: '#/components/schemas/CustomFieldMasterValue' example: サンプル値 definition_id: type: string description: カスタム項目定義ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 definition_name: type: string description: カスタム項目定義名 example: カスタム項目1 required: - value - definition_id - definition_name additionalProperties: false BusinessDetail: allOf: - $ref: '#/components/schemas/BusinessDigest' - type: object properties: actual_profit: type: integer format: int64 maximum: 9223372036854775807 description: 粗利(実績) nullable: true example: 1000000 sales_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 売上合計金額(税抜) nullable: true example: 5000000 procurement_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 仕入合計金額(税抜) nullable: true example: 3000000 other_cost_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: その他原価実績 nullable: true example: 1000000 prospect_sales_order: type: integer format: int64 maximum: 9223372036854775807 description: 受注見込 nullable: true example: 6000000 prospect_purchase_order: type: integer format: int64 maximum: 9223372036854775807 description: 発注見込 nullable: true example: 3500000 prospect_other_cost: type: integer format: int64 maximum: 9223372036854775807 description: その他費用見込 nullable: true example: 1200000 quotation_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 見積合計金額(税抜) nullable: true example: 5500000 sales_order_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 受注合計金額(税抜) nullable: true example: 5200000 delivered_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 納品確定金額(税抜) nullable: true example: 4800000 bill_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 請求合計金額(税抜) nullable: true example: 4800000 purchase_order_totals_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 発注合計金額(税抜) nullable: true example: 3200000 actual_other_cost: type: integer format: int64 maximum: 9223372036854775807 description: その他費用実績 nullable: true example: 900000 prospect_profit: type: integer format: int64 maximum: 9223372036854775807 description: 粗利(見込) nullable: true example: 1300000 budget_profit: type: integer format: int64 maximum: 9223372036854775807 description: 受発注差額(税抜) nullable: true example: 1500000 margin_actual_rate_percent: type: number format: float description: 粗利率実績 nullable: true example: 20.5 budget_total_labor_cost: type: integer format: int64 maximum: 9223372036854775807 description: | 人件費(予算) ※freee工数管理と連携している場合のみ値が反映されます nullable: true example: 2000000 actual_total_labor_cost: type: integer format: int64 maximum: 9223372036854775807 description: | 人件費(実績) ※freee工数管理と連携している場合のみ値が反映されます nullable: true example: 1800000 internal_memo: $ref: '#/components/schemas/InternalMemo' custom_fields: type: array description: カスタム項目一覧 items: $ref: '#/components/schemas/CustomField' example: - value: サンプルテキスト definition_id: 01JPP4FD1CVQWCDSWA90VE1ZTM definition_name: カスタム項目1 - value: 12345 definition_id: 01JPP4FD1CVQWCDSWA90VE1ZTN definition_name: カスタム項目2 - value: type: partner id: 1001 name: サンプル取引先 code: P-001 definition_id: 01JPP4FD1CVQWCDSWA90VE1ZTO definition_name: 担当取引先 required: - custom_fields additionalProperties: false ReportingSectionIds: type: array items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 67890 DatePeriod: type: object description: 発生予定期間 properties: from: type: string format: date description: 開始日 example: '2025-04-01' to: type: string format: date description: 終了日 example: '2025-06-30' required: - from - to additionalProperties: false Business: description: 案件 type: object nullable: true properties: id: type: string description: 案件ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM code: type: string description: 案件コード example: B-001 name: type: string description: 案件名 example: サンプル案件 closed: type: boolean description: ロック状態 example: false required: - id - code - name - closed additionalProperties: false CostBudgetBase: type: object properties: id: type: string description: 原価予算ID minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM cost_budget_no: type: string description: 原価予算No. example: CB-0001 canceled: type: boolean description: 取消状態 example: false type: type: string description: '原価種別 (仕入: procurement, 外部仕入: external_procurement, その他原価: other_cost)' enum: - procurement - external_procurement - other_cost example: procurement amount_excluding_tax: type: integer format: int64 maximum: 999999999999 minimum: -999999999999 description: 税抜金額 example: 100000 date_period: $ref: '#/components/schemas/DatePeriod' business: $ref: '#/components/schemas/Business' memo: type: string description: 備考 nullable: true example: 備考テキスト reporting_section: $ref: '#/components/schemas/ReportingSection' charge_employee: description: 社内担当者 nullable: true allOf: - $ref: '#/components/schemas/Employee' registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' registered_at: type: string format: date-time description: 登録日時 example: '2025-04-01T09:00:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-04-15T14:30:00+09:00' required: - id - cost_budget_no - canceled - type - amount_excluding_tax - date_period - registered_by - last_updated_by - registered_at - last_updated_at additionalProperties: false MasterItemDetail: description: 商品情報 type: object nullable: true properties: id: type: string description: 商品ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM code: type: string description: 商品コード nullable: true example: P-001 name: type: string description: 商品名 example: パンフレットA4 required: - id - name additionalProperties: false DealLineTypeDetail: description: 明細取引タイプ type: object properties: id: type: string description: 明細取引タイプID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: 明細取引タイプ名 example: 課税売上10% required: - id - name additionalProperties: false TaxTypeDetail: description: 税区分 type: object nullable: true properties: code: type: integer format: int32 maximum: 2147483647 description: 税区分コード
※freee会計 APIで参照可能な税区分のコードです example: 10 name: type: string description: 税区分名 example: 課税売上10% required: - code - name additionalProperties: false AccountItem: description: 勘定科目 type: object properties: id: type: integer format: int64 maximum: 9223372036854775807 description: 勘定科目ID example: 12345 name: type: string description: 勘定科目名 example: 仕入高 required: - id - name additionalProperties: false MemoTagDetail: description: メモタグ type: object properties: id: type: integer format: int64 maximum: 9223372036854775807 description: メモタグID example: 3001 name: type: string description: メモタグ名 example: 重要案件 required: - id - name additionalProperties: false ItemTagDetail: description: 会計品目タグ type: object nullable: true properties: id: type: integer format: int64 maximum: 9223372036854775807 description: 会計品目タグID example: 2001 name: type: string description: 会計品目タグ名 example: 印刷物 required: - id - name additionalProperties: false SegmentTag: description: セグメントタグ type: object nullable: true properties: id: type: integer format: int64 maximum: 9223372036854775807 description: セグメントタグID example: 12345 name: type: string description: セグメントタグ名 example: プロジェクトA required: - id - name additionalProperties: false AccountingReportingSectionDetail: description: 会計計上部門 type: object nullable: true properties: id: type: integer format: int64 maximum: 9223372036854775807 description: 部門ID example: 1001 name: type: string description: 部門名 example: 営業部 required: - id - name additionalProperties: false ProcurementCostBudget: description: 原価予算 (仕入) allOf: - $ref: '#/components/schemas/CostBudgetBase' - type: object properties: type: type: string enum: - procurement supplier: description: 仕入先 nullable: true allOf: - $ref: '#/components/schemas/Partner' payment_partner: description: 支払先 nullable: true allOf: - $ref: '#/components/schemas/Partner' master_item: description: 商品 allOf: - $ref: '#/components/schemas/MasterItemDetail' deal_line_type: description: 明細取引タイプ allOf: - $ref: '#/components/schemas/DealLineTypeDetail' quantity: type: number format: double description: 数量 example: 10 uom_name: type: string description: 単位 nullable: true example: 個 unit_price: description: 単価 format: double type: number example: 1000 maximum: 999999999999 minimum: -999999999999 tax_division: description: 税区分 allOf: - $ref: '#/components/schemas/TaxTypeDetail' account_item: description: 勘定科目 allOf: - $ref: '#/components/schemas/AccountItem' memo_tags: type: array description: メモタグ nullable: true items: $ref: '#/components/schemas/MemoTagDetail' item_tag: description: 会計品目タグ nullable: true allOf: - $ref: '#/components/schemas/ItemTagDetail' segment_tag_1: description: セグメントタグ1 allOf: - $ref: '#/components/schemas/SegmentTag' segment_tag_2: description: セグメントタグ2 allOf: - $ref: '#/components/schemas/SegmentTag' segment_tag_3: description: セグメントタグ3 allOf: - $ref: '#/components/schemas/SegmentTag' accounting_reporting_section: description: 会計計上部門 allOf: - $ref: '#/components/schemas/AccountingReportingSectionDetail' required: - deal_line_type - quantity - unit_price - tax_division - account_item additionalProperties: false BasicCostBudget: description: 原価予算 (外部仕入・その他原価) allOf: - $ref: '#/components/schemas/CostBudgetBase' - type: object properties: type: type: string enum: - external_procurement - other_cost additionalProperties: false CostBudgetDetail: description: 原価予算詳細 discriminator: propertyName: type mapping: procurement: '#/components/schemas/ProcurementCostBudget' external_procurement: '#/components/schemas/BasicCostBudget' other_cost: '#/components/schemas/BasicCostBudget' oneOf: - $ref: '#/components/schemas/BasicCostBudget' - $ref: '#/components/schemas/ProcurementCostBudget' CostBudgetRequestBase: type: object description: 原価予算リクエスト共通 properties: business_id: type: string description: 案件ID nullable: true minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM period_from_date: type: string format: date nullable: false description: 期間開始日 example: '2025-04-01' period_to_date: type: string format: date nullable: false description: 期間終了日 example: '2025-06-30' memo: type: string nullable: true description: 備考 example: 備考テキスト charge_employee_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: 社内担当者ID nullable: true example: 1 reporting_section_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: 担当部門ID nullable: true example: 1 additionalProperties: false ProcurementCostBudgetRequestProperties: type: object description: 原価予算リクエスト 仕入固有プロパティ properties: supplier_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: 仕入先ID nullable: true example: 1001 payment_partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: 支払先ID nullable: true example: 1002 quantity: type: number format: float nullable: false description: 数量 example: 10 maximum: 99999999 minimum: -99999999 unit_price: type: number format: float nullable: false description: 単価 example: 10 maximum: 999999999999 minimum: -999999999999 uom_name: type: string description: 単位 nullable: true maxLength: 100 example: 個 master_item_id: type: string description: 商品ID nullable: true minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM deal_line_type_id: type: string description: 明細取引タイプID nullable: false minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM accounting_reporting_section_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: 会計計上部門ID nullable: true example: 1 item_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: 会計品目タグID nullable: true example: 2001 memo_tag_ids: type: array description: メモタグID nullable: true items: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 3001 segment_tag_1_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: セグメントタグ1ID nullable: true example: 12345 segment_tag_2_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: セグメントタグ2ID nullable: true example: 12345 segment_tag_3_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775807 description: セグメントタグ3ID nullable: true example: 12345 ProcurementCostBudgetCreateRequest: description: 原価予算登録リクエスト (仕入) allOf: - $ref: '#/components/schemas/CostBudgetRequestBase' - $ref: '#/components/schemas/ProcurementCostBudgetRequestProperties' - type: object properties: type: type: string enum: - procurement required: - type - period_from_date - period_to_date - quantity - unit_price - deal_line_type_id additionalProperties: false BasicCostBudgetRequestProperties: type: object description: 原価予算リクエスト 外部仕入・その他原価固有プロパティ properties: amount_excluding_tax: type: integer format: int64 nullable: false maximum: 999999999999 minimum: -999999999999 description: 金額 example: 10000 additionalProperties: false BasicCostBudgetCreateRequest: description: 原価予算登録リクエスト (外部仕入・その他原価) allOf: - $ref: '#/components/schemas/CostBudgetRequestBase' - $ref: '#/components/schemas/BasicCostBudgetRequestProperties' - type: object properties: type: type: string enum: - external_procurement - other_cost required: - type - period_from_date - period_to_date - amount_excluding_tax CostBudgetCreateRequestDetail: description: 原価予算登録リクエスト discriminator: propertyName: type mapping: procurement: '#/components/schemas/ProcurementCostBudgetCreateRequest' external_procurement: '#/components/schemas/BasicCostBudgetCreateRequest' other_cost: '#/components/schemas/BasicCostBudgetCreateRequest' oneOf: - $ref: '#/components/schemas/BasicCostBudgetCreateRequest' - $ref: '#/components/schemas/ProcurementCostBudgetCreateRequest' CostBudgetMinimalResponse: type: object description: 原価予算登録・更新・取消のレスポンス properties: id: type: string description: 原価予算ID minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-04-01T09:00:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-04-15T14:30:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false schemas-BusinessPhase: type: object additionalProperties: false properties: id: type: string description: ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: 名称 example: 引き合い required: - id - name schemas-SalesProgression: type: object properties: id: type: string description: ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: 名称 example: A required: - id - name additionalProperties: false MasterItem: type: object properties: id: type: string description: ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM code: type: string description: 商品コード nullable: true example: ITEM-001 name: type: string description: 商品名 example: サンプル商品 display_name: type: string description: 表示名 example: サンプル商品(表示用) uom_name: type: string description: 単位 example: 個 nullable: true unit_price: type: number description: 単価 example: 1000 format: float nullable: true tax_code: type: integer format: int32 maximum: 2147483647 description: 税区分 example: 128 nullable: true item_tag_id: type: integer format: int64 maximum: 9223372036854775807 description: 会計品目タグID example: 2001 nullable: true memo_tag_ids: type: array description: メモタグID items: type: integer format: int64 maximum: 9223372036854775807 example: 3001 nullable: false quantity: type: number description: 標準数量 example: 10 format: float nullable: true account_item_id: type: integer format: int64 maximum: 9223372036854775807 description: 勘定科目ID example: 12345 nullable: true reduced: type: boolean description: 軽減税率対象フラグ example: false nullable: true required: - id - name - display_name - memo_tag_ids additionalProperties: false DealLineType: type: object properties: id: type: string description: ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM code: type: string description: コード example: LT-0000000001 nullable: true name: type: string description: 名称 example: 課税売上 type: type: string description: 利用区分 enum: - sales - procurement example: sales account_item_id: type: integer format: int64 maximum: 9223372036854775807 description: 勘定科目ID example: 12345 tax_code: type: integer format: int32 maximum: 2147483647 description: 税区分 example: 128 reduced: type: boolean description: 軽減税率対象フラグ example: false is_default: type: boolean description: 既定フラグ example: false required: - id - name - type - account_item_id - tax_code - reduced - is_default additionalProperties: false schemas-Employee: type: object additionalProperties: false properties: id: type: integer description: ID example: 101 num: type: string description: 従業員番号 example: A001 nullable: true display_name: type: string description: 表示名 example: 山田太郎 required: - id - display_name CustomFieldDefinitionBase: type: object properties: id: type: string description: カスタム項目定義のID example: 01JPP4FD1CVQWCDSWA90VE1ZTM key: type: string description: カスタム項目定義のキー example: custom_field_001 display_name: type: string description: 表示名 example: プロジェクトコード type: type: string description: |- カスタム項目の入力形式 * `text` - 一行テキスト * `textarea` - 複数行テキスト * `amount` - 金額 * `quantity` - 数量 * `number` - 数値 * `date` - 日付 * `enum` - プルダウン * `partner` - 取引先 * `employee` - 従業員 * `section` - 部門 * `master_item` - 商品 enum: - text - textarea - amount - quantity - number - date - enum - partner - employee - section - master_item example: text required: type: boolean description: 必須項目かどうか example: false description: type: string description: 項目の説明 nullable: true example: プロジェクトを識別するためのコード required: - id - key - display_name - type - required additionalProperties: false TextCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - text example: text required: - type TextareaCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - textarea example: textarea required: - type AmountCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - amount example: amount required: - type QuantityCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - quantity example: quantity required: - type NumberCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - number example: number unit: type: string description: 単位 nullable: true example: 個 required: - type DateCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - date example: date required: - type EnumCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - enum example: enum enumerations: type: array description: 選択肢 items: type: object properties: id: type: string description: ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM name: type: string description: 表示名 example: オプション1 usable: type: boolean description: 入力候補に使用可能かどうか

※falseの場合、その選択肢自体は削除せず、Web画面での案件登録時などに入力候補として表示されません。ただし案件登録APIなどでfalseの選択肢をパラメータに指定すれば設定できます。 example: true required: - id - name - usable additionalProperties: false required: - type - enumerations PartnerCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - partner example: partner required: - type EmployeeCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - employee example: employee required: - type SectionCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - section example: section required: - type MasterItemCustomFieldDefinition: allOf: - $ref: '#/components/schemas/CustomFieldDefinitionBase' - type: object additionalProperties: false properties: type: type: string enum: - master_item example: master_item required: - type CustomFieldDefinition: oneOf: - $ref: '#/components/schemas/TextCustomFieldDefinition' - $ref: '#/components/schemas/TextareaCustomFieldDefinition' - $ref: '#/components/schemas/AmountCustomFieldDefinition' - $ref: '#/components/schemas/QuantityCustomFieldDefinition' - $ref: '#/components/schemas/NumberCustomFieldDefinition' - $ref: '#/components/schemas/DateCustomFieldDefinition' - $ref: '#/components/schemas/EnumCustomFieldDefinition' - $ref: '#/components/schemas/PartnerCustomFieldDefinition' - $ref: '#/components/schemas/EmployeeCustomFieldDefinition' - $ref: '#/components/schemas/SectionCustomFieldDefinition' - $ref: '#/components/schemas/MasterItemCustomFieldDefinition' discriminator: propertyName: type mapping: text: '#/components/schemas/TextCustomFieldDefinition' textarea: '#/components/schemas/TextareaCustomFieldDefinition' amount: '#/components/schemas/AmountCustomFieldDefinition' quantity: '#/components/schemas/QuantityCustomFieldDefinition' number: '#/components/schemas/NumberCustomFieldDefinition' date: '#/components/schemas/DateCustomFieldDefinition' enum: '#/components/schemas/EnumCustomFieldDefinition' partner: '#/components/schemas/PartnerCustomFieldDefinition' employee: '#/components/schemas/EmployeeCustomFieldDefinition' section: '#/components/schemas/SectionCustomFieldDefinition' master_item: '#/components/schemas/MasterItemCustomFieldDefinition' ProcurementStatus: description: '仕入ステータス (未計上: not_sold, 一部計上済: partially_sold, 計上済: sold)' enum: - not_sold - partially_sold - sold type: string example: not_sold PaymentStatus: description: '支払ステータス (なし: none, 未決済: not_settled, 一部決済済: partially_settled, 決済済: settled)' enum: - none - not_settled - partially_settled - settled type: string example: not_settled PaymentMethodType: description: '支払方法 (振込: transfer, 現金: cash, 手形: bill_payable)' type: string enum: - transfer - cash - bill_payable example: transfer AmountSet: type: object required: - excluding_tax - tax - including_tax properties: excluding_tax: type: integer format: int64 description: 税抜金額 maximum: 999999999999 minimum: -999999999999 example: 100000 tax: type: integer format: int64 description: 税額 maximum: 999999999999 minimum: -999999999999 example: 10000 including_tax: type: integer format: int64 description: 税込金額 maximum: 999999999999 minimum: -999999999999 example: 110000 description: 金額セット additionalProperties: false PurchaseOrderDigest: type: object properties: id: type: string description: 発注ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 canceled: type: boolean description: 取消状態 example: false registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' business: $ref: '#/components/schemas/Business' purchase_order_no: type: string description: 発注No. example: PO211212-00001 branch_no: type: integer format: int32 description: 枝番 nullable: true example: 1 internal_subject: description: 発注タイトル type: string nullable: true maxLength: 100 example: サンプル案件発注の件 purchase_order_date: description: 発注日 type: string format: date example: '2025-04-01' procurements_on: description: 仕入予定日 type: string format: date nullable: true example: '2025-05-01' supplier: description: 仕入先 allOf: - $ref: '#/components/schemas/Partner' is_qualified_invoice_issuer: type: boolean description: |- 適格請求書発行事業者該当フラグ
※ 登録値はfreee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況により決定されます。
※ 買い手側対応機能を「使用する」場合、リクエスト指定値が優先され、未指定時は「適格チェックボックスと税区分」の設定に従います。 nullable: true example: true delivery_deadline: description: 納品期限日 type: string format: date nullable: true example: '2025-06-01' delivery_location: description: 納品場所 type: string nullable: true maxLength: 100 example: 東京都渋谷区 purchase_order_note: description: 発注書の備考欄に掲載する内容 type: string nullable: true maxLength: 4000 example: 発注書備考 issued: type: boolean description: 送付ステータス example: false issued_on: type: string format: date description: 送付日 nullable: true example: '2025-04-01' purchase_order_template: description: 発注書テンプレート type: object nullable: true properties: id: type: integer format: int64 maximum: 9223372036854775807 description: 発注書テンプレートID example: 10001 name: type: string description: 発注書テンプレート名称 example: デフォルトテンプレート required: - id - name additionalProperties: false purchase_order_subject: description: 発注書件名 type: string nullable: true maxLength: 100 example: サンプル案件発注の件 procurement_status: description: 仕入ステータス $ref: '#/components/schemas/ProcurementStatus' recorded_procurement_amount_excluding_tax: description: 仕入計上済金額(税抜) type: integer format: int64 example: 50000 remaining_procurement_amount_excluding_tax: description: 仕入残金額(税抜) type: integer format: int64 example: 50000 payment_status: description: 支払ステータス $ref: '#/components/schemas/PaymentStatus' payments_on: description: 支払予定日 type: string format: date nullable: true example: '2025-06-30' payment_method_type: description: 支払方法 allOf: - $ref: '#/components/schemas/PaymentMethodType' payment_partner: description: 支払先 allOf: - $ref: '#/components/schemas/Partner' charge_employee: description: 社内担当者 allOf: - $ref: '#/components/schemas/Employee' nullable: true reporting_section: $ref: '#/components/schemas/ReportingSection' internal_memo: $ref: '#/components/schemas/InternalMemo' amount_set: $ref: '#/components/schemas/AmountSet' amount_of_withholding_tax: description: 源泉徴収税額 type: integer format: int64 nullable: true example: 10000 required: - id - canceled - registered_by - registered_at - last_updated_by - last_updated_at - purchase_order_no - purchase_order_date - supplier - issued - procurement_status - recorded_procurement_amount_excluding_tax - remaining_procurement_amount_excluding_tax - payment_status - payment_method_type - payment_partner - amount_set additionalProperties: false DefaultTitle: description: '敬称区分 (なし: none, 様: to_person, 御中: to_organization)' type: string enum: - none - to_person - to_organization nullable: true RecipientAddress: description: 宛先 type: object properties: official_name: type: string description: 正式名称 nullable: true example: 株式会社サンプル default_title: description: 敬称 nullable: true allOf: - $ref: '#/components/schemas/DefaultTitle' zipcode: type: string description: 郵便番号 nullable: true example: 150-0001 prefecture_code: type: integer format: int64 description: '都道府県コード(-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)' nullable: true example: 12 street_name1: type: string description: 住所1 nullable: true example: 渋谷区神宮前1-1-1 street_name2: type: string description: 住所2 nullable: true example: サンプルビル3F contact_department: type: string description: 連絡先部署 nullable: true example: 営業部 contact_name: type: string description: 連絡先名 nullable: true example: 山田太郎 additionalProperties: false LineType: description: 明細種別 enum: - basic - text type: string BasicLineParams: description: 通常明細パラメータ type: object properties: line_type: $ref: '#/components/schemas/LineType' master_item_id: description: 商品ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM deal_line_type_id: description: 明細取引タイプID type: string maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM description: description: 摘要 type: string nullable: true maxLength: 200 example: パンフレットデザイン料 quantity: description: 数量 format: double type: number example: 100 uom_name: description: 単位 type: string nullable: true maxLength: 10 example: 個 unit_price: description: 単価 format: double type: number example: 1000 maximum: 999999999999 minimum: -999999999999 accounting_reporting_section_id: description: |- 会計計上部門ID
※ 親部門のIDは指定できません format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 67890 item_tag_id: description: 会計品目タグID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 2001 memo_tags: description: メモタグID type: array nullable: true items: format: int64 maximum: 9223372036854775807 type: integer example: 3001 withholding_enabled: description: 源泉徴収税対象明細かどうか type: boolean example: false is_manual_tax_entry: description: 税の手動入力を行うかどうか type: boolean example: false tax: description: |- 手動入力した税額
※is_manual_tax_entryがtrueの場合のみ参照されます。falseの場合は値を設定しても無視されます。 type: integer format: int64 maximum: 999999999999 minimum: -999999999999 nullable: true example: 10000 required: - line_type - deal_line_type_id - quantity - unit_price - withholding_enabled - is_manual_tax_entry additionalProperties: false TextLineParams: description: テキスト明細パラメータ type: object properties: line_type: allOf: - $ref: '#/components/schemas/LineType' example: text text: description: テキスト行 type: string maxLength: 200 example: 備考:特急料金が含まれます required: - line_type - text additionalProperties: false PurchaseOrderLineParams: description: 明細パラメータ discriminator: propertyName: line_type mapping: basic: '#/components/schemas/BasicLineParams' text: '#/components/schemas/TextLineParams' oneOf: - $ref: '#/components/schemas/BasicLineParams' - $ref: '#/components/schemas/TextLineParams' PurchaseOrderRequestBase: type: object properties: business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM internal_subject: description: 発注タイトル type: string nullable: true maxLength: 100 example: サンプル案件発注の件 purchase_order_date: description: 発注日 type: string format: date example: '2025-04-01' procurements_on: description: 仕入予定日 type: string format: date nullable: true example: '2025-05-01' supplier_id: description: 仕入先の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1001 is_qualified_invoice_issuer: description: |- 適格請求書発行事業者該当フラグ
※ 登録値はfreee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況により決定されます。
※ 買い手側対応機能を「使用する」場合、リクエスト指定値が優先され、未指定時は「適格チェックボックスと税区分」の設定に従います。 type: boolean nullable: true example: true delivery_deadline: description: 納品期限日 type: string format: date nullable: true example: '2025-05-15' delivery_location: description: 納品場所 type: string nullable: true maxLength: 100 example: 東京都渋谷区 purchase_order_note: description: 発注書の備考欄に記載する内容 type: string nullable: true maxLength: 4000 example: 納期厳守でお願いします purchase_order_template_id: description: 発注書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 10001 purchase_order_subject: description: 発注書件名 type: string nullable: true maxLength: 100 example: サンプル案件発注の件 recipient_address: $ref: '#/components/schemas/RecipientAddress' payments_on: description: 支払予定日 type: string format: date nullable: true example: '2025-06-30' payment_method_type: description: 支払方法 allOf: - $ref: '#/components/schemas/PaymentMethodType' payment_partner_id: description: 支払先の取引先ID type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 1002 charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array minItems: 1 maxItems: 500 items: $ref: '#/components/schemas/PurchaseOrderLineParams' additionalProperties: false PurchaseOrderMinimalResponse: type: object properties: id: type: string description: 発注ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM minLength: 26 maxLength: 26 registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false AmountSetRate: description: 税率を含む金額セット type: object properties: rate: description: 税率 format: int64 maximum: 9223372036854775807 type: integer example: 10 reduced: description: 軽減税率フラグ type: boolean example: false amount_set: $ref: '#/components/schemas/AmountSet' amount_of_deductible_tax: description: 控除可能税額 format: int64 type: integer nullable: true example: 5000 required: - rate - reduced - amount_set additionalProperties: false BasicLineDetail: description: 通常明細詳細 type: object properties: line_no: description: 明細行番号 type: integer format: int32 maximum: 2147483647 example: 1 line_type: $ref: '#/components/schemas/LineType' master_item: $ref: '#/components/schemas/MasterItemDetail' deal_line_type: $ref: '#/components/schemas/DealLineTypeDetail' description: description: 摘要 type: string nullable: true example: パンフレットデザイン料 quantity: description: 数量 format: double type: number example: 100 uom_name: description: 単位 type: string nullable: true example: 個 unit_price: description: 単価 format: double type: number example: 1000 amount_set: $ref: '#/components/schemas/AmountSet' tax_type: $ref: '#/components/schemas/TaxTypeDetail' accounting_reporting_section: $ref: '#/components/schemas/AccountingReportingSectionDetail' item_tag: $ref: '#/components/schemas/ItemTagDetail' memo_tags: description: メモタグ type: array nullable: true items: $ref: '#/components/schemas/MemoTagDetail' withholding_enabled: description: 源泉徴収税対象明細かどうか type: boolean example: false required: - line_no - line_type - deal_line_type - quantity - unit_price - amount_set - withholding_enabled additionalProperties: false TextLineDetail: description: テキスト明細詳細 type: object properties: line_no: description: 明細行番号 type: integer format: int32 maximum: 2147483647 example: 1 line_type: allOf: - $ref: '#/components/schemas/LineType' example: text text: description: テキスト行 type: string example: 備考:特急料金が含まれます required: - line_no - line_type - text additionalProperties: false PurchaseOrderLineDetail: description: 明細詳細 discriminator: propertyName: line_type mapping: basic: '#/components/schemas/BasicLineDetail' text: '#/components/schemas/TextLineDetail' oneOf: - $ref: '#/components/schemas/BasicLineDetail' - $ref: '#/components/schemas/TextLineDetail' PurchaseOrderDetail: description: 発注詳細 allOf: - $ref: '#/components/schemas/PurchaseOrderDigest' - type: object properties: amount_set_rates: type: array items: $ref: '#/components/schemas/AmountSetRate' recipient_address: $ref: '#/components/schemas/RecipientAddress' lines: type: array items: $ref: '#/components/schemas/PurchaseOrderLineDetail' description: 明細リスト required: - amount_set_rates - lines - recipient_address additionalProperties: false QuotationStatus: description: '見積ステータス (未受注: unanswered, 受注済: order_received, 失注: order_lost)' enum: - unanswered - order_received - order_lost type: string example: unanswered DeliveryProgress: description: '納品進捗 (未納品: not_delivered, 一部納品済: partially_delivered, 納品済: delivered)' enum: - not_delivered - partially_delivered - delivered type: string example: not_delivered DeliveryIssueProgress: description: '納品書発行進捗 (未発行: not_issued, 一部発行済: partially_issued, 発行済: issued)' enum: - not_issued - partially_issued - issued type: string example: not_issued SalesStatus: description: '売上ステータス (未計上: not_sold, 一部計上済: partially_sold, 計上済: sold)' enum: - not_sold - partially_sold - sold type: string example: not_sold BillingStatus: description: |- 請求書送付ステータス (未送付: not_billed, 一部送付済: partially_billed, 送付済: billed, 対象外: none) ※partially_billed(一部送付済)は納品でのみ発生します。none(対象外)は売上でのみ発生します。 enum: - not_billed - partially_billed - billed - none type: string example: not_billed QuotationDigest: type: object properties: id: type: string description: 見積ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM canceled: type: boolean description: 取消状態 example: false registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' quotation_no: type: string description: 見積No. example: Q211212-00001 branch_no: type: integer format: int32 description: 枝番 nullable: true example: 1 quotation_date: description: 見積日 type: string format: date example: '2025-04-01' quotation_subject: description: 見積書件名 type: string nullable: true maxLength: 100 example: サンプル案件見積の件 internal_subject: description: 見積タイトル type: string nullable: true maxLength: 100 example: サンプル案件見積の件 expires_on: description: 有効期限日 type: string format: date nullable: true example: '2025-05-01' delivery_deadline: description: 納品期限日 type: string format: date nullable: true example: '2025-06-01' delivery_location: description: 納品場所 type: string nullable: true maxLength: 100 example: 東京都渋谷区 issued: type: boolean description: 送付ステータス example: false issued_on: type: string format: date description: 送付日 nullable: true example: '2025-04-01' registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' total_amount: description: 源泉徴収税額を除いた合計金額 type: integer format: int64 maximum: 9223372036854775807 example: 10000 amount_set: $ref: '#/components/schemas/AmountSet' amount_of_withholding_tax: description: 源泉徴収税額 type: integer format: int64 nullable: true example: 10000 quotation_status: $ref: '#/components/schemas/QuotationStatus' delivery_progress: $ref: '#/components/schemas/DeliveryProgress' delivery_issue_progress: $ref: '#/components/schemas/DeliveryIssueProgress' sales_status: $ref: '#/components/schemas/SalesStatus' billing_status: $ref: '#/components/schemas/BillingStatus' customer: description: 顧客 allOf: - $ref: '#/components/schemas/Partner' charge_employee: description: 社内担当者 allOf: - $ref: '#/components/schemas/Employee' nullable: true reporting_section: $ref: '#/components/schemas/ReportingSection' business: $ref: '#/components/schemas/Business' internal_memo: $ref: '#/components/schemas/InternalMemo' quotation_note: description: 見積書の備考欄に記載する内容 type: string nullable: true maxLength: 4000 example: 見積書備考 last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' required: - id - canceled - registered_by - quotation_no - quotation_date - issued - registered_at - last_updated_at - total_amount - amount_set - quotation_status - delivery_progress - delivery_issue_progress - sales_status - billing_status - customer - last_updated_by additionalProperties: false QuotationLineParams: description: 明細パラメータ discriminator: propertyName: line_type mapping: basic: '#/components/schemas/BasicLineParams' text: '#/components/schemas/TextLineParams' oneOf: - $ref: '#/components/schemas/BasicLineParams' - $ref: '#/components/schemas/TextLineParams' QuotationRequestBase: type: object properties: business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM internal_subject: description: 見積タイトル type: string nullable: true maxLength: 100 example: サンプル案件見積の件 quotation_date: description: 見積日 type: string format: date example: '2025-04-01' customer_id: description: 顧客の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1001 expires_on: description: 有効期限日 type: string format: date nullable: true example: '2025-04-30' delivery_deadline: description: 納品期限日 type: string format: date nullable: true example: '2025-05-15' delivery_location: description: 納品場所 type: string nullable: true maxLength: 100 example: 東京都渋谷区 quotation_template_id: description: 見積書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 10001 quotation_subject: description: 見積書件名 type: string nullable: true maxLength: 100 example: サンプル案件見積の件 quotation_note: description: 見積書の備考欄に記載する内容 type: string nullable: true maxLength: 4000 example: 有効期限内にご回答ください recipient_address: $ref: '#/components/schemas/RecipientAddress' charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/QuotationLineParams' additionalProperties: false QuotationMinimalResponse: type: object properties: id: type: string description: 見積ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false LineDetail: description: 明細詳細 discriminator: propertyName: line_type mapping: basic: '#/components/schemas/BasicLineDetail' text: '#/components/schemas/TextLineDetail' oneOf: - $ref: '#/components/schemas/BasicLineDetail' - $ref: '#/components/schemas/TextLineDetail' QuotationDetail: allOf: - $ref: '#/components/schemas/QuotationDigest' - type: object properties: amount_set_rates: type: array items: $ref: '#/components/schemas/AmountSetRate' quotation_template_name: type: string description: 見積書テンプレート名称 example: デフォルトテンプレート recipient_address: $ref: '#/components/schemas/RecipientAddress' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/LineDetail' required: - amount_set_rates - quotation_template_name - lines - recipient_address additionalProperties: false QuotationStatusForUpdate: description: '更新可能な見積ステータス (未受注: unanswered, 失注: order_lost)' enum: - unanswered - order_lost type: string example: unanswered QuotationStatusChangeRequest: description: 見積ステータス変更リクエスト allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: quotation_status: $ref: '#/components/schemas/QuotationStatusForUpdate' required: - quotation_status CollectionStatus: description: |- 決済ステータス (未決済: not_settled, 一部決済済: partially_settled, 決済済: settled, 無効: invalidated, 対象外: none) ※invalidated(無効)は請求でのみ発生します。売上・納品では発生しません。 enum: - not_settled - partially_settled - settled - invalidated - none type: string example: not_settled SalesOrderDigest: type: object properties: id: type: string description: 受注ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM sales_order_no: type: string description: 受注No. example: S211212-00001 sales_order_subject: description: 受注タイトル type: string nullable: true example: サンプル案件受注の件 sales_order_date: description: 受注日 type: string format: date example: '2025-04-01' customer_order_no: description: 顧客注文No. type: string nullable: true example: C-PO-20250401-001 amount_set: $ref: '#/components/schemas/AmountSet' amount_of_withholding_tax: description: 源泉徴収税額 format: int64 type: integer example: 10000 nullable: true registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' customer: description: 顧客 allOf: - $ref: '#/components/schemas/Partner' sales_on: description: 売上予定日 type: string format: date example: '2025-04-01' nullable: true delivery_progress: $ref: '#/components/schemas/DeliveryProgress' sales_status: $ref: '#/components/schemas/SalesStatus' billing_status: $ref: '#/components/schemas/BillingStatus' collection_status: $ref: '#/components/schemas/CollectionStatus' business: $ref: '#/components/schemas/Business' quotation_id: description: 紐づく見積ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM total_amount: description: 源泉徴収税額を除いた合計金額 type: integer format: int64 maximum: 9223372036854775807 example: 10000 canceled: description: 取消状態 type: boolean example: false required: - id - sales_order_no - sales_order_date - amount_set - customer - registered_at - registered_by - last_updated_at - last_updated_by - delivery_progress - sales_status - billing_status - collection_status - total_amount - canceled additionalProperties: false BillingCreatingMethodType: description: '請求作成方法区分 (自動作成: automatically, 手動作成: manually)' enum: - automatically - manually type: string example: automatically CollectionMethodType: description: '入金方法 (振込: transfer, 現金: cash, 手形: bill_payable, 振替: direct_debit)' type: string enum: - transfer - cash - bill_payable - direct_debit example: transfer LineParams: description: 明細パラメータ discriminator: propertyName: line_type mapping: basic: '#/components/schemas/BasicLineParams' text: '#/components/schemas/TextLineParams' oneOf: - $ref: '#/components/schemas/BasicLineParams' - $ref: '#/components/schemas/TextLineParams' SalesOrderRequestBase: type: object properties: sales_order_subject: description: 受注タイトル type: string nullable: true maxLength: 100 example: サンプル案件パンフレット作成 sales_order_date: description: 受注日 type: string format: date example: '2021-12-12' customer_order_no: description: 顧客注文No. type: string nullable: true maxLength: 100 example: C-PO-20211212-001 customer_id: description: 顧客の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1001 sales_on: description: 売上予定日 type: string format: date nullable: true example: '2021-12-12' deliveries_on: description: 納品予定日 type: string format: date nullable: true example: '2021-12-12' accepts_on: description: 検収予定日 type: string format: date nullable: true example: '2021-12-12' delivery_template_id: description: 納品書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 10001 delivery_subject: description: 納品書件名 type: string nullable: true maxLength: 100 example: サンプル案件パンフレット作成 delivery_note: description: 納品書の備考欄に掲載する内容 type: string nullable: true maxLength: 4000 example: 納品時の注意事項 billing_creating_method_type: $ref: '#/components/schemas/BillingCreatingMethodType' bills_on: description: 請求予定日 type: string format: date nullable: true example: '2021-12-12' billing_partner_id: description: 請求先の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1002 invoice_template_id: description: 請求書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 10002 invoice_subject: description: 請求書件名 type: string nullable: true maxLength: 100 example: サンプル案件パンフレット作成 invoice_note: description: 請求書の備考欄に掲載する内容 type: string nullable: true maxLength: 4000 example: お振込期限は月末までとなります collects_on: description: 入金予定日 type: string format: date nullable: true example: '2021-12-12' collecting_partner_id: description: 入金元の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1003 collection_method_type: $ref: '#/components/schemas/CollectionMethodType' charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM quotation_id: description: 見積ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM lines: description: 明細リスト type: array items: $ref: '#/components/schemas/LineParams' additionalProperties: false SalesOrderMinimalResponse: type: object properties: id: type: string description: 受注ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false SalesOrderDetail: allOf: - $ref: '#/components/schemas/SalesOrderDigest' - type: object properties: amount_set_rates: type: array items: $ref: '#/components/schemas/AmountSetRate' deliveries_on: description: 納品予定日 type: string format: date example: '2025-04-01' nullable: true accepts_on: description: 検収予定日 type: string format: date example: '2025-04-01' nullable: true delivery_template_name: description: 納品書テンプレート名称 type: string example: デフォルトテンプレート delivery_subject: description: 納品書件名 type: string nullable: true example: サンプル案件受注の件 delivery_note: description: 納品書の備考欄に掲載する内容 type: string nullable: true example: 納品時の注意事項 delivered_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 納品済金額(税抜) nullable: true example: 5200000 remaining_delivered_tax: type: integer format: int64 maximum: 9223372036854775807 description: 納品残金額(税抜) nullable: true example: 5200000 sales_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 売上金額(税抜) nullable: true example: 5200000 remaining_sales_order_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 受注残金額(税抜) nullable: true example: 5200000 billing_creating_method_type: $ref: '#/components/schemas/BillingCreatingMethodType' bills_on: description: 請求予定日 type: string format: date example: '2025-04-01' nullable: true billing_partner: description: 請求先 allOf: - $ref: '#/components/schemas/Partner' invoice_template_name: description: 請求書テンプレート名称 type: string example: デフォルトテンプレート invoice_subject: description: 請求書件名 type: string nullable: true example: サンプル案件受注の件 invoice_note: description: 請求書の備考欄に掲載する内容 type: string nullable: true example: お振込期限は月末までとなります collects_on: description: 入金予定日 type: string format: date example: '2025-04-01' nullable: true collecting_partner: description: 入金元 allOf: - $ref: '#/components/schemas/Partner' collection_method_type: $ref: '#/components/schemas/CollectionMethodType' charge_employee: nullable: true allOf: - $ref: '#/components/schemas/Employee' reporting_section: $ref: '#/components/schemas/ReportingSection' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/LineDetail' required: - amount_set_rates - billing_partner - collecting_partner - billing_creating_method_type - collection_method_type - delivery_template_name - invoice_template_name - lines additionalProperties: false DeliveryStatus: description: '納品ステータス (未納品: not_delivered, 納品済: delivered)' enum: - not_delivered - delivered type: string example: not_delivered AcceptanceStatus: description: '検収ステータス (未検収: not_accepted, 検収済: accepted)' enum: - not_accepted - accepted type: string example: not_accepted DeliveryDigest: type: object properties: id: type: string description: 納品ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM sales_order_id: type: string description: 紐づく受注ID nullable: true example: 01JPP4FD1CVQWCDSWA90VE1ZTM delivery_status: $ref: '#/components/schemas/DeliveryStatus' acceptance_status: $ref: '#/components/schemas/AcceptanceStatus' canceled: type: boolean description: 取消状態 example: false registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' amount_set: $ref: '#/components/schemas/AmountSet' amount_of_withholding_tax: description: 源泉徴収税額 format: int64 type: integer example: 10000 nullable: true total_amount: description: 源泉徴収税額を除いた合計金額 type: integer format: int64 maximum: 9223372036854775807 example: 10000 business: $ref: '#/components/schemas/Business' delivery_no: type: string description: 納品No. example: D211212-00001 branch_no: type: integer format: int32 description: 枝番 nullable: true example: 1 internal_subject: description: 納品タイトル type: string example: サンプル案件納品の件 nullable: true customer_order_no: description: 顧客注文No. type: string nullable: true example: C-PO-20250401-001 delivery_date: description: 納品日 type: string format: date example: '2025-04-01' acceptance_date: description: 検収日 type: string format: date example: '2025-04-01' nullable: true customer: description: 顧客 allOf: - $ref: '#/components/schemas/Partner' issued: type: boolean description: 送付ステータス example: false issued_on: type: string format: date description: 送付日 nullable: true example: '2025-04-01' subject: description: 納品書件名 type: string nullable: true example: サンプル案件納品の件 sales_status: $ref: '#/components/schemas/SalesStatus' billing_status: $ref: '#/components/schemas/BillingStatus' collection_status: $ref: '#/components/schemas/CollectionStatus' required: - id - delivery_no - delivery_date - customer - delivery_status - acceptance_status - sales_status - billing_status - collection_status - amount_set - total_amount - issued - canceled - registered_at - registered_by - last_updated_at - last_updated_by additionalProperties: false DeliveryLineParams: description: 明細パラメータ discriminator: propertyName: line_type mapping: basic: '#/components/schemas/BasicLineParams' text: '#/components/schemas/TextLineParams' oneOf: - $ref: '#/components/schemas/BasicLineParams' - $ref: '#/components/schemas/TextLineParams' DeliveryRequestBase: type: object properties: business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM internal_subject: description: 納品タイトル type: string nullable: true maxLength: 100 example: サンプル案件納品の件 customer_order_no: description: 顧客注文No. type: string nullable: true maxLength: 100 example: C-PO-20250401-001 delivery_date: description: 納品日 type: string format: date example: '2025-04-01' acceptance_date: description: 検収日 type: string format: date nullable: true example: '2025-04-01' customer_id: description: 顧客の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1001 delivery_note: description: 納品書の備考欄に記載する内容 type: string nullable: true maxLength: 4000 example: 納品時の注意事項 delivery_template_id: description: 納品書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 10001 subject: description: 納品書件名 type: string nullable: true maxLength: 100 example: サンプル案件納品の件 recipient_address: $ref: '#/components/schemas/RecipientAddress' billing_creating_method_type: $ref: '#/components/schemas/BillingCreatingMethodType' bills_on: description: 請求予定日 type: string format: date nullable: true example: '2025-04-01' invoice_template_id: description: 請求書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 10002 billing_partner_id: description: 請求先の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1002 invoice_subject: description: 請求書件名 type: string nullable: true maxLength: 100 example: サンプル案件納品の件 invoice_note: description: 請求書の備考欄に掲載する内容 type: string nullable: true maxLength: 4000 example: お振込期限は月末までとなります collects_on: description: 入金予定日 type: string format: date nullable: true example: '2025-04-01' collection_method_type: $ref: '#/components/schemas/CollectionMethodType' collecting_partner_id: description: 入金元の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1003 charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/DeliveryLineParams' additionalProperties: false DeliveryMinimalResponse: type: object properties: id: type: string description: 納品ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false DeliveryDetail: allOf: - $ref: '#/components/schemas/DeliveryDigest' - type: object properties: amount_set_rates: type: array items: $ref: '#/components/schemas/AmountSetRate' delivery_note: description: 納品書の備考欄に記載する内容 type: string nullable: true example: 納品時の注意事項 delivery_template_name: description: 納品書テンプレート名称 type: string example: デフォルトテンプレート recipient_address: $ref: '#/components/schemas/RecipientAddress' recorded_sales_amount_excluding_tax: type: integer format: int64 description: 売上金額(税抜) example: 5200000 remaining_sales_amount_excluding_tax: type: integer format: int64 description: 売上残金額(税抜) example: 5200000 billing_creating_method_type: $ref: '#/components/schemas/BillingCreatingMethodType' bills_on: description: 請求予定日 type: string format: date nullable: true example: '2025-04-01' invoice_template_name: description: 請求書テンプレート名称 type: string example: デフォルトテンプレート customer: description: 顧客 nullable: true allOf: - $ref: '#/components/schemas/Partner' billing_partner: description: 請求先 nullable: true allOf: - $ref: '#/components/schemas/Partner' invoice_subject: description: 請求書件名 type: string nullable: true example: サンプル案件納品の件 invoice_note: description: 請求書の備考欄に掲載する内容 type: string nullable: true example: お振込期限は月末までとなります collects_on: description: 入金予定日 type: string format: date nullable: true example: '2025-04-01' collection_method_type: $ref: '#/components/schemas/CollectionMethodType' collecting_partner: description: 入金元 nullable: true allOf: - $ref: '#/components/schemas/Partner' charge_employee: nullable: true allOf: - $ref: '#/components/schemas/Employee' reporting_section: $ref: '#/components/schemas/ReportingSection' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/LineDetail' required: - delivery_template_name - invoice_template_name - collection_method_type - lines - recipient_address - billing_creating_method_type - amount_set_rates - recorded_sales_amount_excluding_tax - remaining_sales_amount_excluding_tax additionalProperties: false DeliveryStatusChangeRequest: description: 納品ステータス変更リクエスト allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: delivery_status: $ref: '#/components/schemas/DeliveryStatus' required: - delivery_status AcceptanceStatusChangeRequest: description: 検収ステータス変更リクエスト allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: acceptance_status: $ref: '#/components/schemas/AcceptanceStatus' required: - acceptance_status BillingCreatingStatus: description: |- 請求登録ステータス (未作成: not_created, 作成済: created, 取消済: canceled, 赤伝作成済: aka_created, 対象外: none) ※aka_created(赤伝作成済)は過去データにのみ存在します。今後、新規に発生することはありません。 enum: - not_created - created - canceled - aka_created - none type: string example: not_created SaleDigest: type: object properties: id: type: string description: 売上ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 deal_id: type: integer format: int64 description: 会計の取引ID nullable: true example: 12345 canceled: type: boolean description: 取消状態 example: false registered_at: type: string format: date-time description: 登録日時 example: '2024-01-15T10:30:00+09:00' registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' last_updated_at: type: string format: date-time description: 変更日時 example: '2024-01-16T14:45:00+09:00' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' amount_set: $ref: '#/components/schemas/AmountSet' amount_of_withholding_tax: description: 源泉徴収税額 format: int64 type: integer example: 10000 nullable: true total_amount: description: 源泉徴収税額を除いた合計金額 type: integer format: int64 maximum: 9223372036854775807 example: 10000 business: $ref: '#/components/schemas/Business' sales_no: type: string description: 売上No. example: S-2024-0001 subject: type: string description: 売上タイトル nullable: true example: Webシステム開発業務 customer_order_no: type: string description: 顧客注文No. nullable: true example: PO-2024-001 revenue_recognition_date: type: string format: date description: 売上日 example: '2024-01-31' customer: description: 顧客 allOf: - $ref: '#/components/schemas/Partner' billing_creating_status: $ref: '#/components/schemas/BillingCreatingStatus' billing_status: $ref: '#/components/schemas/BillingStatus' collection_status: $ref: '#/components/schemas/CollectionStatus' required: - id - canceled - registered_at - registered_by - last_updated_at - last_updated_by - amount_set - total_amount - sales_no - revenue_recognition_date - customer - billing_creating_status - billing_status - collection_status additionalProperties: false SaleBasicLineParams: description: 売上通常明細パラメータ allOf: - $ref: '#/components/schemas/BasicLineParams' - type: object properties: segment_tag_1_id: description: セグメントタグ1のID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 12345 segment_tag_2_id: description: セグメントタグ2のID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 12345 segment_tag_3_id: description: セグメントタグ3のID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 12345 additionalProperties: false schemas-LineParams: description: 明細パラメータ discriminator: propertyName: line_type mapping: basic: '#/components/schemas/SaleBasicLineParams' text: '#/components/schemas/TextLineParams' oneOf: - $ref: '#/components/schemas/SaleBasicLineParams' - $ref: '#/components/schemas/TextLineParams' SaleRequestBase: type: object properties: business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM subject: description: 売上タイトル type: string nullable: true maxLength: 100 example: サンプル案件売上の件 customer_order_no: description: 顧客注文No. type: string nullable: true maxLength: 100 example: C-PO-20211212-001 revenue_recognition_date: description: 売上日 type: string format: date example: '2021-12-12' customer_id: description: 顧客の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1001 bills_on: description: 請求日 type: string format: date nullable: true example: '2021-12-12' invoice_template_id: description: 請求書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: true example: 10002 billing_partner_id: description: 請求先の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1002 invoice_subject: description: 請求書件名 type: string nullable: true maxLength: 100 example: サンプル案件売上の件 invoice_note: description: 請求書の備考欄に掲載する内容 type: string nullable: true maxLength: 4000 example: お振込期限は月末までとなります collects_on: description: 入金期日 type: string format: date nullable: true example: '2021-12-12' collection_method_type: $ref: '#/components/schemas/CollectionMethodType' collecting_partner_id: description: 入金元の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1003 charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/schemas-LineParams' additionalProperties: false SaleMinimalResponse: type: object properties: id: type: string description: 売上ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false CollectionMethodTypeWithNone: description: |- 入金方法 * `transfer` - 振込 * `cash` - 現金 * `bill_payable` - 手形 * `direct_debit` - 振替 * `none` - なし type: string enum: - transfer - cash - bill_payable - direct_debit - none example: none SaleBasicLineDetail: description: 売上通常明細詳細 allOf: - $ref: '#/components/schemas/BasicLineDetail' - type: object properties: is_manual_tax_entry: description: 税の手動入力フラグ type: boolean example: false account_item: $ref: '#/components/schemas/AccountItem' segment_tag_1: $ref: '#/components/schemas/SegmentTag' segment_tag_2: $ref: '#/components/schemas/SegmentTag' segment_tag_3: $ref: '#/components/schemas/SegmentTag' required: - is_manual_tax_entry - account_item additionalProperties: false SaleLineDetail: description: 売上明細詳細 discriminator: propertyName: line_type mapping: basic: '#/components/schemas/SaleBasicLineDetail' text: '#/components/schemas/TextLineDetail' oneOf: - $ref: '#/components/schemas/SaleBasicLineDetail' - $ref: '#/components/schemas/TextLineDetail' SaleDetail: allOf: - $ref: '#/components/schemas/SaleDigest' - type: object properties: sales_order_id: type: string description: 紐づく受注ID nullable: true example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 delivery_id: type: string description: 紐づく納品ID nullable: true example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 amount_set_rates: type: array items: $ref: '#/components/schemas/AmountSetRate' bills_on: description: 請求日 type: string format: date nullable: true example: '2024-02-01' invoice_template_name: description: 請求書テンプレート名称 type: string nullable: true example: デフォルトテンプレート customer: description: 顧客 nullable: true allOf: - $ref: '#/components/schemas/Partner' billing_partner: description: 請求先 nullable: true allOf: - $ref: '#/components/schemas/Partner' invoice_subject: description: 請求書件名 type: string nullable: true example: Webシステム開発業務 invoice_note: description: 請求書の備考欄に掲載する内容 type: string nullable: true example: お振込期限は月末までとなります billing_amount_excluding_tax: type: integer format: int64 description: 請求金額(税抜) nullable: true example: 5200000 invoice_no: type: string description: 請求書番号 nullable: true example: INV-2024-0001 bill_id: type: string description: 請求ID nullable: true example: 01JPP4FD1CVQWCDSWA90VE1ZTM maxLength: 26 minLength: 26 collects_on: description: 入金期日 type: string format: date nullable: true example: '2024-02-28' collection_method_type: $ref: '#/components/schemas/CollectionMethodTypeWithNone' collecting_partner: description: 入金元 nullable: true allOf: - $ref: '#/components/schemas/Partner' charge_employee: nullable: true allOf: - $ref: '#/components/schemas/Employee' reporting_section: $ref: '#/components/schemas/ReportingSection' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/SaleLineDetail' required: - amount_set_rates - collection_method_type - lines additionalProperties: false OtherCostDetail: type: object properties: id: type: string description: その他原価ID minLength: 26 maxLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM other_cost_no: type: string description: その他原価番号 example: OC-00001 canceled: type: boolean description: 取消状態 example: false amount_excluding_tax: type: integer format: int64 maximum: 9223372036854775807 description: 税抜金額 example: 10000 incurred_date: type: string format: date description: 発生日 example: '2025-04-01' memo: type: string description: メモ nullable: true example: その他原価メモ registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' business: $ref: '#/components/schemas/Business' deal_line: type: object description: 会計連携情報 nullable: true properties: deal_id: type: integer format: int64 maximum: 9223372036854775807 description: 会計取引ID example: 1001 deal_line_id: type: integer format: int64 maximum: 9223372036854775807 description: 会計取引明細ID example: 2001 required: - deal_id - deal_line_id additionalProperties: false required: - id - other_cost_no - amount_excluding_tax - incurred_date - canceled - registered_at - registered_by - last_updated_at - last_updated_by additionalProperties: false OtherCostMinimalResponse: type: object properties: id: type: string description: その他原価ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false ProcurementPaymentStatus: description: '決済ステータス (未決済: not_settled, 一部決済済: partially_settled, 決済済: settled)' enum: - not_settled - partially_settled - settled type: string example: not_settled ProcurementDigest: type: object properties: id: type: string description: 仕入ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM deal_id: type: integer format: int64 description: 会計の取引ID nullable: true example: 12345 canceled: type: boolean description: 取消状態 example: false registered_by: description: 登録者 allOf: - $ref: '#/components/schemas/Employee' procurement_no: type: string description: 仕入No. example: P211212-00001 internal_subject: description: 仕入タイトル type: string nullable: true maxLength: 100 example: 事務用品仕入 procurement_date: description: 仕入日 type: string format: date example: '2025-04-01' supplier: description: 仕入先 allOf: - $ref: '#/components/schemas/Partner' is_qualified_invoice_issuer: type: boolean description: |- 適格請求書発行事業者該当フラグ
※ 登録値はfreee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況により決定されます。
※ 買い手側対応機能を「使用する」場合、リクエスト指定値が優先され、未指定時は「適格チェックボックスと税区分」の設定に従います。 nullable: true example: true payment_status: $ref: '#/components/schemas/ProcurementPaymentStatus' payments_on: description: 支払期日 type: string format: date example: '2025-05-31' payment_method_type: $ref: '#/components/schemas/PaymentMethodType' payment_partner: description: 支払先 allOf: - $ref: '#/components/schemas/Partner' charge_employee: allOf: - $ref: '#/components/schemas/Employee' nullable: true reporting_section: $ref: '#/components/schemas/ReportingSection' business: description: |- 案件 ※ 複数の案件が紐づく場合はnullになります allOf: - $ref: '#/components/schemas/Business' purchase_order_id: description: |- 発注ID ※ 複数の発注が紐づく場合はnullになります type: string nullable: true example: 01JPP4FD1CVQWCDSWA90VE1ZTM internal_memo: $ref: '#/components/schemas/InternalMemo' amount_set: $ref: '#/components/schemas/AmountSet' amount_of_withholding_tax: description: 源泉徴収税額 type: integer format: int64 nullable: true example: 10000 registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' last_updated_by: description: 変更者 allOf: - $ref: '#/components/schemas/Employee' required: - id - canceled - registered_by - registered_at - last_updated_by - last_updated_at - procurement_no - procurement_date - supplier - payment_status - payments_on - payment_method_type - payment_partner - amount_set additionalProperties: false ProcurementLineParams: description: 明細パラメータ type: object properties: master_item_id: description: 商品ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM deal_line_type_id: description: 明細取引タイプID type: string maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM description: description: 摘要 type: string nullable: true maxLength: 200 example: 事務用品購入 quantity: description: 数量 format: double type: number example: 100 uom_name: description: 単位 type: string nullable: true maxLength: 10 example: 個 unit_price: description: 単価 format: double type: number example: 1000 maximum: 999999999999 minimum: 0 withholding_enabled: description: 源泉徴収税対象明細かどうか type: boolean example: false is_manual_tax_entry: description: 税の手動入力を行うかどうか type: boolean example: false tax: description: |- 手動入力した税額
※is_manual_tax_entryがtrueの場合のみ参照されます。falseの場合は値を設定しても無視されます。 type: integer format: int64 maximum: 999999999999 minimum: -999999999999 nullable: true example: 10000 business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM purchase_order_id: description: 発注ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM accounting_reporting_section_id: description: |- 会計計上部門ID
※ 親部門のIDは指定できません format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 67890 item_tag_id: description: 会計品目タグID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 2001 memo_tags: description: メモタグID type: array nullable: true items: format: int64 maximum: 9223372036854775807 type: integer example: 3001 segment_tag_1_id: description: セグメントタグ1 ID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 12345 segment_tag_2_id: description: セグメントタグ2 ID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 12346 segment_tag_3_id: description: セグメントタグ3 ID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 12347 required: - deal_line_type_id - quantity - unit_price - withholding_enabled - is_manual_tax_entry additionalProperties: false ProcurementRequestBase: type: object properties: internal_subject: description: 仕入タイトル type: string nullable: true maxLength: 100 example: 事務用品仕入 procurement_date: description: 仕入日 type: string format: date example: '2025-04-01' supplier_id: description: 仕入先の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1001 is_qualified_invoice_issuer: description: |- 適格請求書発行事業者該当フラグ
※ 登録値はfreee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況により決定されます。
※ 買い手側対応機能を「使用する」場合、リクエスト指定値が優先され、未指定時は「適格チェックボックスと税区分」の設定に従います。 type: boolean nullable: true example: true payments_on: description: 支払期日 type: string format: date example: '2025-05-31' payment_method_type: $ref: '#/components/schemas/PaymentMethodType' payment_partner_id: description: 支払先の取引先ID type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 1002 charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト type: array minItems: 1 maxItems: 500 items: $ref: '#/components/schemas/ProcurementLineParams' additionalProperties: false ProcurementMinimalResponse: type: object properties: id: type: string description: 仕入ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM registered_at: type: string format: date-time description: 登録日時 example: '2025-01-15T10:30:00+09:00' last_updated_at: type: string format: date-time description: 変更日時 example: '2025-01-16T14:45:00+09:00' required: - id - registered_at - last_updated_at additionalProperties: false PurchaseOrderRef: description: 発注参照 type: object nullable: true properties: id: type: string description: 発注ID example: 01JPP4FD1CVQWCDSWA90VE1ZTM purchase_order_no: type: string description: 発注No. example: PO211212-00001 required: - id - purchase_order_no additionalProperties: false ProcurementLineDetail: description: 明細詳細 type: object properties: line_no: description: 明細行番号 type: integer format: int32 maximum: 2147483647 example: 1 master_item: $ref: '#/components/schemas/MasterItemDetail' deal_line_type: $ref: '#/components/schemas/DealLineTypeDetail' account_item: $ref: '#/components/schemas/AccountItem' description: description: 摘要 type: string nullable: true example: 事務用品購入 quantity: description: 数量 format: double type: number example: 100 uom_name: description: 単位 type: string nullable: true example: 個 unit_price: description: 単価 format: double type: number example: 1000 tax_type: $ref: '#/components/schemas/TaxTypeDetail' withholding_enabled: description: 源泉徴収税対象明細かどうか type: boolean example: false amount_set: $ref: '#/components/schemas/AmountSet' memo_tags: description: メモタグ type: array nullable: true items: $ref: '#/components/schemas/MemoTagDetail' item_tag: $ref: '#/components/schemas/ItemTagDetail' accounting_reporting_section: $ref: '#/components/schemas/AccountingReportingSectionDetail' segment_tag_1: $ref: '#/components/schemas/SegmentTag' segment_tag_2: $ref: '#/components/schemas/SegmentTag' segment_tag_3: $ref: '#/components/schemas/SegmentTag' business: $ref: '#/components/schemas/Business' purchase_order: $ref: '#/components/schemas/PurchaseOrderRef' required: - line_no - deal_line_type - quantity - unit_price - withholding_enabled - amount_set - account_item additionalProperties: false ProcurementDetail: allOf: - $ref: '#/components/schemas/ProcurementDigest' - type: object properties: amount_set_rates: type: array items: $ref: '#/components/schemas/AmountSetRate' lines: description: 明細リスト type: array items: $ref: '#/components/schemas/ProcurementLineDetail' required: - amount_set_rates - lines additionalProperties: false ProcurementUpdateLineParams: description: 更新用明細パラメータ type: object properties: master_item_id: description: 商品ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM deal_line_type_id: description: 明細取引タイプID type: string maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM description: description: 摘要 type: string nullable: true maxLength: 200 example: 事務用品購入 quantity: description: 数量 format: double type: number example: 100 uom_name: description: 単位 type: string nullable: true maxLength: 10 example: 個 unit_price: description: 単価 format: double type: number example: 1000 maximum: 999999999999 minimum: 0 withholding_enabled: description: 源泉徴収税対象明細かどうか type: boolean example: false is_manual_tax_entry: description: 税の手動入力を行うかどうか type: boolean example: false tax: description: |- 手動入力した税額
※is_manual_tax_entryがtrueの場合のみ参照されます。falseの場合は値を設定しても無視されます。 type: integer format: int64 maximum: 999999999999 minimum: -999999999999 nullable: true example: 10000 business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM purchase_order_id: description: |- 発注ID
※省略した場合、またはnullを指定した場合、発注との紐づけは解除されます。既存の紐づけを維持したい場合は必ず指定してください。 type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM accounting_reporting_section_id: description: |- 会計計上部門ID
※ 親部門のIDは指定できません format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 67890 item_tag_id: description: 会計品目タグID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 2001 memo_tags: description: メモタグID type: array nullable: true items: format: int64 maximum: 9223372036854775807 type: integer example: 3001 segment_tag_1_id: description: セグメントタグ1 ID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 12345 segment_tag_2_id: description: セグメントタグ2 ID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 12346 segment_tag_3_id: description: セグメントタグ3 ID format: int64 maximum: 9223372036854775807 type: integer nullable: true example: 12347 required: - deal_line_type_id - quantity - unit_price - withholding_enabled - is_manual_tax_entry additionalProperties: false ProcurementUpdateRequestBody: description: 仕入更新リクエストボディ type: object properties: internal_subject: description: 仕入タイトル type: string nullable: true maxLength: 100 example: 事務用品仕入 procurement_date: description: 仕入日 type: string format: date example: '2025-04-01' supplier_id: description: 仕入先の取引先ID type: integer format: int64 maximum: 9223372036854775807 example: 1001 is_qualified_invoice_issuer: description: |- 適格請求書発行事業者該当フラグ
※ 登録値はfreee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況により決定されます。
※ 買い手側対応機能を「使用する」場合、リクエスト指定値が優先され、未指定時は「適格チェックボックスと税区分」の設定に従います。 type: boolean nullable: true example: true payments_on: description: 支払期日 type: string format: date example: '2025-05-31' payment_method_type: $ref: '#/components/schemas/PaymentMethodType' payment_partner_id: description: 支払先の取引先ID type: integer format: int64 minimum: 1 maximum: 9223372036854775807 example: 1002 charge_employee_id: $ref: '#/components/schemas/ChargeEmployeeId' reporting_section_id: $ref: '#/components/schemas/ReportingSectionId' internal_memo: $ref: '#/components/schemas/InternalMemo' lines: description: 明細リスト(指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます) type: array minItems: 1 maxItems: 500 items: $ref: '#/components/schemas/ProcurementUpdateLineParams' additionalProperties: false responses: BusinessIndexResponse: description: 案件一覧のレスポンス content: application/json: schema: type: object properties: businesses: type: array items: $ref: '#/components/schemas/BusinessDigest' meta: $ref: '#/components/schemas/PaginationMeta' required: - businesses - meta additionalProperties: false BadRequestErrorResponse: description: Bad Request - リクエストパラメータが不正 content: application/json: schema: $ref: '#/components/schemas/ProductError' example: status_code: 400 errors: - codes: - bad_request messages: - リクエストの形式が不正です。 UnauthorizedErrorResponse: description: Unauthorized - アクセストークンが無効 content: application/json: schema: $ref: '#/components/schemas/AuthError' example: message: ログインをして下さい code: invalid_access_token ForbiddenErrorResponse: description: Forbidden - アクセス権限がない content: application/json: schema: $ref: '#/components/schemas/ProductError' example: status_code: 403 errors: - codes: - forbidden messages: - アクセス権限がありません。 NotFoundErrorResponse: description: Not Found - リソースが存在しない content: application/json: schema: $ref: '#/components/schemas/ProductError' example: status_code: 404 errors: - codes: - not_found messages: - 指定されたリソースが見つかりませんでした。 TooManyRequestsErrorResponse: description: Too Many Requests - リクエスト回数制限を超えた content: application/json: schema: $ref: '#/components/schemas/ProductError' example: status_code: 429 errors: - codes: - too_many_requests messages: - リクエスト回数制限を超えました。しばらく時間をおいてから再度お試しください。 InternalServerErrorResponse: description: Internal Server Error - システム内で予期しないエラーが発生 content: application/json: schema: $ref: '#/components/schemas/ProductError' example: status_code: 500 errors: - codes: - internal_server_error messages: - システムエラーが発生しました。 BusinessCreateResponse: description: 案件登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/BusinessMinimalResponse' ConflictErrorResponse: description: Conflict - リソースの競合 content: application/json: schema: $ref: '#/components/schemas/ProductError' example: status_code: 409 errors: - codes: - conflict messages: - リソースが競合しています。 BusinessShowResponse: description: 案件詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/BusinessDetail' BusinessUpdateResponse: description: 案件更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/BusinessMinimalResponse' BusinessCancelResponse: description: 案件取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/BusinessMinimalResponse' BusinessCloseResponse: description: 案件ロックのレスポンス content: application/json: schema: $ref: '#/components/schemas/BusinessMinimalResponse' BusinessReopenResponse: description: 案件ロック解除のレスポンス content: application/json: schema: $ref: '#/components/schemas/BusinessMinimalResponse' CostBudgetIndexResponse: description: 原価予算一覧のレスポンス content: application/json: schema: type: object properties: cost_budgets: type: array items: $ref: '#/components/schemas/CostBudgetDetail' meta: $ref: '#/components/schemas/PaginationMeta' required: - cost_budgets - meta additionalProperties: false CostBudgetCreateResponse: description: 原価予算登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/CostBudgetMinimalResponse' CostBudgetShowResponse: description: 原価予算詳細取得のレスポンス content: application/json: schema: $ref: '#/components/schemas/CostBudgetDetail' CostBudgetUpdateResponse: description: 原価予算更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/CostBudgetMinimalResponse' CostBudgetCancelResponse: description: 原価予算取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/CostBudgetMinimalResponse' BusinessPhasesIndexResponse: description: 案件一覧のレスポンス content: application/json: schema: type: object additionalProperties: false properties: business_phases: type: array items: $ref: '#/components/schemas/schemas-BusinessPhase' required: - business_phases SalesProgressionIndexResponse: description: 営業進捗一覧のレスポンス content: application/json: schema: type: object properties: sales_progressions: type: array items: $ref: '#/components/schemas/schemas-SalesProgression' required: - sales_progressions additionalProperties: false ItemsIndexResponse: description: 商品一覧のレスポンス content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MasterItem' required: - items additionalProperties: false DealLineTypesIndexResponse: description: 明細取引タイプ一覧のレスポンス content: application/json: schema: type: object properties: deal_line_types: type: array items: $ref: '#/components/schemas/DealLineType' required: - deal_line_types additionalProperties: false EmployeesIndexResponse: description: 従業員一覧のレスポンス content: application/json: schema: type: object additionalProperties: false properties: employees: type: array items: $ref: '#/components/schemas/schemas-Employee' required: - employees CustomFieldDefinitionsIndexResponse: description: カスタム項目定義一覧のレスポンス content: application/json: schema: type: object properties: custom_field_definitions: type: array items: $ref: '#/components/schemas/CustomFieldDefinition' required: - custom_field_definitions additionalProperties: false example: custom_field_definitions: - id: 01JPP4FD1CVQWCDSWA90VE1ZTM key: custom_field_001 display_name: プロジェクトコード type: text required: false description: プロジェクトを識別するためのコード - id: 01JPP4FD1CVQWCDSWA90VE1ZTN key: custom_field_002 display_name: 詳細説明 type: textarea required: false description: null - id: 01JPP4FD1CVQWCDSWA90VE1ZTO key: custom_field_003 display_name: 契約金額 type: amount required: true description: null - id: 01JPP4FD1CVQWCDSWA90VE1ZTP key: custom_field_004 display_name: 数量 type: quantity required: false description: null - id: 01JPP4FD1CVQWCDSWA90VE1ZTQ key: custom_field_005 display_name: 重要度 type: number required: false description: null unit: 点 - id: 01JPP4FD1CVQWCDSWA90VE1ZTR key: custom_field_006 display_name: 契約開始日 type: date required: false description: null - id: 01JPP4FD1CVQWCDSWA90VE1ZTS key: custom_field_007 display_name: 優先度 type: enum required: false description: null enumerations: - id: 01JPP4FD1CVQWCDSWA90VE1ZTT name: 高 usable: true - id: 01JPP4FD1CVQWCDSWA90VE1ZTU name: 中 usable: true - id: 01JPP4FD1CVQWCDSWA90VE1ZTV name: 低 usable: false - id: 01JPP4FD1CVQWCDSWA90VE1ZTW key: custom_field_008 display_name: 担当取引先 type: partner required: false description: null - id: 01JPP4FD1CVQWCDSWA90VE1ZTX key: custom_field_009 display_name: 担当従業員 type: employee required: false description: null - id: 01JPP4FD1CVQWCDSWA90VE1ZTY key: custom_field_010 display_name: 担当部門 type: section required: false description: null - id: 01JPP4FD1CVQWCDSWA90VE1ZTZ key: custom_field_011 display_name: 関連商品 type: master_item required: false description: null PurchaseOrderIndexResponse: description: 発注一覧のレスポンス content: application/json: schema: type: object properties: purchase_orders: type: array items: $ref: '#/components/schemas/PurchaseOrderDigest' meta: $ref: '#/components/schemas/PaginationMeta' required: - purchase_orders - meta additionalProperties: false PurchaseOrderCreateResponse: description: 発注登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderMinimalResponse' PurchaseOrderUpdateResponse: description: 発注更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderMinimalResponse' PurchaseOrderCancellationResponse: description: 発注取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderMinimalResponse' QuotationIndexResponse: description: 見積一覧のレスポンス content: application/json: schema: type: object properties: quotations: type: array items: $ref: '#/components/schemas/QuotationDigest' meta: $ref: '#/components/schemas/PaginationMeta' required: - quotations - meta additionalProperties: false QuotationCreateResponse: description: 見積登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/QuotationMinimalResponse' QuotationUpdateResponse: description: 見積更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/QuotationMinimalResponse' QuotationCancellationResponse: description: 見積取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/QuotationMinimalResponse' SalesOrderIndexResponse: description: 受注一覧のレスポンス content: application/json: schema: type: object properties: sales_orders: type: array items: $ref: '#/components/schemas/SalesOrderDigest' meta: $ref: '#/components/schemas/PaginationMeta' required: - sales_orders - meta additionalProperties: false SalesOrderCreateResponse: description: 受注登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/SalesOrderMinimalResponse' SalesOrderUpdateResponse: description: 受注更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/SalesOrderMinimalResponse' SalesOrderCancelResponse: description: 受注取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/SalesOrderMinimalResponse' DeliveryIndexResponse: description: 納品一覧のレスポンス content: application/json: schema: type: object properties: deliveries: type: array items: $ref: '#/components/schemas/DeliveryDigest' meta: $ref: '#/components/schemas/PaginationMeta' required: - deliveries - meta additionalProperties: false DeliveryCreateResponse: description: 納品登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/DeliveryMinimalResponse' DeliveryUpdateResponse: description: 納品更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/DeliveryMinimalResponse' DeliveryCancelResponse: description: 納品取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/DeliveryMinimalResponse' SalesIndexResponse: description: 売上一覧のレスポンス content: application/json: schema: type: object properties: sales: type: array items: $ref: '#/components/schemas/SaleDigest' meta: $ref: '#/components/schemas/PaginationMeta' required: - sales - meta additionalProperties: false SaleCreateResponse: description: 売上登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/SaleMinimalResponse' SaleUpdateResponse: description: 売上更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/SaleMinimalResponse' SaleCancelResponse: description: 売上取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/SaleMinimalResponse' OtherCostIndexResponse: description: その他原価一覧のレスポンス content: application/json: schema: type: object properties: other_costs: type: array items: $ref: '#/components/schemas/OtherCostDetail' meta: $ref: '#/components/schemas/PaginationMeta' required: - other_costs - meta additionalProperties: false OtherCostCreateResponse: description: その他原価登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/OtherCostMinimalResponse' OtherCostUpdateResponse: description: その他原価更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/OtherCostMinimalResponse' OtherCostRestorationResponse: description: その他原価復元のレスポンス content: application/json: schema: $ref: '#/components/schemas/OtherCostMinimalResponse' OtherCostCancellationResponse: description: その他原価取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/OtherCostMinimalResponse' ProcurementIndexResponse: description: 仕入一覧のレスポンス content: application/json: schema: type: object properties: procurements: type: array items: $ref: '#/components/schemas/ProcurementDigest' meta: $ref: '#/components/schemas/PaginationMeta' required: - procurements - meta additionalProperties: false ProcurementCreateResponse: description: 仕入登録のレスポンス content: application/json: schema: $ref: '#/components/schemas/ProcurementMinimalResponse' ProcurementUpdateResponse: description: 仕入更新のレスポンス content: application/json: schema: $ref: '#/components/schemas/ProcurementMinimalResponse' ProcurementCancellationResponse: description: 仕入取消のレスポンス content: application/json: schema: $ref: '#/components/schemas/ProcurementMinimalResponse' requestBodies: BusinessCreateRequest: description: 案件登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/BusinessRequestBase' - type: object additionalProperties: false required: - name BusinessUpdateRequest: description: 案件更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/BusinessRequestBase' BusinessCancelRequest: description: 案件取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' example: company_id: 1 BusinessCloseRequest: description: 案件ロックリクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' example: company_id: 1 BusinessReopenRequest: description: 案件ロック解除リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' example: company_id: 1 CostBudgetCreateRequest: description: 原価予算登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/CostBudgetCreateRequestDetail' example: company_id: 1 type: procurement period_from_date: '2025-04-01' period_to_date: '2025-06-30' quantity: 10 unit_price: 1000 deal_line_type_id: 01JPP4FD1CVQWCDSWA90VE1ZTM master_item_id: 01JPP4FD1CVQWCDSWA90VE1ZTM supplier_id: 1001 memo: 備考テキスト CostBudgetUpdateRequest: description: 原価予算更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/CostBudgetRequestBase' - $ref: '#/components/schemas/BasicCostBudgetRequestProperties' - $ref: '#/components/schemas/ProcurementCostBudgetRequestProperties' example: company_id: 1 period_from_date: '2025-04-01' period_to_date: '2025-06-30' quantity: 20 unit_price: 1500 memo: 更新後の備考 CostBudgetCancelRequest: description: 原価予算取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' example: company_id: 1 PurchaseOrderCreateRequest: description: 発注登録リクエスト required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: {} required: - purchase_order_date - supplier_id - payment_method_type - payment_partner_id - lines - $ref: '#/components/schemas/PurchaseOrderRequestBase' PurchaseOrderUpdateRequest: description: 発注更新リクエスト required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: branch_no: description: 枝番 type: integer format: int32 nullable: true example: 1 - $ref: '#/components/schemas/PurchaseOrderRequestBase' PurchaseOrderCancellationRequest: description: 発注取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' QuotationCreateRequest: description: 見積登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: {} required: - quotation_date - customer_id - lines - $ref: '#/components/schemas/QuotationRequestBase' QuotationUpdateRequest: description: 見積更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/QuotationRequestBase' - type: object additionalProperties: false properties: branch_no: description: 枝番 type: integer format: int32 nullable: true example: 1 QuotationCancellationRequest: description: 見積取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' SalesOrderCreateRequest: description: 受注登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/SalesOrderRequestBase' - type: object additionalProperties: false required: - sales_order_date - customer_id - billing_creating_method_type - billing_partner_id - collecting_partner_id - collection_method_type - lines SalesOrderUpdateRequest: description: 受注更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/SalesOrderRequestBase' - type: object properties: delivery_template_id: description: 納品書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: false example: 10001 invoice_template_id: description: 請求書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: false example: 10002 additionalProperties: false SalesOrderCancelRequest: description: 受注取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' example: company_id: 1 DeliveryCreateRequest: description: 納品登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: sales_order_id: description: 受注ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM required: - delivery_date - customer_id - billing_partner_id - billing_creating_method_type - collecting_partner_id - collection_method_type - lines - $ref: '#/components/schemas/DeliveryRequestBase' DeliveryUpdateRequest: description: 納品更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/DeliveryRequestBase' - type: object additionalProperties: false properties: branch_no: description: 枝番 type: integer format: int32 nullable: true example: 1 DeliveryCancelRequest: description: 納品取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' example: company_id: 1 SaleCreateRequest: description: 売上登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: sales_order_id: description: 受注ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM delivery_id: description: 納品ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM billing_creating_method_type: $ref: '#/components/schemas/BillingCreatingMethodType' required: - revenue_recognition_date - customer_id - billing_partner_id - collecting_partner_id - collection_method_type - billing_creating_method_type - lines - $ref: '#/components/schemas/SaleRequestBase' SaleUpdateRequest: description: 売上更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/SaleRequestBase' - type: object properties: invoice_template_id: description: 請求書テンプレートID type: integer format: int64 maximum: 9223372036854775807 nullable: false example: 10002 additionalProperties: false SaleCancelRequest: description: 売上取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' example: company_id: 1 OtherCostCreateRequest: description: その他原価登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM amount_excluding_tax: description: 金額(税抜) type: integer format: int64 maximum: 999999999999 minimum: -999999999999 nullable: false example: 10000 incurred_date: description: 発生日 type: string format: date nullable: false example: '2025-04-01' memo: description: メモ type: string nullable: true example: その他原価メモ required: - amount_excluding_tax - incurred_date OtherCostUpdateRequest: description: その他原価更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: business_id: description: 案件ID type: string nullable: true maxLength: 26 minLength: 26 example: 01JPP4FD1CVQWCDSWA90VE1ZTM amount_excluding_tax: description: 金額(税抜) type: integer format: int64 maximum: 999999999999 minimum: -999999999999 nullable: false example: 10000 incurred_date: description: 発生日 type: string format: date nullable: false example: '2025-04-01' memo: description: メモ type: string nullable: true example: その他原価メモ OtherCostRestorationRequest: description: その他原価復元リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' OtherCostCancellationRequest: description: その他原価取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId' ProcurementCreateRequest: description: 仕入登録リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - type: object additionalProperties: false properties: {} required: - procurement_date - supplier_id - payments_on - payment_method_type - payment_partner_id - lines - $ref: '#/components/schemas/ProcurementRequestBase' ProcurementUpdateRequest: description: 仕入更新リクエスト content: application/json: schema: allOf: - $ref: '#/components/schemas/WithCompanyId' - $ref: '#/components/schemas/ProcurementUpdateRequestBody' ProcurementCancellationRequest: description: 仕入取消リクエスト content: application/json: schema: $ref: '#/components/schemas/WithCompanyId'