Skip to content
This repository was archived by the owner on Jul 24, 2023. It is now read-only.

Commit 5a0c01e

Browse files
authored
Merge pull request #12 from freee/openapi-3
Updated for API schema release v0.0.9.
2 parents ee1ea44 + 1d61ba7 commit 5a0c01e

File tree

552 files changed

+17017
-1544
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

552 files changed

+17017
-1544
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
vendor/
2+
composer.lock

.openapi-generator/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
4.1.3
1+
4.2.2

README_auto-generated.md

Lines changed: 115 additions & 105 deletions
Large diffs are not rendered by default.

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "freee/freee-accounting-sdk",
33
"type": "library",
4-
"version": "v1.0.0",
4+
"version": "v2.0.0-alpha",
55
"description": "Accounting freee PHP SDK",
66
"keywords": [
77
"openapitools",

config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"invokerPackage": "Freee\\Accounting",
33
"gitUserId": "freee",
44
"gitRepoId": "freee-accounting-sdk-php",
5-
"artifactVersion": "v1.0.0"
5+
"artifactVersion": "v2.0.0-alpha"
66
}

docs/Api/AccountItemsApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Freee\Accounting\AccountItemsApi
22

3-
All URIs are relative to *https://api.freee.co.jp/api/1*
3+
All URIs are relative to *https://api.freee.co.jp*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createAccountItem**](AccountItemsApi.md#createAccountItem) | **POST** /account_items | 勘定科目の作成
8-
[**destroyAccountItem**](AccountItemsApi.md#destroyAccountItem) | **DELETE** /account_items/{id} | 勘定科目の削除
9-
[**getAccountItem**](AccountItemsApi.md#getAccountItem) | **GET** /account_items/{id} | 勘定科目の詳細情報の取得
10-
[**getAccountItems**](AccountItemsApi.md#getAccountItems) | **GET** /account_items | 勘定科目一覧の取得
11-
[**updateAccountItem**](AccountItemsApi.md#updateAccountItem) | **PUT** /account_items/{id} | 勘定科目の更新
7+
[**createAccountItem**](AccountItemsApi.md#createAccountItem) | **POST** /api/1/account_items | 勘定科目の作成
8+
[**destroyAccountItem**](AccountItemsApi.md#destroyAccountItem) | **DELETE** /api/1/account_items/{id} | 勘定科目の削除
9+
[**getAccountItem**](AccountItemsApi.md#getAccountItem) | **GET** /api/1/account_items/{id} | 勘定科目の詳細情報の取得
10+
[**getAccountItems**](AccountItemsApi.md#getAccountItems) | **GET** /api/1/account_items | 勘定科目一覧の取得
11+
[**updateAccountItem**](AccountItemsApi.md#updateAccountItem) | **PUT** /api/1/account_items/{id} | 勘定科目の更新
1212

1313

1414

@@ -65,7 +65,7 @@ Name | Type | Description | Notes
6565

6666
### HTTP request headers
6767

68-
- **Content-Type**: application/json, application/x-www-form-urlencoded
68+
- **Content-Type**: application/json
6969
- **Accept**: application/json
7070

7171
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)
@@ -128,7 +128,7 @@ void (empty response body)
128128
### HTTP request headers
129129

130130
- **Content-Type**: Not defined
131-
- **Accept**: Not defined
131+
- **Accept**: application/json
132132

133133
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)
134134
[[Back to Model list]](../../README.md#documentation-for-models)
@@ -316,7 +316,7 @@ Name | Type | Description | Notes
316316

317317
### HTTP request headers
318318

319-
- **Content-Type**: application/json, application/x-www-form-urlencoded
319+
- **Content-Type**: application/json
320320
- **Accept**: application/json
321321

322322
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)

docs/Api/BanksApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Freee\Accounting\BanksApi
22

3-
All URIs are relative to *https://api.freee.co.jp/api/1*
3+
All URIs are relative to *https://api.freee.co.jp*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**getBank**](BanksApi.md#getBank) | **GET** /banks/{id} | 連携サービスの取得
8-
[**getBanks**](BanksApi.md#getBanks) | **GET** /banks | 連携サービス一覧の取得
7+
[**getBank**](BanksApi.md#getBank) | **GET** /api/1/banks/{id} | 連携サービスの取得
8+
[**getBanks**](BanksApi.md#getBanks) | **GET** /api/1/banks | 連携サービス一覧の取得
99

1010

1111

docs/Api/CompaniesApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Freee\Accounting\CompaniesApi
22

3-
All URIs are relative to *https://api.freee.co.jp/api/1*
3+
All URIs are relative to *https://api.freee.co.jp*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**getCompanies**](CompaniesApi.md#getCompanies) | **GET** /companies | 事業所一覧の取得
8-
[**getCompany**](CompaniesApi.md#getCompany) | **GET** /companies/{id} | 事業所の詳細情報の取得
9-
[**updateCompany**](CompaniesApi.md#updateCompany) | **PUT** /companies/{id} | 事業所情報の更新
7+
[**getCompanies**](CompaniesApi.md#getCompanies) | **GET** /api/1/companies | 事業所一覧の取得
8+
[**getCompany**](CompaniesApi.md#getCompany) | **GET** /api/1/companies/{id} | 事業所の詳細情報の取得
9+
[**updateCompany**](CompaniesApi.md#updateCompany) | **PUT** /api/1/companies/{id} | 事業所情報の更新
1010

1111

1212

@@ -199,7 +199,7 @@ Name | Type | Description | Notes
199199

200200
### HTTP request headers
201201

202-
- **Content-Type**: application/json, application/x-www-form-urlencoded
202+
- **Content-Type**: application/json
203203
- **Accept**: application/json
204204

205205
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)

docs/Api/DealsApi.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Freee\Accounting\DealsApi
22

3-
All URIs are relative to *https://api.freee.co.jp/api/1*
3+
All URIs are relative to *https://api.freee.co.jp*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createDeal**](DealsApi.md#createDeal) | **POST** /deals | 取引(収入/支出)の作成
8-
[**destroyDeal**](DealsApi.md#destroyDeal) | **DELETE** /deals/{id} | 取引(収入/支出)の削除
9-
[**getDeal**](DealsApi.md#getDeal) | **GET** /deals/{id} | 取引(収入/支出)の取得
10-
[**getDeals**](DealsApi.md#getDeals) | **GET** /deals | 取引(収入/支出)一覧の取得
11-
[**updateDeal**](DealsApi.md#updateDeal) | **PUT** /deals/{id} | 取引(収入/支出)の更新
7+
[**createDeal**](DealsApi.md#createDeal) | **POST** /api/1/deals | 取引(収入/支出)の作成
8+
[**destroyDeal**](DealsApi.md#destroyDeal) | **DELETE** /api/1/deals/{id} | 取引(収入/支出)の削除
9+
[**getDeal**](DealsApi.md#getDeal) | **GET** /api/1/deals/{id} | 取引(収入/支出)の取得
10+
[**getDeals**](DealsApi.md#getDeals) | **GET** /api/1/deals | 取引(収入/支出)一覧の取得
11+
[**updateDeal**](DealsApi.md#updateDeal) | **PUT** /api/1/deals/{id} | 取引(収入/支出)の更新
1212

1313

1414

@@ -18,7 +18,7 @@ Method | HTTP request | Description
1818
1919
取引(収入/支出)の作成
2020

21-
<h2 id=\"\">概要</h2> <p>指定した事業所の取引(収入/支出)を作成する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>issue_date : 発生日</p> </li> <li> <p>due_date : 支払期日</p> </li> <li> <p>amount : 金額</p> </li> <li> <p>due_amount : 支払残額</p> </li> <li> <p>type</p> <ul> <li>income : 収入</li> <li>expense : 支出</li> </ul> </li> <li> <p>ref_number : 管理番号</p> </li> <li> <p>details : 取引の明細行</p> </li> <li> <p>payments : 取引の支払行</p> </li> <li> <p>from_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : 現金</li> <li>private_account_item : プライベート資金(法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借)</li> </ul> </li> </ul> <h2 id=\"_3\">注意点</h2> <ul> <li> <p>tax_idは廃止予定です。tax_codeをご利用ください。</p> </li> <li> <p>tax_code, tax_idはどちらかの指定が必須です。両方指定した場合はtax_codeが優先されます。</p> </li> <p><li>本APIでは+更新行(renews)の操作ができません。+更新行の作成APIをご利用ください。</p></li> <p><li>セグメントタグ情報は法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</p></li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。</p></li> </ul>
21+
<h2 id=\"\">概要</h2> <p>指定した事業所の取引(収入/支出)を作成する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>issue_date : 発生日</p> </li> <li> <p>due_date : 支払期日</p> </li> <li> <p>amount : 金額</p> </li> <li> <p>due_amount : 支払残額</p> </li> <li> <p>type</p> <ul> <li>income : 収入</li> <li>expense : 支出</li> </ul> </li> <li> <p>ref_number : 管理番号</p> </li> <li> <p>details : 取引の明細行</p> </li> <li> <p>payments : 取引の支払行</p> </li> <li> <p>receipt_ids : 証憑ファイルID</p> </li> <li> <p>from_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : 現金</li> <li>private_account_item : プライベート資金(法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借)</li> </ul> </li> </ul> <h2 id=\"_3\">注意点</h2> <ul> <li> <p>tax_idは廃止予定です。tax_codeをご利用ください。</p> </li> <li> <p>tax_code, tax_idはどちらかの指定が必須です。両方指定した場合はtax_codeが優先されます。</p> </li> <p><li>本APIでは+更新行(renews)の操作ができません。+更新行の作成APIをご利用ください。</p></li> <p><li>セグメントタグ情報は法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</p></li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。</p></li> </ul>
2222

2323
### Example
2424

@@ -65,7 +65,7 @@ Name | Type | Description | Notes
6565

6666
### HTTP request headers
6767

68-
- **Content-Type**: application/json, application/x-www-form-urlencoded
68+
- **Content-Type**: application/json
6969
- **Accept**: application/json
7070

7171
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)
@@ -295,7 +295,7 @@ Name | Type | Description | Notes
295295
296296
取引(収入/支出)の更新
297297

298-
<h2 id=\"\">概要</h2> <p>指定した事業所の取引(収入/支出)を更新する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>issue_date : 発生日</p> </li> <li> <p>due_date : 支払期日</p> </li> <li> <p>amount : 金額</p> </li> <li> <p>due_amount : 支払残額</p> </li> <li> <p>type</p> <ul> <li>income : 収入</li> <li>expense : 支出</li> </ul> </li> <li> <p>details : 取引の明細行</p> </li> <li> <p>renews : 取引の+更新行</p> </li> <li> <p>payments : 取引の支払行</p> </li> <li> <p>from_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : 現金</li> <li>private_account_item : プライベート資金(法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借)</li> </ul> </li> </ul> <h2 id=\"_3\">注意点</h2> <ul> <li>本APIでは支払行(payments)の操作ができません。支払行の作成・更新・削除APIをご利用ください。</li> <li>本APIでは+更新行(renews)の操作ができません。+更新行の作成・更新・削除APIをご利用ください。</li> <li>本APIでは収入/支出の切替えができません。既存の取引を削除後、再度作成してください。</li> <li>本APIで取引を更新すると、消費税の計算方法は必ず内税方式が選択されます。</li> <li>セグメントタグ情報は法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</li> <li>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。</ul>
298+
<h2 id=\"\">概要</h2> <p>指定した事業所の取引(収入/支出)を更新する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>issue_date : 発生日</p> </li> <li> <p>due_date : 支払期日</p> </li> <li> <p>amount : 金額</p> </li> <li> <p>due_amount : 支払残額</p> </li> <li> <p>type</p> <ul> <li>income : 収入</li> <li>expense : 支出</li> </ul> </li> <li> <p>details : 取引の明細行</p> </li> <li> <p>renews : 取引の+更新行</p> </li> <li> <p>payments : 取引の支払行</p> </li> <li> <p>from_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : 現金</li> <li>private_account_item : プライベート資金(法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借)</li> </ul> </li> <li> <p>receipt_ids : 証憑ファイルID</p> </li> </ul> <h2 id=\"_3\">注意点</h2> <ul> <li>本APIでは支払行(payments)の操作ができません。支払行の作成・更新・削除APIをご利用ください。</li> <li>本APIでは+更新行(renews)の操作ができません。+更新行の作成・更新・削除APIをご利用ください。</li> <li>本APIでは収入/支出の切替えができません。既存の取引を削除後、再度作成してください。</li> <li>本APIで取引を更新すると、消費税の計算方法は必ず内税方式が選択されます。</li> <li>セグメントタグ情報は法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</li> <li>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。</ul>
299299

300300
### Example
301301

@@ -344,7 +344,7 @@ Name | Type | Description | Notes
344344

345345
### HTTP request headers
346346

347-
- **Content-Type**: application/json, application/x-www-form-urlencoded
347+
- **Content-Type**: application/json
348348
- **Accept**: application/json
349349

350350
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)

docs/Api/ExpenseApplicationLineTemplatesApi.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Freee\Accounting\ExpenseApplicationLineTemplatesApi
22

3-
All URIs are relative to *https://api.freee.co.jp/api/1*
3+
All URIs are relative to *https://api.freee.co.jp*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#createExpenseApplicationLineTemplate) | **POST** /expense_application_line_templates | 経費科目の作成
8-
[**destroyExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#destroyExpenseApplicationLineTemplate) | **DELETE** /expense_application_line_templates/{id} | 経費科目の削除
9-
[**getExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#getExpenseApplicationLineTemplate) | **GET** /expense_application_line_templates/{id} | 経費科目の取得
10-
[**getExpenseApplicationLineTemplates**](ExpenseApplicationLineTemplatesApi.md#getExpenseApplicationLineTemplates) | **GET** /expense_application_line_templates | 経費科目一覧の取得
11-
[**updateExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#updateExpenseApplicationLineTemplate) | **PUT** /expense_application_line_templates/{id} | 経費科目の更新
7+
[**createExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#createExpenseApplicationLineTemplate) | **POST** /api/1/expense_application_line_templates | 経費科目の作成
8+
[**destroyExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#destroyExpenseApplicationLineTemplate) | **DELETE** /api/1/expense_application_line_templates/{id} | 経費科目の削除
9+
[**getExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#getExpenseApplicationLineTemplate) | **GET** /api/1/expense_application_line_templates/{id} | 経費科目の取得
10+
[**getExpenseApplicationLineTemplates**](ExpenseApplicationLineTemplatesApi.md#getExpenseApplicationLineTemplates) | **GET** /api/1/expense_application_line_templates | 経費科目一覧の取得
11+
[**updateExpenseApplicationLineTemplate**](ExpenseApplicationLineTemplatesApi.md#updateExpenseApplicationLineTemplate) | **PUT** /api/1/expense_application_line_templates/{id} | 経費科目の更新
1212

1313

1414

@@ -63,7 +63,7 @@ Name | Type | Description | Notes
6363

6464
### HTTP request headers
6565

66-
- **Content-Type**: application/json, application/x-www-form-urlencoded
66+
- **Content-Type**: application/json
6767
- **Accept**: application/json
6868

6969
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)
@@ -95,7 +95,7 @@ $apiInstance = new Freee\Accounting\Api\ExpenseApplicationLineTemplatesApi(
9595
$config
9696
);
9797
$id = 56; // int | 経費科目ID
98-
$company_id = new \stdClass; // object | 事業所ID
98+
$company_id = 56; // int | 事業所ID
9999

100100
try {
101101
$apiInstance->destroyExpenseApplicationLineTemplate($id, $company_id);
@@ -111,7 +111,7 @@ try {
111111
Name | Type | Description | Notes
112112
------------- | ------------- | ------------- | -------------
113113
**id** | **int**| 経費科目ID |
114-
**company_id** | [**object**](../Model/.md)| 事業所ID |
114+
**company_id** | **int**| 事業所ID |
115115

116116
### Return type
117117

@@ -154,8 +154,8 @@ $apiInstance = new Freee\Accounting\Api\ExpenseApplicationLineTemplatesApi(
154154
new GuzzleHttp\Client(),
155155
$config
156156
);
157-
$id = new \stdClass; // object | 経費科目ID
158-
$company_id = new \stdClass; // object | 事業所ID
157+
$id = 56; // int | 経費科目ID
158+
$company_id = 56; // int | 事業所ID
159159

160160
try {
161161
$result = $apiInstance->getExpenseApplicationLineTemplate($id, $company_id);
@@ -171,8 +171,8 @@ try {
171171

172172
Name | Type | Description | Notes
173173
------------- | ------------- | ------------- | -------------
174-
**id** | [**object**](../Model/.md)| 経費科目ID |
175-
**company_id** | [**object**](../Model/.md)| 事業所ID |
174+
**id** | **int**| 経費科目ID |
175+
**company_id** | **int**| 事業所ID |
176176

177177
### Return type
178178

@@ -280,7 +280,7 @@ $apiInstance = new Freee\Accounting\Api\ExpenseApplicationLineTemplatesApi(
280280
new GuzzleHttp\Client(),
281281
$config
282282
);
283-
$id = new \stdClass; // object | 経費科目ID
283+
$id = 56; // int | 経費科目ID
284284
$parameters = new \Freee\Accounting\Model\ExpenseApplicationLineTemplateParams(); // \Freee\Accounting\Model\ExpenseApplicationLineTemplateParams | 経費科目の更新
285285

286286
try {
@@ -297,7 +297,7 @@ try {
297297

298298
Name | Type | Description | Notes
299299
------------- | ------------- | ------------- | -------------
300-
**id** | [**object**](../Model/.md)| 経費科目ID |
300+
**id** | **int**| 経費科目ID |
301301
**parameters** | [**\Freee\Accounting\Model\ExpenseApplicationLineTemplateParams**](../Model/ExpenseApplicationLineTemplateParams.md)| 経費科目の更新 |
302302

303303
### Return type
@@ -310,7 +310,7 @@ Name | Type | Description | Notes
310310

311311
### HTTP request headers
312312

313-
- **Content-Type**: application/json, application/x-www-form-urlencoded
313+
- **Content-Type**: application/json
314314
- **Accept**: application/json
315315

316316
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)

0 commit comments

Comments
 (0)