下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年7月14日(火)1:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。
================================================
freee developer support
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年7月14日(火)1:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。
================================================
freee developer support
既にリリースされている経費精算のワークフローAPIに加え、新たに各種申請のワークフローAPIをリリースしました。
今回のリリースにより、各種申請の作成(POST)や取得(GET)、更新(PUT)、削除(DELETEおよび申請に対する承認操作が可能となり、クラウド会計ソフトfreee(以下、会計freee)の各種申請機能を外部サービスと連携してご利用いただけます。
ワークフローAPIは、購買申請・稟議などの各種申請に関わるワークフローを自由に構築できる機能です。ワークフローAPIにより会計freeeの各種申請機能と外部サービスを連携することで、各種申請の申請や承認、差戻し、却下を普段使っているコミュニケーションツールやグループウェア上で行うことができます。
ワークフローAPIは、以下の会計freeeのプランでご利用可能です。
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年6月17日(水)1:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。
================================================
freee developer support
2020年12月に、下記に記述した会計freeeのAPIの仕様変更を実施します。
仕様変更に先立ちまして、2020年6月より、新仕様のAPIを提供します。
リクエストヘッダーにAPIのバージョン
X-Api-Version: 2020-06-15
を指定することで、新仕様のAPIが利用可能となります。
APIのバージョン指定をせずにリクエストを行った場合、12月に新仕様のAPIに自動的に切り替わります。詳しくは、本ページ下部のサンプルコードをご覧ください。
開発者の皆さまは、変更内容をご確認の上、アプリの改修計画など、適宜対応のご検討をお願い対します。
(2020/12/17追記)
仕様変更に伴うQ&Aを公開しました。ご不明な点がある場合、一度お目通しください。
※今回の仕様変更の影響を受けないアプリについては、改修の必要はありません。
2020年12月中旬
パラメータ名 | 変更前 | 変更後 |
---|---|---|
支出取引相手勘定科目 | 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(=数値)で指定 |
POST、PUT リクエスト送信時に指定が可能
パラメータ名 | 変更前 | 変更後 |
減価償却累計額勘定科目 | accumulated_dep_account_item_name 名前(=文字列)で指定 | accumulated_dep_account_item_id ID(=数値)で指定 |
GET、POST、 PUTのレスポンスから不要となるパラメータを削除
パラメータ名 | 変更前 | 変更後 |
支出取引相手勘定科目種別 収入取引相手勘定科目種別 | corresponding_type_expense corresponding_type_income | 利用しないため削除 |
POST、PUT リクエスト送信時の指定方法およびレスポンスが変更
変更前 | 変更後 |
パートナー名に関するパラメータの必須指定はない |
|
POST, PUTリクエスト送信時、これまでは任意だったものが必須となる
変更前 | 変更後 |
partner_title 任意 | partner_title 設定が必須 |
POST, PUTリクエスト送信時、グループ権限で利用できる部門を絞ることが可能となる
変更前 | 変更後 |
グループ権限で特定のユーザーが利用できない部門のタグがついた取引の請求書でも、API経由で取得、更新、削除ができる | グループ管理で利用可能となっていない部門のタグを指定している場合、請求書の取得、更新、削除ができない |
GETリクエスト送信時の期間指定用パラメータが変更になる
変更前 | 変更後 |
以下のパラメータで期間指定
期日の開始日と終了日
| 以下のパラメータで期間指定
期日の開始日と終了日パラメータが変わる
|
GETリクエスト送信時、およびレスポンスが変更
変更前 | 変更後 |
invoice_status を見ると 送付待ち・送付済み関わらず、以下になる
| invoice_status が送付済みの時に以下になる
invoice_status が送付待ちの時に以下になる
|
変更前 | 変更後 |
GETとPOSTでレスポンスフォーマットが異なる | GETとPOSTのレスポンス共にフォーマットが統一される |
変更前 | 変更後 |
レスポンス内のパラメータ 「messages」の型が string、arrayの2つが混在 | 「messages」の型をarrayに統一 |
パラメータ名 | 変更前 | 変更後 |
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」に統一 |
変更前 | 変更後 |
リクエスト、レスポンスでJSONのフォーマットが異なる | リクエスト・レスポンスでJSONのフォーマットを統一 |
変更前 | 変更後 |
|
|
変更前 | 変更後 |
「type」を「bank_account」で 指定するとエラーが発生する。 「bank」に指定するとリクエストが成功する。 | 「type」を「bank_account」の指定に統一 |
変更前 | 変更後 |
trial_plでパラメータaccount_item_display_type, breakdown_display_typeでgroupやaccount_itemを指定しても有効ではない | trial_plでパラメータaccount_item_display_type, breakdown_display_typeでgroupやaccount_itemを指定すると、意図した挙動となる |
変更前 | 変更後 |
以下のプロパティがレスポンスに入っている
| 左記のプロパティ が削除される |
変更前 | 変更後 |
以下のプロパティがレスポンスに入っている
| 以下のプロパティを削除
以下のプロパティを追加
|
変更前 | 変更後 |
|
|
変更前 | 変更後 |
|
|
変更前 | 変更後 |
リクエストURLが「****.json」でAPIコールができる | リクエストURLが「****.json」でAPIコールができない |
変更前 | 変更後 |
400、404、500エラーの場合、 返されるエラーメッセージのフォーマットが Arrayの場合とStringの場合がある | Array に統一する |
変更前 | 変更後 |
「Invoices 請求書」「Expense Applications 経費精算」などリクエスト送信時に、部門指定(section_id)で親階層の部門を指定できる | 部門指定(section_id)で親階層の部門を指定できなくなる |
変更前 | 変更後 |
|
POSTメソッドを利用し、content typeはapplication/x-www-form-urlencoded を指定してください。 より詳細は、以下を確認してください。
旧認可エンドポイントからの移行は、以下もご参照ください。 |
変更前 | 変更後 |
tags, items エンドポイントへのGETリクエスト時にlimit, offset不要で全件取得可 | 50件以上の情報取得にはlimit, offsetの利用が必要 |
新仕様のAPIを試すには、APIコールの際にリクエストヘッダーにバージョン指定を行います。
新仕様の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'
2020-06-15が新バージョンとなります
バージョン指定 | 並行期間前 | 並行期間中 | 並行期間終了後 |
指定なし | 現行版 | 現行版 | 新バージョン |
2020-06-15 | 現行版 | 新バージョン | 新バージョン |
2020年12月の新仕様の施行までに、変更箇所があった場合、改訂記録に記述の上、随時本URLのリリースノートにてご案内します。
2020年5月25日(月)16:00頃ー20:01 にかけて、会計freee APIの一部機能が不安定となる事象が発生しました。
ご利用者の皆様にご迷惑をおかけしたことを深くお詫び申し上げます。
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年5月28日(木)1:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
※定期メンテナンスの実施日が、5月22日→28日に変更となりました。ご迷惑をおかけしますが、ご理解の程よろしくお願いいたします。
(2020年5月20日 13:50 追記)
================================================
freee developer support
下記の日時に、当サイト「freee Developers Communty」のシステムメンテナンスを行います。
日時:2020年5月14日(木)16:30-17:30
メンテナンス時間中も、各ページ・リファレンスなどの閲覧は可能ですが、当サイトへのログイン および Community掲示板への投稿はできません。
ご迷惑をおかけしますが、よろしくお願いいたします。
2020年8月20日から、freee API を利用したアプリの認可について、以下の通り仕様変更を行います。
アプリ開発者の皆様は、下記の仕様変更をご確認いただき、開発済みのアプリに対して適宜修正を行っていただきますよう、よろしくお願いいたします。
2020年8月20日(木)
freeeアプリストアのアプリ管理画面、権限設定で参照および更新するデータ種別を追加した場合、再認可処理が必要なタイミングで、APIから以下のレスポンスが返る
アプリユーザーは、利用中のアプリで再認可取得の操作を行う必要がある。
{
"code": "re_authorization_required"
"message": "アプリのバージョンが更新されてデータアクセス範囲が追加されています。再度認可をしてください。",
}
アプリ開発者の皆様は、code に応じた処理の追加をご検討ください。
お手数をおかけしますが、何卒ご理解とご了承をいただきたく、よろしくお願い申し上げます。
2020年6月22日追記:
コードの要素名の修正およびレスポンスデータのサンプルを追記しました。
2020年8月18日追記:
反映日時を8月20日に修正しました。
2020年11月6日追記:
エラー時のコードとメッセージは以下を参照してください
https://developer.freee.co.jp/reference/faq/40x-checkpoint
================================================
freee developer support <dev-support@freee.co.jp>
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年4月22日(水)1:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。
================================================
freee developer support
会計freee APIに、新たに「見積書API」が追加されました。
今回のリリースにより、見積書の作成(POST)や一覧の取得(GET)、更新(PUT)、削除(DELETE)が可能となり、クラウド会計ソフトfreee(以下、会計freee)の見積書作成機能を外部サービスと連携して利用いただけます。
見積書API (/quotations)は会計freeeの全プランでご利用可能です。
今回の新見積書API(/quotations)公開に伴い、旧見積書API(/docs)をご利用の上、アプリ作成をされている場合は新APIへの移行をご検討ください。
※請求書API(/invoices)について、近日、計画的な変更が入る予定があります。請求書APIの変更点は後日当サイトで告知予定です。旧見積書API(/docs)と請求書APIを同時に利用しているアプリは、後日の改修をご検討ください。
下記の日時に、当サイト「freee Developers Communty」のシステムメンテナンスを行います。
日時:2020年3月2日(月)16:00-17:00
メンテナンス時間中も、各ページ・リファレンスなどの閲覧は可能ですが、当サイトへのログイン および Community掲示板への投稿はできません。
ご迷惑をおかけしますが、よろしくお願いいたします。
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年2月27日(木)3:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。
================================================
freee developer support
2020年2月13日(木)、会計freee APIにおいて、”.json”拡張子をつけてAPIコールをした場合にエラーが起こる障害が発生しました。関係者の皆様にご迷惑をおかけしたことをお詫び申し上げます。
2020年2月13日(木)17:00頃-22:00頃、会計freee の APIに”.json”拡張子をつけてリクエストした場合にエラーが発生しました。
例:
上記の発生時間中に上記条件でのAPIコールは常時エラー(http status code: 400/404)となり参照(GET)や登録(POST)が失敗しました。利用しているアプリケーションが正しく動作しなかった可能性があります。
今後は再発の防止に努め、安定してお客様へサービス提供を続けられるよう全社を挙げて取り組んで参ります。
何卒よろしくお願い申し上げます。
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年2月14日(金)1:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。
================================================
freee developer support
会計freeeにおいて、2020年1月中旬に仕訳承認フローの機能変更が実施されます。
本機能において、会計freeeの管理画面から、仕訳承認フローの使用可否を設定できるになりました。
会計freeeの管理画面から設定を変更しない限り、既存アプリへの影響はありませんが、
「仕訳承認フロー」を利用しているアプリ開発者様につきましては、本機能変更へのご対応をご検討いただければ幸いです。
会計freeeの機能改善のため
2020年1月中旬
以下の条件が揃っている場合、承認フローが途中で止まる場合がある
開発者の皆様にはお手数をおかけしますが、何卒ご理解とご了承をいただきたく、よろしくお願い申し上げます。
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
日時:2020年1月23日(木)1:00-5:00
対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。
================================================
freee developer support
会計freee API の試算表のレスポンスデータについて、特定の条件でGETした場合の分類名に変更が行われます。開発者の皆様は、必要に応じてアプリの改修のご検討をお願い申し上げます。
会計freeeの機能改善を行うため。
2020年1月上旬
試算表データを取得するエンドポイント「/reports」に対して「account_item_display_type=group」を指定してGETした際、レスポンスデータに含まれている分類名の変更が行われます。
/reports の下記エンドポイントに対して、勘定科目の表示を決算書表示名(小カテゴリー)とするためのパラメータ「account_item_display_type=group」を付与してGETリクエストを行なった場合、レスポンスデータに含まれる分類名が変更される
{
"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