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
freee API開発がはじめての方はfreee API スタートガイドを参照してください。
\n\n\nインボイス制度に伴い、freee会計の帳票機能がfreee請求書に移行します。これに伴い、2023年10月にfreee会計の「請求書の作成、見積書の作成」エンドポイントは廃止、freee請求書APIに移行する予定です。詳細は freee会計 APIの仕様変更(インボイス制度対応)についてをご確認ください。\n
\n\nhttps://api.freee.co.jp/ (httpsのみ)
\n\nOAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。
\n\nリクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄(application/jsonなど)を確認してください。
\n\nfreeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。
\n\nすべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。
\n\nX-Freee-Request-ID
\nステータスコードはレスポンス内のJSONに含まれる他、HTTPヘッダにも含まれる
\n一部のエラーレスポンスにはエラーコードが含まれます。
詳細は、HTTPステータスコード400台エラー時のチェックポイントを参照してください
type
\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\nfreeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。
\nその際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。
\n\nfreeeはエンドポイント毎に一定頻度以上のアクセスを検知した場合、APIアクセスをコントロールする場合があります。その際のhttp status codeは429(too many requests)となります。
\nhttp status codeが429となった場合、API使用ステータスはレスポンスヘッダに付与されます。
\nx-ratelimit-limit:10\nx-ratelimit-remaining:1\nx-ratelimit-reset:2023-01-13T10:22:29+09:00\n
\n\nヘッダ名 | \n説明 | \n
---|---|
x-ratelimit-limit | 使用回数の上限 |
x-ratelimit-remaining | 残り使用回数 |
x-ratelimit-reset | 使用回数がリセットされる時刻 |
freee会計プラン名 | \n事業所とアプリケーション毎に、1日のAPIコール数の上限 | \n
---|---|
法人エンタープライズプラン | \n10,000 | \n
法人アドバンスプラン(および旧法人プロフェッショナルプラン) | \n5,000 | \n
上記以外 | \n3,000 | \n
契約プランごとにご利用可能な freee 会計 API は異なります。 freee 会計の Web 版でご利用いただける機能について、 freee 会計 API でもご利用いただけます。
\n例えば法人スタータープラン、旧法人ベーシックプランをご契約いただいている場合、 Web 版では経費精算機能をご利用いただけますので、 API でも経費精算 API をご利用可能です。
\nただし以下の API は例外です。
\n詳しくは、【個人】freee会計のプランについて 並びに 【法人】freee会計のプランについてをご確認ください。
\n\nご利用可能な freee 会計 API であっても、契約プランごとに利用可能なパラメータは異なります。
\nパラメータ | \n説明 | \n利用可能プラン | \n
---|---|---|
segment_1_tag | \nセグメント1タグ | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン | \n
segment_2_tag | \nセグメント2タグ | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_3_tag | \nセグメント3タグ | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_1_tag_id | \nセグメント1タグID | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン | \n
segment_2_tag_id | \nセグメント2タグID | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_3_tag_id | \nセグメント3タグID | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_1_tag_name | \nセグメント1タグ名 | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン | \n
segment_2_tag_name | \nセグメント2タグ名 | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_3_tag_name | \nセグメント3タグ名 | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_id | \nセグメントID(1, 2, 3 のいずれか) | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン 旧法人プロフェッショナルプランにつきましては、 1 のみ指定可能です。 | \n
詳細は会計Webhook概要を参照してください。
\n\nご不明点、ご要望等は freee サポートデスクへのお問い合わせフォーム からご連絡ください。
\nfreee API開発がはじめての方はfreee API スタートガイドを参照してください。
\n\n\nインボイス制度に伴い、freee会計の帳票機能がfreee請求書に移行します。これに伴い、2023年10月にfreee会計の「請求書の作成、見積書の作成」エンドポイントは廃止、freee請求書APIに移行する予定です。詳細は freee会計 APIの仕様変更(インボイス制度対応)についてをご確認ください。\n
\n\nhttps://api.freee.co.jp/ (httpsのみ)
\n\nOAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。
\n\nリクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄(application/jsonなど)を確認してください。
\n\nfreeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。
\n\nすべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。
\n\nX-Freee-Request-ID
\nステータスコードはレスポンス内のJSONに含まれる他、HTTPヘッダにも含まれる
\n一部のエラーレスポンスにはエラーコードが含まれます。
詳細は、HTTPステータスコード400台エラー時のチェックポイントを参照してください
type
\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\nfreeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。
\nその際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。
\n\nfreeeはエンドポイント毎に一定頻度以上のアクセスを検知した場合、APIアクセスをコントロールする場合があります。その際のhttp status codeは429(too many requests)となります。
\nhttp status codeが429となった場合、API使用ステータスはレスポンスヘッダに付与されます。
\nx-ratelimit-limit:10\nx-ratelimit-remaining:1\nx-ratelimit-reset:2023-01-13T10:22:29+09:00\n
\n\nヘッダ名 | \n説明 | \n
---|---|
x-ratelimit-limit | 使用回数の上限 |
x-ratelimit-remaining | 残り使用回数 |
x-ratelimit-reset | 使用回数がリセットされる時刻 |
freee会計プラン名 | \n事業所とアプリケーション毎に、1日のAPIコール数の上限 | \n
---|---|
法人エンタープライズプラン | \n10,000 | \n
法人アドバンスプラン(および旧法人プロフェッショナルプラン) | \n5,000 | \n
上記以外 | \n3,000 | \n
契約プランごとにご利用可能な freee 会計 API は異なります。 freee 会計の Web 版でご利用いただける機能について、 freee 会計 API でもご利用いただけます。
\n例えば法人スタータープラン、旧法人ベーシックプランをご契約いただいている場合、 Web 版では経費精算機能をご利用いただけますので、 API でも経費精算 API をご利用可能です。
\nただし以下の API は例外です。
\n詳しくは、【個人】freee会計のプランについて 並びに 【法人】freee会計のプランについてをご確認ください。
\n\nご利用可能な freee 会計 API であっても、契約プランごとに利用可能なパラメータは異なります。
\nパラメータ | \n説明 | \n利用可能プラン | \n
---|---|---|
segment_1_tag | \nセグメント1タグ | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン | \n
segment_2_tag | \nセグメント2タグ | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_3_tag | \nセグメント3タグ | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_1_tag_id | \nセグメント1タグID | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン | \n
segment_2_tag_id | \nセグメント2タグID | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_3_tag_id | \nセグメント3タグID | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_1_tag_name | \nセグメント1タグ名 | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン | \n
segment_2_tag_name | \nセグメント2タグ名 | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_3_tag_name | \nセグメント3タグ名 | \n法人アドバンスプラン 法人エンタープライズプラン | \n
segment_id | \nセグメントID(1, 2, 3 のいずれか) | \n法人アドバンスプラン 法人エンタープライズプラン 旧法人プロフェッショナルプラン 旧法人プロフェッショナルプランにつきましては、 1 のみ指定可能です。 | \n
詳細は会計Webhook概要を参照してください。
\n\nご不明点、ご要望等は freee サポートデスクへのお問い合わせフォーム からご連絡ください。
\n