ニュース

各種申請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活用セミナー

ニュース

システムメンテナンス(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アプリストア上で有料販売することが可能です。

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

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

リリースノート

2021年6月の更新情報

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

ニュース

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

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

日時：2021年6月24日（木）1:00-5:00

対象：全サービス

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

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

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

freee developer support

ニュース

【重要】Community 機能変更に関するご案内

当サイトで提供をしている「Community」機能の変更を行います。Developer Community 会員の皆様におきましては、変更内容のご確認とご理解をいただきたく、よろしくお願いいたします。

  1. Community 掲示板の廃止と、TeraTail上のコミュニティ新設について
  2. サポートポリシーについて
  3. Developer Community 会員の位置付けについて

１. Community 掲示板の廃止と、TeraTailのコミュニティ新設について

当サイトで提供している、Q&A用の掲示板「Community」機能を、2021年6月25日(金)をもって提供終了します。終了に先立ち、6月11日(金)に新規スレッドの作成を終了します。6月25日(金)にはスレッド作成・コメント作成・Developer Community会員のログイン機能提供を全て終了します。

同時に、技術者向けのQ&A 提供サービス「TeraTail」に、freee開発者向けのコミュニティを新設します。

2. サポートポリシーについて

会計freee, 人事労務freeeをはじめとする、freeeの各サービスをご契約の方は、管理画面から正規のサポートをご利用いただけます。お問い合わせから、お問い合わせの種類を「操作方法についてのご質問」、対象の画面カテゴリを「Public API」を選択しお問い合わせください。

画像に alt 属性が指定されていません。ファイル名: image1-1024x735.png

会計freee, 人事労務freee等のfreee各種サービスの契約を行なっていない方は、今後はTeraTail上のコミュニティをご利用ください。

  • TeraTailのご利用に際しては、TeraTail上でアカウント登録を行う必要があります。
  • TeraTail のご利用に際しては、TeraTailの利用規約をご覧いただき、ご承諾いただく必要があります。
  • TeraTail上のコミュニティでは、freeeからの公式回答は行いません。freeeの公式回答をご希望の方は、上記の手順に従い、正規サポートをご利用ください。

３. Developer Community 会員の位置付けについて

これまで、Developer Community 会員には以下の2つの情報・機能を提供してきました。

  • freee API に関する情報をメール配信
  • Community機能（掲示板）の提供

6月25日以降は「freee API に関する情報をメール配信」をご提供いたします。以下のページから登録いただけます。

Developers Community 会員登録

今後とも freee Developers Community をどうぞよろしくお願いいたします。

ニュース

システムメンテナンス(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の動作が不安定な状況が確認されており、現在、復旧に向けた対応を行っております。

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