freee のすべての投稿

仕訳帳API から取得したCSVデータで発生した問題について

2020年7月28日~8月5日にかけて、仕訳帳APIからCSVデータを取得した際に、リクエストと異なるデータが含まれる現象が発生しました。現在は問題解消しています。

ご迷惑をおかけしたことをお詫びいたします。

期間中、仕訳帳APIから、意図通りのCSVが取得できなかった方は、再取得をお試しいただきますようお願いいたします。

  • 発生時期
    • 2020年7月28日-8月5日
  • 発生プラン
    • プロフェッショナルプラン、エンタープライズプラン
  • 現象
    • 仕訳帳API を利用してCSVをダウンロードした際、download_type=genericでvisible_tags[] = all を指定していたときに、セグメントの情報がCSVファイルに含まれていた可能性がある

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

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

日時:2020年7月14日(火)1:00-5:00

対象:全サービス

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

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

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

freee developer support

会計freee ワークフローAPIの提供開始

既にリリースされている経費精算のワークフローAPIに加え、新たに各種申請のワークフローAPIをリリースしました。

今回のリリースにより、各種申請の作成(POST)や取得(GET)、更新(PUT)、削除(DELETEおよび申請に対する承認操作が可能となり、クラウド会計ソフトfreee(以下、会計freee)の各種申請機能を外部サービスと連携してご利用いただけます。

各種申請のワークフロー APIの操作一覧

ワークフローAPIの機能一覧

各種申請のワークフローAPIでできること

ワークフローAPIは、購買申請・稟議などの各種申請に関わるワークフローを自由に構築できる機能です。ワークフローAPIにより会計freeeの各種申請機能と外部サービスを連携することで、各種申請の申請や承認、差戻し、却下を普段使っているコミュニケーションツールやグループウェア上で行うことができます。

ご利用可能なプラン

ワークフローAPIは、以下の会計freeeのプランでご利用可能です。

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

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

日時:2020年6月17日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

【重要】会計freee API 新仕様の提供開始

先だってご案内した、2020年12月に変更予定の新API仕様について、提供を開始しました。

freeeアプリ開発者の皆さまは、新仕様の確認、ならびに早期改修の対応をご検討いただきますよう、何卒よろしくお願い申し上げます。

仕様変更の実施予定日:

2020年12月

仕様変更対象:

会計freee API

新仕様の確認方法:

利用方法は リリースノート ならびに APIリファレンス をご覧ください。

新仕様の試験期間:

2020年6月−11月の間に、新仕様のAPIバージョンを指定してテストを行いながら、アプリの改修を計画ください。

仕様変更の詳細:

リリースノート をご覧ください。

【重要】会計freee APIの仕様変更と対応のお願い(2020年12月)

2020年12月に、会計freee のAPIに対して仕様変更の実施を予定しています。

freeeアプリ開発者の皆さまは、新仕様の確認、ならびに早期改修の対応をご検討いただきますよう、何卒よろしくお願い申し上げます。

仕様変更の実施予定日:

2020年12月

仕様変更対象:

会計freee API

新仕様の確認方法:

2020年6月から提供開始予定。利用方法はリリースノートをご覧ください。

新仕様の試験期間:

2020年6月−11月の間に、新仕様のAPIバージョンを指定してテストを行いながら、アプリの改修を計画ください。

仕様変更の詳細:

リリースノートをご覧ください。

【重要】2020年12月の会計freee APIの仕様変更について

2020年12月に、下記に記述した会計freeeのAPIの仕様変更を実施します。

新仕様APIの提供開始時期と利用方法

仕様変更に先立ちまして、2020年6月より、新仕様のAPIを提供します。

リクエストヘッダーにAPIのバージョン

X-Api-Version: 2020-06-15

を指定することで、新仕様のAPIが利用可能となります。

APIのバージョン指定をせずにリクエストを行った場合、12月に新仕様のAPIに自動的に切り替わります。詳しくは、本ページ下部のサンプルコードをご覧ください。

開発者の皆さまは、変更内容をご確認の上、アプリの改修計画など、適宜対応のご検討をお願い対します。

(2020/12/17追記)
仕様変更に伴うQ&Aを公開しました。ご不明な点がある場合、一度お目通しください。

※今回の仕様変更の影響を受けないアプリについては、改修の必要はありません。

仕様変更スケジュール時期:

2020年12月中旬

変更内容:

1. 勘定科目(Account_items)

1-1 POST、PUTメソッドでリクエストを送信する際、下記の各パラメータの指定方法が変更となる(C1,C2,C3)

パラメータ名変更前変更後
支出取引相手勘定科目corresponding_expense_name
名前(=文字列)で指定
corresponding_expense_id
ID(=数値)で指定
収入取引相手勘定科目corresponding_income_name
名前(=文字列)で指定
corresponding_income_id
ID(=数値)で指定
税区分tax_name
名前(=文字列)で指定
tax_code
ID(=数値)で指定
勘定科目のカテゴリaccount_category
名前(=文字列)で指定
account_category_id
ID(=数値)で指定

1-2 変更となる任意パラメータ(C5)

POST、PUT リクエスト送信時に指定が可能

パラメータ名変更前変更後
減価償却累計額勘定科目accumulated_dep_account_item_name
名前(=文字列)で指定
accumulated_dep_account_item_id
ID(=数値)で指定

1-3 削除となるレスポンス内のパラメータ(C27)

GET、POST、 PUTのレスポンスから不要となるパラメータを削除

パラメータ名変更前変更後
支出取引相手勘定科目種別
収入取引相手勘定科目種別
corresponding_type_expense
corresponding_type_income
利用しないため削除

2. 請求書(Invoices)

2-1 パートナー名の必須化(C6)

POST、PUT リクエスト送信時の指定方法およびレスポンスが変更

変更前変更後
パートナー名に関するパラメータの必須指定はない
  • リクエスト、レスポンスともにpartner_display_nameが必須となる
  • リクエストから partner_name 指定が削除
  • レスポンスから partner_long_name が削除

2-2 敬称(必須パラメータ)(C7)

POST, PUTリクエスト送信時、これまでは任意だったものが必須となる

変更前変更後
partner_title
任意
partner_title
設定が必須

2-3 権限適用範囲の変更(C8)

POST, PUTリクエスト送信時、グループ権限で利用できる部門を絞ることが可能となる

変更前変更後
グループ権限で特定のユーザーが利用できない部門のタグがついた取引の請求書でも、API経由で取得、更新、削除ができるグループ管理で利用可能となっていない部門のタグを指定している場合、請求書の取得、更新、削除ができない

2-4 期間指定パラメータの変更(C9)

GETリクエスト送信時の期間指定用パラメータが変更になる

変更前変更後
以下のパラメータで期間指定

 

  • issue_date_start
  • issue_date_end

期日の開始日と終了日

  • due_date_start
  • due_date_end
以下のパラメータで期間指定

 

  • start_issue_date
  • end_issue_date

期日の開始日と終了日パラメータが変わる

  • start_due_date
  • end_due_date

2-5 請求書ステータスの変更(C10)

GETリクエスト送信時、およびレスポンスが変更

変更前変更後
invoice_status を見ると
送付待ち・送付済み関わらず、以下になる

 

  • invoice_status = issued
invoice_status が送付済みの時に以下になる

 

  • invoice_status = submitted
  • issuedは廃止

invoice_status が送付待ちの時に以下になる

  • invoice_status = unsubmitted

3 口座(Walletables)

3-1 GETとPOSTのレスポンスフォーマット統一(C12)

変更前変更後
GETとPOSTでレスポンスフォーマットが異なるGETとPOSTのレスポンス共にフォーマットが統一される

4 仕訳帳(Journals)

4-1 GETリクエストに対するレスポンス内の「messages」の型を統一(C13)

変更前変更後
レスポンス内のパラメータ
「messages」の型が
string、arrayの2つが混在
「messages」の型をarrayに統一

5 事業所(Companies)

5-1 「PUT」パラメータの型を統一(C14)

パラメータ名変更前変更後
private_settlementリクエスト・レスポンスで型が異なるリクエスト・レスポンスともに「boolean」に統一
fiscal_years_attributesの
use_industry_template
製造業向け機能
リクエスト・レスポンスで型が異なるリクエスト・レスポンスともに「boolean」に統一
fiscal_years_attributesの
indirect_write_off_method
固定資産の控除法
リクエスト・レスポンスで型が異なるリクエスト・レスポンスともに「boolean」に統一
fiscal_years_attributesの
indirect_write_off_method_type
間接控除時の累計額
リクエスト・レスポンスで型が異なるリクエスト・レスポンスともに「boolean」に統一

5-2 PUT時のリクエスト、レスポンスのフォーマットを統一(C15)

変更前変更後
リクエスト、レスポンスでJSONのフォーマットが異なるリクエスト・レスポンスでJSONのフォーマットを統一

6 取引

6-1 POST、GET、PUTで「tax_id」 パラメーターの廃止(C20)

変更前変更後
  • POST、GET、PUTでtax_idを利用できる
  • GETでtax_idを参照できる
  • リクエスト時にtax_idが利用不可となる
  • レスポンスにtax_idは含まないようになる

7 連携サービス(Banks)

7-1 GETリクエスト時のパラメータ「type」指定方法の変更(C18)

変更前変更後
「type」を「bank_account」で
指定するとエラーが発生する。
「bank」に指定するとリクエストが成功する。
「type」を「bank_account」の指定に統一

8 試算表(Reports)

8-1  損益計算書の取得 (trial_pl) 時にフィルタが正しく動作する(C21)

変更前変更後
trial_plでパラメータaccount_item_display_type, breakdown_display_typeでgroupやaccount_itemを指定しても有効ではないtrial_plでパラメータaccount_item_display_type, breakdown_display_typeでgroupやaccount_itemを指定すると、意図した挙動となる

8-2 GET時に不要もしくは不明確な account_item_display_type パラメータの整理(C28)

8-2-1 BSとPLでaccount_item_display_typeを指定しない、あるいはaccount_itemを指定する場合
変更前変更後
以下のプロパティがレスポンスに入っている

 

  • category:勘定科目カテゴリ
    • account_category_id
    • parent_account_category_id
  • account_item:勘定科目
    • account_category_id
左記のプロパティ が削除される
8-2-2 BSとPLでaccount_item_display_typeにgroupを指定する場合
変更前変更後
以下のプロパティがレスポンスに入っている

 

  • category:勘定科目カテゴリ
    • account_category_id
    • parent_account_category_id
  • group:決算書表示
    • account_category_id
    • total_line
  • breakdown_display_type=account_itemの時:勘定科目
    • account_category_id
以下のプロパティを削除

 

  • category:勘定科目カテゴリ
    • account_category_id
    • parent_account_category_id
  • group:決算書表示
    • account_category_id
    • total_line
  • breakdown_display_type=account_itemの時
    • account_category_id

以下のプロパティを追加

  • group:決算書表示
    • aaccount_group_name

8−3損益計算書で部門比較(traial_pl_sections)取得時のレスポンスデータ変更(C29)

8-3-1 account_item_display_type= groupとbreakdown_display_type=account_itemを同時に指定した時
変更前変更後
  • balances.sections.account_items.idが常に0
  • balances.sections.account_items.nameが常に未選択
  • balances.sections.account_items.closing_balanceにbalances.sections.closing_balanceと同じ値が入っている
  • balances.sections.account_itemsはレスポンスでsectionsの中からsectionsと同じ階層に移動
8-3-2 account_item_display_type= groupとbreakdown_display_type=partnerを同時に指定した時
変更前変更後
  • closing_balanceがnullになっている
  • closing_balanceが0になる

9 その他

9-1 リクエストURL「*****.json」でのリクエスト廃止(C22)

変更前変更後
リクエストURLが「****.json」でAPIコールができるリクエストURLが「****.json」でAPIコールができない

9-2 400、404、500 時のレスポンスデータ統一(C16、C24)

変更前変更後
400、404、500エラーの場合、
返されるエラーメッセージのフォーマットが
Arrayの場合とStringの場合がある
Array に統一する

9−3 請求書などの部門指定で親階層の部門を指定不可に変更(C23)

変更前変更後
「Invoices 請求書」「Expense Applications 経費精算」などリクエスト送信時に、部門指定(section_id)で親階層の部門を指定できる部門指定(section_id)で親階層の部門を指定できなくなる

9−4 旧認可エンドポイントの廃止(C26)

変更前変更後
  • https://secure.freee.co.jp/oauth/token
  • https://secure.freee.co.jp/oauth/revoke
  • https://api.freee.co.jp/oauth/token
  • https://api.freee.co.jp/oauth/revoke
  • https://accounts.secure.freee.co.jp/
    public_api/token
  • https://accounts.secure.freee.co.jp/
    public_api/revoke

POSTメソッドを利用し、content typeはapplication/x-www-form-urlencoded を指定してください。

より詳細は、以下を確認してください。

  • https://developer.freee.co.jp/tutorials/getting-access-token

旧認可エンドポイントからの移行は、以下もご参照ください。

9-5 tags, Items へのGETリクエスト時に特定件数以上ではlimit,offset の指定が必要になる(C25)

変更前変更後
tags, items エンドポイントへのGETリクエスト時にlimit, offset不要で全件取得可50件以上の情報取得にはlimit, offsetの利用が必要

 

新仕様APIのバージョン指定方法

新仕様のAPIを試すには、APIコールの際にリクエストヘッダーにバージョン指定を行います。

請求書APIの新バージョンを試す際のAPIコールのサンプル(curl)

新仕様のAPIを指定する場合のリクエスト(現在公開されているものは指定不要)です。Google Apps Scriptなどをご利用いただいている場合は、このサンプルではなくリクエストヘッダーを指定する方法をご確認いただき、テストいただきますようお願いいたします。

curl -X GET 'https://api.freee.co.jp/api/1/invoices?company_id=xxxxxx&start_issue_date=2019-01-01&end_issue_date=2019-12-31' \
--header 'Authorization: Bearer xxxxxxxxxxx’\
--header 'X-Api-Version: 2020-06-15'

APIバージョン指定の有無による挙動

2020-06-15が新バージョンとなります

バージョン指定並行期間前並行期間中並行期間終了後
指定なし現行版現行版新バージョン
2020-06-15現行版新バージョン新バージョン
  • 指定なしの場合
    • 現行版を利用となり、並行期間終了時に新バージョンに切り替わる
      • 変更の影響を受けないアプリは指定の必要なし
  • 指定ありの場合
    • 並行期間開始後に新バージョンを意図的に利用できる
      • 移行テスト、動作確認にご利用ください

注記事項

2020年12月の新仕様の施行までに、変更箇所があった場合、改訂記録に記述の上、随時本URLのリリースノートにてご案内します。

改訂記録

  • 2020年12月17日(木)
  •  2020年11月5日(木)
    • 8 試算表(Reports)内の項目「8−2-1」を修正しました。
      • 修正前
        • 「BSとPLでaccount_item_display_typeにaccount_itemを指定する場合」
      • 修正後
        • 「BSとPLでaccount_item_display_typeを指定しない、あるいはaccount_itemを指定する場合」
  • 2020年5月28日(木)
    • リリースノート第1版を公開

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

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

日時:2020年5月28日(木)1:00-5:00

対象:全サービス

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

※定期メンテナンスの実施日が、5月22日→28日に変更となりました。ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。
(2020年5月20日 13:50 追記)

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

freee developer support

当サイトメンテナンスのお知らせ(5/14)

下記の日時に、当サイト「freee Developers Communty」のシステムメンテナンスを行います。

日時:2020年5月14日(木)16:30-17:30

メンテナンス時間中も、各ページ・リファレンスなどの閲覧は可能ですが、当サイトへのログイン および Community掲示板への投稿はできません。

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

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

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

日時:2020年4月22日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

【再掲】アプリの再認可必須化について

2020年8月20日から、freee API を利用したアプリの認可について、以下の通り仕様変更を行います。

  • アプリに対してScopeの再設定を伴う改修を行った場合、アプリユーザーは再度OAuthによる認可を行う必要がある

アプリ開発者の皆様は、下記の仕様変更をご確認いただき、開発済みのアプリに対して適宜修正を行っていただきますよう、よろしくお願いいたします。

仕様変更予定日:

2020年8月20日(木)

仕様変更内容:

freeeアプリストアのアプリ管理画面、権限設定で参照および更新するデータ種別を追加した場合、再認可処理が必要なタイミングで、APIから以下のレスポンスが返る

  • status:401
  • code:re_authorization_required
  • message:アプリのバージョンが更新されてデータアクセス範囲が追加されています。再度認可をしてください。

アプリユーザーは、利用中のアプリで再認可取得の操作を行う必要がある。

レスポンスデータサンプル

{
    "code": "re_authorization_required"
    "message": "アプリのバージョンが更新されてデータアクセス範囲が追加されています。再度認可をしてください。",
}

アプリの変更について:

アプリ開発者の皆様は、code に応じた処理の追加をご検討ください。

お手数をおかけしますが、何卒ご理解とご了承をいただきたく、よろしくお願い申し上げます。

2020年6月22日追記:
コードの要素名の修正およびレスポンスデータのサンプルを追記しました。

2020年8月18日追記:
反映日時を8月20日に修正しました。

2020年11月6日追記:
エラー時のコードとメッセージは以下を参照してください
https://developer.freee.co.jp/tips/faq/40x-checkpoint

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

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

当サイトメンテナンスのお知らせ

下記の日時に、当サイト「freee Developers Communty」のシステムメンテナンスを行います。

日時:2020年3月2日(月)16:00-17:00

メンテナンス時間中も、各ページ・リファレンスなどの閲覧は可能ですが、当サイトへのログイン および Community掲示板への投稿はできません。

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

「見積書API」リリース

会計freee APIに、新たに「見積書API」が追加されました。

今回のリリースにより、見積書の作成(POST)や一覧の取得(GET)、更新(PUT)、削除(DELETE)が可能となり、クラウド会計ソフトfreee(以下、会計freee)の見積書作成機能を外部サービスと連携して利用いただけます。

■見積書APIの操作一覧

■ご利用可能なプラン

見積書API (/quotations)は会計freeeの全プランでご利用可能です。

■旧見積書API(/docs)からの移行について

今回の新見積書API(/quotations)公開に伴い、旧見積書API(/docs)をご利用の上、アプリ作成をされている場合は新APIへの移行をご検討ください。

※請求書API(/invoices)について、近日、計画的な変更が入る予定があります。請求書APIの変更点は後日当サイトで告知予定です。旧見積書API(/docs)と請求書APIを同時に利用しているアプリは、後日の改修をご検討ください。

会計freee APIで発生した障害の報告とお詫び (2020/2/13)

2020年2月13日(木)、会計freee APIにおいて、”.json”拡張子をつけてAPIコールをした場合にエラーが起こる障害が発生しました。関係者の皆様にご迷惑をおかけしたことをお詫び申し上げます。

事象概要

2020年2月13日(木)17:00頃-22:00頃、会計freee の APIに”.json”拡張子をつけてリクエストした場合にエラーが発生しました。

例:

  • POST /api/1/deals.json
  • GET /api/1/companies.json
  • GET /api/1/items.json?company_id=ABCDE

影響範囲と内容

上記の発生時間中に上記条件でのAPIコールは常時エラー(http status code: 400/404)となり参照(GET)や登録(POST)が失敗しました。利用しているアプリケーションが正しく動作しなかった可能性があります。

今後は再発の防止に努め、安定してお客様へサービス提供を続けられるよう全社を挙げて取り組んで参ります。

何卒よろしくお願い申し上げます。

システムメンテナンスのお知らせ

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

日時:2020年2月27日(木)3:00-5:00

対象:全サービス

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

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

================================================
freee developer support

システムメンテナンスのお知らせ

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

日時:2020年2月14日(金)1:00-5:00

対象:全サービス

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

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

================================================
freee developer support

仕訳承認フローの機能変更に関する影響について

会計freeeにおいて、2020年1月中旬に仕訳承認フローの機能変更が実施されます。

本機能において、会計freeeの管理画面から、仕訳承認フローの使用可否を設定できるになりました。

会計freeeの管理画面から設定を変更しない限り、既存アプリへの影響はありませんが、
「仕訳承認フロー」を利用しているアプリ開発者様につきましては、本機能変更へのご対応をご検討いただければ幸いです。

仕様変更の理由:

会計freeeの機能改善のため

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

2020年1月中旬

影響範囲:

以下の条件が揃っている場合、承認フローが途中で止まる場合がある

  • エンタープライズプランを利用している
  • API経由で取引を作成しているアプリを利用している
  • 仕訳承認機能を利用している
  • 会計freeeの管理画面から、自己承認機能を「不可」に設定変更する

開発者の皆様にはお手数をおかけしますが、何卒ご理解とご了承をいただきたく、よろしくお願い申し上げます。

試算表レスポンスデータの分類名変更について

会計freee API の試算表のレスポンスデータについて、特定の条件でGETした場合の分類名に変更が行われます。開発者の皆様は、必要に応じてアプリの改修のご検討をお願い申し上げます。

仕様変更の理由:

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

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

2020年1月上旬

仕様変更の詳細:

試算表レスポンスデータの分類名変更

試算表データを取得するエンドポイント「/reports」に対して「account_item_display_type=group」を指定してGETした際、レスポンスデータに含まれている分類名の変更が行われます。

対象エンドポイントと条件:

/reports の下記エンドポイントに対して、勘定科目の表示を決算書表示名(小カテゴリー)とするためのパラメータ「account_item_display_type=group」を付与してGETリクエストを行なった場合、レスポンスデータに含まれる分類名が変更される

  • /reports/trial_bs
  • /reports/trial_bs_two_years
  • /reports/trial_bs_three_years

変更前のレスポンスデータ例:

{
    "trial_bs": {
        "company_id": "26",
        "fiscal_year": 2019,
        "account_item_display_type": "group",
        "breakdown_display_type": "account_item",
        "created_at": "2019-11-20T18:24:58+09:00",
        "balances": [
            {
                "account_category_id": 36,
                "account_category_name": "現金・預金",
                "total_line": true,
                "hierarchy_level": 3,
                "opening_balance": 0,
                "debit_amount": 77981000,
                "credit_amount": 42076000,
                "closing_balance": 35905000,
                "composition_ratio": 93.55
            },

変更後のレスポンスデータ例:

{
    "trial_bs": {
        "company_id": "26",
        "fiscal_year": 2019,
        "account_item_display_type": "group",
        "breakdown_display_type": "account_item",
        "created_at": "2019-11-20T18:24:58+09:00",
        "balances": [
            {
                "account_category_id": 36,
                "account_category_name": "現金及び預金",
                "total_line": true,
                "hierarchy_level": 3,
                "opening_balance": 0,
                "debit_amount": 77981000,
                "credit_amount": 42076000,
                "closing_balance": 35905000,
                "composition_ratio": 93.55
            },

アプリの変更について:

開発中のアプリが、「/reports」の各種エンドポイントに対して、「account_item_display_type=group」を付与したGETリクエストを行なっており、分類名に関する処理を行なっている場合は、必要に応じて改修のご検討をお願いいたします。

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

freee developer support