コンテンツにスキップ

受注税金内訳取得

POST

/api_v1_receiveorder_tax_account/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_ids=10001,10002' https://api.next-engine.org/api_v1_receiveorder_tax_account/search

// POST /api_v1_receiveorder_tax_account/search - 受注税金内訳取得
const params = new URLSearchParams({
  access_token: '<access_token>',
  receive_order_ids: '<receive_order_ids>',
  fields: 'field1,field2',
  offset: '0',
  limit: '50',
})
const res = await fetch('https://api.next-engine.org/api_v1_receiveorder_tax_account/search', {
  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)

# POST /api_v1_receiveorder_tax_account/search - 受注税金内訳取得
import requests

params = {
    'access_token': '<access_token>',
    'receive_order_ids': '<receive_order_ids>',
    'fields': 'field1,field2',
    'offset': '0',
    'limit': '50',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_receiveorder_tax_account/search',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

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

receive_order_ids

required

検索対象にする受注伝票の伝票番号（カンマ区切りで複数可） / 最大1000件まで指定可能です

string

Responses

200

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

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

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

receive_order_id

伝票番号 / 数値型 / ネクストエンジン内で一意に付与される番号

string | integer | number | boolean | null

receive_order_request_amount_tax0

請求金額（0%） / 数値型 / 税率毎の（商品計+送料+手数料) - (クーポン+ポイント)

string | integer | number | boolean | null

receive_order_request_amount_tax8

請求金額（8%） / 数値型 / 税率毎の（商品計+送料+手数料) - (クーポン+ポイント)

string | integer | number | boolean | null

receive_order_request_amount_tax10

請求金額（10%） / 数値型 / 税率毎の（商品計+送料+手数料) - (クーポン+ポイント)

string | integer | number | boolean | null

receive_order_request_amount_tax_tax8

請求額に対する税額（8%） / 数値型 / 税率ごとの請求金額から割り戻した消費税額

string | integer | number | boolean | null

receive_order_request_amount_tax_tax10

請求額に対する税額（10%） / 数値型 / 税率ごとの請求金額から割り戻した消費税額

string | integer | number | boolean | null

receive_order_charge_amount_tax0

手数料（0%） / 数値型

string | integer | number | boolean | null

receive_order_charge_amount_tax8

手数料（8%） / 数値型

string | integer | number | boolean | null

receive_order_charge_amount_tax10

手数料（10%） / 数値型

string | integer | number | boolean | null

receive_order_other_amount_tax0

他費用（0%） / 数値型 / 受注伝票の「他費用」のうち、加算する金額（税率毎）

string | integer | number | boolean | null

receive_order_other_amount_tax8

他費用（8%） / 数値型 / 受注伝票の「他費用」のうち、加算する金額（税率毎）

string | integer | number | boolean | null

receive_order_other_amount_tax10

他費用（10%） / 数値型 / 受注伝票の「他費用」のうち、加算する金額（税率毎）

string | integer | number | boolean | null

receive_order_distributed_coupon_amount_tax0

按分済みクーポン割引額（0%） / 数値型 / （「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください）受注伝票の「他費用」の値引金額（税率毎）

string | integer | number | boolean | null

receive_order_distributed_coupon_amount_tax8

按分済みクーポン割引額（8%） / 数値型 / （「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください）受注伝票の「他費用」の値引金額（税率毎）

string | integer | number | boolean | null

receive_order_distributed_coupon_amount_tax10

按分済みクーポン割引額（10%） / 数値型 / （「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください）受注伝票の「他費用」のうち、値引の金額（税率毎）

string | integer | number | boolean | null

receive_order_coupon_amount_tax0

クーポン割引額（0%） / 数値型 / 受注伝票の「他費用」のうち、値引の金額（税率毎）

string | integer | number | boolean | null

receive_order_coupon_amount_tax8

クーポン割引額（8%） / 数値型 / 受注伝票の「他費用」のうち、値引の金額（税率毎）

string | integer | number | boolean | null

receive_order_coupon_amount_tax10

クーポン割引額（10%） / 数値型 / 受注伝票の「他費用」のうち、値引の金額（税率毎）

string | integer | number | boolean | null

receive_order_coupon_amount_distribute

クーポン割引額（按分） / 数値型 / 受注伝票の「他費用」のうち、値引の金額（按分されるクーポン割引額）

string | integer | number | boolean | null

receive_order_distributed_point_amount_tax0

按分済みポイント（0%） / 数値型 / (「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください）ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）

string | integer | number | boolean | null

receive_order_distributed_point_amount_tax8

按分済みポイント（8%） / 数値型 / (「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください）ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）

string | integer | number | boolean | null

receive_order_distributed_point_amount_tax10

按分済みポイント（10%） / 数値型 / (「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください）ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）

string | integer | number | boolean | null

receive_order_point_amount_tax0

ポイント（0%） / 数値型 / ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）

string | integer | number | boolean | null

receive_order_point_amount_tax8

ポイント（8%） / 数値型 / ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）

string | integer | number | boolean | null

receive_order_point_amount_tax10

ポイント（10%） / 数値型 / ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）

string | integer | number | boolean | null

receive_order_point_amount_distribute

ポイント（按分） / 数値型 / ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（按分されるポイント）

string | integer | number | boolean | null

receive_order_point_amount_payment

ポイント（支払い） / 数値型

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": 2,
  "data": [
    {
      "receive_order_id": 10001,
      "receive_order_request_amount_tax0": 0,
      "receive_order_request_amount_tax8": 0,
      "receive_order_request_amount_tax10": 11000,
      "receive_order_request_amount_tax_tax8": 0,
      "receive_order_request_amount_tax_tax10": 1000,
      "receive_order_charge_amount_tax0": 0,
      "receive_order_charge_amount_tax8": 0,
      "receive_order_charge_amount_tax10": 220,
      "receive_order_other_amount_tax0": 0,
      "receive_order_other_amount_tax8": 0,
      "receive_order_other_amount_tax10": 440,
      "receive_order_distributed_coupon_amount_tax0": 0,
      "receive_order_distributed_coupon_amount_tax8": 0,
      "receive_order_distributed_coupon_amount_tax10": 990,
      "receive_order_coupon_amount_tax0": 0,
      "receive_order_coupon_amount_tax8": 0,
      "receive_order_coupon_amount_tax10": 550,
      "receive_order_coupon_amount_distribute": 440,
      "receive_order_distributed_point_amount_tax0": 0,
      "receive_order_distributed_point_amount_tax8": 0,
      "receive_order_distributed_point_amount_tax10": 330,
      "receive_order_point_amount_tax0": 0,
      "receive_order_point_amount_tax8": 0,
      "receive_order_point_amount_tax10": 220,
      "receive_order_point_amount_distribute": 110,
      "receive_order_point_amount_payment": 1000
    },
    {
      "receive_order_id": 10002,
      "receive_order_request_amount_tax0": 100000,
      "receive_order_request_amount_tax8": 108000,
      "receive_order_request_amount_tax10": 110000,
      "receive_order_request_amount_tax_tax8": 8000,
      "receive_order_request_amount_tax_tax10": 10000,
      "receive_order_charge_amount_tax0": 1400,
      "receive_order_charge_amount_tax8": 1300,
      "receive_order_charge_amount_tax10": 1200,
      "receive_order_other_amount_tax0": 1100,
      "receive_order_other_amount_tax8": 1000,
      "receive_order_other_amount_tax10": 900,
      "receive_order_distributed_coupon_amount_tax0": 957,
      "receive_order_distributed_coupon_amount_tax8": 869,
      "receive_order_distributed_coupon_amount_tax10": 774,
      "receive_order_coupon_amount_tax0": 800,
      "receive_order_coupon_amount_tax8": 700,
      "receive_order_coupon_amount_tax10": 600,
      "receive_order_coupon_amount_distribute": 500,
      "receive_order_distributed_point_amount_tax0": 431,
      "receive_order_distributed_point_amount_tax8": 333,
      "receive_order_distributed_point_amount_tax10": 236,
      "receive_order_point_amount_tax0": 400,
      "receive_order_point_amount_tax8": 300,
      "receive_order_point_amount_tax10": 200,
      "receive_order_point_amount_distribute": 100,
      "receive_order_point_amount_payment": 1000
    }
  ],
  "access_token": "xxx",
  "access_token_end_date": "2023-09-21 09:01:00",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2023-09-23 09:01:00"
}

4XX

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

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

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"
}