軽減税率一覧取得

GET

/reduce_tax_rates

サンドボックス
本番

軽減税率一覧を取得します。

契約共通で固定のID値で設定されている軽減税率に加え、カスタム軽減税率として契約ごとに設定された軽減税率が取得できます。

対象プラン

スタンダード
プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.transactions:read
UserAccessToken
pos.transactions:read

Parameters

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

reduceTaxId：軽減税率ID
division：軽減税率区分
rate：軽減税率
termStart：適用開始日
termEnd：適用終了日

limit

integer

上限数

page

integer

ページ

reduce_tax_id

string

軽減税率ID

division

string

軽減税率区分：軽減税率の適用時、部門や商品にこの軽減税率が設定されている場合にこれをそのまま適用して販売するか、それとも状態（提供方法など）によって標準税率と軽減税率で適用税率を切り替えて販売するかの区分値が設定されます。
1:特定商品や特定部門の軽減税率適用
2:状態による軽減税率適用

target_date

string

対象日：指定した場合、対象日時点で有効な軽減税率を取得します。 [YYYY-MM-DD]

Responses

200

取得成功

Array<object>

object

reduceTaxId

軽減税率ID

string

name

軽減税率名：軽減税率につけられた名称です。

string

division

string

rate

軽減税率：軽減税率がパーセントで設定されます。（数字3桁、小数は第3位まで）

string

termStart

適用開始日：軽減税率が適用可能な期間の開始日です。

string

termEnd

適用終了日：軽減税率が適用可能な期間の最終日です。

string

condition

ボタン名称：軽減税率区分が 2:状態による軽減税率適用の場合、スマレジ・アプリ上で適用する／適用しないを選択するボタンの名称が、カンマ(,)区切りで設定されます。
※ 軽減税率区分が 1:特定商品や特定部門の軽減税率適用の場合は null が設定されます。

string

advancedCondition

ボタン選択初期値：軽減税率区分が 2:状態による権限税率適用の場合、スマレジ・アプリ上で適用する／適用しないを選択するボタンのうち、初期状態でどちらが選択されているかが設定されます。（null:都度選択する、0:適用しない、1:適用する）
※ 軽減税率区分が 1:特定商品や特定部門の軽減税率適用の場合も null が設定されます。

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

[
  {
    "reduceTaxId": "10000001",
    "name": "string",
    "division": "string",
    "rate": "string",
    "termStart": "string",
    "termEnd": "string",
    "condition": "string",
    "advancedCondition": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]