税ルール一覧取得

GET

/tax_rules

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/tax_rules?limit=10&page=1&sort=applyAt%3Adesc';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/tax_rules?limit=10&page=1&sort=applyAt%3Adesc' \
  --header 'Authorization: Bearer <token>'

税ルールの一覧を取得します。

Authorizations

AppAccessToken
ec-b2b.tax-rules:read

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

取得件数

page

integer

default: 1 >= 1

ページ

sort

string

default: applyAt:desc

Allowed values: applyAt applyAt:desc

ソート

applyAt: 適用開始日時

Example

applyAt:desc

Responses

200

取得成功

application/json

Array

TaxRuleResponse

object

税ルールID

string format: uuid

taxRate

税率（%）

integer

calcRule

端数処理ルール

0: 処理無し
1: 四捨五入
2: 切り捨て
3: 切り上げ

integer

Allowed values: 0 1 2 3

taxCalcType

税計算タイプ

2: 明細単位
3: 伝票単位

integer

Allowed values: 2 3

applyAt

適用開始日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Examples

default

[
  {
    "id": "12345678-1234-1234-1234-1234567890ab",
    "taxRate": 10,
    "calcRule": 2,
    "taxCalcType": 3,
    "applyAt": "2019-10-01T00:00:00+09:00"
  },
  {
    "id": "12345678-1234-1234-1234-1234567890cd",
    "taxRate": 8,
    "calcRule": 2,
    "taxCalcType": 3,
    "applyAt": "2014-04-01T00:00:00+09:00"
  },
  {
    "id": "12345678-1234-1234-1234-1234567890ef",
    "taxRate": 5,
    "calcRule": 2,
    "taxCalcType": 3,
    "applyAt": "1997-04-01T00:00:00+09:00"
  }
]

Headers

Link

string

<前ページURI>; rel="prev", <次ページURI>; rel="next"

400

入力チェックエラーの場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[limit]は100以下の数字を指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[page]は1以上の数字を指定してください。",
  "status": 400
}