From f3795286e69b454d31a62cafcc805785c55eca75 Mon Sep 17 00:00:00 2001 From: Yusuke Suematsu Date: Fri, 23 Dec 2022 17:48:31 +0900 Subject: [PATCH] update schema --- _sdk_compatible/open-api-3/api-schema.json | 38 +++++++++-------- _sdk_compatible/open-api-3/api-schema.yml | 45 +++++++++++++------- v2020_06_15/open-api-3/api-schema.yml | 49 +++++++++++++++------- 3 files changed, 85 insertions(+), 47 deletions(-) diff --git a/_sdk_compatible/open-api-3/api-schema.json b/_sdk_compatible/open-api-3/api-schema.json index 450fa4a..776fff0 100644 --- a/_sdk_compatible/open-api-3/api-schema.json +++ b/_sdk_compatible/open-api-3/api-schema.json @@ -16808,7 +16808,7 @@ "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, - "description": "取引金額(税込で指定してください)", + "description": "取引金額(税込で指定してください)
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1 }, "item_id": { @@ -17019,7 +17019,7 @@ "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, - "description": "取引金額(税込で指定してください)", + "description": "取引金額(税込で指定してください)
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1 }, "item_id": { @@ -29105,7 +29105,7 @@ "type": "integer", "minimum": 1, "maximum": 2147483647, - "description": "決済口座のデフォルト", + "description": "デフォルトの決済口座が紐づく勘定科目ID", "example": 1 }, "private_settlement": { @@ -29153,7 +29153,8 @@ "zipcode": { "type": "string", "description": "郵便番号", - "example": "000-0000" + "example": "000-0000", + "nullable": true }, "prefecture_code": { "type": "integer", @@ -29166,12 +29167,14 @@ "street_name1": { "type": "string", "description": "市区町村・番地", - "example": "XX区YY1−1−1" + "example": "XX区YY1−1−1", + "nullable": true }, "street_name2": { "type": "string", "description": "建物名・部屋番号など", - "example": "ビル1F" + "example": "ビル1F", + "nullable": true }, "invoice_layout": { "type": "string", @@ -29195,9 +29198,15 @@ "description": "金額端数処理方法(0: 切り捨て、1: 切り上げ、2: 四捨五入)", "example": 0 }, + "use_partner_code": { + "type": "boolean", + "description": "取引先コードの利用設定(true: 有効、 false: 無効)", + "example": true + }, "industry_class": { "type": "string", - "description": "種別(agriculture_forestry_fisheries_ore: 農林水産業/鉱業、construction: 建設、manufacturing_processing: 製造/加工、it: IT、transportation_logistics: 運輸/物流、retail_wholesale: 小売/卸売、finance_insurance: 金融/保険、real_estate_rental: 不動産/レンタル、profession: 士業/学術/専門技術サービス、design_production: デザイン/制作、food: 飲食、leisure_entertainment: レジャー/娯楽、lifestyle: 生活関連サービス、education: 教育/学習支援、medical_welfare: 医療/福祉、other_services: その他サービス、other: その他, \"\": 未選択)", + "nullable": true, + "description": "種別(agriculture_forestry_fisheries_ore: 農林水産業/鉱業,construction: 建設,manufacturing_processing: 製造/加工,it: IT,transportation_logistics: 運輸/物流,retail_wholesale: 小売/卸売,finance_insurance: 金融/保険,real_estate_rental: 不動産/レンタル,profession: 士業/学術/専門技術サービス,design_production: デザイン/制作,food: 飲食,leisure_entertainment: レジャー/娯楽,lifestyle: 生活関連サービス,education: 教育/学習支援,medical_welfare: 医療/福祉,other_services: その他サービス,other_association: NPO、一般社団法人等,other: その他, \"\": 未選択)", "example": "agriculture_forestry_fisheries_ore", "enum": [ "agriculture_forestry_fisheries_ore", @@ -29216,6 +29225,7 @@ "education", "medical_welfare", "other_services", + "other_association", "other", "" ] @@ -29365,11 +29375,6 @@ "disable" ] }, - "use_partner_code": { - "type": "boolean", - "description": "取引先コードの利用設定(true: 有効、 false: 無効)", - "example": true - }, "fiscal_years": { "type": "array", "items": { @@ -29489,7 +29494,6 @@ "type": "object", "required": [ "id", - "code", "name" ], "properties": { @@ -33046,7 +33050,7 @@ "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, - "description": "取引金額(税込で指定してください)", + "description": "取引金額(税込で指定してください)
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1080 }, "vat": { @@ -33169,7 +33173,7 @@ "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, - "description": "取引金額(税込で指定してください)", + "description": "取引金額(税込で指定してください)
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1080 }, "vat": { @@ -34553,7 +34557,7 @@ }, "total_vat": { "type": "integer", - "description": "合計金額", + "description": "消費税", "example": 8000 }, "sub_total": { @@ -35134,7 +35138,7 @@ }, "total_vat": { "type": "integer", - "description": "合計金額", + "description": "消費税", "example": 8000 }, "sub_total": { diff --git a/_sdk_compatible/open-api-3/api-schema.yml b/_sdk_compatible/open-api-3/api-schema.yml index cdc1885..85303f0 100644 --- a/_sdk_compatible/open-api-3/api-schema.yml +++ b/_sdk_compatible/open-api-3/api-schema.yml @@ -12999,7 +12999,7 @@ components: example: '1234567890123' type: string default_wallet_account_id: - description: 決済口座のデフォルト + description: デフォルトの決済口座が紐づく勘定科目ID example: 1 maximum: 2147483647 minimum: 1 @@ -13032,12 +13032,13 @@ components: minimum: 1 type: integer industry_class: - description: '種別(agriculture_forestry_fisheries_ore: 農林水産業/鉱業、construction: - 建設、manufacturing_processing: 製造/加工、it: IT、transportation_logistics: - 運輸/物流、retail_wholesale: 小売/卸売、finance_insurance: 金融/保険、real_estate_rental: - 不動産/レンタル、profession: 士業/学術/専門技術サービス、design_production: デザイン/制作、food: - 飲食、leisure_entertainment: レジャー/娯楽、lifestyle: 生活関連サービス、education: 教育/学習支援、medical_welfare: - 医療/福祉、other_services: その他サービス、other: その他, "": 未選択)' + description: '種別(agriculture_forestry_fisheries_ore: 農林水産業/鉱業,construction: + 建設,manufacturing_processing: 製造/加工,it: IT,transportation_logistics: + 運輸/物流,retail_wholesale: 小売/卸売,finance_insurance: 金融/保険,real_estate_rental: + 不動産/レンタル,profession: 士業/学術/専門技術サービス,design_production: デザイン/制作,food: + 飲食,leisure_entertainment: レジャー/娯楽,lifestyle: 生活関連サービス,education: 教育/学習支援,medical_welfare: + 医療/福祉,other_services: その他サービス,other_association: NPO、一般社団法人等,other: + その他, "": 未選択)' enum: - agriculture_forestry_fisheries_ore - construction @@ -13055,9 +13056,11 @@ components: - education - medical_welfare - other_services + - other_association - other - '' example: agriculture_forestry_fisheries_ore + nullable: true type: string industry_code: description: |- @@ -13437,7 +13440,6 @@ components: type: string required: - id - - code - name type: object type: array @@ -13506,10 +13508,12 @@ components: street_name1: description: 市区町村・番地 example: XX区YY1−1−1 + nullable: true type: string street_name2: description: 建物名・部屋番号など example: ビル1F + nullable: true type: string tax_at_source_calc_type: description: '源泉徴収税計算(0: 消費税を含める、1: 消費税を含めない)' @@ -13591,6 +13595,7 @@ components: zipcode: description: 郵便番号 example: 000-0000 + nullable: true type: string required: - amount_fraction @@ -14114,7 +14119,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1 format: int64 maximum: 9223372036854775807 @@ -14611,7 +14619,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1 format: int64 maximum: 9223372036854775807 @@ -16576,7 +16587,7 @@ components: - vat_8 type: object total_vat: - description: 合計金額 + description: 消費税 example: 8000 type: integer web_confirmed_at: @@ -17108,7 +17119,7 @@ components: - vat_8 type: object total_vat: - description: 合計金額 + description: 消費税 example: 8000 type: integer web_confirmed_at: @@ -22141,7 +22152,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1080 format: int64 maximum: 9223372036854775807 @@ -22250,7 +22264,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1080 format: int64 maximum: 9223372036854775807 diff --git a/v2020_06_15/open-api-3/api-schema.yml b/v2020_06_15/open-api-3/api-schema.yml index 1bcc2ee..12bf499 100644 --- a/v2020_06_15/open-api-3/api-schema.yml +++ b/v2020_06_15/open-api-3/api-schema.yml @@ -17,7 +17,7 @@ info:

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

認証について

-

OAuth2.0を利用します。詳細はドキュメントの認証パートを参照してください。

+

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

データフォーマット

@@ -258,7 +258,7 @@ paths:

指定した事業所の勘定科目を作成する

注意点

-

tax_nameは、api/1/taxes/companies/{company_id} で該当事業所の税区分の一覧を取得して、availableの値がtrue、かつ”name_ja”に”税率%”を含んでいない税区分を確認して、そのnameを指定して勘定科目の作成をしてください

+

tax_codeは、api/1/taxes/companies/{company_id} で該当事業所の税区分の一覧を取得して、availableの値がtrue、かつ”name_ja”に”税率%”を含んでいない税区分を確認して、そのcodeを指定して勘定科目の作成をしてください

operationId: create_account_item requestBody: content: @@ -16625,7 +16625,7 @@ components: example: '1234567890123' type: string default_wallet_account_id: - description: 決済口座のデフォルト + description: デフォルトの決済口座が紐づく勘定科目ID example: 1 maximum: 2147483647 minimum: 1 @@ -16658,12 +16658,13 @@ components: minimum: 1 type: integer industry_class: - description: '種別(agriculture_forestry_fisheries_ore: 農林水産業/鉱業、construction: - 建設、manufacturing_processing: 製造/加工、it: IT、transportation_logistics: - 運輸/物流、retail_wholesale: 小売/卸売、finance_insurance: 金融/保険、real_estate_rental: - 不動産/レンタル、profession: 士業/学術/専門技術サービス、design_production: デザイン/制作、food: - 飲食、leisure_entertainment: レジャー/娯楽、lifestyle: 生活関連サービス、education: 教育/学習支援、medical_welfare: - 医療/福祉、other_services: その他サービス、other: その他, "": 未選択)' + description: '種別(agriculture_forestry_fisheries_ore: 農林水産業/鉱業,construction: + 建設,manufacturing_processing: 製造/加工,it: IT,transportation_logistics: + 運輸/物流,retail_wholesale: 小売/卸売,finance_insurance: 金融/保険,real_estate_rental: + 不動産/レンタル,profession: 士業/学術/専門技術サービス,design_production: デザイン/制作,food: + 飲食,leisure_entertainment: レジャー/娯楽,lifestyle: 生活関連サービス,education: 教育/学習支援,medical_welfare: + 医療/福祉,other_services: その他サービス,other_association: NPO、一般社団法人等,other: + その他, "": 未選択)' enum: - agriculture_forestry_fisheries_ore - construction @@ -16681,9 +16682,11 @@ components: - education - medical_welfare - other_services + - other_association - other - '' example: agriculture_forestry_fisheries_ore + nullable: true type: string industry_code: description: |- @@ -17063,7 +17066,6 @@ components: type: string required: - id - - code - name type: object type: array @@ -17132,10 +17134,12 @@ components: street_name1: description: 市区町村・番地 example: XX区YY1−1−1 + nullable: true type: string street_name2: description: 建物名・部屋番号など example: ビル1F + nullable: true type: string tax_at_source_calc_type: description: '源泉徴収税計算(0: 消費税を含める、1: 消費税を含めない)' @@ -17217,6 +17221,7 @@ components: zipcode: description: 郵便番号 example: 000-0000 + nullable: true type: string required: - amount_fraction @@ -17740,7 +17745,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1 format: int64 maximum: 9223372036854775807 @@ -18237,7 +18245,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1 format: int64 maximum: 9223372036854775807 @@ -20202,7 +20213,7 @@ components: - vat_8 type: object total_vat: - description: 合計金額 + description: 消費税 example: 8000 type: integer web_confirmed_at: @@ -20734,7 +20745,7 @@ components: - vat_8 type: object total_vat: - description: 合計金額 + description: 消費税 example: 8000 type: integer web_confirmed_at: @@ -25767,7 +25778,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1080 format: int64 maximum: 9223372036854775807 @@ -25876,7 +25890,10 @@ components: minimum: 1 type: integer amount: - description: 取引金額(税込で指定してください) + description: | + 取引金額(税込で指定してください)
+ マイナスの値を指定した場合、控除・マイナス行として登録されます。
+ 上記以外の値を指定した場合、通常行として登録されます。 example: 1080 format: int64 maximum: 9223372036854775807