ShuheiMuto のすべての投稿

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

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

変更の概要

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

変更のスケジュール

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

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


変更の詳細

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の仕様差異を無くし、ユーザー体験を向上するため。

システムメンテナンス(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

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

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

変更の実施予定時期:

2021年10月

変更内容:

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

変更前:

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

変更後:

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

対象エンドポイント:

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

変更理由:

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

システムメンテナンス(8/24) のお知らせ

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

日時:2021年8月24日(火)1:00-5:00

対象:全サービス

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

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

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

freee developer support

freee人事労務APIの仕様変更について

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

変更の実施予定時期:

2021年12月

変更内容:

給与明細APIで従業員の給与明細を取得する際、配列[overtime_pays]に含まれる内容が下記のように変更されます。

変更前:

name(項目名), time(時間[分]) ,amount(手当金額)の3項目が返却され、固定残業代および固定残業代の超過額は「固定割増手当」および「固定割増手当超過額」という項目名で返却されます。

レスポンスデータ例

overtime_pays: [
  {
    name: '法定内残業',
    time: '600.0'
    amount: '12350.0'
  },
  {
     name: '固定割増手当',
     time: null,
     amount: '100000.0'
  },
  {
     name: '固定割増手当超過額',
     time: null,
     amount: '0.0'
  }

変更後:

変更前の3項目に加え、事業所毎に任意に設定可能な小文字英数最大10桁のcode(コード)が返却され、固定残業代および固定残業代の超過額にも事業所毎でユーザーが設定した任意の項目名(最大20文字)で返却されます。
code(コード)には固定残業代および固定残業代の超過額場合にname(項目名)に対応する値が入り、それ以外の場合はnullが返却されます。

レスポンスデータ例

overtime_pays: [
  {
    name: '法定内残業',
    time: '600.0'
    amount: '12350.0',
    code: null
  },
  {
     name: 'カスタム固定残業代1',
     time: null,
     amount: '100000.0',
     code: 'a001'
  },
  {
     name: 'カスタム固定残業代1超過分',
     time: null,
     amount: '0.0',
     code: 'a001'
  },
 {
     name: 'カスタム固定残業代2',
     time: null,
     amount: '100000.0',
     code: 'a002'
  },
  {
     name: 'カスタム固定残業代2超過分',
     time: null,
     amount: '0.0',
     code: 'a002'
  },
  ...

対象エンドポイント:

  • GET /api/v1/salaries/employee_payroll_statements
  • GET /api/v1/salaries/employee_payroll_statements/{employee_id}

変更理由:

固定残業代付与に関する機能改善のため。(freee人事労務の仕様変更によるもの)

改訂履歴:

2021年11月17日

  • 変更の実施予定時期を2021年10月から2021年12月に変更しました
  • 変更後の記載をより詳細化しました
  • 変更前・変更後それぞれのレスポンスサンプルを記載しました

[復旧済] ファイルボックスAPIの障害について

本事象について、2021年8月2日 15時50分頃に復旧対応が完了し、現在は解消しております。

ファイルボックスAPIが正常に動作しないケースが発生しております

【発生日時】
2021年7月15日(木)以降

【発生事象】
ファイルボックスAPI(POST /api/1/receipts)をコールする際、HTTP request header に Transfer-Encoding: chunked を指定してリクエストを送った場合に正常に処理が完了しません。

現在、復旧に向けた対応を行っております。
ご迷惑をおかけし、大変申し訳ございません。

システムメンテナンス(7/21) のお知らせ

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

日時:2021年7月21日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

[復旧済] freeeAPIのWebhook通知の障害について

freeeAPIのWebhook通知が正常に動作していなかった時間帯がありました。

現在は復旧対応が完了しており、影響を受けたアプリケーションのオーナー開発者さまにはご連絡済みです。

【発生日時】
2021年7月12日(月)17:15 ~ 2021年7月13日(火)09:03

【発生事象】
freeeAPIのWebhook通知が正常に動作せず、上記の時間帯においてWebhook通知が送信されていませんでした。
対象は、経費精算・各種申請・支払依頼の全てです。

ご迷惑をおかけしましたことをお詫びいたします。
再発防止の対策を進めてまいります。

「アプリストア決済機能」リリースのお知らせ

2021年7月8日に新機能「アプリストア決済機能」がリリースされました。
「アプリストア決済機能」を利用することで、freee APIを活用したサービスをfreeeアプリストア上で有料販売することが可能です。

ご利用方法については、下記サポートドキュメントをご参照ください。

アプリケーションを有料で販売する

システムメンテナンス(6/24) のお知らせ

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

日時:2021年6月24日(木)1:00-5:00

対象:全サービス

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

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

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

freee developer support

システムメンテナンス(5/19) のお知らせ

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

日時:2021年5月19日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

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

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

日時:2021年4月22日(木)1:00-5:00

対象:全サービス

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

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

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

freee developer support

【重要】会計freee APIの仕様変更と対応のお願い

下記の通り、会計freee APIの仕様変更を予定しています。
変更点は大きく分けて5つあり、アプリの挙動に大きな影響がある変更(破壊的変更)が2点含まれます。
会計freee APIをご利用の開発者の皆さまは、新仕様の確認ならびに改修の対応をご検討いただきますよう、よろしくお願い申し上げます。


1. マイナス金額の取引を登録した場合の処理変更(破壊的変更)

変更の実施予定時期:

2021年6月

変更内容:

取引(Deals)APIで合計金額がマイナスの取引の登録が可能になります。
また、取引を新規登録(POST)する場合、未決済取引を登録した場合の処理(取引登録の結果)が下記のように変更されます。

変更前:

合計金額がマイナスの取引を新規登録しようとした場合、取引明細行の金額を正負を反転し、指定された収支区分も反転して登録していました。

例)
登録内容:収入 売上高 10,000、立替金 -20,000
登録結果:支出 売上高 -10,000、立替金 20,000

変更後:

金額の正負と収支区分を反転せず、合計金額がマイナスのまま登録するようになります。

例)
登録内容:収入 売上高10,000、立替金 -20,000
登録結果:収入 売上高10,000、立替金 -20,000

※決済済み(paymentsを指定する)取引を登録する場合の処理は変更されません、ご注意ください。

対象エンドポイント:

  • POST /api/1/deals
  • PUT /api/1/deals/{id}

変更理由:

値引きや返品・キャンセルなどが発生した場合の決済処理や入金管理の改善のため。(会計freeeの仕様変更によるもの)


2. 経費精算APIのリクエストパラメータ・レスポンス項目削除(破壊的変更)

変更の実施予定時期:

2021年6月

変更内容:

経費精算(Expense applications)APIのリスエストパラメータ・レスポンス項目のから、「editable_on_web」が削除されます。

対象エンドポイント:

  • GET /api/1/expense_applications/{id}
  • POST /api/1/expense_applications
  • PUT /api/1/expense_applications/{id}

変更理由:

これまで、API経由の経費申請の作成は下書きステータスでの登録のみだったため、編集をコントロールする機能として提供してきました。2020年10月のアップデートにより、APIからも申請中状態(申請済で編集ができない状態)で経費申請の作成が可能になったため、申請後の編集を許容したくない場合は、申請中ステータスで登録を行うことで実現可能です。


3. 各種申請APIのレスポンス項目追加・修正

変更の実施予定時期:

2021年5月

変更内容:

各種申請(Approval requests)APIのレスポンス項目に「manual_journal_id」が追加され、今まで「deal_id」として返却されていた振替伝票IDは「manual_journal_id」として返却されるようになります。
(「deal_id」には取引IDのみが返却されるようになります)

対象エンドポイント:

  • GET /api/1/approval_requests
  • GET /api/1/approval_requests/{id}

変更理由:

取引IDが含まれることが想定されるプロパティの値に振替伝票のIDが入っているため。
取引IDと振替伝票IDは意味が異なり、項目として区別できるようにするため。


4. 固定資産償却処理の非同期化に伴う変更

変更の実施予定時期:

2021年5月

変更内容①:

会計の年度締め処理および残高の集計処理が完了している場合であっても、固定資産の償却仕訳作成が完了していない場合は、「fiscal_years」配下の項目の更新ができなくなります。
更新を試みた場合、503エラーが返却されます。

対象エンドポイント:

  • PUT /api/1/companies/{id}
    ※このエンドポイントは2021年6月に廃止予定です。詳しくはこちらをご確認ください。

変更内容②:

会計の年度締め処理および残高の集計処理が完了している場合であっても、固定資産の償却仕訳作成が完了していない場合は、「accumulated_dep_account_item_id」を更新することができなくなります。
更新を試みた場合、503エラーが返却されます。

対象エンドポイント:

  • PUT /api/1/account_items/{id}

変更内容③:

会計の年度締め処理および残高の集計処理が完了している場合であっても、固定資産の償却仕訳作成が完了していない場合は、試算表(Trial balance)APIのレスポンス項目「up_to_date」が「false」になります。

対象エンドポイント:

  • GET /api/1/reports/trial_bs
  • GET /api/1/reports/trial_bs_two_years
  • GET /api/1/reports/trial_bs_three_years
  • GET /api/1/reports/trial_pl
  • GET /api/1/reports/trial_pl_two_years
  • GET /api/1/reports/trial_pl_three_years
  • GET /api/1/reports/trial_pl_sections

変更内容④:

試算表(Trial balance)APIのレスポンス項目に「up_to_date_reasons」が追加されます。
「up_to_date_reasons」には「code」および「message」がネストされます。
固定資産の償却仕訳作成が完了していない場合、「code」に「depreciation_creating」が返却され、「message」に固定資産の償却仕訳作成処理が完了していない旨のメッセージが返却されます。
また、固定資産の償却仕訳作成がエラー終了した場合、「code」に「depreciation_create_error」が返却され、「message」に固定資産の償却仕訳作成処理がエラー終了した旨のメッセージが返却されます。

対象エンドポイント:

  • GET /api/1/reports/trial_bs
  • GET /api/1/reports/trial_bs_two_years
  • GET /api/1/reports/trial_bs_three_years
  • GET /api/1/reports/trial_pl
  • GET /api/1/reports/trial_pl_two_years
  • GET /api/1/reports/trial_pl_three_years
  • GET /api/1/reports/trial_pl_sections

変更内容⑤:

仕訳帳(Journals)APIのレスポンス項目に「up_to_date」および「up_to_date_reasons」が追加されます。
「up_to_date_reasons」には「code」および「message」がネストされます。
固定資産の償却仕訳作成が完了していない場合、「up_to_date」が「false」になります。
その場合、「code」に「depreciation_creating」が返却され、「messages」に固定資産の償却仕訳作成処理が完了していない旨のメッセージが返却されます。
また、固定資産の償却仕訳作成がエラー終了した場合、「code」に「depreciation_create_error」が返却され、「message」に固定資産の償却仕訳作成処理がエラー終了した旨のメッセージが返却されます。

対象エンドポイント:

  • GET /api/1/journals

変更理由:

会計freeeのパフォーマンス向上のため、年度締め処理から固定資産の償却仕訳作成処理が分離されるため。(会計freeeの仕様変更によるもの)


5. 請求書APIのレスポンス項目「posting_status」の内容追加

変更の実施予定時期:

2021年5月

変更内容:

請求書(Invoices)APIのレスポンス項目の「posting_status」に、郵送された書類が不達となった場合を示すステータス「bounced」が追加されます。

対象エンドポイント:

  • GET /api/1/invoices/{id}

変更理由:

郵送された書類が宛先不明等で不達となる場合があり、その状態を把握できるようにするため。

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

本事象について、2021年4月5日20時10分頃に復旧対応が完了し、現在は解消しております。[2021年4月5日21時00分更新]

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

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

【重要】事業所情報の更新API廃止のお知らせ(2021年6月)

2021年6月に、事業所情報の更新APIを廃止いたします。
freeeAPIをご利用の皆さまにおかれましては、ご承知くださいますようお願いいたします。

仕様変更の実施予定時期:

2021年6月

仕様変更の内容:

会計freeeAPI、事業所情報更新(PUT /api/1/companies/{id})の廃止

仕様変更理由:

当該APIの利用実績が非常に少なく、会計freeeのweb画面から更新が可能であるため