ニュース

ニュース2019/11/22

「/reports」「/walletables」の仕様変更に関して

会計freee API のエンドポイント「/reports」「/walletables」 に対して、仕様変更が行われます。開発者の皆様は、必要に応じてアプリの改修のご検討をお願い申し上げます。

仕様変更の理由:

会計freeeの機能改善を行うため。

※詳細は「レポート集計についての詳細」をご参照ください。

仕様変更リリース予定日:

2019年11月25日以降順次

仕様変更の詳細:

1.新しいプロパティ「up_to_date」が追加

エンドポイント「/reports」「/walletables」 に、「up_to_date」プロパティが追加されます。このプロパティは、返り値の集計データが、最新かどうかを判断するパラメータとなります。

対象となるエンドポイントは以下となります。

/reports

  • /reports/trial_bs
  • /reports/trial_bs_two_years
  • /reports/trial_bs_three_years
  • /reports/trial_pl
  • /reports/trial_pl_two_years
  • /reports/trial_pl_three_years
  • /reports/trial_pl_sections

/walletables

  • 「with_balance」というパラメータを付与してGETリクエストを行った場合のみ追加

[up_to_date] の値が [true] の時は、最新の集計データが反映されている状態です。

[up_to_date] の値が [false] の時は、集計作業を行なっているため、最新の集計データとは異なる可能性があります。

[up_to_date] の値は最大1分ほどで更新されます。このため、値が[false] の時は、1分ほど待ってからリクエストを行うことで、最新の情報が反映されます。

レスポンス例:

以下は「/reports」のレスポンスのサンプルとなります。

{
  "trial_bs": {
    "company_id": 1,
    "up_to_date": true,
    "fiscal_year": 2019,
    "start_month": 1,
    "end_month": 12,
    "start_date": {},
    "end_date": {},
    "account_item_display_type": "account_item",
    "breakdown_display_type": "partner",

2. エンドポイント「/report」に対するリクエストの上限設定について

エンドポイント「/report」 に対して、近日中に 一定時間内のリクエスト上限値を設定する予定です。上限数を超えた場合、httpステータスは429となり、レスポンスに使用回数がリセットされる時刻を含めます。上限数およびレスポンス内容は別途決定して、freee Developer Community にて告知を行います。

レスポンスボディのmetaプロパティに以下を含めます。

  • 設定されている上限値
  • 上限に達するまでの使用可能回数
  • (上限値に達した場合)使用回数がリセットされる時刻

アプリの変更について:

ご利用のアプリが、上記のエンドポイント「/reports」 「/walletables」 を利用しており、かつ、集計データに最新情報の反映が必要な場合は、「up_to_date」 の値を考慮する形で改修のご検討をお願いいたします。

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

freee developer support <dev-support@freee.co.jp>