ニュース

ニュース2021/04/14

【重要】会計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}

変更理由:

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