【freee会計】API仕様の変更について(ファイルボックス API)

下記2点、freee会計 ファイルボックス(証憑ファイル)APIの仕様変更があります。

変更内容①は実施済み、変更内容②は今後実施される予定です。
freee会計APIをご利用の開発者の皆様におかれましては、変更点をご確認いただき、アプリの改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。

変更内容①:

  • POST・PUT時のリクエストパラメーター「issue_date(発生日)」を廃止しました。

対象エンドポイント:

  • POST /api/1/receipts ファイルボックス(証憑ファイル)のアップロード
  • PUT /api/1/receipts/{id} ファイルボックス(証憑ファイル)の更新

変更理由:

  • 不具合への対応となります。
    ユーザーがリクエストパラメーターで指定した値に関わらず、アップロード日付がissue_dateに登録されていました。
  • Webの仕様と合わせ、POSTやPUT時にissue_dateを指定できないようにします。
    ※なお、今後issue_dateを指定したリクエストはエラーにならず、値が無視されるようになります。
    そのため、この変更は既存アプリの挙動に影響はございません。

変更の実施時期:

  • 2023年6月(実施済み)

変更内容②:

  • GET時のレスポンスから「issue_date(発生日)」「file_src(ファイルのダウンロードURL)」を廃止します。

対象エンドポイント:

  • GET /api/1/receipts ファイルボックス(証憑ファイル)一覧の取得
  • GET /api/1/receipts/{id} ファイルボックス(証憑ファイル)の取得

変更理由:

  • いずれもWebで利用されてない非推奨の値となります。
    今後、issue_dateに代わりcreated_atをご利用ください。
  • 今後、file_srcに代わり、ファイルボックス(証憑ファイル)のダウンロードAPIをご利用ください。
  • ※なお、issue_dateは現在POST/PUT時のレスポンスパラメーターにも含まれますが、上記GETのレスポンスパラメーターと同じタイミングで廃止されます。

変更の実施時期:

  • 2023年7月中旬