diff --git a/v2020_06_15/open-api-3/api-schema.json b/v2020_06_15/open-api-3/api-schema.json index 97ed241..cf876d7 100644 --- a/v2020_06_15/open-api-3/api-schema.json +++ b/v2020_06_15/open-api-3/api-schema.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "freee会計 API", - "description": "\n
\n

スタートガイド

\n\n

freee API開発がはじめての方はfreee API スタートガイドを参照してください。

\n\n
\n

お知らせ

\n\n

\nインボイス制度に伴い、freee会計の帳票機能がfreee請求書に移行します。これに伴い、2023年10月にfreee会計の「請求書の作成、見積書の作成」エンドポイントは廃止、freee請求書APIに移行する予定です。詳細は freee会計 APIの仕様変更(インボイス制度対応)についてをご確認ください。\n

\n\n

仕様

\n\n

APIエンドポイント

\n\n

https://api.freee.co.jp/ (httpsのみ)

\n\n

認証について

\n

OAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。

\n\n

データフォーマット

\n\n

リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄(application/jsonなど)を確認してください。

\n\n

後方互換性ありの変更

\n\n

freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。

\n\n\n\n

共通レスポンスヘッダー

\n\n

すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。

\n\n\n\n

共通エラーレスポンス

\n\n\n\n

レスポンスの例

\n\n
  {\n    "status_code" : 400,\n    "errors" : [\n      {\n        "type" : "status",\n        "messages" : ["不正なリクエストです。"]\n      },\n      {\n        "type" : "validation",\n        "messages" : ["Date は不正な日付フォーマットです。入力例:2019-12-17"]\n      }\n    ]\n  }
\n\n
\n\n

API 使用制限

\n\n

freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。

\n

その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。

\n\n

/reportsと/receipts/{id}/downloadエンドポイント

\n\n

freeeはエンドポイント毎に一定頻度以上のアクセスを検知した場合、APIアクセスをコントロールする場合があります。その際のhttp status codeは429(too many requests)となります。

\n\n\n

http status codeが429となった場合、API使用ステータスはレスポンスヘッダに付与されます。

\n
x-ratelimit-limit:10\nx-ratelimit-remaining:1\nx-ratelimit-reset:2023-01-13T10:22:29+09:00\n
\n\n
各ヘッダの意味は次のとおりです。

\n\n\n \n \n \n \n \n \n \n \n \n
ヘッダ名説明
x-ratelimit-limit使用回数の上限
x-ratelimit-remaining残り使用回数
x-ratelimit-reset使用回数がリセットされる時刻
\n\n
\n\n

プランごとの API 使用制限

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
freee会計プラン名事業所とアプリケーション毎に、1日のAPIコール数の上限
法人エンタープライズプラン10,000
法人アドバンスプラン(および旧法人プロフェッショナルプラン)5,000
上記以外3,000
\n\n

プランごとの利用可能 API

\n

契約プランごとにご利用可能な freee 会計 API は異なります。 freee 会計の Web 版でご利用いただける機能について、 freee 会計 API でもご利用いただけます。

\n

例えば法人スタータープラン、旧法人ベーシックプランをご契約いただいている場合、 Web 版では経費精算機能をご利用いただけますので、 API でも経費精算 API をご利用可能です。

\n

ただし以下の API は例外です。

\n\n

詳しくは、【個人】freee会計のプランについて 並びに 【法人】freee会計のプランについてをご確認ください。

\n\n

プランごとの利用可能パラメータ

\n

ご利用可能な freee 会計 API であっても、契約プランごとに利用可能なパラメータは異なります。

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
パラメータ説明利用可能プラン
segment_1_tagセグメント1タグ法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
segment_2_tagセグメント2タグ法人アドバンスプラン
法人エンタープライズプラン
segment_3_tagセグメント3タグ法人アドバンスプラン
法人エンタープライズプラン
segment_1_tag_idセグメント1タグID法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
segment_2_tag_idセグメント2タグID法人アドバンスプラン
法人エンタープライズプラン
segment_3_tag_idセグメント3タグID法人アドバンスプラン
法人エンタープライズプラン
segment_1_tag_nameセグメント1タグ名法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
segment_2_tag_nameセグメント2タグ名法人アドバンスプラン
法人エンタープライズプラン
segment_3_tag_nameセグメント3タグ名法人アドバンスプラン
法人エンタープライズプラン
segment_idセグメントID(1, 2, 3 のいずれか)法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
旧法人プロフェッショナルプランにつきましては、 1 のみ指定可能です。
\n\n

Webhookについて

\n\n

詳細は会計Webhook概要を参照してください。

\n\n
\n

連絡先

\n\n

ご不明点、ご要望等は freee サポートデスクへのお問い合わせフォーム からご連絡ください。

\n
© Since 2013 freee K.K.", + "description": "\n
\n

スタートガイド

\n\n

freee API開発がはじめての方はfreee API スタートガイドを参照してください。

\n\n
\n

お知らせ

\n\n

\nインボイス制度に伴い、freee会計の帳票機能がfreee請求書に移行します。これに伴い、2023年10月にfreee会計の「請求書の作成、見積書の作成」エンドポイントは廃止、freee請求書APIに移行する予定です。詳細は freee会計 APIの仕様変更(インボイス制度対応)についてをご確認ください。\n

\n\n

仕様

\n\n

APIエンドポイント

\n\n

https://api.freee.co.jp/ (httpsのみ)

\n\n

認証について

\n

OAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。

\n\n

データフォーマット

\n\n

リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄(application/jsonなど)を確認してください。

\n\n

後方互換性ありの変更

\n\n

freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。

\n\n\n\n

共通レスポンスヘッダー

\n\n

すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。

\n\n\n\n

共通エラーレスポンス

\n\n\n\n

レスポンスの例

\n\n
  {\n    "status_code" : 400,\n    "errors" : [\n      {\n        "type" : "status",\n        "messages" : ["不正なリクエストです。"]\n      },\n      {\n        "type" : "validation",\n        "messages" : ["Date は不正な日付フォーマットです。入力例:2019-12-17"]\n      }\n    ]\n  }
\n\n
\n\n

API 使用制限

\n\n

freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。

\n

その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。

\n\n

/reportsと/receipts/{id}/downloadエンドポイント

\n\n

freeeはエンドポイント毎に一定頻度以上のアクセスを検知した場合、APIアクセスをコントロールする場合があります。その際のhttp status codeは429(too many requests)となります。

\n\n\n

http status codeが429となった場合、API使用ステータスはレスポンスヘッダに付与されます。

\n
x-ratelimit-limit:10\nx-ratelimit-remaining:1\nx-ratelimit-reset:2023-01-13T10:22:29+09:00\n
\n\n
各ヘッダの意味は次のとおりです。

\n\n\n \n \n \n \n \n \n \n \n \n
ヘッダ名説明
x-ratelimit-limit使用回数の上限
x-ratelimit-remaining残り使用回数
x-ratelimit-reset使用回数がリセットされる時刻
\n\n
\n\n

プランごとの API 使用制限

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
freee会計プラン名事業所とアプリケーション毎に、1日のAPIコール数の上限
法人エンタープライズプラン10,000
法人アドバンスプラン(および旧法人プロフェッショナルプラン)5,000
上記以外3,000
\n\n

プランごとの利用可能 API

\n

契約プランごとにご利用可能な freee 会計 API は異なります。 freee 会計の Web 版でご利用いただける機能について、 freee 会計 API でもご利用いただけます。

\n

例えば法人スタータープラン、旧法人ベーシックプランをご契約いただいている場合、 Web 版では経費精算機能をご利用いただけますので、 API でも経費精算 API をご利用可能です。

\n

ただし以下の API は例外です。

\n\n

詳しくは、【個人】freee会計のプランについて 並びに 【法人】freee会計のプランについてをご確認ください。

\n\n

プランごとの利用可能パラメータ

\n

ご利用可能な freee 会計 API であっても、契約プランごとに利用可能なパラメータは異なります。

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
パラメータ説明利用可能プラン
segment_1_tagセグメント1タグ法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
segment_2_tagセグメント2タグ法人アドバンスプラン
法人エンタープライズプラン
segment_3_tagセグメント3タグ法人アドバンスプラン
法人エンタープライズプラン
segment_1_tag_idセグメント1タグID法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
segment_2_tag_idセグメント2タグID法人アドバンスプラン
法人エンタープライズプラン
segment_3_tag_idセグメント3タグID法人アドバンスプラン
法人エンタープライズプラン
segment_1_tag_nameセグメント1タグ名法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
segment_2_tag_nameセグメント2タグ名法人アドバンスプラン
法人エンタープライズプラン
segment_3_tag_nameセグメント3タグ名法人アドバンスプラン
法人エンタープライズプラン
segment_idセグメントID(1, 2, 3 のいずれか)法人アドバンスプラン
法人エンタープライズプラン
旧法人プロフェッショナルプラン
旧法人プロフェッショナルプランにつきましては、 1 のみ指定可能です。
\n\n

Webhookについて

\n\n

詳細は会計Webhook概要を参照してください。

\n\n
\n

連絡先

\n\n

ご不明点、ご要望等は freee サポートデスクへのお問い合わせフォーム からご連絡ください。

\n
© Since 2013 freee K.K.", "version": "v1.0", "x-copyright": "© Since 2013 freee K.K." },