All posts by ShuheiMuto

【重要】freee会計APIの仕様変更(インボイス制度対応)について

(2023/3/10追記:インボイス対応関する最新情報は今後、以下のお知らせをご確認ください。
https://developer.freee.co.jp/news/6369

2023年10月に開始予定のインボイス制度への対応として、freee会計APIの仕様変更を予定しています。

変更点は大きく分けて5つあり、アプリの挙動に大きな影響がある変更(破壊的変更)が2点含まれます。
freee会計APIをご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

1.請求書API・見積書APIのfreee請求書への移行(破壊的変更)

変更内容:

「freee請求書」リリースに伴い、「freee会計」APIの「請求書(invoices)」および「見積書(quotations)」は廃止され、「freee請求書」APIの「請求書」「見積書」「帳票テンプレート」へ移行し、インボイス制度対応についても「freee請求書」APIのみで対応されます。
詳細につきましては後日改めてお知らせいたします。

対象エンドポイント:

廃止

  • 請求書(invoices)
    • DELETE /api/1/invoices/{id}:請求書の削除
    • GET /api/1/invoices:請求書一覧の取得
    • GET /api/1/invoices/{id}:請求書の取得
    • POST /api/1/invoices:請求書の作成
    • PUT /api/1/invoices/{id}:請求書の更新
  • 見積書(quotations)
    • DELETE /api/1/quotations/{id}:見積書の削除
    • GET /api/1/quotations:見積書一覧の取得
    • GET /api/1/quotations/{id}:見積書の取得
    • POST /api/1/quotations:見積書の作成
    • PUT /api/1/quotations/{id}:見積書の更新

新設(「freee請求書API」としてリリース)

  • 請求書
  • 見積書
  • 帳票テンプレート

変更の実施予定時期:

2023年4月:freee請求書API「請求書」「見積書」「帳票テンプレート」リリース
2023年10月:freee会計API「請求書」「見積書」の新規作成(POST)廃止
時期未定:freee会計API「請求書」「見積書」の更新・削除(PUT, DELETE)廃止
時期未定:freee会計API「請求書」「見積書」の取得(GET)廃止


2.経費精算APIの仕様変更(破壊的変更)

変更内容:

経費精算APIに仕様変更が発生します。
詳細につきましては後日改めてお知らせいたします。

対象エンドポイント:

  • 経費精算(expense applications)

変更の実施予定時期:

2023年7月:freee会計API「経費精算」登録・更新・取得(POST,PUT, GET) インボイス対応仕様での利用開始
2023年10月以降:freee会計API「経費精算」登録・更新・取得(POST,PUT, GET) 旧仕様の廃止


3.インボイス制度関連項目の追加

変更内容:

インボイス制度対応に必要な下記項目が関連APIに追加されます。

  • 適格請求書発行事業者の登録番号
  • 適格請求書発行事業者か否かのステータス
  • 書類の種類(ファイルボックスAPIのみ)

対象エンドポイント:

  • 取引先(partners)
    • GET /api/1/partners:取引先一覧の取得
    • GET /api/1/partners/{id}:取引先の取得
    • POST /api/1/partners:取引先の作成
    • PUT /api/1/partners/{id}:取引先の更新
    • PUT /api/1/partners/code/{code}:取引先の更新
  • ファイルボックス(receipts)
    • GET /api/1/receipts:ファイルボックス 証憑ファイル一覧の取得
    • GET /api/1/receipts/{id}:ファイルボックス 証憑ファイルの取得
    • POST /api/1/receipts:ファイルボックス 証憑ファイルアップロード
    • PUT /api/1/receipts/{id}: ファイルボックス 証憑ファイル情報更新

変更の実施予定時期:

2023年4月


4.新規税区分の追加

変更内容:

インボイス制度対応に伴い新たに48件の税区分および8件の税区分カテゴリが追加され、関連エンドポイントで利用可能になります。

対象エンドポイント:

税区分

  • 税区分(taxes)
    • GET /api/1/taxes/codes 税区分コード一覧の取得
    • GET /api/1/taxes/codes/{code} 税区分コードの取得
    • GET /api/1/taxes/companies/{company_id} 税区分コード詳細一覧の取得
  • 事業所(companies)
    • GET /api/1/companies/{id}: 事業所の詳細情報の取得
  • 取引(deals)
    • GET /api/1/deals:取引(収入/支出)一覧の取得
    • GET /api/1/deals/{id}:取引(収入/支出)の取得
    • POST /api/1/deals:取引(収入/支出)の作成
    • PUT /api/1/deals/{id}:取引(収入/支出)の更新
  • 仕訳帳(journals)
    • GET /api/1/journals/reports/{id}/download:ダウンロード実行
  • 振替伝票(manual journals)
    • GET /api/1/manual_journals 振替伝票一覧の取得
    • GET /api/1/manual_journals/{id} 振替伝票の取得
    • POST /api/1/manual_journals 振替伝票の作成
    • PUT /api/1/manual_journals/{id} 振替伝票の更新
  • 取引の+更新(renews)
    • POST /api/1/deals/{id}/renews:取引(収入/支出)に対する+更新の作成
    • PUT /api/1/deals/{id}/renews/{renew_id}:取引(収入/支出)の+更新の更新
  • フォーム用選択項目(selectables)
    • GET /api/1/forms/selectables フォーム用選択項目情報の取得

税区分カテゴリ

  • 税区分(taxes)
    • GET /api/1/taxes/codes 税区分コード一覧の取得
    • GET /api/1/taxes/codes/{code} 税区分コードの取得
    • GET /api/1/taxes/companies/{company_id} 税区分コード詳細一覧の取得

変更の実施予定時期:

2023年7月


5.支払依頼APIの仕様変更

変更内容:

支払依頼APIに仕様変更が発生します。
詳細につきましては後日改めてお知らせいたします。

対象エンドポイント:

  • 支払依頼(payment requests)

変更の実施予定時期:

2023年7月

(2023/3/10追記:インボイス対応関する最新情報は今後、以下のお知らせをご確認ください。
https://developer.freee.co.jp/news/6369

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

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

日時:2022年12月14日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

システムメンテナンス(11/29) のお知らせ

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

日時:2022年11月29日(火)1:00-5:00

対象:全サービス

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

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

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

freee developer support

「フォーム用選択項目情報の取得」に「tax_code」に関連する項目が追加されました

フォーム用選択項目情報の取得(GET /api/1/forms/selectables)について、「tax_code(税区分コード)」に関連する項目の追加がリリースされ、利用可能になりました。
利用方法については下記リファレンスページをご確認ください。
https://developer.freee.co.jp/reference/accounting/reference#/Selectables/get_forms_selectables

なお、本リリースは先日配信いたしました告知(https://developer.freee.co.jp/news/5981)の「変更の詳細③」に関連するリリースです。

システムメンテナンス(10/27) のお知らせ

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

日時:2022年10月27日(木)1:00-5:00

対象:全サービス

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

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

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

freee developer support

freee会計APIの仕様変更について

下記の通り、freee会計APIの仕様変更を予定しています。
freee会計APIをご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更内容:

口座に紐づく勘定科目※を更新する際、name(勘定科目名)を指定できなくなり、指定した場合エラーとなります。
この変更に伴い、name(勘定科目名)は任意項目となりますが、口座に紐づかない勘定科目を更新する場合は引き続きname(勘定科目名)の指定が必要です。

口座に紐づく勘定科目の名称を変更したい場合は、口座の更新(PUT /api/1/walletables/{type}/{id})で口座名を更新することで勘定科目名にも変更が反映されます。

※walletables(口座)を作成した際に自動的に生成される勘定科目を指します。

対象エンドポイント:

  • PUT /api/1/account_items/{id}:勘定科目の更新

変更理由:

freee会計のWeb画面とギャップがあり、データ不整合が発生する恐れがあるため

変更の実施予定時期:

2022年10月末ごろ

freee会計APIの仕様変更について

[2022-10-13更新]
告知事項の追加に伴い、「変更の詳細②」「変更の詳細③」を追記いたしました。
以前から告知している内容については「変更の詳細①」とタイトルを改めました。


下記の通り、freee会計APIの仕様変更を予定しています。
freee会計APIをご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の詳細①:

勘定科目一覧または事業所の詳細情報を取得した際のレスポンス項目から「tax_id(税区分ID)」に関連する項目が削除されます。

なお、freeeにおける税区分は「tax_code(税区分コード)」に移行しており、「tax_id(税区分ID)」は過去の変更により他のエンドポイントではすでに使用できなくなっているため、実質的な影響はありません。

対象のエンドポイントと削除される項目:

  • GET /api/1/account_items:勘定科目一覧の取得
    • default_tax_id(デフォルト設定がされている税区分ID)
  • GET /api/1/companies/{id}:事業所の詳細情報の取得
    • default_tax_id(デフォルト設定がされている税区分ID)
    • taxes.id(税区分ID)
    • taxes.name(税区分名)

変更の理由:

廃止された項目を削除するため

変更の実施予定時期:

2022年10月


変更の詳細②:

勘定科目の詳細情報を取得した際のレスポンス項目から「tax_id(税区分ID)」に関連する項目が削除されます(すでにリファレンスからは削除されておりますが実際には返却されており、仕様通りに修正するための変更です)。
なお、freeeにおける税区分は「tax_code(税区分コード)」に移行しており、「tax_id(税区分ID)」は過去の変更により他のエンドポイントではすでに使用できなくなっているため、実質的な影響はありません。

対象のエンドポイントと削除される項目:

  • GET /api/1/account_items/{id}:勘定科目の詳細情報の取得
    • default_tax_id(デフォルト設定がされている税区分ID)

変更の理由:

廃止された項目「tax_id(税区分ID)」を削除するため

変更の実施予定時期:

2022年10月


変更の詳細③:

フォーム用選択項目情報を取得した際のレスポンス項目から「tax_id(税区分ID)」に関連する項目が削除され、「tax_code(税区分コード)」に関連する項目が追加されます。

対象のエンドポイントと削除・追加される項目:

  • GET /api/1/forms/selectables:フォーム用選択項目情報の取得
    • [削除] account_categories.account_items.default_tax.tax_rate_5.id(税区分ID)
    • [削除] account_categories.account_items.default_tax.tax_rate_8.id(税区分ID)
    • [追加] account_categories.account_items.default_tax.tax_rate_5.code(税区分コード)
    • [追加] account_categories.account_items.default_tax.tax_rate_8.code(税区分コード)
    • [追加] account_categories.account_items.default_tax.tax_rate_10.code(税区分コード)
    • [追加] account_categories.account_items.default_tax.tax_rate_r8.code(税区分コード)

変更の理由:

使用されていない項目「tax_id(税区分ID)」を削除し、「tax_code(税区分コード)」への移行を行うため

変更の実施予定時期:

2022年12月
※「tax_code(税区分コード)」の追加に関しては2022年10月中を予定しており、リリース後に改めてお知らせいたします。

[復旧済]freee会計APIで一部の見積書・請求書を取得できない状況です

[2022年9月7日 17:00更新]

影響範囲の詳細について確認が取れたため、以下に記載いたします。

なお、影響を受けた可能性のあるアプリのオーナーさまには個別にご案内いたします。

見積書:

請求書の承認機能が有効になっている事業所について、ステータスが送付待ち(quotation_status = unsubmitted)の見積書の一部が取得できない状態が発生していました。

対象エンドポイント:GET /api/1/quotations(見積書一覧の取得)

対象期間:2022年8月25日 15:39 〜 2022年9月6日 21:45

請求書:

請求書の承認機能が有効になっている事業所について、ステータスが下書き(invoice_status = draft)の請求書の全てが取得できない状態が発生していました。

対象エンドポイント:GET /api/1/invoices(請求書一覧の取得)

対象期間:2022年8月25日 16:15 〜 2022年9月6日 21:45


[2022年9月7日 9:00更新]

本事象について、2022年9月6日 21:45頃に復旧対応が完了し、現在は解消しております。


本日16時30分頃より、freee会計APIで一部の見積書・請求書を取得できない状況が発生しております。

現在、復旧に向けた対応を行っております。

ご迷惑をおかけし、大変申し訳ございません。

見積書:

見積書一覧の取得API(GET /api/1/quotations)でステータスが送付待ち(quotation_status = unsubmitted)の見積書の一部が取得できません。

請求書:

請求書一覧の取得API(GET /api/1/invoices)でステータスが下書き(invoice_status = draft)の請求書の全てが取得できません。

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

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

日時:2022年8月24日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

[復旧済] APIリファレンスの表示が不安定な状況です

本事象について、現在は安定的な稼働状況に戻っていることを確認しております。
ご迷惑をおかけし、大変申し訳ございませんでした。
引き続き、よろしくお願い申し上げます。[2022年8月3日15時30分更新]

本日13時30分頃より、freeeAPIリファレンスの表示が不安定な状況が確認されており、現在対応を行っております。

ご迷惑をおかけし、大変申し訳ございません。

freee会計APIの仕様変更について

下記の通り、freee会計APIの仕様変更を予定しています。
freee会計APIをご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の概要:

現預金カテゴリに属する勘定科目※が明細行に存在する取引および振替伝票について、以下に記載する特定の条件を満たす操作ができなくなります。
実行した場合、エラーとなります。(HTTPステータスコード:400)
なお、すでに特定の条件を満たす操作によって作成された取引を更新する場合にも適用されるため、対象となる取引の更新が必要な場合は取引の作り直しが必要となります。

※「現金・預金」の勘定科目カテゴリに属する勘定科目を指します。勘定科目カテゴリIDは下記の通りです。

  • 法人事業所の場合:account_category_id = 36
  • 個人事業所の場合:account_category_id = 19

変更の詳細①:

決済状況が未決済※となる取引の作成・更新ができなくなります。

※取引の支払行(payments)が未指定、または取引の支払行(payments)の金額の合計が取引の明細行(details)の合計金額より少ない(部分入金)場合

対象エンドポイント:

  • POST /api/1/deals
  • PUT /api/1/deals

変更の詳細②:

以下のいずれかの条件を満たす取引・+更新・振替伝票の作成・更新ができなくなります。

  • 以下の条件を満たす明細を1件以上含む
    • 税区分 ≠ ‘対象外’, ‘未選択’, ‘不課税’
  • 以下の条件を満たす明細を1件以上含む
    • 税額 ≠ 0

対象エンドポイント:

  • POST /api/1/deals
  • PUT /api/1/deals
  • POST /api/1/deals/{id}/renews
  • PUT /api/1/deals/{id}/renews
  • POST /api/1/manual_journals
  • PUT /api/1/manual_journals

変更の詳細③:

取引の支払行(payments)の金額の合計が取引の明細行(details)の合計金額より少なくなるような取引の支払行の更新・削除ができなくなります。

対象エンドポイント:

  • PUT /api/1/deals/{id}/payments/{payment_id}
  • DELETE /api/1/deals/{id}/payments/{payment_id}

変更の理由:

会計データとして不正な現預金系取引の作成防止のため

変更の実施予定時期:

2022年9月

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

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

日時:2022年7月27日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

freee会計APIの仕様変更について

下記の通り、freee会計APIの仕様変更を予定しています。

freee会計APIをご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の詳細:

事業所の設定で請求書が承認制になっており、かつ請求書のステータス(invoice_status)が「draft(下書き)」の場合、請求書の作成者以外のユーザーが請求書を取得・更新・削除できなくなります。

一覧取得の場合は、条件に該当する請求書は取得結果に含まれなくなります。
IDを指定して取得・更新・削除する場合は、エラーとなります(HTTPステータスコード:400)。

対象エンドポイント:

  • GET /api/1/invoices:請求書一覧の取得
  • GET /api/1/invoices/{id}:請求書の取得
  • PUT /api/1/invoices/{id}:請求書の更新
  • DELETE /api/1/invoices/{id}:請求書の削除

変更の理由:

freee会計Web画面の仕様変更によるもの。
参考:見積書・納品書・請求書・発注書作成を承認制にする

変更の実施予定時期:

2022年8月

freee会計APIの仕様変更について

下記の通り、freee会計APIの仕様変更を予定しています。
freee会計APIをご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の詳細:

取引に対する+更新時に、+更新対象の取引明細行の備考欄が、+更新により作成する取引明細行の備考欄にコピーされなくなります。

例えば、以下のような仕訳の前受金に対して売上高で+更新を行った場合

現金(備考:なし)前受金(備考:手付金)

今までは以下のように前受金行の備考がコピーされていました。

現金(備考:なし)前受金(備考:手付金)
前受金(備考:手付金売上高(備考:なし)

今後は以下のように前受金行の備考がコピーされなくなります。

現金(備考:なし)前受金(備考:手付金)
前受金(備考:なし売上高(備考:なし)

対象のエンドポイント:

  • POST /api/1/deals/{id}/renews:取引(収入/支出)に対する+更新の作成

変更の理由:

freee会計Web画面の仕様変更によるもの。

変更の実施予定時期:

2022年7月中旬

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

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

日時:2022年6月23日(木)1:00-5:00

対象:全サービス

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

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

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

freee developer support

【重要】freeeプロジェクト管理APIの仕様変更について

下記の通り、freeeプロジェクト管理APIの仕様変更を予定しています。
ご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の詳細:

工数登録時のリクエストパラメータ「工数タグID(workload_tags.tag_id)」が必須項目になります。

変更の理由:

freeeプロジェクト管理Web画面との仕様ギャップを無くすため。

変更の実施予定時期:

2022年7月11日

[2022年7月11日追記]
本仕様変更は、都合により延期させていただくことになりました。
延期後のリリース時期は決定次第ご案内させていただきます。

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

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

日時:2022年6月9日(木)1:00-5:00

対象:全サービス

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

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

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

freee developer support

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

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

日時:2022年5月26日(木)1:00-5:00

対象:全サービス

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

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

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

freee developer support

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

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

日時:2021年11月17日(水)1:00-5:00

対象:全サービス

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

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

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

freee developer support

[復旧済] freeeAPIの動作が不安定な状況です

本事象について、現在は復旧対応が完了しており、安定的な稼働状況に戻っていることを確認しております。
ご迷惑をおかけし、大変申し訳ございませんでした。
引き続き、よろしくお願い申し上げます。[2021年11月9日9時15分更新]

本事象について、17時22分より安定的な稼働状況に戻っていることを確認しております。
また、念の為稼働状況のモニタリングを続けております。ご迷惑をおかけし大変申し訳ございません。[2021年11月8日19時30分更新]

本日16時22分頃より、freeeAPIの動作が不安定な状況が確認されており、現在、復旧に向けた対応を行っております。

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