コンテンツにスキップ

税区分情報取得

POST
/api_v1_system_tax/info
// POST /api_v1_system_tax/info - 税区分情報取得
const params = new URLSearchParams({
access_token: '<access_token>',
})
const res = await fetch('https://api.next-engine.org/api_v1_system_tax/info', {
method: 'POST',
headers: { 'content-type': 'application/x-www-form-urlencoded' },
body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)
Media type application/x-www-form-urlencoded

ネクストエンジン API 共通リクエストパラメータ

object
access_token
required

OAuth2 アクセストークン (必須)

string
refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string
wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string
Allowed values: 0 1
fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string
offset

検索開始位置 (search 系のみ)

integer
limit

取得件数 (search 系のみ)

integer
>= 1

実行結果 (result が success / error / redirect のいずれか)

Media type application/json
object
result
required

実行結果ステータス

string
Allowed values: success error redirect
code

エラー時のエラーコード

string
message
One of:
string
access_token

更新後のアクセストークン

string
access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string
refresh_token

更新後のリフレッシュトークン

string
refresh_token_end_date

リフレッシュトークン有効期限

string
data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string
data
Array<object>
object
tax_id

税区分 / 文字列型

string | integer | number | boolean | null
tax_name

税名 / 文字列型

string | integer | number | boolean | null
key
additional properties
any
Example
{
"result": "success",
"count": "2",
"data": [
{
"tax_id": "0",
"tax_name": "税込"
},
{
"tax_id": "1",
"tax_name": "税抜"
}
],
"access_token": "xxxxxxxxxxx",
"access_token_end_date": "2017-04-13 18:24:53",
"refresh_token": "xxxxxxxxxxx",
"refresh_token_end_date": "2017-04-15 18:24:53"
}

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

Media type application/json
object
result
required

実行結果ステータス

string
Allowed values: success error redirect
code

エラー時のエラーコード

string
message
One of:
string
access_token

更新後のアクセストークン

string
access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string
refresh_token

更新後のリフレッシュトークン

string
refresh_token_end_date

リフレッシュトークン有効期限

string
data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string
Example
{
"result": "success"
}