ニュース

システムメンテナンス(3/23) のお知らせ

[2022年3月22日更新]
3月23日（水）の定期メンテナンスは延期されました。
詳しくはこちらをご確認ください。

下記の日時に、freeeの各サービスでシステムメンテナンスを行います。

日時：2022年3月23日（水）1:00-5:00

対象：全サービス

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。

================================================

freee developer support

リリースノート

【freee人事労務API】部門・役職の一覧取得が可能になりました

freee人事労務APIに、部門・役職の一覧取得が可能なエンドポイントが追加されました。

部門API（/api/v1/groups）

人事労務freeeに設定されている部門情報を一覧取得することが可能です。
部門の階層レベルや親部門なども取得することができ、部門マスタの同期などに利用することができます。

役職API（/api/v1/positions）

人事労務freeeに設定されている役職情報を一覧取得することが可能です。
役職マスタの同期などに利用することができます。

利用方法

freee人事労務APIのリファレンスページをご参照ください。
https://developer.freee.co.jp/reference/hr/reference

ニュース

システムメンテナンス(2/10) のお知らせ

下記の日時に、freeeの各サービスでシステムメンテナンスを行います。

日時：2022年2月10日（木）1:00-5:00

対象：全サービス

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。

================================================

freee developer support

リリースノート

【重要】freee人事労務APIの新バージョンをリリースしました

先日告知いたしましたfreee人事労務APIのバージョンアップ（https://developer.freee.co.jp/news/5418）について、本日より新バージョンの利用が可能になりました。

新バージョンの利用方法

新バージョンを利用するにはリクエストヘッダーに以下を指定します。

FREEE-VERSION: 2022-02-01

指定がない場合の挙動は以下のとおりです。

  • 2022年7月末まで（現バージョン廃止前）
    • 現バージョンに接続されます
  • 2022年8月以降（現バージョン廃止後）
    • 新バージョンに接続されます

なお、2022年8月以降（現バージョン廃止後）にFREEE-VERSION: 2022-02-01を指定し続けても問題はございません。

APIドキュメント

新バージョンリリースに伴い、freee人事労務APIリファレンスを更新いたしました。
それぞれ下記のURLから参照いただくことが可能です。

ニュース

[復旧済]freeeAPIの動作が不安定な状況が確認されました

本日17時32分頃より、freee APIを含むfreeeの全てのサービスにおいて、動作が不安定な状況が確認されておりました。
17時58分に復旧対応が完了しており、安定的な稼働状況に戻っていることを確認しております。

ご迷惑をおかけし、大変申し訳ございませんでした。引き続き、よろしくお願い申し上げます。

ニュース

【重要】freee人事労務APIの仕様変更について

freee人事労務APIのバージョンアップに伴う仕様変更を予定しています。
freee人事労務APIをご利用の開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の概要

freee人事労務APIのバージョンアップを行います。
それに伴い、リクエストパラメータの指定方法やレスポンス型式の変更など、広範囲に影響が及ぶ仕様変更が発生いたします。

変更のスケジュール

新バージョンは2022年2月から提供開始予定です。
今回の仕様変更に際しましては、影響範囲の大きさを鑑み、移行期間として現バージョンと新バージョンの並行提供期間を6ヶ月設けます。
この期間中に新バージョンへの移行を行っていただきますよう、お願い申し上げます。
なお、新バージョンの利用方法はリリース時に改めて告知いたします。

[追記]リリース情報についてはリリースノート（https://developer.freee.co.jp/release-note/5653）をご確認ください。

本件についてご不明点がある場合は以下のフォームよりお問い合わせください。

お問い合わせフォーム

変更の詳細

1.レスポンスのフォーマット変更

変更内容：

エラー（http status codeが400, 403, 404, 500）の場合のレスポンスフォーマットが変更されます。

変更前：

以下のフォーマットで共通のメッセージが返却されます。

レスポンスデータ例：

{
  "message": "不正なリクエストです。"
}

変更後：

以下のフォーマットでエラーの内容に即したメッセージが返却されます。

レスポンスデータ例：

{
    "status_code": 400,
    "errors": [
        {
            "type": "bad_request",
            "messages": [
                "締め日支払い日を選択してください。"
            ]
        }
    ]
}

対象エンドポイント：

  • freee人事労務APIの全エンドポイント

2.任意項目の必須項目化

変更内容：

一部のエンドポイントにおいて、現在任意項目のリクエストパラメータが必須項目になります。
変更の詳細については、別表をご確認ください。

3.パラメータ指定箇所の変更

変更内容：

一部のエンドポイントにおいて、リクエストパラメータ[company_id]の指定箇所が変更されます。

3−1.bodyパラメータからqueryパラメータへの変更：

以下のエンドポイントでは、[company_id]をbodyパラメータからqueryパラメータへ変更します。

  • 勤怠
    • DELETE /api/v1/employees/{emp_id}/work_records/{date}
  • 従業員
    • DELETE /api/v1/employees/{id}

3-2.queryパラメータからbodyパラメータへの変更：

以下のエンドポイントでは、[company_id]をqueryパラメータからbodyパラメータへ変更します。 

  • 勤怠情報サマリ
    • PUT /api/v1/employees/{emp_id}/work_record_summaries/{year}/{month}

4.ページネーション指定方法の変更

変更内容：

一覧取得系APIのページネーションの指定方法が変更されます。

変更前：

一回のリクエストで取得するアイテム数を[per]（デフォルト：25）で指定し、取得対象のページを[page]（デフォルト：1）で指定します。

変更後：

一回のリクエストで取得するアイテム数を[limit]（デフォルト：50、最小：1、最大：100）で指定し、取得レコードのオフセットを[offset]（デフォルト：0）で指定します。

対象エンドポイント：

  • 打刻
    • GET /api/v1/employees/{emp_id}/time_clocks
  • 給与明細
    • GET /api/v1/salaries/employee_payroll_statements
  • 従業員
    • GET /api/v1/companies/{company_id}/employees
    • GET /api/v1/employees
  • 所属
    • GET /api/v1/employee_group_memberships
  • 賞与明細
    • GET /api/v1/bonuses/employee_payroll_statements

5.http_status_codeの変更

変更内容：

一部のエンドポイントにおいて、http_status_codeが変更されます。
変更の詳細については別表をご確認ください。

6.項目のデータ型統一

変更内容：

リクエスト時はstring、レスポンス時はintegerとなっている以下項目のデータ型をintegerに統一します。

  • id
  • employee_id※
  • year
  • month

※現在、[emp_id]が使用されている箇所にも適用されます（変更点#8参照）

対象エンドポイント：

  • 打刻
    • GET api/v1/employees/{emp_id}/time_clocks
  • 勤怠情報サマリ
    • GET api/v1/employees/{emp_id}/work_record_summaries/{year}/{month}
    • PUT api/v1/employees/{emp_id}/work_record_summaries/{year}/{month}
  • 従業員
    • GET api/v1/employees/{id}
  • 賞与明細
    • GET api/v1/bonuses/employee_payroll_statements
    • GET /api/v1/bonuses/employee_payroll_statements/{employee_id}
  • 従業員の基本給
    • GET /api/v1/employees/{emp_id}/basic_pay_rule
    • PUT /api/v1/employees/{emp_id}/basic_pay_rule
  • 従業員の銀行口座
    • GET /api/v1/employees/{emp_id}/bank_account_rule
    • PUT /api/v1/employees/{emp_id}/bank_account_rule
  • 従業員の健康保険
    • GET /api/v1/employees/{emp_id}/health_insurance_rule
    • PUT /api/v1/employees/{emp_id}/health_insurance_rule
  • 従業員の厚生年金保険
    • GET /api/v1/employees/{emp_id}/welfare_pension_insurance_rule
    • PUT /api/v1/employees/{emp_id}/welfare_pension_insurance_rule
  • 従業員の姓名・住所など
    • GET /api/v1/employees/{emp_id}/profile_rule
    • PUT /api/v1/employees/{emp_id}/profile_rule
  • 従業員の扶養親族
    • GET /api/v1/employees/{emp_id}/dependent_rules
    • PUT /api/v1/employees/{emp_id}/dependent_rules

7.都道府県指定方法の変更

変更内容：

都道府県の項目名と指定方法を変更します。

変更前：

項目名は以下のとおりで、都道府県名をローマ字で指定します。
データ型はstringです。

  • pref: 住民票住所の都道府県 
  • residential_pref: 現住所の都道府県

変更後：

項目名は以下に変更され、都道府県と対応するコード値を指定します。
データ型はintegerになります。

  • prefecture_code: 住民票住所の都道府県コード
  • residential_prefecture_code: 現住所の都道府県コード

対象エンドポイント：

  • 従業員の姓名・住所など
    • PUT /api/v1/employees/{emp_id}/profile_rule

8.[emp_id]を廃止し、[employee_id]に統一

変更内容：

従業員IDを示す項目として[emp_id]と[employee_id]が混在していますが、リクエストパラメータ・レスポンスパラメータ共に[employee_id]に統一されます。

対象エンドポイント：

  • 打刻
    • GET /api/v1/employees/{emp_id}/time_clocks
    • GET /api/v1/employees/{emp_id}/time_clocks/{id}
    • GET /api/v1/employees/{emp_id}/time_clocks/available_types
    • POST /api/v1/employees/{emp_id}/time_clocks
  • 勤怠
    • DELETE /api/v1/employees/{emp_id}/work_records/{date}
    • GET /api/v1/employees/{emp_id}/work_records/{date}
    • PUT /api/v1/employees/{emp_id}/work_records/{date}
  • 勤怠情報サマリ
    • GET /api/v1/employees/{emp_id}/work_record_summaries/{year}/{month}
    • PUT /api/v1/employees/{emp_id}/work_record_summaries/{year}/{month}
  • 従業員の基本給
    • GET /api/v1/employees/{emp_id}/basic_pay_rule
    • PUT /api/v1/employees/{emp_id}/basic_pay_rule
  • 従業員の銀行口座
    • GET /api/v1/employees/{emp_id}/bank_account_rule
    • PUT /api/v1/employees/{emp_id}/bank_account_rule
  • 従業員の健康保険
    • GET /api/v1/employees/{emp_id}/health_insurance_rule
    • PUT /api/v1/employees/{emp_id}/health_insurance_rule
  • 従業員の厚生年金保険
    • GET /api/v1/employees/{emp_id}/welfare_pension_insurance_rule
    • PUT /api/v1/employees/{emp_id}/welfare_pension_insurance_rule
  • 従業員の姓名・住所など
    • GET /api/v1/employees/{emp_id}/profile_rule
    • PUT /api/v1/employees/{emp_id}/profile_rule
  • 従業員の扶養親族
    • GET /api/v1/employees/{emp_id}/dependent_rules
    • PUT /api/v1/employees/{emp_id}/dependent_rules/bulk_update

9.[gender]の型式統一

変更内容：

エンドポイントごとに型式が異なっている[gender(性別)]について、全て以下の型式に統一します。

  • データ型
    • string
  • 選択肢
    • unselected: 未選択
    • male: 男性
    • female: 女性

対象エンドポイント：

  • 従業員
    • POST /api/v1/employees
  • 従業員の姓名・住所など
    • PUT /api/v1/employees/{emp_id}/profile_rule
  • 従業員の扶養親族
    • PUT /api/v1/employees/{emp_id}/dependent_rules/bulk_update

10.[widow_type]の値追加

変更内容：

寡夫/寡婦かどうかを示す項目[widow_type]で指定可能な値として[one_parent:ひとり親]が追加されます。

変更前：

[widow_type]は以下の4種類です。

  • na: 空白
  • widower: 寡夫
  • widow: 寡婦
  • special_widow: 特別寡婦

変更後：

[widow_type]は以下の5種類になります。

  • na: 空白
  • widower: 寡夫
  • widow: 寡婦
  • special_widow: 特別寡婦
  • one_parent:ひとり親

※2020年11月以前のyear, monthにを指定してPUTする場合、[one_parent:ひとり親]は指定できません

対象エンドポイント：

  • 従業員の姓名・住所など
    • GET /api/v1/employees/{emp_id}/profile_rule
    • PUT /api/v1/employees/{emp_id}/profile_rule

11.[married_f]の項目名称変更

変更内容：

従業員APIのリクエストパラメータで、配偶者の有無を表す[married_f]の名称が[married]に変更されます。
（レスポンスは以前から[married]であり、リクエストとレスポンスのパラメータ名称が統一されます。）

対象エンドポイント：

  • 従業員
    • POST /api/v1/employees

12.バリデーションの見直し

変更内容：

APIリファレンスに記載されているバリデーションの内容と、実際のバリデーションの齟齬を解消します。

変更前：

以下のような挙動になっている場合があります。

  • 必須項目を指定していなくてもエラーとならない
  • 選択肢の中から選ぶものがあるが、選択肢以外を指定してもエラーとならない
  • 値や桁数・文字数の上限、下限がAPIリファレンスやレスポンスではわからない

変更後：

APIリファレンスの各エンドポイントの説明欄に記載された通りの挙動になります。

対象エンドポイント：

  • freee人事労務APIの全エンドポイント
ニュース

freee会計APIの仕様変更について

下記の通り、freee会計APIの仕様変更を予定しています。
freee会計APIをご利用の開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

1.申請の申請日を任意項目化

変更の実施予定時期：

2022年2月

変更内容：

経費精算API・支払依頼API・各種申請APIのリクエストパラメータ[application_date(申請日)]が必須項目から任意項目になります。

変更前：

経費精算API・支払依頼API・各種申請APIのリクエストパラメータ[application_date(申請日)]は必須項目であり、未指定の場合はエラーが返却されます（エラーコード：400）。

変更後：

経費精算API・支払依頼API・各種申請APIのリクエストパラメータ[application_date(申請日)]は任意項目になり、未指定の場合はリクエスト送信日が申請日として適用されます。

対象エンドポイント：

  • POST /api/1/expense_applications
  • POST /api/1/payment_requests
  • POST /api/1/approval_requests

変更理由：

申請日の不正入力を防止するため（freee会計の仕様変更によるもの）。

2.freee APIで登録した明細に自動登録ルールを適用

変更の実施予定時期：

2022年2月

変更内容：

明細APIで登録した明細に、取引の自動登録ルールが適用されるようになります。
自動登録ルールについては以下のページをご参照ください。
https://support.freee.co.jp/hc/ja/articles/202848350

変更前：

明細APIで登録した明細には、取引の自動登録ルールは適用されません。

変更後：

明細APIで登録した明細にも、取引の自動登録ルールは適用されます。
これに伴い、レスポンス項目に、登録した明細に自動登録ルールが適用されたかどうかを示す項目が追加されます。

対象エンドポイント：

  • POST /api/1/wallet_txns

変更理由：

freee会計のweb画面とAPIの仕様差異を無くし、ユーザー体験を向上するため。

ニュース

システムメンテナンス(12/23) のお知らせ

下記の日時に、freeeの各サービスでシステムメンテナンスを行います。

日時：2021年12月23日（木）1:00-5:00

対象：全サービス

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。

================================================

freee developer support

リリースノート

2021年11月の更新情報

  • [人事労務] [employees] 削除成功時のステータスコードが204になります。
  • [人事労務] [work_records] 削除成功時のステータスコードが204になります。
  • [会計] [partners] address_attributes.prefecture_code に -1 (設定しない)が指定可能になります。

以上です。
引き続きどうぞよろしくお願いいたします。

ニュース

システムメンテナンス(11/17) のお知らせ

下記の日時に、freeeの各サービスでシステムメンテナンスを行います。

日時：2021年11月17日（水）1:00-5:00

対象：全サービス

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。

================================================

freee developer support

ニュース

[復旧済] freeeAPIの動作が不安定な状況です

本事象について、現在は復旧対応が完了しており、安定的な稼働状況に戻っていることを確認しております。
ご迷惑をおかけし、大変申し訳ございませんでした。
引き続き、よろしくお願い申し上げます。[2021年11月9日9時15分更新]

本事象について、17時22分より安定的な稼働状況に戻っていることを確認しております。
また、念の為稼働状況のモニタリングを続けております。ご迷惑をおかけし大変申し訳ございません。[2021年11月8日19時30分更新]

本日16時22分頃より、freeeAPIの動作が不安定な状況が確認されており、現在、復旧に向けた対応を行っております。

ご迷惑をおかけし、大変申し訳ございません。
逐次、状況をお知らせいたします。

ニュース

システムメンテナンス(10/22) のお知らせ

下記の日時に、freeeの各サービスでシステムメンテナンスを行います。

日時：2021年10月22日（金）1:00-5:00

対象：全サービス

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。

================================================

freee developer support

ニュース

システムメンテナンス(9/22) のお知らせ

下記の日時に、freeeの各サービスでシステムメンテナンスを行います。

日時：2021年9月22日（水）1:00-5:00

対象：全サービス

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。

================================================

freee developer support

リリースノート

2021年8月の更新情報

  • 試算表APIでセグメントによる内訳表示(breakdown_display_type)に対応しました。
  • 試算表API(貸借対照表の取得)で部門(section_id)による絞り込みに対応しました。
  • 部門取得APIで部門の使用設定(available)が取得できるように対応しました。
  • 取引先取得APIで更新日時(start_update_date, end_update_date)によるフィルタリングができるように対応しました。
  • 品目取得APIで更新日時(start_update_date, end_update_date)によるフィルタリングができるように対応しました。
  • メモタグ取得APIで更新日時(start_update_date, end_update_date)によるフィルタリングができるように対応しました。

以上です。

引き続きどうぞよろしくお願いいたします。

ニュース

試算表APIのレスポンス内容変更について

下記の通り、試算表APIの仕様変更を予定しています。

開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の実施予定時期

2021年10月

変更内容

試算表APIのリクエストパラメータ[section_id（部門ID）]に親部門のIDを指定した場合の実行結果が変更されます。

変更前

親部門のIDを指定した場合、集計値は0が返却されます。（HTTPステータスコードは[200(成功)]）

変更後

親部門のIDを指定した場合、指定した親部門の配下の部門（子部門）の集計値が返却されます。（HTTPステータスコードは[200(成功)]）

対象エンドポイント

  • /api/1/reports/trial_bs
  • /api/1/reports/trial_bs_two_years
  • /api/1/reports/trial_bs_three_years
  • /api/1/reports/trial_pl
  • /api/1/reports/trial_pl_two_years
  • /api/1/reports/trial_pl_three_years
  • /api/1/reports/trial_pl_segment_1_tags
  • /api/1/reports/trial_pl_segment_2_tags
  • /api/1/reports/trial_pl_segment_3_tags

変更理由

freee会計の機能アップデートのため

ニュース

freeeアプリストア　決済機能セミナー開催のお知らせ

freeeアプリストア　決済機能セミナーを、9月10日(金) 17時よりオンラインで開催します。

「アプリストア 決済機能」を利用すると、freee用に開発したアプリを有料販売することが可能となります。

この新機能の詳細、利用方法をご紹介いたします。

※7月21日に開催したセミナーと同じ内容となります。セミナー動画をもとに再構成して開催します。

開催日時

2021年9月10日(金)　17時00分ー17時40分

参加対象者

freeeアプリストアでアプリの販売をお考えの開発者様
freeeアプリストアを使っているfreee ユーザーのみなさま

お申し込み

下記のセミナーの告知ページからお申し込みください。

freeeアプリストア　決済機能セミナー　申し込みページ

ニュース

各種申請APIのHTTPステータスコード変更について

下記の通り、各種申請APIの仕様変更を予定しています。
各種申請APIをご利用の開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の実施予定時期：

2021年10月

変更内容：

各種申請APIで申請の承認操作を行う際、指定した申請が存在しなかった場合または指定した申請を操作する権限が無い場合に返却されるHTTPステータスコードが変更されます。

変更前：

指定した申請が存在しなかった場合または指定した申請を操作する権限が無い場合に返却されるHTTPステータスコードは[400]です。

変更後：

指定した申請が存在しなかった場合または指定した申請を操作する権限が無い場合に返却されるHTTPステータスコードは[404]です。

対象エンドポイント：

  • POST /api/1/approval_requests/{id}/actions

変更理由：

適切なHTTPステータスコードを返却するため。

ニュース

試算表API活用セミナー開催のお知らせ

試算表APIセミナーを9月8日(水) 15時からオンラインで開催します。

今回のセミナーでは「試算表」に絞り込み

・試算表の新機能、これから実装予定の機能
・試算表APIを利用した簡単な分析アプリのデモ
・活用事例

などをご紹介します。

freee会計をもっと活用したい方、試算表の活用をお考えの方、経営分析・予実管理や経営資料の作成など、社内の情報共有に試算表の活用をお考えの方は、ぜひご参加ください。

開催日時

2021年9月8日(水)　15時ー15時40分（予定）

参加対象者

  • freee会計をもっと活用したい方
  • 試算表の活用をお考えの方
  • 経営資料の作成など、社内の情報共有に活用をお考えの方

お申し込み

下記のセミナーの告知ページからお申し込みください。

freee会計 試算表API活用セミナー