Skip to content

Commit ded2765

Browse files
Merge pull request #505 from freee/feature/iv_update_schema_files_2025-08-01-05-05
Update schema files
2 parents 1e230d0 + 879755f commit ded2765

File tree

1 file changed

+38
-11
lines changed

1 file changed

+38
-11
lines changed

iv/open-api-3/api-schema.yml

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,31 @@ info:
7070
</br>
7171
7272
<h3 id="api_rate_limit">API使用制限</h3>
73-
<p>APIリクエストは1時間で1500回、1分で30回を上限としています。API使用ステータスはレスポンスヘッダに付与されます。</p>
73+
<p>APIリクエストは、全プラン共通で1時間あたり1500回、1分あたり30回を上限としています。また、契約プランに応じて1日あたりの上限が設定されています。</p>
74+
75+
<table border="1">
76+
<tbody>
77+
<tr>
78+
<th style="padding: 10px"><strong>freee会計プラン名</strong></th>
79+
<th style="padding: 10px"><strong>事業所とアプリケーション毎に、1日のAPIコール数の上限</strong></th>
80+
</tr>
81+
<tr><td style="padding: 10px">法人エンタープライズプラン</td><td style="padding: 10px">10,000</td></tr>
82+
<tr><td style="padding: 10px">法人アドバンスプラン(および旧法人プロフェッショナルプラン)</td><td style="padding: 10px">5,000</td></tr>
83+
<tr><td style="padding: 10px">上記以外</td><td style="padding: 10px">3,000</td></tr>
84+
</tbody>
85+
</table>
86+
87+
<p>API使用ステータスはレスポンスヘッダに付与されます。</p>
88+
7489
<pre><code>X-RateLimit-Limit:1500
75-
X-RateLimit-Remaining:1798
90+
X-RateLimit-Remaining:1498
7691
X-RateLimit-Reset:2018-01-01T12:00:00.000000Z
7792
X-Ratelimit-Limit-Minute:30
7893
X-Ratelimit-Remaining-Minute:29
7994
X-Ratelimit-Reset-Minute:2018-01-01T12:00:00.000000Z
95+
X-RateLimit-Limit-Day:3000
96+
X-RateLimit-Remaining-Day:2991
97+
X-RateLimit-Reset-Day:2018-01-02T00:00:00.000000Z
8098
</code></pre>
8199
82100
<br> 各ヘッダの意味は次のとおりです。</p>
@@ -87,12 +105,15 @@ info:
87105
<th style="padding: 10px"><strong>ヘッダ名</strong></th>
88106
<th style="padding: 10px"><strong>説明</strong></th>
89107
</tr>
90-
<tr><td style="padding: 10px">X-RateLimit-Limit</td><td style="padding: 10px">使用回数の上限</td></tr>
91-
<tr><td style="padding: 10px">X-RateLimit-Remaining</td><td style="padding: 10px">残り使用回数</td></tr>
92-
<tr><td style="padding: 10px">X-RateLimit-Reset</td><td style="padding: 10px">使用回数がリセットされる時刻</td></tr>
108+
<tr><td style="padding: 10px">X-RateLimit-Limit</td><td style="padding: 10px">1時間の使用回数の上限</td></tr>
109+
<tr><td style="padding: 10px">X-RateLimit-Remaining</td><td style="padding: 10px">1時間の残り使用回数</td></tr>
110+
<tr><td style="padding: 10px">X-RateLimit-Reset</td><td style="padding: 10px">1時間の使用回数がリセットされる時刻</td></tr>
93111
<tr><td style="padding: 10px">X-Ratelimit-Limit-Minute</td><td style="padding: 10px">1分間の使用回数の上限</td></tr>
94112
<tr><td style="padding: 10px">X-Ratelimit-Remaining-Minute</td><td style="padding: 10px">1分間の残り使用回数</td></tr>
95113
<tr><td style="padding: 10px">X-Ratelimit-Reset-Minute</td><td style="padding: 10px">1分間の使用回数がリセットされる時刻</td></tr>
114+
<tr><td style="padding: 10px">X-RateLimit-Limit-Day</td><td style="padding: 10px">1日間の使用回数の上限</td></tr>
115+
<tr><td style="padding: 10px">X-RateLimit-Remaining-Day</td><td style="padding: 10px">1日間の残り使用回数</td></tr>
116+
<tr><td style="padding: 10px">X-Ratelimit-Reset-Day</td><td style="padding: 10px">1日間の使用回数がリセットされる時刻</td></tr>
96117
</tbody>
97118
</table>
98119
@@ -1501,9 +1522,11 @@ components:
15011522
type: integer
15021523
invoice_note:
15031524
description: 備考
1504-
example: 備考
1525+
example: |
1526+
備考
1527+
- 入力がない場合、freee請求書Webで設定した、帳票種別ごとの既定のテンプレートの内容が適用されます。
15051528
maxLength: 4000
1506-
minLength: 1
1529+
minLength: 0
15071530
type: string
15081531
memo:
15091532
description: 社内メモ
@@ -1804,9 +1827,11 @@ components:
18041827
type: string
18051828
quotation_note:
18061829
description: 備考
1807-
example: 備考
1830+
example: |
1831+
備考
1832+
- 入力がない場合、freee請求書Webで設定した、帳票種別ごとの既定のテンプレートの内容が適用されます。
18081833
maxLength: 4000
1809-
minLength: 1
1834+
minLength: 0
18101835
type: string
18111836
memo:
18121837
description: 社内メモ
@@ -2065,9 +2090,11 @@ components:
20652090
type: string
20662091
delivery_slip_note:
20672092
description: 備考
2068-
example: 備考
2093+
example: |
2094+
備考
2095+
- 入力がない場合、freee請求書Webで設定した、帳票種別ごとの既定のテンプレートの内容が適用されます。
20692096
maxLength: 4000
2070-
minLength: 1
2097+
minLength: 0
20712098
type: string
20722099
memo:
20732100
description: 社内メモ

0 commit comments

Comments
 (0)