案件の一覧を取得します。\n登録されている案件情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する案件のみを取得することが可能です。\n
\nstart_business_date : 案件登録日(絞り込み開始)
\nend_business_date : 案件登録日(絞り込み終了)
\nstart_last_updated_date : 案件更新日(絞り込み開始)
\nend_last_updated_date : 案件更新日(絞り込み終了)
\nsales_progression_ids : 受注確度ID(複数指定可)
\nbusiness_phase_ids : 案件フェーズID(複数指定可)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\ncode : 案件コード
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_business_date", "in": "query", "type": "string", "required": false, "description": "案件登録日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_business_date", "in": "query", "type": "string", "required": false, "description": "案件登録日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "案件更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "案件更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "sales_progression_ids[]", "in": "query", "type": "array", "required": false, "description": "受注確度ID", "style": "form", "explode": true }, { "name": "business_phase_ids[]", "in": "query", "type": "array", "required": false, "description": "案件フェーズID", "style": "form", "explode": true }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "code", "in": "query", "type": "string", "required": false, "description": "案件コードで絞込" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "案件登録", "description": "新しい案件を登録します。\n顧客との商談や受注案件を管理するための案件情報を登録できます。\n
\nname : 案件名称
\ncompany_id : 事業所ID
\ncode : 案件コード
\nbusiness_date : 案件登録日
\ncharge_employee_id : 社内担当者の従業員ID
\ncustomer_id : 顧客の取引先ID
\nprospect_sales_order : 受注見込
\nsales_progression_id : 受注確度ID
\nscheduled_completion_date : 完了予定日
\ncompletion_date : 完了日
\nbusiness_phase_id : 案件フェーズID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\ncommon_business_id : 案件マスタID
\ncustom_fields : カスタム項目
\n指定されたIDの案件の詳細情報を取得します。\n案件の基本情報に加えて、粗利や売上情報などの詳細な集計情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "案件ID" } ] }, "patch": { "summary": "案件更新", "description": "指定されたIDの案件を更新します。\n案件の基本情報、受注見込、完了予定日などを部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nname : 案件名称
code : 案件コード
business_date : 案件登録日
charge_employee_id : 社内担当者の従業員ID
customer_id : 顧客の取引先ID
prospect_sales_order : 受注見込
sales_progression_id : 受注確度ID
scheduled_completion_date : 完了予定日
completion_date : 完了日
business_phase_id : 案件フェーズID
reporting_section_id : 担当部門ID
internal_memo : 社内メモ
custom_fields : カスタム項目(指定した場合、既存のカスタム項目は全て削除され、新しいカスタム項目に置き換えられます)
※全ての項目は任意です。更新したい項目のみを送信してください。
\n※custom_fieldsを指定した場合、リクエストに含まれないカスタム項目はnullとして扱われます。必須のカスタム項目が指定されていない場合はバリデーションエラーになります。
\n※common_business_id（案件マスタID）はこのAPIでは更新できません。紐付け済みの案件に対して既存と異なる値を指定した場合はエラーになります。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "案件ID" } ] } }, "/businesses/{id}/cancellation": { "post": { "summary": "案件取消", "description": "指定されたIDの案件を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "案件ID" } ] } }, "/businesses/{id}/close": { "post": { "summary": "案件ロック", "description": "指定されたIDの案件をロックします。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "案件ID" } ] } }, "/businesses/{id}/reopen": { "post": { "summary": "案件ロック解除", "description": "指定されたIDの案件ロックを解除します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "案件ID" } ] } }, "/cost_budgets": { "get": { "summary": "原価予算一覧", "description": "原価予算の一覧を取得します。\n登録されている原価予算情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する原価予算のみを取得することが可能です。\n
\ntype : 原価種別 (procurement, external_procurement, other_cost)
start_amount_excluding_tax : 金額(税抜):下限
end_amount_excluding_tax : 金額(税抜):上限
start_date_period : 発生予定期間:開始日(yyyy-mm-dd)
end_date_period : 発生予定期間:終了日(yyyy-mm-dd)
master_item_ids : 商品ID(複数指定可)
start_quantity : 数量:下限
end_quantity : 数量:上限
start_unit_price : 単価:下限
end_unit_price : 単価:上限
charge_employee_ids : 社内担当者の従業員ID(複数指定可)
reporting_section_ids : 担当部門ID(複数指定可)
supplier_ids : 仕入先の取引先ID(複数指定可)
payment_partner_ids : 支払先の取引先ID(複数指定可)
accounting_reporting_section_ids : 会計計上部門ID(複数指定可)
item_tag_ids : 会計品目タグID(複数指定可)
segment_tag_1_ids : セグメントタグ1 ID(複数指定可)
segment_tag_2_ids : セグメントタグ2 ID(複数指定可)
segment_tag_3_ids : セグメントタグ3 ID(複数指定可)
business_ids : 案件ID(複数指定可)
cost_budget_no : 原価予算No.
start_last_updated_date : 更新日(絞り込み開始)
end_last_updated_date : 更新日(絞り込み終了)
canceled : 取消状態(デフォルト:false)
\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "type", "in": "query", "type": "string", "required": false, "description": "原価種別 (仕入: procurement, 外部仕入: external_procurement, その他原価: other_cost)" }, { "name": "start_amount_excluding_tax", "in": "query", "type": "integer", "required": false, "description": "金額(税抜):下限" }, { "name": "end_amount_excluding_tax", "in": "query", "type": "integer", "required": false, "description": "金額(税抜):上限" }, { "name": "start_date_period", "in": "query", "type": "string", "required": false, "description": "発生予定期間:開始日(yyyy-mm-dd)" }, { "name": "end_date_period", "in": "query", "type": "string", "required": false, "description": "発生予定期間:終了日(yyyy-mm-dd)" }, { "name": "master_item_ids[]", "in": "query", "type": "array", "required": false, "description": "商品ID", "style": "form", "explode": true }, { "name": "start_quantity", "in": "query", "type": "integer", "required": false, "description": "数量:下限" }, { "name": "end_quantity", "in": "query", "type": "integer", "required": false, "description": "数量:上限" }, { "name": "start_unit_price", "in": "query", "type": "integer", "required": false, "description": "単価:下限" }, { "name": "end_unit_price", "in": "query", "type": "integer", "required": false, "description": "単価:上限" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "reporting_section_ids[]", "in": "query", "type": "array", "required": false, "description": "担当部門ID", "style": "form", "explode": true }, { "name": "supplier_ids[]", "in": "query", "type": "array", "required": false, "description": "仕入先の取引先ID", "style": "form", "explode": true }, { "name": "payment_partner_ids[]", "in": "query", "type": "array", "required": false, "description": "支払先の取引先ID", "style": "form", "explode": true }, { "name": "accounting_reporting_section_ids[]", "in": "query", "type": "array", "required": false, "description": "会計計上部門ID", "style": "form", "explode": true }, { "name": "item_tag_ids[]", "in": "query", "type": "array", "required": false, "description": "会計品目タグID", "style": "form", "explode": true }, { "name": "segment_tag_1_ids[]", "in": "query", "type": "array", "required": false, "description": "セグメントタグ1 ID", "style": "form", "explode": true }, { "name": "segment_tag_2_ids[]", "in": "query", "type": "array", "required": false, "description": "セグメントタグ2 ID", "style": "form", "explode": true }, { "name": "segment_tag_3_ids[]", "in": "query", "type": "array", "required": false, "description": "セグメントタグ3 ID", "style": "form", "explode": true }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID", "style": "form", "explode": true }, { "name": "cost_budget_no", "in": "query", "type": "string", "required": false, "description": "原価予算No.で絞込" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "原価予算登録", "description": "原価予算を新規登録します。\ntype で原価種別を指定してください。procurement（仕入）はリクエストスキーマが異なります。external_procurement（外部仕入）と other_cost（その他原価）は同じリクエストスキーマを使用します。\n
type (必須) : 原価種別 (procurement: 仕入, external_procurement: 外部仕入, other_cost: その他原価)
period_from_date (必須) : 期間開始日
period_to_date (必須) : 期間終了日。period_from_date と両方必須。
business_id : 案件ID
memo : 備考
charge_employee_id : 社内担当者ID
reporting_section_id : 担当部門ID
quantity (必須) : 数量
unit_price (必須) : 単価
deal_line_type_id (必須) : 明細取引タイプID
supplier_id : 仕入先ID
payment_partner_id : 支払先ID
uom_name : 単位
master_item_id : 商品ID
accounting_reporting_section_id : 会計計上部門ID
item_tag_id : 会計品目タグID
memo_tag_ids : メモタグID（複数指定可）
segment_tag_1_id : セグメントタグ1ID
segment_tag_2_id : セグメントタグ2ID
segment_tag_3_id : セグメントタグ3ID
amount_excluding_tax (必須) : 金額(税抜)
指定されたIDの原価予算の詳細情報を取得します。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "原価予算ID" } ] }, "patch": { "summary": "原価予算更新", "description": "指定されたIDの原価予算を更新します。\n原価種別に応じて使用可能なフィールドが異なります。\n送信したフィールドのみ更新されます。\nなお原価種別を変更することはできません。\n
\nperiod_from_date : 期間開始日。period_to_date と両方同時に送信する必要がある。
period_to_date : 期間終了日。period_from_date と両方同時に送信する必要がある。
business_id : 案件ID
memo : 備考
charge_employee_id : 社内担当者ID
reporting_section_id : 担当部門ID
quantity : 数量
unit_price : 単価
deal_line_type_id : 明細取引タイプID
supplier_id : 仕入先ID
payment_partner_id : 支払先ID
uom_name : 単位
master_item_id : 商品ID
accounting_reporting_section_id : 会計計上部門ID
item_tag_id : 会計品目タグID
memo_tag_ids : メモタグID（複数指定可）
segment_tag_1_id : セグメントタグ1ID
segment_tag_2_id : セグメントタグ2ID
segment_tag_3_id : セグメントタグ3ID
amount_excluding_tax : 金額(税抜)
指定されたIDの原価予算を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "原価予算ID" } ] } }, "/master/business_phases": { "get": { "summary": "案件フェーズ一覧", "description": "案件フェーズ一覧を取得します。\n使用可能なもののみを返却します。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" } ] } }, "/master/sales_progressions": { "get": { "summary": "受注確度一覧", "description": "受注確度情報を取得します。\n使用可能なもののみを返却します。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" } ] } }, "/master/items": { "get": { "summary": "商品一覧", "description": "商品情報を取得します。\n使用可能なもののみを返却します。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：100, 最小：1, 最大：500）" }, { "name": "type", "in": "query", "type": "string", "required": true, "description": "業務区分 (sales: 販売系, procurement: 調達系)" } ] } }, "/master/deal_line_types": { "get": { "summary": "明細取引タイプ一覧", "description": "明細取引タイプ一覧を取得します。\n使用停止中のものはレスポンスに含まれません。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "type", "in": "query", "type": "string", "required": true, "description": "利用区分: 販売系、調達系どちらの明細取引タイプを取得するか" } ] } }, "/master/employees": { "get": { "summary": "従業員一覧", "description": "従業員一覧を取得します。\n使用可能なもののみを返却します。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：100, 最小：1, 最大：500）" } ] } }, "/master/custom_fields/business/definitions": { "get": { "summary": "案件カスタム項目定義一覧", "description": "\nカスタム項目定義の一覧を取得します。\n使用可能なもののみを返却します。\n
\n\ntext: 一行テキストtextarea: 複数行テキストamount: 金額quantity: 数量number: 数値date: 日付enum: プルダウンpartner: 取引先employee: 従業員section: 部門master_item: 商品発注の一覧を取得します。\n登録されている発注情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する発注のみを取得することが可能です。\n
\nstart_registered_date : 発注登録日(絞り込み開始)
\nend_registered_date : 発注登録日(絞り込み終了)
\nstart_last_updated_date : 発注更新日(絞り込み開始)
\nend_last_updated_date : 発注更新日(絞り込み終了)
\nstart_purchase_order_date : 発注日(絞り込み開始)
\nend_purchase_order_date : 発注日(絞り込み終了)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\nsupplier_ids : 仕入先の取引先ID(複数指定可)
\nbusiness_ids : 案件ID(複数指定可)
\npurchase_order_no : 発注No.
\npayment_status : 支払ステータス
\nissued : 送付ステータス
\nprocurement_status : 仕入ステータス
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_registered_date", "in": "query", "type": "string", "required": false, "description": "発注登録日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_registered_date", "in": "query", "type": "string", "required": false, "description": "発注登録日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "発注更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "発注更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_purchase_order_date", "in": "query", "type": "string", "required": false, "description": "発注日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_purchase_order_date", "in": "query", "type": "string", "required": false, "description": "発注日で絞込：終了日(yyyy-mm-dd)" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "supplier_ids[]", "in": "query", "type": "array", "required": false, "description": "仕入先の取引先ID", "style": "form", "explode": true }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID", "style": "form", "explode": true }, { "name": "purchase_order_no", "in": "query", "type": "string", "required": false, "description": "発注No.で絞込" }, { "name": "payment_status", "in": "query", "type": "string", "required": false, "description": "支払ステータス (なし: none, 未決済: not_settled, 一部決済済: partially_settled, 決済済: settled)" }, { "name": "issued", "in": "query", "type": "boolean", "required": false, "description": "送付ステータス" }, { "name": "procurement_status", "in": "query", "type": "string", "required": false, "description": "仕入ステータス (未計上: not_sold, 一部計上済: partially_sold, 計上済: sold)" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "発注登録", "description": "新しい発注を登録します。\n仕入先への発注情報を登録し、発注書の発行や仕入への引き継ぎに利用できます。\n
\npurchase_order_date : 発注日
\nsupplier_id : 仕入先の取引先ID
\npayment_method_type : 支払方法
\npayment_partner_id : 支払先の取引先ID
\nlines : 明細リスト
\nis_qualified_invoice_issuer : 適格請求書発行事業者該当フラグ
\nbusiness_id : 案件ID
\ninternal_subject : 発注タイトル
\nprocurements_on : 仕入予定日
\ndelivery_deadline : 納品期限日
\ndelivery_location : 納品場所
\npurchase_order_note : 発注書の備考欄に記載する内容
\npurchase_order_template_id : 発注書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\npurchase_order_subject : 発注書件名
\nrecipient_address : 宛先情報 ※Web画面とは異なり、仕入先マスタからの自動補完は行われません。指定しない場合は全ての項目がnullとして登録されます。
\npayments_on : 支払予定日
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\n本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。
\n登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。
\n買い手側対応機能を「使用しない」に設定している場合、経過措置の判定を行わないため、リクエストでの指定値は無視され、常に true が登録されます。
買い手側対応機能を「使用する」に設定している場合は、以下の通りです。
\nリクエストで値を指定した場合は、その値が登録されます。
値を指定しなかった場合（null を指定した場合、または項目自体を省略した場合）は、「適格チェックボックスと税区分」の設定に従って値が決まります。
\n「取引先情報と連携」が「連携する」になっている場合は、仕入先に指定した取引先に設定されている値が登録されます。
それ以外の場合は、同設定のデフォルト値が登録されます。
指定されたIDの発注の詳細情報を取得します。\n発注の基本情報に加えて、明細情報や各種ステータスなどの詳細な情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "発注ID" } ] }, "patch": { "summary": "発注更新", "description": "指定されたIDの発注を更新します。\n発注の基本情報を部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nbranch_no : 枝番
\nbusiness_id : 案件ID
\ninternal_subject : 発注タイトル
\npurchase_order_date : 発注日
\nsupplier_id : 仕入先の取引先ID
\nis_qualified_invoice_issuer : 適格請求書発行事業者該当フラグ
\nprocurements_on : 仕入予定日
\ndelivery_deadline : 納品期限日
\ndelivery_location : 納品場所
\npurchase_order_note : 発注書の備考欄に記載する内容
\npurchase_order_template_id : 発注書テンプレートID
\npurchase_order_subject : 発注書件名
\nrecipient_address : 宛先情報（指定した場合、既存の宛先情報は全て削除され、新しい宛先情報に置き換えられます）
\npayments_on : 支払予定日
\npayment_method_type : 支払方法
\npayment_partner_id : 支払先の取引先ID
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\n※recipient_addressを指定した場合、リクエストに含まれない項目はnullとして扱われます。
\n本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。
\n登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。
\n買い手側対応機能を「使用しない」に設定している場合、経過措置の判定を行わないため、リクエストでの指定値は無視され、常に true が登録されます。
買い手側対応機能を「使用する」に設定している場合は、以下の通りです。
\nリクエストで値を指定した場合は、その値が登録されます。
値を指定しなかった場合（null を指定した場合、または項目自体を省略した場合）は、「適格チェックボックスと税区分」の設定に従って値が決まります。
\n「取引先情報と連携」が「連携する」になっている場合は、仕入先に指定した取引先に設定されている値が登録されます。
それ以外の場合は、同設定のデフォルト値が登録されます。
指定されたIDの発注を取り消します。
\ncompany_id : 事業所ID
\n見積の一覧を取得します。\n登録されている見積情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する見積のみを取得することが可能です。\n
\nstart_registered_date : 見積登録日(絞り込み開始)
\nend_registered_date : 見積登録日(絞り込み終了)
\nstart_last_updated_date : 見積更新日(絞り込み開始)
\nend_last_updated_date : 見積更新日(絞り込み終了)
\nstart_quotation_date : 見積日(絞り込み開始)
\nend_quotation_date : 見積日(絞り込み終了)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\nbusiness_ids : 案件ID(複数指定可)
\nquotation_no : 見積No.
\nquotation_status : 見積ステータス
\nbilling_status : 請求書送付ステータス
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_registered_date", "in": "query", "type": "string", "required": false, "description": "見積登録日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_registered_date", "in": "query", "type": "string", "required": false, "description": "見積登録日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "見積更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "見積更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_quotation_date", "in": "query", "type": "string", "required": false, "description": "見積日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_quotation_date", "in": "query", "type": "string", "required": false, "description": "見積日で絞込：終了日(yyyy-mm-dd)" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID", "style": "form", "explode": true }, { "name": "quotation_no", "in": "query", "type": "string", "required": false, "description": "見積No.で絞込" }, { "name": "start_gross_profit_amount_excluding_tax", "in": "query", "type": "number", "required": false, "description": "粗利額計(税抜)で絞込：下限" }, { "name": "end_gross_profit_amount_excluding_tax", "in": "query", "type": "number", "required": false, "description": "粗利額計(税抜)で絞込：上限" }, { "name": "start_gross_profit_rate", "in": "query", "type": "number", "required": false, "description": "粗利率(%)で絞込：下限" }, { "name": "end_gross_profit_rate", "in": "query", "type": "number", "required": false, "description": "粗利率(%)で絞込：上限" }, { "name": "quotation_status", "in": "query", "type": "string", "required": false, "description": "見積ステータス (未受注: unanswered, 受注済: order_received, 失注: order_lost)" }, { "name": "billing_status", "in": "query", "type": "string", "required": false, "description": "請求書送付ステータス (未請求: not_billed, 一部請求済: partially_billed, 請求済: billed, なし: none)" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "見積登録", "description": "新しい見積を登録します。\n顧客への見積情報を登録し、見積書の発行や受注への引き継ぎに利用できます。\n
\nquotation_date : 見積日
\ncustomer_id : 顧客の取引先ID
\nlines : 明細リスト
\nbusiness_id : 案件ID
\ninternal_subject : 見積タイトル
\nexpires_on : 有効期限日
\ndelivery_deadline : 納品期限日
\ndelivery_location : 納品場所
\nquotation_template_id : 見積書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\nquotation_subject : 見積書件名
\nquotation_note : 見積書の備考欄に記載する内容
\nrecipient_address : 宛先情報 ※Web画面とは異なり、顧客マスタからの自動補完は行われません。指定しない場合は全ての項目がnullとして登録されます。
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\n指定されたIDの見積の詳細情報を取得します。\n見積の基本情報に加えて、明細情報や各種ステータスなどの詳細な情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "見積ID" } ] }, "patch": { "summary": "見積更新", "description": "指定されたIDの見積を更新します。\n見積の基本情報を部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nbusiness_id : 案件ID
\ninternal_subject : 見積タイトル
\nquotation_date : 見積日
\ncustomer_id : 顧客の取引先ID
\nexpires_on : 有効期限日
\ndelivery_deadline : 納品期限日
\ndelivery_location : 納品場所
\nquotation_template_id : 見積書テンプレートID
\nquotation_subject : 見積書件名
\nquotation_note : 見積書の備考欄に記載する内容
\nrecipient_address : 宛先情報（指定した場合、既存の宛先情報は全て削除され、新しい宛先情報に置き換えられます）
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nbranch_no : 枝番
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\n※recipient_addressを指定した場合、リクエストに含まれない項目はnullとして扱われます。
\n見積を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。
\n事業所(自社)の設定が変更された場合：freee会計の「設定」で変更可能な\"消費税の経理処理\"、\"消費税の端数処理\"の設定値
取引先の設定が変更された場合：freeeの「取引先」で変更可能な\"内税/外税\"の設定値
発行済みの見積書がある場合、見積情報を更新しても見積書の内容には自動で反映されません。見積書の内容を更新するには、再発行が必要です。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "見積ID" } ] } }, "/quotations/{id}/quotation_status": { "put": { "summary": "見積ステータス変更", "description": "指定されたIDの見積のステータスを変更します。\n見積のステータス（未受注/失注）を更新できます。\n
\nquotation_status : 見積ステータス (未受注: unanswered, 失注: order_lost)
\n※ステータス変更は取り消されていない見積に対してのみ可能です。
\n※受注済（order_received）への変更は本APIでは行えません。受注登録APIで対象の見積を指定して受注登録することで、見積ステータスが自動的に受注済へ更新されます。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "見積ID" } ], "hasJsonBody": true } }, "/quotations/{id}/cancellation": { "post": { "summary": "見積取消", "description": "指定されたIDの見積を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "見積ID" } ] } }, "/sales_orders": { "get": { "summary": "受注一覧", "description": "受注の一覧を取得します。\n登録されている受注情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する受注のみを取得することが可能です。\n
\nstart_last_updated_date : 更新日(絞り込み開始)
\nend_last_updated_date : 更新日(絞り込み終了)
\nstart_sales_order_date : 受注日(絞り込み開始)
\nend_sales_order_date : 受注日(絞り込み終了)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\nsales_order_no : 受注No.
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_sales_order_date", "in": "query", "type": "string", "required": false, "description": "受注日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_sales_order_date", "in": "query", "type": "string", "required": false, "description": "受注日で絞込：終了日(yyyy-mm-dd)" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "sales_order_no", "in": "query", "type": "string", "required": false, "description": "受注No.で絞込" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "受注登録", "description": "新しい受注を登録します。\n顧客からの注文情報を登録し、納品・請求・入金の予定情報を管理できます。\n
\nsales_order_date : 受注日
\ncustomer_id : 顧客の取引先ID
\nbilling_partner_id : 請求先の取引先ID
\ncollecting_partner_id : 入金元の取引先ID
\nlines : 明細リスト
\nquotation_id : 見積ID（見積に紐づける場合）
\nsales_order_subject : 受注タイトル
\ncustomer_order_no : 顧客注文No.
\ndeliveries_on : 納品予定日
\naccepts_on : 検収予定日
\nbills_on : 請求予定日
\ncollects_on : 入金予定日
\nbusiness_id : 案件ID
\ndelivery_template_id : 納品書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\ninvoice_template_id : 請求書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\n指定されたIDの受注の詳細情報を取得します。\n受注の基本情報に加えて、納品・請求・入金情報などの詳細な進捗情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "受注ID" } ] }, "patch": { "summary": "受注更新", "description": "指定されたIDの受注を更新します。\n受注の基本情報、納品・請求・入金情報などを部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nsales_order_subject : 受注タイトル
\nsales_order_date : 受注日
\ncustomer_order_no : 顧客注文No.
\ncustomer_id : 顧客の取引先ID
\nsales_on : 売上予定日
\ndeliveries_on : 納品予定日
\naccepts_on : 検収予定日
\ndelivery_template_id : 納品書テンプレートID
\ndelivery_subject : 納品書件名
\ndelivery_note : 納品書の備考欄に掲載する内容
\nbilling_creating_method_type : 請求の管理
\nbills_on : 請求予定日
\nbilling_partner_id : 請求先の取引先ID
\ninvoice_template_id : 請求書テンプレートID
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollects_on : 入金予定日
\ncollecting_partner_id : 入金元の取引先ID
\ncollection_method_type : 入金方法
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nbusiness_id : 案件ID
\nlines : 明細リスト ※指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます。
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\n受注を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。
\n事業所(自社)の設定が変更された場合：freee会計の「設定」で変更可能な\"消費税の経理処理\"、\"消費税の端数処理\"の設定値
取引先の設定が変更された場合：freeeの「取引先」で変更可能な\"内税/外税\"の設定値
明細取引タイプが変更された場合：freee販売の「明細取引タイプ」で変更可能な\"税区分\"、\"軽減税率\"の設定値
指定されたIDの受注を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "受注ID" } ] } }, "/deliveries": { "get": { "summary": "納品一覧", "description": "納品の一覧を取得します。\n登録されている納品情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する納品のみを取得することが可能です。\n
\nstart_registered_date : 登録日(絞り込み開始)
\nend_registered_date : 登録日(絞り込み終了)
\nstart_last_updated_date : 更新日(絞り込み開始)
\nend_last_updated_date : 更新日(絞り込み終了)
\nstart_delivery_date : 納品日(絞り込み開始)
\nend_delivery_date : 納品日(絞り込み終了)
\nstart_acceptance_date : 検収日(絞り込み開始)
\nend_acceptance_date : 検収日(絞り込み終了)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\ndelivery_no : 納品No.
\ndelivery_status : 納品ステータス
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_registered_date", "in": "query", "type": "string", "required": false, "description": "登録日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_registered_date", "in": "query", "type": "string", "required": false, "description": "登録日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_delivery_date", "in": "query", "type": "string", "required": false, "description": "納品日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_delivery_date", "in": "query", "type": "string", "required": false, "description": "納品日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_acceptance_date", "in": "query", "type": "string", "required": false, "description": "検収日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_acceptance_date", "in": "query", "type": "string", "required": false, "description": "検収日で絞込：終了日(yyyy-mm-dd)" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "delivery_no", "in": "query", "type": "string", "required": false, "description": "納品No.で絞込" }, { "name": "delivery_status", "in": "query", "type": "string", "required": false, "description": "納品ステータス (未納品: not_delivered, 納品済: delivered)" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "納品登録", "description": "新しい納品を登録します。\n受注に紐づく納品、または独立した納品を登録できます。\n
\ndelivery_date : 納品日
\ncustomer_id : 顧客の取引先ID
\nbilling_partner_id : 請求先の取引先ID
\nbilling_creating_method_type : 請求作成方法
\ncollecting_partner_id : 入金元の取引先ID
\ncollection_method_type : 入金方法
\nlines : 明細リスト
\nsales_order_id : 受注ID（受注に紐づける場合）
\nbusiness_id : 案件ID
\ninternal_subject : 納品タイトル
\ncustomer_order_no : 顧客注文No.
\nacceptance_date : 検収日
\ndelivery_note : 納品書の備考欄に記載する内容
\ndelivery_template_id : 納品書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\nsubject : 納品書件名
\nrecipient_address : 宛先情報 ※Web画面とは異なり、顧客マスタからの自動補完は行われません。指定しない場合は全ての項目がnullとして登録されます。
\nbills_on : 請求予定日
\ninvoice_template_id : 請求書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollects_on : 入金予定日
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\n指定されたIDの納品の詳細情報を取得します。\n納品の基本情報に加えて、売上・請求情報などの詳細な進捗情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "納品ID" } ] }, "patch": { "summary": "納品更新", "description": "指定されたIDの納品を更新します。\n納品の基本情報、請求・入金情報などを部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nbranch_no : 枝番
\ninternal_subject : 納品タイトル
\ndelivery_date : 納品日
\ncustomer_order_no : 顧客注文No.
\nacceptance_date : 検収日
\ncustomer_id : 顧客の取引先ID
\ndelivery_note : 納品書の備考欄に記載する内容
\ndelivery_template_id : 納品書テンプレートID
\nsubject : 納品書件名
\nrecipient_address : 宛先情報（指定した場合、既存の宛先情報は全て削除され、新しい宛先情報に置き換えられます）
\nbilling_creating_method_type : 請求作成方法
\nbills_on : 請求予定日
\ninvoice_template_id : 請求書テンプレートID
\nbilling_partner_id : 請求先の取引先ID
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollects_on : 入金予定日
\ncollection_method_type : 入金方法
\ncollecting_partner_id : 入金元の取引先ID
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nbusiness_id : 案件ID
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\n※recipient_addressを指定した場合、リクエストに含まれない項目はnullとして扱われます。
\n納品を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。
\n事業所(自社)の設定が変更された場合：freee会計の「設定」で変更可能な\"消費税の経理処理\"、\"消費税の端数処理\"の設定値
取引先の設定が変更された場合：freeeの「取引先」で変更可能な\"内税/外税\"の設定値
発行済みの納品書がある場合、納品情報を更新しても納品書の内容には自動で反映されません。納品書の内容を更新するには、再発行が必要です。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "納品ID" } ] } }, "/deliveries/{id}/cancellation": { "post": { "summary": "納品取消", "description": "指定されたIDの納品を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "納品ID" } ] } }, "/deliveries/{id}/delivery_status": { "put": { "summary": "納品ステータス変更", "description": "指定されたIDの納品の納品ステータスを変更します。
\nstatus : 納品ステータス (未納品: not_delivered, 納品済: delivered)
\n指定されたIDの納品の検収ステータスを変更します。
\nstatus : 検収ステータス (未検収: not_accepted, 検収済: accepted)
\n売上の一覧を取得します。\n登録されている売上情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する売上のみを取得することが可能です。\n
\nstart_registered_date : 売上登録日(絞り込み開始)
\nend_registered_date : 売上登録日(絞り込み終了)
\nstart_last_updated_date : 売上更新日(絞り込み開始)
\nend_last_updated_date : 売上更新日(絞り込み終了)
\nstart_revenue_recognition_date : 売上日(絞り込み開始)
\nend_revenue_recognition_date : 売上日(絞り込み終了)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\nbusiness_ids : 案件ID(複数指定可)
\nsales_no : 売上No.
\nbilling_status : 請求書送付ステータス
\ncollection_status : 決済ステータス
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_registered_date", "in": "query", "type": "string", "required": false, "description": "売上登録日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_registered_date", "in": "query", "type": "string", "required": false, "description": "売上登録日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_revenue_recognition_date", "in": "query", "type": "string", "required": false, "description": "売上日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_revenue_recognition_date", "in": "query", "type": "string", "required": false, "description": "売上日で絞込：終了日(yyyy-mm-dd)" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "billing_status", "in": "query", "type": "string", "required": false, "description": "請求書送付ステータス (未送付: not_billed, 送付済: billed, 対象外: none)" }, { "name": "collection_status", "in": "query", "type": "string", "required": false, "description": "決済ステータス (未決済: not_settled, 一部決済済: partially_settled, 決済済: settled, 対象外: none)" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "売上登録", "description": "新しい売上を登録します。\n受注や納品に紐づく売上、または独立した売上を登録できます。\n
\nrevenue_recognition_date : 売上日
\ncustomer_id : 顧客の取引先ID
\nbilling_partner_id : 請求先の取引先ID
\ncollecting_partner_id : 入金元の取引先ID
\ncollection_method_type : 入金方法
\nbilling_creating_method_type : 請求の管理
\nlines : 明細リスト
\nsales_order_id : 受注ID（受注に紐づける場合）
\ndelivery_id : 納品ID（納品に紐づける場合）
\nbusiness_id : 案件ID
\nsubject : 売上タイトル
\ncustomer_order_no : 顧客注文No.
\nbills_on : 請求日 ※billing_creating_method_typeがautomaticallyの場合は必須
\ninvoice_template_id : 請求書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollects_on : 入金期日 ※billing_creating_method_typeがautomaticallyの場合は必須
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\n指定されたIDの売上の詳細情報を取得します。\n売上の基本情報に加えて、請求・入金情報などの詳細な進捗情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "売上ID" } ] }, "patch": { "summary": "売上更新", "description": "指定されたIDの売上を更新します。\n売上の基本情報、請求・入金情報などを部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nsubject : 売上タイトル
\nrevenue_recognition_date : 売上日
\ncustomer_order_no : 顧客注文No.
\ncustomer_id : 顧客の取引先ID
\nbilling_partner_id : 請求先の取引先ID
\nbills_on : 請求日
\ninvoice_template_id : 請求書テンプレートID
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollecting_partner_id : 入金元の取引先ID
\ncollection_method_type : 入金方法
\ncollects_on : 入金期日
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nbusiness_id : 案件ID
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\n売上を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。
\n事業所(自社)の設定が変更された場合：freee会計の「設定」で変更可能な\"消費税の経理処理\"、\"消費税の端数処理\"の設定値
取引先の設定が変更された場合：freeeの「取引先」で変更可能な\"内税/外税\"の設定値
明細取引タイプが変更された場合：freee販売の「明細取引タイプ」で変更可能な\"税区分\"、\"軽減税率\"の設定値
発行済みの請求書がある場合、売上情報を更新すると請求データは更新されますが、請求書の内容には自動で反映されません。請求書の内容を更新するには、再発行が必要です。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "売上ID" } ] } }, "/sales/{id}/cancellation": { "post": { "summary": "売上取消", "description": "指定されたIDの売上を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "売上ID" } ] } }, "/periodic_sales": { "get": { "summary": "定期売上一覧", "description": "定期売上の一覧を取得します。\n登録されている定期売上情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する定期売上のみを取得することが可能です。\n
\ncanceled : 取消状態(デフォルト:false)
\nstart_recurrence_period : 繰り返し期間(絞り込み開始)
\nend_recurrence_period : 繰り返し期間(絞り込み終了)
\nstart_recorded_count : 計上済み回数(絞り込み下限)
\nend_recorded_count : 計上済み回数(絞り込み上限)
\nstart_total_schedule_count : 売上予定の総回数(絞り込み下限)
\nend_total_schedule_count : 売上予定の総回数(絞り込み上限)
\nstart_next_sales_on : 次回売上予定日(絞り込み開始)
\nend_next_sales_on : 次回売上予定日(絞り込み終了)
\nstart_last_revenue_recognition_date : 最終計上日(絞り込み開始)
\nend_last_revenue_recognition_date : 最終計上日(絞り込み終了)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\nreporting_section_ids : 担当部門ID(複数指定可)
\nbusiness_ids : 案件ID(複数指定可)
\nperiodic_sales_no : 定期売上No.で絞込
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "start_recurrence_period", "in": "query", "type": "string", "required": false, "description": "繰り返し期間で絞込：指定期間の開始日。この日付以降も有効な（繰り返し終了日がこの日付以降の）定期売上を返す(yyyy-mm-dd)" }, { "name": "end_recurrence_period", "in": "query", "type": "string", "required": false, "description": "繰り返し期間で絞込：指定期間の終了日。この日付までに開始している（繰り返し開始日がこの日付以前の）定期売上を返す(yyyy-mm-dd)" }, { "name": "start_recorded_count", "in": "query", "type": "integer", "required": false, "description": "計上済み回数で絞込：下限" }, { "name": "end_recorded_count", "in": "query", "type": "integer", "required": false, "description": "計上済み回数で絞込：上限" }, { "name": "start_total_schedule_count", "in": "query", "type": "integer", "required": false, "description": "売上予定の総回数で絞込：下限" }, { "name": "end_total_schedule_count", "in": "query", "type": "integer", "required": false, "description": "売上予定の総回数で絞込：上限" }, { "name": "start_next_sales_on", "in": "query", "type": "string", "required": false, "description": "次回売上予定日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_next_sales_on", "in": "query", "type": "string", "required": false, "description": "次回売上予定日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_last_revenue_recognition_date", "in": "query", "type": "string", "required": false, "description": "最終計上日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_revenue_recognition_date", "in": "query", "type": "string", "required": false, "description": "最終計上日で絞込：終了日(yyyy-mm-dd)" }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "reporting_section_ids[]", "in": "query", "type": "array", "required": false, "description": "担当部門ID", "style": "form", "explode": true }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID", "style": "form", "explode": true }, { "name": "periodic_sales_no", "in": "query", "type": "string", "required": false, "description": "定期売上No.で絞込" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "定期売上登録", "description": "新しい定期売上を登録します。\n登録した定期売上の繰り返しルールに従って売上予定が作成されます。\n前受金を取り崩す定期売上を登録する場合は、本APIではなく「前受金取崩（定期売上登録）」API（POST /advance_receipts/{id}/periodic_reduction）を使用してください。\n
customer_id : 顧客の取引先ID
\nrecurrence_rule : 繰り返しルール
\nbilling_partner_id : 請求先の取引先ID
\nbilling_creating_method_type : 請求の管理
\ncollecting_partner_id : 入金元の取引先ID
\ncollection_method_type : 入金方法
\nlines : 明細リスト
\nbusiness_id : 案件ID
\nsubject : 定期売上タイトル
\ncustomer_order_no : 顧客注文No.
\ninvoice_template_id : 請求書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\nbills_on_rule : 請求予定日ルール ※billing_creating_method_typeがautomaticallyの場合は必須
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollects_on_rule : 入金予定日ルール ※billing_creating_method_typeがautomaticallyの場合は必須
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\n指定されたIDの定期売上の詳細情報を取得します。
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "定期売上ID" } ] }, "patch": { "summary": "定期売上更新", "description": "指定されたIDの定期売上を更新します。\n定期売上の基本情報や繰り返しルール、請求・入金情報などを部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nsubject : 定期売上タイトル
\ncustomer_order_no : 顧客注文No.
\nrecurrence_rule : 繰り返しルール
\ncustomer_id : 顧客の取引先ID
\nbilling_creating_method_type : 請求の管理
\nbills_on_rule : 請求予定日ルール ※billing_creating_method_typeがautomaticallyの場合は必須
\ninvoice_template_id : 請求書テンプレートID
\nbilling_partner_id : 請求先の取引先ID
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollects_on_rule : 入金予定日ルール ※billing_creating_method_typeがautomaticallyの場合は必須
\ncollection_method_type : 入金方法
\ncollecting_partner_id : 入金元の取引先ID
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nbusiness_id : 案件ID
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\n定期売上を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。
\n事業所(自社)の設定が変更された場合：freee会計の「設定」で変更可能な\"消費税の経理処理\"、\"消費税の端数処理\"の設定値
取引先の設定が変更された場合：freeeの「取引先」で変更可能な\"内税/外税\"の設定値
明細取引タイプが変更された場合：freee販売の「明細取引タイプ」で変更可能な\"税区分\"、\"軽減税率\"の設定値
定期売上を更新しても請求は作成されません。繰り返しルールに従って作成される売上予定に更新内容が反映されます。
\n個別に内容を変更した売上予定がある場合でも、定期売上の更新内容が反映されます。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "定期売上ID" } ] } }, "/periodic_sales/{id}/sales_entries": { "get": { "summary": "売上計上状況取得", "description": "指定された定期売上に含まれる各回の売上予定について、計上済みか未計上かの状況を一覧で取得します。\n各行は1回分の売上予定に対応し、statusが計上済み(actual)か未計上(scheduled)かを示します。\nlimit/offsetによるページネーションに対応しています。\n
指定されたIDの定期売上を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "定期売上ID" } ] } }, "/sales_schedules": { "get": { "summary": "売上予定一覧", "description": "売上予定の一覧を取得します。\n登録されている売上予定情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する売上予定のみを取得することが可能です。\n
\nperiodic_sales_id : 定期売上IDで絞込
\nstart_scheduled_date : 売上予定日(絞り込み開始)
\nend_scheduled_date : 売上予定日(絞り込み終了)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\nstart_bills_on : 請求予定日(絞り込み開始)
\nend_bills_on : 請求予定日(絞り込み終了)
\nstart_collects_on : 入金予定日(絞り込み開始)
\nend_collects_on : 入金予定日(絞り込み終了)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\nreporting_section_ids : 担当部門ID(複数指定可)
\nbusiness_ids : 案件ID(複数指定可)
\nstart_last_updated_date : 変更日時(絞り込み開始)
\nend_last_updated_date : 変更日時(絞り込み終了)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "periodic_sales_id", "in": "query", "type": "string", "required": false, "description": "定期売上IDで絞込" }, { "name": "start_scheduled_date", "in": "query", "type": "string", "required": false, "description": "売上予定日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_scheduled_date", "in": "query", "type": "string", "required": false, "description": "売上予定日で絞込：終了日(yyyy-mm-dd)" }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "start_bills_on", "in": "query", "type": "string", "required": false, "description": "請求予定日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_bills_on", "in": "query", "type": "string", "required": false, "description": "請求予定日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_collects_on", "in": "query", "type": "string", "required": false, "description": "入金予定日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_collects_on", "in": "query", "type": "string", "required": false, "description": "入金予定日で絞込：終了日(yyyy-mm-dd)" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "reporting_section_ids[]", "in": "query", "type": "array", "required": false, "description": "担当部門ID", "style": "form", "explode": true }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID", "style": "form", "explode": true }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "変更日時で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "変更日時で絞込：終了日(yyyy-mm-dd)" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] } }, "/sales_schedules/{id}": { "get": { "summary": "売上予定詳細取得", "description": "指定されたIDの売上予定の詳細情報を取得します。\n指定された売上予定が既に売上として計上済みの場合、303 See Otherを返却し、Locationヘッダーに計上済み売上の詳細取得APIのURLを設定します。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "売上予定ID" } ] }, "delete": { "summary": "売上予定削除", "description": "指定されたIDの売上予定を削除します。", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "売上予定ID" } ] }, "patch": { "summary": "売上予定更新", "description": "指定されたIDの売上予定を更新します。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\ncustomer_id : 顧客の取引先ID
\nsubject : 件名
\ncustomer_order_no : 顧客注文No.
\nscheduled_date : 売上予定日
\nbilling_creating_method_type : 請求の管理
\nbills_on : 請求予定日
\nbilling_partner_id : 請求先の取引先ID
\ninvoice_template_id : 請求書テンプレートID
\ninvoice_subject : 請求書件名
\ninvoice_note : 請求書の備考欄に掲載する内容
\ncollects_on : 入金予定日
\ncollecting_partner_id : 入金元の取引先ID
\ncollection_method_type : 入金方法
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\n※全ての項目は任意です。更新したい項目のみを送信してください。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "売上予定ID" } ] } }, "/sales_schedules/{id}/actualization": { "post": { "summary": "売上予定の売上計上", "description": "指定されたIDの売上予定を売上として計上します。", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "売上予定ID" } ] } }, "/other_costs": { "get": { "summary": "その他原価一覧", "description": "その他原価の一覧を取得します。\n登録されているその他原価情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致するその他原価のみを取得することが可能です。\n
\nstart_amount_excluding_tax : 金額(税抜)の絞り込み下限
\nend_amount_excluding_tax : 金額(税抜)の絞り込み上限
\nbusiness_ids : 案件ID(複数指定可)
\nother_cost_no : その他原価No.
\nstart_last_updated_date : 更新日(絞り込み開始)
\nend_last_updated_date : 更新日(絞り込み終了)
\nstart_incurred_date : 発生日の絞り込み開始日
\nend_incurred_date : 発生日の絞り込み終了日
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_amount_excluding_tax", "in": "query", "type": "integer", "required": false, "description": "金額(税抜)で絞込：下限" }, { "name": "end_amount_excluding_tax", "in": "query", "type": "integer", "required": false, "description": "金額(税抜)で絞込：上限" }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID", "style": "form", "explode": true }, { "name": "other_cost_no", "in": "query", "type": "string", "required": false, "description": "その他原価No.で絞込" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_incurred_date", "in": "query", "type": "string", "required": false, "description": "発生日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_incurred_date", "in": "query", "type": "string", "required": false, "description": "発生日で絞込：終了日(yyyy-mm-dd)" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "その他原価登録", "description": "新しいその他原価を登録します。\n案件に紐づくその他原価、または案件に紐づかないその他原価を登録できます。\n
\ncompany_id : 事業所ID
\namount_excluding_tax : 金額(税抜)
\nincurred_date : 発生日
\nbusiness_id : 案件ID
\nmemo : メモ
\n指定されたIDのその他原価の詳細情報を取得します。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "その他原価ID" } ] }, "patch": { "summary": "その他原価更新", "description": "指定されたIDのその他原価を更新します。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\nbusiness_id : 案件ID
\namount_excluding_tax : 金額(税抜)
\nincurred_date : 発生日
\nmemo : メモ
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\nfreee会計の取引明細インポートから登録されたその他原価は本APIでは更新できません。該当データを更新しようとした場合はエラーになります。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "その他原価ID" } ] } }, "/other_costs/{id}/restoration": { "post": { "summary": "その他原価復元", "description": "指定されたIDの取消済みその他原価を復元します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "その他原価ID" } ] } }, "/other_costs/{id}/cancellation": { "post": { "summary": "その他原価取消", "description": "指定されたIDのその他原価を取り消します。\n
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "その他原価ID" } ] } }, "/procurements": { "get": { "summary": "仕入一覧", "description": "仕入の一覧を取得します。\n登録されている仕入情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する仕入のみを取得することが可能です。\n
\nstart_registered_date : 仕入登録日(絞り込み開始)
\nend_registered_date : 仕入登録日(絞り込み終了)
\nstart_last_updated_date : 仕入更新日(絞り込み開始)
\nend_last_updated_date : 仕入更新日(絞り込み終了)
\nstart_procurement_date : 仕入日(絞り込み開始)
\nend_procurement_date : 仕入日(絞り込み終了)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\nsupplier_ids : 仕入先の取引先ID(複数指定可)
\nbusiness_ids : 案件ID(複数指定可) ※複数の案件が紐づく仕入は本パラメータでヒットしません
\nprocurement_no : 仕入No.
\npayment_status : 決済ステータス
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
\n仕入は明細単位で複数の案件と紐付けることができます。複数の案件が紐づく仕入は本パラメータでは検索ヒットしません。
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "start_registered_date", "in": "query", "type": "string", "required": false, "description": "仕入登録日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_registered_date", "in": "query", "type": "string", "required": false, "description": "仕入登録日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "仕入更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "仕入更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_procurement_date", "in": "query", "type": "string", "required": false, "description": "仕入日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_procurement_date", "in": "query", "type": "string", "required": false, "description": "仕入日で絞込：終了日(yyyy-mm-dd)" }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "supplier_ids[]", "in": "query", "type": "array", "required": false, "description": "仕入先の取引先ID", "style": "form", "explode": true }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID新しい仕入を登録します。\n仕入先への仕入情報を登録し、支払管理や会計連携に利用できます。\n
\nprocurement_date : 仕入日
\nsupplier_id : 仕入先の取引先ID
\npayments_on : 支払期日
\npayment_method_type : 支払方法
\npayment_partner_id : 支払先の取引先ID
\nlines : 明細リスト
\nis_qualified_invoice_issuer : 適格請求書発行事業者該当フラグ
\ninternal_subject : 仕入タイトル
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\n本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。
\n登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。
\n買い手側対応機能を「使用しない」に設定している場合、経過措置の判定を行わないため、リクエストでの指定値は無視され、常に true が登録されます。
買い手側対応機能を「使用する」に設定している場合は、以下の通りです。
\nリクエストで値を指定した場合は、その値が登録されます。
値を指定しなかった場合（null を指定した場合、または項目自体を省略した場合）は、「適格チェックボックスと税区分」の設定に従って値が決まります。
\n「取引先情報と連携」が「連携する」になっている場合は、仕入先に指定した取引先に設定されている値が登録されます。
それ以外の場合は、同設定のデフォルト値が登録されます。
仕入は明細(lines)単位で案件(business_id)・発注(purchase_order_id)を紐付けることができます。レスポンスのヘッダーレベルの business / purchase_order_id は明細に紐づくものが単一の場合のみ値が設定され、複数紐づく場合は null になります。
" } }, "/procurements/{id}": { "get": { "summary": "仕入詳細取得", "description": "指定されたIDの仕入の詳細情報を取得します。\n仕入の基本情報に加えて、明細情報や各種ステータスなどの詳細な情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "仕入ID" } ] }, "patch": { "summary": "仕入更新", "description": "指定されたIDの仕入を更新します。\n仕入の基本情報を部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\ninternal_subject : 仕入タイトル
\nprocurement_date : 仕入日
\nsupplier_id : 仕入先の取引先ID
\nis_qualified_invoice_issuer : 適格請求書発行事業者該当フラグ
\npayments_on : 支払期日
\npayment_method_type : 支払方法
\npayment_partner_id : 支払先の取引先ID
\ncharge_employee_id : 社内担当者の従業員ID
\nreporting_section_id : 担当部門ID
\ninternal_memo : 社内メモ
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\nlinesを指定して明細を更新する場合、各明細行でpurchase_order_idを省略する、またはnullを指定すると発注との紐づけが解除されます。既存の発注との紐づけを維持したい場合は、必ずpurchase_order_idを指定してください。
\n本フラグの登録時の挙動は、freee会計の「税区分の設定 > インボイス制度関連 > 買い手側対応機能」の設定状況によって変わります。リクエストでの指定値がそのまま登録されるとは限りません。
\n登録された値は、免税事業者からの仕入れに係る経過措置に対応した税区分を利用するかどうかの判定に使われます。
\n買い手側対応機能を「使用しない」に設定している場合、経過措置の判定を行わないため、リクエストでの指定値は無視され、常に true が登録されます。
買い手側対応機能を「使用する」に設定している場合は、以下の通りです。
\nリクエストで値を指定した場合は、その値が登録されます。
値を指定しなかった場合（null を指定した場合、または項目自体を省略した場合）は、「適格チェックボックスと税区分」の設定に従って値が決まります。
\n「取引先情報と連携」が「連携する」になっている場合は、仕入先に指定した取引先に設定されている値が登録されます。
それ以外の場合は、同設定のデフォルト値が登録されます。
指定されたIDの仕入を取り消します。
\ncompany_id : 事業所ID
\n前受金の一覧を取得します。\n登録されている前受金情報を一覧形式で取得できます。\n各種フィルタ条件を指定することで、特定の条件に合致する前受金のみを取得することが可能です。\n
\nadvance_receipt_no : 前受金No.
\nstart_advance_receipt_date : 前受金発生日(絞り込み開始)
\nend_advance_receipt_date : 前受金発生日(絞り込み終了)
\nstart_registered_date : 前受金登録日(絞り込み開始)
\nend_registered_date : 前受金登録日(絞り込み終了)
\nstart_last_updated_date : 前受金更新日(絞り込み開始)
\nend_last_updated_date : 前受金更新日(絞り込み終了)
\ncustomer_ids : 顧客の取引先ID(複数指定可)
\ncharge_employee_ids : 社内担当者の従業員ID(複数指定可)
\nbusiness_ids : 案件ID(複数指定可)
\nbilling_status : 請求書送付ステータス
\ncollection_status : 決済ステータス
\ncanceled : 取消状態(デフォルト:false)
\n\n`limit`と`offset`パラメータを使用してページネーションが可能です。\nデフォルトでは20件ずつ取得され、最大100件まで一度に取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "advance_receipt_no", "in": "query", "type": "string", "required": false, "description": "前受金No.で絞込" }, { "name": "start_advance_receipt_date", "in": "query", "type": "string", "required": false, "description": "前受金発生日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_advance_receipt_date", "in": "query", "type": "string", "required": false, "description": "前受金発生日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_registered_date", "in": "query", "type": "string", "required": false, "description": "前受金登録日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_registered_date", "in": "query", "type": "string", "required": false, "description": "前受金登録日で絞込：終了日(yyyy-mm-dd)" }, { "name": "start_last_updated_date", "in": "query", "type": "string", "required": false, "description": "前受金更新日で絞込：開始日(yyyy-mm-dd)" }, { "name": "end_last_updated_date", "in": "query", "type": "string", "required": false, "description": "前受金更新日で絞込：終了日(yyyy-mm-dd)" }, { "name": "customer_ids[]", "in": "query", "type": "array", "required": false, "description": "顧客の取引先ID", "style": "form", "explode": true }, { "name": "charge_employee_ids[]", "in": "query", "type": "array", "required": false, "description": "社内担当者の従業員ID", "style": "form", "explode": true }, { "name": "business_ids[]", "in": "query", "type": "array", "required": false, "description": "案件ID", "style": "form", "explode": true }, { "name": "billing_status", "in": "query", "type": "string", "required": false, "description": "請求書送付ステータス (未請求: not_billed, 一部請求済: partially_billed, 請求済: billed, なし: none)" }, { "name": "collection_status", "in": "query", "type": "string", "required": false, "description": "決済ステータス (未決済: not_settled, 一部決済済: partially_settled, 決済済: settled, 無効: invalidated, 対象外: none)" }, { "name": "canceled", "in": "query", "type": "boolean", "required": false, "description": "取消状態" }, { "name": "limit", "in": "query", "type": "integer", "required": false, "description": "取得レコードの件数（デフォルト：20, 最小：1, 最大：100）" }, { "name": "offset", "in": "query", "type": "integer", "required": false, "description": "取得レコードのオフセット（デフォルト：0）" } ] }, "post": { "summary": "前受金登録", "description": "新しい前受金を登録します。\n顧客から受け取った前受金情報を登録し、請求・入金管理に利用できます。\n
\naccount_item_id : 勘定科目ID
\nadvance_receipt_date : 前受金発生日
\nbilling_partner_id : 請求先の取引先ID
\nbills_on : 請求日
\nbusiness_id : 案件ID
\ncollecting_partner_id : 入金元の取引先ID
\ncollection_method_type : 入金方法
\ncollects_on : 入金期日
\ncustomer_id : 顧客の取引先ID
\nlines : 明細リスト
\nsales_order_id : 受注ID（受注に紐づける場合）
\naccounting_reporting_section_id : 会計計上部門ID
\ncharge_employee_id : 社内担当者の従業員ID
\ncustomer_order_no : 顧客注文No.
\ninternal_memo : 社内メモ
\ninternal_subject : 前受金タイトル
\ninvoice_note : 請求書の備考欄に掲載する内容
\ninvoice_subject : 請求書件名
\ninvoice_template_id : 請求書テンプレートID ※指定しない場合はデフォルトのテンプレートが適用されます。
\nitem_tag_id : 会計品目タグID
\nmemo_tags : メモタグID
\nreporting_section_id : 担当部門ID
\nsegment_tag_1_id : セグメント1のID
\nsegment_tag_2_id : セグメント2のID
\nsegment_tag_3_id : セグメント3のID
\n前受金は案件(business_id)に紐づけて登録する必要があります。案件IDの指定は必須です。
\n前受金を登録すると、請求情報が自動で作成されます。売上のように請求の管理方式を指定することはできません。
" } }, "/advance_receipts/{id}": { "get": { "summary": "前受金詳細取得", "description": "指定されたIDの前受金の詳細情報を取得します。\n前受金の基本情報に加えて、明細、勘定科目、品目タグ、メモタグ、セグメントタグなどの詳細情報も取得できます。\n
", "parameters": [ { "name": "company_id", "in": "query", "type": "integer", "required": true, "description": "事業所ID" }, { "name": "id", "in": "path", "type": "string", "required": true, "description": "前受金ID" } ] }, "patch": { "summary": "前受金更新", "description": "指定されたIDの前受金を更新します。\n前受金の基本情報を部分的に更新できます。\n送信したフィールドのみが更新され、送信しなかったフィールドは変更されません。\n
\naccount_item_id : 勘定科目ID
\nadvance_receipt_date : 前受金発生日
\nbusiness_id : 案件ID
\ncustomer_id : 顧客の取引先ID
\nlines : 明細リスト（指定した場合、既存の明細は全て削除され、新しい明細に置き換えられます）
\naccounting_reporting_section_id : 会計計上部門ID
\ncharge_employee_id : 社内担当者の従業員ID
\ncustomer_order_no : 顧客注文No.
\ninternal_memo : 社内メモ
\ninternal_subject : 前受金タイトル
\nitem_tag_id : 会計品目タグID
\nmemo_tags : メモタグID
\nreporting_section_id : 担当部門ID
\nsegment_tag_1_id : セグメント1のID
\nsegment_tag_2_id : セグメント2のID
\nsegment_tag_3_id : セグメント3のID
\n※全ての項目は任意です。更新したい項目のみを送信してください。
\n前受金を更新する際、登録後に下記の設定変更が行われていた場合は、明細行の金額が再計算されます。
\n事業所(自社)の設定が変更された場合：freee会計の「設定」で変更可能な\"消費税の経理処理\"、\"消費税の端数処理\"の設定値
取引先の設定が変更された場合：freeeの「取引先」で変更可能な\"内税/外税\"の設定値
明細取引タイプが変更された場合：freee販売の「明細取引タイプ」で変更可能な\"税区分\"、\"軽減税率\"の設定値
発行済みの請求書がある場合、前受金情報を更新すると請求データは更新されますが、請求書の内容には自動で反映されません。請求書の内容を更新するには、再発行が必要です。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "前受金ID" } ] } }, "/advance_receipts/{id}/cancellation": { "post": { "summary": "前受金取消", "description": "指定されたIDの前受金を取り消します。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "前受金ID" } ] } }, "/advance_receipts/{id}/reduction": { "post": { "summary": "前受金取崩（売上登録）", "description": "指定されたIDの前受金を取り崩して売上を登録します。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "前受金ID" } ] } }, "/advance_receipts/{id}/periodic_reduction": { "post": { "summary": "前受金取崩（定期売上登録）", "description": "指定されたIDの前受金を取り崩す定期売上を登録します。繰り返しルールに従って売上予定が作成されます。
", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true, "description": "前受金ID" } ] } } } }