(9/1)[会計]freee会計 APIにおいて、フォーム用選択項目情報APIのスキーマ定義が修正
変更対象API:
- GET /api/1/forms/selectables – フォーム用選択項目情報の取得
変更種別: 破壊的変更なし(スキーマ定義の修正)
変更内容:
APIの挙動に変更はありません。実際に返却されるレスポンスに合わせて、スキーマ定義を以下のとおり修正しました。
account_categories 内 account_items の shortcut、および default_tax 内 tax_rate_10、tax_rate_8、tax_rate_r8、tax_rate_5 の code と name が nullable に修正されました。
account_categories 内 account_items において、default_tax、desc、help、name、shortcut、および default_tax 内の各税率(tax_rate_10、tax_rate_10_exempt_30 など)の code と name が必須項目に修正されました。account_categories の desc も必須項目に修正されました。
あわせて、default_tax 内 tax_rate_r8 の code のフォーマットが int64 に修正されました。
account_groups において、created_at、updated_at、detail_type が必須項目に修正されました。created_at と updated_at は nullable に、フォーマットは date-time に修正されました。
account_groups に、実際に返却されていた必須プロパティ company_id が追加されました。
account_groups の detail_type に列挙値 0、1、2、3、4 が明記されました(現状は常に 0 が返却されます)。
account_groups の index に最小値 0、最大値 2147483647 が明記されました。
(9/1)[会計]freee会計 APIにおいて、メモタグAPIのスキーマ定義が修正
変更対象API:
- GET /api/1/tags – メモタグ一覧の取得
- POST /api/1/tags – メモタグの作成
- GET /api/1/tags/{id} – メモタグの取得
- PUT /api/1/tags/{id} – メモタグの更新
変更種別: 破壊的変更なし(スキーマ定義の修正)
変更内容:
APIの挙動に変更はありません。実際に返却されるレスポンスに
合わせて、スキーマ定義を以下のとおり修正しました。
メモタグの各種レスポンスにおいて、shortcut1 と shortcut2 が
必須項目に修正されました。
メモタグの各種レスポンスにおいて、update_date のフォーマットが date に修正されました。
(9/4)[会計]freee会計 APIにおいて、経費精算の外貨に関するエンドポイントが公開
変更対象API:
- GET /api/1/expense_applications/currencies – 経費精算の外貨一覧の取得
- POST /api/1/expense_applications/currencies – 経費精算の外貨の作成
- GET /api/1/expense_applications/currencies/{id} – 経費精算の外貨の取得
- PUT /api/1/expense_applications/currencies/{id} – 経費精算の外貨の更新
- DELETE /api/1/expense_applications/currencies/{id} – 経費精算の外貨の削除
変更種別: 破壊的変更なし
変更内容:
経費精算で利用する外貨の一覧取得、作成、取得、更新および削除を行う一連のエンドポイントが新設されました。
(9/7)[会計]freee会計 APIにおいて、取引(振替)に品目・取引先・部門・セグメントタグ・メモタグの情報が追加
変更対象API:
- GET /api/1/transfers – 取引(振替)一覧の取得
- POST /api/1/transfers – 取引(振替)の作成
- GET /api/1/transfers/{id} – 取引(振替)の取得
- PUT /api/1/transfers/{id} – 取引(振替)の更新
変更種別: 破壊的変更なし
変更内容:
取引(振替)の作成・更新APIに、振替元口座行の任意のリクエストプロパティ from_item_id、from_partner_id、from_section_id、from_tag_ids、from_segment_1_tag_id、from_segment_2_tag_id、from_segment_3_tag_id が追加されました。to_walletables 内にも、
振替先口座行の任意のリクエストプロパティ item_id、partner_id、section_id、tag_ids、segment_1_tag_id、segment_2_tag_id、segment_3_tag_id が追加されました。取引先の追加・変更・削除は、「口座振替(口座間移動)での取引先タグ付与ルール」が設定されている場合のみ可能です。
取引(振替)の各種レスポンスに、必須プロパティ from_item_id、from_item_code、from_partner_id、from_partner_code、from_section_id、from_section_code、from_tag_ids が追加されました。to_walletables 内にも、必須プロパティ item_id、item_code、partner_id、partner_code、section_id、section_code、tag_ids が追加されました。
取引(振替)の各種レスポンスに、任意のプロパティ from_segment_1_tag_id、from_segment_1_tag_code、from_segment_2_tag_id、from_segment_2_tag_code、from_segment_3_tag_id、from_segment_3_tag_code が追加されました。to_walletables 内にも、任意のプロパティ segment_1_tag_id、segment_1_tag_code、segment_2_tag_id、segment_2_tag_code、segment_3_tag_id、segment_3_tag_code が追加されました。セグメントタグが利用できないプランの場合、これらのキーはレスポンスに含まれません。
(9/9)[会計]freee会計 APIにおいて、経費申請フォームに関するエンドポイントが公開
変更対象API:
- GET /api/1/expense_applications/form – 経費申請フォームの取得
- PUT /api/1/expense_applications/form – 経費申請フォームの更新
変更種別: 破壊的変更なし
変更内容:
経費申請フォームの取得および更新を行うエンドポイントが新設されました。
(9/9)[会計]freee会計 APIにおいて、部門APIのスキーマ定義が修正
変更対象API:
- PUT /api/1/sections/code/upsert – 部門の更新(存在しない場合は作成)
変更種別: 破壊的変更なし(スキーマ定義の修正)
変更内容:
APIの挙動に変更はありません。実際に返却されるレスポンスに合わせて、スキーマ定義を以下のとおり修正しました。
8/24 に追加をお知らせした 404 のエラーレスポンスのうち、
部門の更新(存在しない場合は作成)APIの 404 は実際には返却されないため、削除されました。親部門コードが存在しない場合は、
従来どおり 400 のエラーレスポンスが返却されます。
(9/29)[会計]freee会計 APIにおいて、経費科目にカスタム申請項目・金額計算設定・内容の入力設定・利用可能範囲が追加
変更対象API:
- GET /api/1/expense_application_line_templates – 経費科目一覧の取得
- POST /api/1/expense_application_line_templates – 経費科目の作成
- GET /api/1/expense_application_line_templates/{id} – 経費科目の取得
- PUT /api/1/expense_application_line_templates/{id} – 経費科目の更新
変更種別: 破壊的変更なし
変更内容:
経費科目一覧の取得APIに、任意のクエリパラメータ section_ids[](申請部門ID。指定した場合、指定部門と認証ユーザーで利用可能な経費科目のみを返却)が追加されました。
経費科目の作成・更新APIに、以下の任意のリクエストプロパティが
追加されました。
- custom_form_parts(カスタム申請項目)
- amount_calculation_setting(金額計算設定)
- line_content_setting(内容の入力設定。optional、required、disable のいずれか)
- available_section_ids(利用可能な部門IDの配列)
- available_user_ids(利用可能な事業所メンバーのユーザーIDの配列)
経費科目の各種レスポンスに、任意のプロパティ custom_form_parts、amount_calculation_setting、line_content_setting が追加されました。
(9/24)[請求書]freee請求書 APIにおいて、請求書APIのスキーマ定義が修正
変更対象API:
- GET /invoices – 請求書一覧の取得
- POST /invoices – 請求書の作成
- GET /invoices/{id} – 請求書の取得
- PUT /invoices/{id} – 請求書の更新
変更種別: 破壊的変更なし(スキーマ定義の修正)
変更内容:
APIの挙動に変更はありません。実際に返却されるレスポンスに
合わせて、スキーマ定義を以下のとおり修正しました。
請求書の各種レスポンスの payment_type に、列挙値 cash(現金)と bill_payable(手形)が追加されました。これらは既存データや
インポート、freee販売連携などで登録された請求書で返却される値です。請求書の作成・更新APIのリクエストでは指定できません。
(9/16)[販売]freee販売 APIにおいて、仕入APIのスキーマ定義が修正
変更対象API:
- GET /procurements – 仕入一覧
- GET /procurements/{id} – 仕入詳細取得
変更種別: 破壊的変更なし(スキーマ定義の修正)
変更内容:
APIの挙動に変更はありません。実際に返却されるレスポンスに
合わせて、スキーマ定義を以下のとおり修正しました。
仕入一覧・仕入詳細取得APIのレスポンスの payment_status に、
実際に返却されていた列挙値 none(対象外)が追加されました。
(9/17)[販売]freee販売 APIにおいて、見積に粗利情報が追加
変更対象API:
- GET /quotations – 見積一覧
- POST /quotations – 見積登録
- GET /quotations/{id} – 見積詳細取得
- PATCH /quotations/{id} – 見積更新
変更種別: 破壊的変更なし
変更内容:
見積一覧APIに、粗利で絞り込むための任意のクエリパラメータ start_gross_profit_amount_excluding_tax、end_gross_profit_amount_excluding_tax(粗利額計(税抜)の下限・上限)、start_gross_profit_rate、end_gross_profit_rate(粗利率の下限・上限)が追加されました。
見積一覧APIのレスポンスに、任意のプロパティ gross_profit_amount_excluding_tax(粗利額計(税抜))と gross_profit_rate(粗利率)が追加されました。
見積登録・見積更新APIの通常明細(line_type が basic)に、
任意のリクエストプロパティ gross_profit(明細の粗利情報。原価 cost と社内メモ memo)が追加されました。粗利情報は税方式が外税の
顧客でのみ登録されます。
見積詳細取得APIのレスポンスに、任意のプロパティ gross_profit_summary(見積全体の粗利合計)が追加されました。
あわせて、通常明細に任意のプロパティ gross_profit(原価、売価、粗利額、原価率、粗利率、上乗せ率など)が追加されました。
(9/24)[販売]freee販売 APIにおいて、売上・仕入・前受金の決済ステータス変更エンドポイントが公開
変更対象API:
- PUT /sales/{id}/collection_status – 決済ステータス変更
- PUT /procurements/{id}/payment_status – 決済ステータス変更
- PUT /advance_receipts/{id}/collection_status – 決済ステータス変更
変更種別: 破壊的変更なし
変更内容:
売上・仕入・前受金の決済ステータスを変更するエンドポイントが新設されました。freee会計と連携しているデータの決済ステータスはfreee会計の決済状況が反映されるため、本APIでは変更できません。
(9/18)[IT管理]IT管理 APIにおいて、部署・備品種別・備品ステータスに関するエンドポイントが追加
変更対象API:
- GET /hub/it_management/departments – 部署一覧取得(β版)
- POST /hub/it_management/departments – 部署作成(β版)
- GET /hub/it_management/departments/{id} – 部署詳細取得(β版)
- PATCH /hub/it_management/departments/{id} – 部署部分更新(β版)
- DELETE /hub/it_management/departments/{id} – 部署削除(β版)
- GET /hub/it_management/asset_categories – 備品種別一覧取得(β版)
- POST /hub/it_management/asset_categories – 備品種別作成(β版)
- GET /hub/it_management/asset_categories/{id} – 備品種別詳細取得(β版)
- PATCH /hub/it_management/asset_categories/{id} – 備品種別部分更新(β版)
- DELETE /hub/it_management/asset_categories/{id} – 備品種別削除(β版)
- GET /hub/it_management/asset_statuses – 備品ステータス一覧取得(β版)
- POST /hub/it_management/asset_statuses – 備品ステータス作成(β版)
- GET /hub/it_management/asset_statuses/{id} – 備品ステータス詳細取得(β版)
- PATCH /hub/it_management/asset_statuses/{id} – 備品ステータス部分更新(β版)
- DELETE /hub/it_management/asset_statuses/{id} – 備品ステータス削除(β版)
変更種別: 破壊的変更なし
変更内容:
部署、備品種別および備品ステータスの一覧取得、作成、詳細取得、部分更新および削除を行う一連のエンドポイントが新設されました。
(9/8)[工数管理]freee工数管理 APIにおいて、受注ステータスの取得エンドポイントが追加
変更対象API:
- GET /sales_order_statuses – 受注ステータスの取得
変更種別: 破壊的変更なし
変更内容:
受注ステータスの一覧を取得するエンドポイントが新設されました。
(9/28)[工数管理]freee工数管理 APIにおいて、プロジェクトのメンバーの従業員単価マスタIDが任意項目に変更
変更対象API:
- POST /projects – プロジェクトの登録
- PATCH /projects/{id} – プロジェクトの編集
変更種別: 破壊的変更なし
変更内容:
プロジェクトの登録・編集APIのリクエストプロパティ members 内 unit_cost_id が必須項目から任意項目に変更されました。use_standard_unit_cost が false の場合は必須、true の場合は省略できます。
(9/28)[工数管理]freee工数管理 APIにおいて、工数に従業員単価の情報が追加
変更対象API:
- GET /workloads – 工数詳細の取得
- POST /workloads – 工数登録
- PATCH /workloads/{id} – 工数編集
変更種別: 破壊的変更なし
変更内容:
工数の各種レスポンスに、任意のプロパティ unit_cost_id(工数に適用された従業員単価マスタID)、unit_cost_name(従業員単価マスタ名)、unit_cost_amount(従業員単価の金額)が追加されました。工数の人件費をエクスポートする権限がある場合のみ返却されます。
(9/28)[工数管理]freee工数管理 APIにおいて、プロジェクトタググループの取得エンドポイントが追加
変更対象API:
- GET /project_tag_groups – プロジェクトタググループの取得
変更種別: 破壊的変更なし
変更内容:
配下のプロジェクトタグを含むプロジェクトタググループの一覧を取得するエンドポイントが新設されました。
(9/30)[工数管理]freee工数管理 APIにおいて、プロジェクトのメンバーに単価情報が追加
変更対象API:
- POST /projects – プロジェクトの登録
- GET /projects/{id} – プロジェクト詳細の取得
- PATCH /projects/{id} – プロジェクトの編集
変更種別: 破壊的変更なし
変更内容:
プロジェクトの登録・詳細の取得・編集APIのレスポンスの members に、任意のプロパティ unit_cost_id(このプロジェクトで使用する従業員単価マスタID)、budgets_cost(予算計算用の単価)、use_standard_unit_cost(従業員の標準単価マスタを使用しているかどうか)が追加されました。人件費の閲覧権限がある場合のみ返却されます。
(9/30)[工数管理]freee工数管理 APIにおいて、勤怠情報の一括登録・更新エンドポイントが追加
変更対象API:
- PUT /daily_attendances/bulk – 勤怠情報の一括登録・更新
変更種別: 破壊的変更なし
変更内容:
外部の勤怠データを工数管理に取り込み、工数照合に必要な日単位の勤怠情報(勤務区分 day_status、勤務時間 worked_minutes)を最大31日分まとめて登録・更新するエンドポイントが新設されました。対象従業員の勤怠連携設定が「Public API」になっていない場合はエラーになります。