リリースノート

人事労務 freeeのAPIを大幅アップデート

freeeAPIの機能追加についてご連絡いたします。

新たに公開したAPI

従業員情報API・給与明細API・賞与明細API

概要

今までAPIでは取得できなかった、人事労務で用いる従業員情報や給与・賞与の明細がAPI化されました。以下のような情報がAPIから操作可能です。※一部抜粋

従業員情報API　(POST/PUT/GET)
  • 基本情報（住所等）
  • 健康保険情報
  • 厚生年金情報
  • 扶養家族情報
  • 給与振込先情報
  • 給与情報
給与明細API　(GET)
  • 基本情報（基本給・労働・休暇日数等）
  • 支給項目
  • 控除項目
賞与明細API　(GET)
  • 基本情報（支給額・確定日等）
  • 支給項目
  • 控除項目

注意事項

今回のリリースにて、より人事労務関連サービスとの便利な連携が実現可能となります。一方で個人情報や給与情報といったセンシティブな情報を扱うAPIであるため、利用に際しては細心の注意を持って情報管理を行なってください。

詳細は「人事労務freee APIドキュメント」をご覧ください。

—

freee Developers Community 運営事務局・技術サポート
ニュース

システムメンテナンス(2019/03/26)

下記の日時に、会計freeeを含む freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：3/26 (火) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2019/02/19)

下記の日時に、freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：02/19 (火) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2019/02/07)

下記の日時に、freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：02/07 (木) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2019/01/24)

下記の日時に、freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：01/24 (木) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2018/12/19)

下記の日時に、freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：12/19 (水) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

リリースノート

バリデーションチェックの厳格化およびエラーレスポンスの形式統一をリリースしました


リリース概要
自動エラーチェックライブラリを導入し、バリデーションチェックの厳格化およびエラーレスポンスの形式統一を行います。

リリースによる変更点
  • データ型のバリデーションが強化され、amountへのString型でのリクエストなどができなくなります。正しい指定形式はdeveloperサイトの「パラメータ詳細」欄をご確認ください。なお、修正が必要と思われるユーザー様へは別途個別に必要な変更についてご連絡いたします。
  • エラーレスポンスの一部でerrorsのfieldをarrayではなく、文字列で返しておりました。今後はarray形式に統一いたします。
  • リクエストヘッダーにて適切なapplication/jsonを指定してください。指定がない場合、エラーレスポンスが適切に返されない場合がございます。
  1. (一部パートナー)ファイルボックスAPI：multipart/form-data, boundary=Boundary
  2. journals #download：application/csv,application/pdf
  3. その他：application/json

詳細はドキュメントにてご確認ください

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

2018年11月のAPIアップデート


12/3(月)に修正対応が必要なアップデートをリリースします。

リリース概要
自動エラーチェックライブラリを導入し、バリデーションチェックの厳格化およびエラーレスポンスの形式統一を行います。

リリースによる変更点
  • データ型のバリデーションが強化され、amountへのString型でのリクエストなどができなくなります。正しい指定形式はdeveloperサイトの「パラメータ詳細」欄をご確認ください。なお、修正が必要と思われるユーザー様へは別途個別に必要な変更についてご連絡いたします。
  • エラーレスポンスの一部でerrorsのfieldをarrayではなく、文字列で返しておりました。今後はarray形式に統一いたします。
  • リクエストヘッダーにて適切なapplication/jsonを指定してください。指定がない場合、エラーレスポンスが適切に返されない場合がございます。
  1. (一部パートナー)ファイルボックスAPI：multipart/form-data, boundary=Boundary
  2. journals #download：application/csv,application/pdf
  3. その他：application/json

詳細はドキュメントにてご確認ください

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2018/10/11)

下記の日時に、freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：10/11 (木) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2018/09/26)

下記の日時に、freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：9/26 (水) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

【要ご確認】2点仕様アップデートを行います。

いつもfreee APIをご利用いただき誠にありがとうございます

freee APIをお使いのユーザー様に影響のある内容ですので、必ず内容をご確認いただき、必要なご対応をお願いいたします。

ご不明な点がございましたらdev-support@freee.co.jpまでご連絡ください。

取引先API GET

================================================
■ 仕様変更内容

(1)取引先API　GET時に返すlimitに制限を入れます。
現在 変更後
デフォルト値 = 無し デフォルト値 = 50、最大値 = 500
(2)keywordをパラメータとして追加します。

■ 仕様変更理由
1事業所辺りの取引先件数が多くなる過程での安定した稼働、
またkeyword検索による利便性向上のため。

■ 影響範囲
取引先APIでGETメソッドをご利用のユーザー様

■ 必要なご対応
GETリクエストにlimit,offsetを活用したループ処理の実装をお願いします

■ 新仕様リリース予定日
2018年10月1日(月)
================================================


認証基盤のアップデート

================================================
■ 仕様変更内容

認証に利用しているライブラリのアップデートを行います。
アップデートに伴いパラメータの返し方、およびエラー文が変更になります。
詳細は下記をご参照ください。

■ 仕様変更理由
セキュリティ強化のため

■ 影響範囲
freee APIご利用のユーザー様

■ 新仕様リリース予定日
2018年9月18日(火)-19日(水)
================================================

クライアント認証失敗時のエラーメッセージ変更

client_id / client_secret によるクライアント認証に失敗した場合のエラーメッセージが下記のように変わります。

現在 変更後
「クライアント認証は次のいずれかの理由で失敗しました。不明なクライアント、クライアント認証が含まれていない、サポートされない認証メソッド」 「クライアントが不明か、クライアント認証が含まれていないか、もしくは認証メソッドがサポートされていないため、クライアント認証は失敗しました。」

Authorization code の許可・拒否における挙動の変更


「Web認証用URL」にアクセスし、アプリケーションによるリソースアクセスの許可・拒否を行なった場合の挙動に変更があります。

redirect_uri がテスト用（urn:ietf:wg:oauth:2.0:oob）の場合
  • 許可時
    • リダイレクトされるURLが次のように変わります。
    テスト用途では特に問題ありません。
  • 拒否時
    • 拒否時のjsonで返すエラーメッセージが次のように変わります。
現在 変更後
許可時 https://secure.freee.co.jp/oauth/authorize/authorization_code https://secure.freee.co.jp/oauth/authorize/native?code=authorization_code
拒否時 {“error”:”access_denied”,”error_description”:”リソース保有者もしくは認証サーバはリクエストを拒否しました。”} {“error”:”access_denied”,”error_description”:”リソースオーナーもしくは認可サーバがリクエストを拒否しました。”}
redirect_uri が有効なURL形式の場合
拒否時 &error_description=${error_description} リソース保有者もしくは認証サーバはリクエストを拒否しました。 &error_description=${error_description} リソースオーナーもしくは認可サーバがリクエストを拒否しました。
※authorization_code はaccess token 取得時に code パラメータに渡す値です。


Implicitの許可・拒否における挙動の変更


redirect_uri がテスト用（urn:ietf:wg:oauth:2.0:oob）の場合
  • 許可時
    • リダイレクトされるURL、レスポンスの形式、メッセージの内容が次のように変わります。
    テスト用途では特に問題ありません。
  • 拒否時
    • メッセージの値が次のように変わります。
許可時
現在 変更後
リダイレクトされるURL https://secure.freee.co.jp/oauth/authorize/access_token https://secure.freee.co.jp/oauth/token/info?access_token=access_token
レスポンス形式 HTML JSON
メッセージの内容 HTMLの中に access token の値を表示 {“resource_owner_id”:resource ownerであるuser_idの値,”scopes”:[“read”,”write”],”expires_in_seconds”:86399,”application”:{“uid”:”client_idの値”},”created_at”:unixtime stampの値}
拒否時
メッセージの内容 {“error”:”access_denied”,”error_description”:”リソース保有者もしくは認証サーバはリクエストを拒否しました。”} {“error”:”access_denied”,”error_description”:”リソースオーナーもしくは認可サーバがリクエストを拒否しました。”}

redirect_uri が有効なURL形式の場合
クエリパラメータerror_descriptionに渡されるURLエンコードされた値が次のように変わります。

拒否時
現在 変更後
メッセージの内容 {“error”:”access_denied”,”error_description”:”リソース保有者もしくは認証サーバはリクエストを拒否しました。”} {“error”:”access_denied”,”error_description”:”リソースオーナーもしくは認可サーバがリクエストを拒否しました。”}
ニュース

請求書API ドキュメントを非公開にします

エンタープライズプランご利用のお客様向けに公開している請求書APIドキュメントを一度非公開とします。
対応予定日：9/3(月)

事由

APIの実装とドキュメントに差異があることが分かっており、 あるべき仕様を検討した際に、破壊的な変更を伴う可能性がある。

今後の対応について

現在開発中の方はお手数ですが9/3(月)までにキャプチャを取るなどのご対応をお願いいたします。 これから開発される方は、弊社営業担当にお問い合わせください。 再公開については、決まり次第改めてお知らせいたします。
ニュース

?振替伝票APIのドキュメントを公開?

会計freeeをより便利に、より多くの業務効率化実現を目指して、中核機能にあたる振替伝票のAPIを9/3(月)にリリースいたします。
リリースに先駆けて、本日振替伝票APIのドキュメントを公開いたしました。

対応するメソッド
  • POST
  • PUT
  • GET #index
  • GET #show
  • DELETE

利用シーン
前受金の振替、工事台帳との連携、人件費の製品原価 / 仕掛りへの振替、固定資産の減価償却など幅広い用途で利用できます。

ニュース

システムメンテナンス(2018/08/23)

下記の日時に、会計freeeを含む freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：8/23 (木) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2018/07/24)

下記の日時に、会計freeeを含む freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：7/24 (火) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

【要ご対応】請求書API新規作成時のエラーハンドリング追加について

いつもfreee APIをご利用いただき誠にありがとうございます。

請求書APIの仕様変更を2018年7月下旬に予定しています。
freee APIをお使いのユーザー様に影響のある内容ですので、必ず内容をご確認いただき、必要なご対応をお願いいたします。

================================================
■仕様変更内容
請求書API POST時に存在しない部門名 / 品目名を指定した場合に、エラーを返すようにエラーハンドリングを拡張します。
存在する部門名 / 品目名を指定した場合には、これまで通り動作します。

また、従来の名前指定に加えてIDでの指定にも近日対応予定です。

■仕様変更理由
APIの利便性向上のため

■影響範囲
請求書APIのPOSTをご利用で、部門 / 品目を指定しているユーザー様すべて

■新仕様リリース予定日
2018年7月26日(木)
================================================

ご利用の皆様にはお手数をおかけいたしますが、ご対応のほどよろしくおねがいします。
ニュース

システムメンテナンス(2018/07/02)

下記の日時に、会計freeeを含む freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：7/2 (月) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new

ニュース

システムメンテナンス(2018/06/20)

下記の日時に、会計freeeを含む freeeの全サービスと各モバイルアプリでシステムメンテナンスを行います。

日時：6/20 (木) 1:00 – 5:00

対象: 全サービス

メンテナンス中は当該サービスおよびAPIをご利用いただけません。
ご迷惑をおかけしますが、よろしくお願いいたします。

—

freee Developers Community 運営事務局・技術サポート

https://support.freee.co.jp/hc/ja/requests/new