今回の機能追加によりAPIからデータ操作(作成・更新・削除)できる範囲が広がり、freee APIを活用した様々な種類のアプリケーションの作成が可能となります。
■API method対応表
☆印:今回の追加 緑印:既存の機能
■新たに可能となる操作一覧
freee オープンプラットフォーム戦略の一環として、日本で初めて会計システムにおけるAPI開発者向けのSDKをリリースしました。
第一弾としてC#、Java版の「会計freee C# SDK」「会計freee Java SDK」をリリースいたします。
SDKはクラウド会計ソフトfreeeとシステム連携を検討いただいている開発会社、協業をご検討いただいている事業会社の皆様にご利用いただけます。
各SDKの詳細については、GitHubに公開されているレポジトリ をご参照ください。
■公開SDKについて
SDK:
- 会計freee C# SDK
- https://github.com/freee/freee-accounting-sdk-csharp/
- 会計freee Java SDK
- https://github.com/freee/freee-accounting-sdk-java/
■実行環境
会計 freee C# SDK
- .NET Core 2.2 以上
- Visual Studio Code
会計freee Java SDK
Java SDKをお持ちでない方は適宜インストールを実行してください
※SDKのご利用には、会計freeeのアカウントがfreeeアプリストアへのアプリケーション登録で必要となります
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
- 日時:2019年10月24日(木)1:00-5:00
- 対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。
================================================
freee developer support
2019/10/1から、人事労務freeeのプランが
新体系になりました。
これに伴い、人事労務freeeの1ヶ月の試用期間を終えて契約がない場合、一部のエンドポイントからデータが取得できなくなります。
影響があるエンドポイント:
給与明細のGET、勤怠のGET、勤怠のPUTのエンドポイント
- /salaries/employee_payroll_statements
- /salaries/employee_payroll_statements/{employee_id}
- /employees/{emp_id}/work_records/{date}
- /employees/{emp_id}/work_records/{date}
変更内容:
人事労務freeeをご契約後、1ヶ月の試用期間を経過してもご入金がない場合、データ取得ができない。
試用期間が経過した方は、この機会に有償プランへの変更をご検討くださいますよう、よろしくお願いいたします。
2019/9/30の21:10-21:34、および10/01の0:40-02:08、人事労務freeeAPIへ接続できない事象が発生しました。
現在は復旧対応が完了しており、全ての機能をご利用いただけます。
APIご利用の皆様に多大なご迷惑をおかけしましたことをお詫び申し上げます。再発防止の対策を進めてまいりますので、ご容赦賜りますようお願い申し上げます。
2019年11月中旬以降に、会計freeeの請求書APIに関わるエンドポイントに対して、仕様変更が行われます。請求書APIを利用したアプリ開発者の皆様は、変更点をご確認いただき、アプリプログラムの改修をご検討ください。
仕様変更の理由:
会計freeeの機能改善を行うため。
仕様変更リリース予定日:
2019年11月中旬以降
影響範囲:
請求書発行のエンドポイント
- /invoices
- /docs
- /partners
を利用したアプリの一部に対して影響が発生します。
仕様変更内容:
1 請求書作成時に、[partner_id] もしくは [partner_code] が必須となります。
これまでは、[partner_id]/[partner_code] がなくても請求書発行の操作が可能でした。改修後は、[partner_id] もしくは [partner_code] が必須パラメーターになります。
2 請求書に記載する取引先を事前に作成する必要があります
これまでは請求書作成時に取引先情報を入れて請求書と取引先を同時に登録できました。
改修後は、事前に partner API から取引先と [partner_id] を作成後、[partner_id]/[partner_code] を利用して請求書を作成する必要があります。
3 取引先の情報を更新した際、必要に応じて請求書の取引先情報も更新ください。
アプリの変更について:
- 請求書関連のエンドポイント
に対して、POSTメソッドをリクエストしているアプリは、[partner_id] もしくは [partner_code] を付与するように変更をお願いいたします。
2. 取引先関連のエンドポイント
に対してPUTによる情報更新を行った後、必要に応じて請求書の取引先情報を更新してください。
いつまでに対処すれば良いのか:
freeeの仕様変更は、2019年11月中旬以降に仕様変更予定となっています。このため、上記エンドポイントを利用するアプリは、2019年11月初旬までにご対応ください。
開発者の皆様にはお手数をおかけしますが、何卒ご理解とご了承をいただきたく、よろしくお願い申し上げます。
(2019年10月25日追記:必須パラメーターを[partner_id] [partner_code] のいずれか、と修正しました。)
下記の日時に、freeeの各サービスでシステムメンテナンスを行います。
- 日時:2019年9月26日(木)1:00-5:00
- 対象:全サービス
メンテナンス中は該当サービスをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。
================================================
freee developer support
会計freeeAPIでのエラーメッセージの具体化とエラーコードの最適化についてご連絡いたします。
概要
今までのエラーメッセージでは判別できなかった、アプリの権限設定の問題、ユーザーの権限の問題が判別できるようになります。
ユーザーに特定の情報に対する参照または更新権限がない
エラーコードは401となり、認可を行った(アクセストークンを取得した)ユーザーのユーザー権限を正しく設定する必要があるというメッセージがAPIレスポンスに入ります。
■ 解決方法:概要ユーザーに必要なアクセス権を付与するには、事業所の管理者ユーザーが会計freeeにアクセスして設定>メンバー招待・権限管理>メンバー管理で正しい権限を割り当ててください。
アプリに特定の情報に対する参照または更新権限がない
エラーコードは403となり、アプリケーションにアクセス権がないとうメッセージがAPIレスポンスに入ります。
■ 解決方法:freee アプリストアでアプリ管理者がfreeeアプリケーションの権限設定を正しく行います。
アプリストア>アプリ管理>アプリ詳細>権限設定
■ 新仕様リリース予定日
2019年9月11日(水)
================================================
freee developer support
2019/8/23の13:45~18:15の間、AWSのシステム障害により、会計freeeを含む全てのサービスにアクセスしずらい事象が発生しておりましたが、復旧対応が完了しており、現在は全ての機能をご利用いただけます。
この度は、多大なご迷惑をおかけしましたこと、改めてお詫び申し上げます。
AWSのシステム障害により、freeeのAPIを含めた各サービスにもエラーが多発しております。ご不便・迷惑おかけして申し訳ございません。
2019年7月24日(水)1:00〜5:00に予定していた、会計freee、人事労務freeeを含むfreeeサービスと各モバイルアプリのシステムメンテナンスですが、
弊社の都合により、中止となりました。
どうぞよろしくお願いいたします。
—
freee Developers Community 運営事務局・技術サポート
https://support.freee.co.jp/hc/ja/requests/new
リリース概要
従来会計freeeでは「取引先名」をキーにデータの作成/更新を行っていましたが、多様なユーザー様にご導入いただく中で取引先名の重複などが発生するようになりました。
そこでユーザーが任意に指定できる取引先コードを用意し、取引先コードをキーにデータの作成/更新ができるようになりました。
- 取引先コードは事業所の詳細設定から有効化を行えます。
- デフォルトでは「使用しない」になっています。
リリース日
5/22(水)にリリース済み
リリースによる取引先APIへの影響について
-
- 取引先コードを「使用する」にすることで、新規作成時に取引先コードが必須になります。
- 「使用する」に設定した状態で取引先APIのPOSTを利用すると『”Codeを入力してください。”』の400エラーを返却します。
リリース伴って各社へお願いしたいこと
-
- 取引先コードへの対応状況をヘルプページなどにご記載ください。
- 任意のコードを貴社システムで持たれている場合は、ぜひ取引先コードへの対応をご検討ください
freeeAPIでの新消費税、軽減税率の対応についてです。
以前のニュースで通知した新消費税、軽減税率に関する税区分追加対応のリリースが完了しました。
税区分コード一覧APIで新税区分のリストが参照できますので、10月に向けて必要な改修を開始いただけます。
事前準備やテストなどは
開発用テスト環境をご利用ください。
注意点
- 取引や請求書などにおいて、10/1以前の発生日で、10%および8%(軽減税率)の税区分を利用することはできません(指定はでききますが、保存したときにエラーとなります)。
- 10月以降の日付ですでに8%税率で登録している取引や仕訳がある場合は、必要に応じて更新を行ってください。
新消費税、軽減税率に関する過去のfreee API関連のニュースについて
概要
人事労務freeeにて、扶養親族情報に扶養状況の属性に関する項目が追加されます。
それに伴い、人事労務freeeAPIでも扶養状況の属性が操作できるようになりました。
追加内容の詳細
(1)下記APIのリクエスト/レスポンスの扶養親族に扶養状況の属性 (social_insurance_and_tax_dependent) が追加されます。
- 対象API:従業員の扶養親族
- 更新: PUT /api/v1/employees/{emp_id}/dependent_rules/bulk_update
(2)下記APIのレスポンスの扶養親族に扶養状況の属性 (social_insurance_and_tax_dependent) が追加されます。
- 対象API:従業員の扶養親族
- 取得: GET /api/v1/employees/{emp_id}/dependent_rules
- 従業員一覧の取得: GET /api/v1/employees
- 取得: GET /api/v1/employees/{id}
- 作成: POST /api/v1/employees
- 更新: PUT /api/v1/employees/{id}
廃止予定API
この変更に伴い、インパクトがあるアプリケーション
税区分一覧(/taxes)で取得したtax_idを活用しているアプリケーション
依頼事項
サポート終了予定日までに税区分コード一覧(/taxes/codes)への移行と税区分一覧の利用停止をお願いいたします。
税区分一覧APIサポート終了予定日
2019/9/30(月)
この日以降は税区分一覧に関する問い合わせ対応や不具合改修は予定しておりません。
API廃止予定日
2019/12/2(月)
この日以降はAPIコールに対してエラーで応答します。
今後の対応について
2019/9/30までに税区分コードを利用して必要な情報を取得できるようにアプリケーションの改修をお願いいたします。必要に応じて、開発者環境を活用してテストを行ってください。
また、移行先の税区分コード一覧における新消費税率や軽減税率に伴う税区分コード一覧での
新税区分コードの追加と詳細はこちらを参照してください。
新規追加される各税区分の、税区分コード(code)税区分名(name)日本語税区分名(name_ja)についてのお知らせです。
2019年10月1日から消費税及び地方消費税の税率が8%から10%に引き上げられると同時に、消費税の軽減税率制度が実施されるため、以下の追加を行います。
軽減税率による税率8%につきましては、現在ある消費税8%の区分とは別で軽減税率用のものを準備しましたので、使い分けてご利用ください。
freee APIを利用した多くのアプリケーションに影響がございますので、 開発者の皆さまには必ず以下の内容をご確認いただき、必要なご対応をお願いいたします。
変更内容、影響範囲は4月のニュースをご確認ください。
本件リリース予定は7月初旬となっております。リリースが完了しましたら、別途お知らせをさせていただきます。
※(7/8更新)2019/7/8にリリース完了いたしました。
新規追加税区分コード一覧
税区分コード(code) |
税区分名(name) |
日本語税区分名(name_ja) |
129 |
sales_with_tax_10 |
課税売上10% |
130 |
sales_with_tax_10_simple_1 |
課売上一10% |
131 |
sales_with_tax_10_simple_2 |
課売上二10% |
132 |
sales_with_tax_10_simple_3 |
課売上三10% |
133 |
sales_with_tax_10_simple_4 |
課売上四10% |
134 |
sales_with_tax_10_simple_5 |
課売上五10% |
135 |
sales_with_tax_10_simple_6 |
課売上六10% |
136 |
purchase_with_tax_10 |
課対仕入10% |
137 |
purchase_with_no_tax_10 |
非対仕入10% |
138 |
purchase_with_common_10 |
共対仕入10% |
139 |
import_tax_10 |
課対輸税10% |
140 |
import_tax_no_tax_10 |
非対輸税10% |
141 |
import_tax_common_10 |
共対輸税10% |
142 |
import_local_tax_10 |
地消貨割10% |
143 |
return_of_sales_with_tax_10 |
課税売返10% |
144 |
return_of_sales_with_tax_10_simple_1 |
課売返一10% |
145 |
return_of_sales_with_tax_10_simple_2 |
課売返二10% |
146 |
return_of_sales_with_tax_10_simple_3 |
課売返三10% |
147 |
return_of_sales_with_tax_10_simple_4 |
課売返四10% |
148 |
return_of_sales_with_tax_10_simple_5 |
課売返五10% |
149 |
return_of_sales_with_tax_10_simple_6 |
課売返六10% |
150 |
bad_receivable_10 |
課税売倒10% |
151 |
returned_bad_receivable_10 |
課税売回10% |
152 |
return_of_purchase_with_tax_10 |
課対仕返10% |
153 |
return_of_purchase_with_no_tax_10 |
非対仕返10% |
154 |
return_of_purchase_with_common_10 |
共対仕返10% |
155 |
taxable_10 |
課税10% |
156 |
sales_with_tax_reduced_8 |
課税売上8%(軽) |
157 |
sales_with_tax_reduced_8_simple_1 |
課売上一8%(軽) |
158 |
sales_with_tax_reduced_8_simple_2 |
課売上二8%(軽) |
159 |
sales_with_tax_reduced_8_simple_3 |
課売上三8%(軽) |
160 |
sales_with_tax_reduced_8_simple_4 |
課売上四8%(軽) |
161 |
sales_with_tax_reduced_8_simple_5 |
課売上五8%(軽) |
162 |
sales_with_tax_reduced_8_simple_6 |
課売上六8%(軽) |
163 |
purchase_with_tax_reduced_8 |
課対仕入8%(軽) |
164 |
purchase_with_no_tax_reduced_8 |
非対仕入8%(軽) |
165 |
purchase_with_common_reduced_8 |
共対仕入8%(軽) |
166 |
import_tax_reduced_8 |
課対輸税8%(軽) |
167 |
import_tax_no_tax_reduced_8 |
非対輸税8%(軽) |
168 |
import_tax_common_reduced_8 |
共対輸税8%(軽) |
169 |
import_local_tax_reduced_8 |
地消貨割8%(軽) |
170 |
return_of_sales_with_tax_reduced_8 |
課税売返8%(軽) |
171 |
return_of_sales_with_tax_reduced_8_simple_1 |
課売返一8%(軽) |
172 |
return_of_sales_with_tax_reduced_8_simple_2 |
課売返二8%(軽) |
173 |
return_of_sales_with_tax_reduced_8_simple_3 |
課売返三8%(軽) |
174 |
return_of_sales_with_tax_reduced_8_simple_4 |
課売返四8%(軽) |
175 |
return_of_sales_with_tax_reduced_8_simple_5 |
課売返五8%(軽) |
176 |
return_of_sales_with_tax_reduced_8_simple_6 |
課売返六8%(軽) |
177 |
bad_receivable_reduced_8 |
課税売倒8%(軽) |
178 |
returned_bad_receivable_reduced_8 |
課税売回8%(軽) |
179 |
return_of_purchase_with_tax_reduced_8 |
課対仕返8%(軽) |
180 |
return_of_purchase_with_no_tax_reduced_8 |
非対仕返8%(軽) |
181 |
return_of_purchase_with_common_reduced_8 |
共対仕返8%(軽) |
182 |
taxable_reduced_8 |
課税8%(軽) |
下記の日時に、freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。
日時 : 2019/6/19 (水) 1:00 – 5:00
対象: 全サービス
メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。
—
freee Developers Community 運営事務局・技術サポート
https://support.freee.co.jp/hc/ja/requests/new
2019/6/4の17:40~18:47の間「会計freeeを含む全てのサービスにログインできない」事象が発生しておりましたが、復旧対応が完了しており、現在は全ての機能をご利用いただけます。
この度は、多大なご迷惑をおかけしましたことあらためてお詫び申し上げます。
再発防止の対策を進めてまいりますので、何卒ご容赦賜りますようお願い申し上げます。
2019年6月4日現在 現在会計freeeを含む全てのサービスでアクセスし辛い問題が発生しております。
ご不便をおかけして申し訳ございませんが、原因の調査を行っておりますので、今しばらくお待ち下さい。
2019年5月23日(木)1:00〜5:00の間で、会計freee、人事労務freeeを含むfreeeサービスと各モバイルアプリでシステムメンテナンスを行います。メンテナンス中は該当サービスをご利用いただけません。ご迷惑をおかけしますが、よろしくお願いいたします。
https://secure.freee.co.jp/system_messages