受注税金内訳取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_tax_account/search

リファレンス内容

検索について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)	【指定してaccess_tokenの有効期限が切れた場合】正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます【省略してaccess_tokenの有効期限が切れた場合】出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
`wait_flag`	1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却	可能(省略時は1以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
`receive_order_ids`	検索対象にする受注伝票の伝票番号（カンマ区切りで複数可）	必須	最大1000件まで指定可能です

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`access_token_end_date`	access_tokenの有効期限切れ日時
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`refresh_token_end_date`	refresh_tokenの有効期限切れ日時
`count`	検索結果の件数
`data`	検索結果の連想配列(JSONのオブジェクト型)

検索速度について

入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります

検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい

大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します

受注税金内訳

項目名	フィールド名	データ型	備考
伝票番号	`receive_order_id`	数値型	ネクストエンジン内で一意に付与される番号
請求金額（0%）	`receive_order_request_amount_tax0`	数値型	税率毎の（商品計+送料+手数料) - (クーポン+ポイント)
請求金額（8%）	`receive_order_request_amount_tax8`	数値型	税率毎の（商品計+送料+手数料) - (クーポン+ポイント)
請求金額（10%）	`receive_order_request_amount_tax10`	数値型	税率毎の（商品計+送料+手数料) - (クーポン+ポイント)
請求額に対する税額（8%）	`receive_order_request_amount_tax_tax8`	数値型	税率ごとの請求金額から割り戻した消費税額
請求額に対する税額（10%）	`receive_order_request_amount_tax_tax10`	数値型	税率ごとの請求金額から割り戻した消費税額
手数料（0%）	`receive_order_charge_amount_tax0`	数値型
手数料（8%）	`receive_order_charge_amount_tax8`	数値型
手数料（10%）	`receive_order_charge_amount_tax10`	数値型
他費用（0%）	`receive_order_other_amount_tax0`	数値型	受注伝票の「他費用」のうち、加算する金額（税率毎）
他費用（8%）	`receive_order_other_amount_tax8`	数値型	受注伝票の「他費用」のうち、加算する金額（税率毎）
他費用（10%）	`receive_order_other_amount_tax10`	数値型	受注伝票の「他費用」のうち、加算する金額（税率毎）
按分済みクーポン割引額（0%）	`receive_order_distributed_coupon_amount_tax0`	数値型	（「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください）受注伝票の「他費用」の値引金額（税率毎）
按分済みクーポン割引額（8%）	`receive_order_distributed_coupon_amount_tax8`	数値型	（「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください）受注伝票の「他費用」の値引金額（税率毎）
按分済みクーポン割引額（10%）	`receive_order_distributed_coupon_amount_tax10`	数値型	（「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください）受注伝票の「他費用」のうち、値引の金額（税率毎）
クーポン割引額（0%）	`receive_order_coupon_amount_tax0`	数値型	受注伝票の「他費用」のうち、値引の金額（税率毎）
クーポン割引額（8%）	`receive_order_coupon_amount_tax8`	数値型	受注伝票の「他費用」のうち、値引の金額（税率毎）
クーポン割引額（10%）	`receive_order_coupon_amount_tax10`	数値型	受注伝票の「他費用」のうち、値引の金額（税率毎）
クーポン割引額（按分）	`receive_order_coupon_amount_distribute`	数値型	受注伝票の「他費用」のうち、値引の金額（按分されるクーポン割引額）
按分済みポイント（0%）	`receive_order_distributed_point_amount_tax0`	数値型	(「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください）ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
按分済みポイント（8%）	`receive_order_distributed_point_amount_tax8`	数値型	(「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください）ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
按分済みポイント（10%）	`receive_order_distributed_point_amount_tax10`	数値型	(「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください）ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
ポイント（0%）	`receive_order_point_amount_tax0`	数値型	ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
ポイント（8%）	`receive_order_point_amount_tax8`	数値型	ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
ポイント（10%）	`receive_order_point_amount_tax10`	数値型	ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
ポイント（按分）	`receive_order_point_amount_distribute`	数値型	ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（按分されるポイント）
ポイント（支払い）	`receive_order_point_amount_payment`	数値型

サンプル

リクエスト

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

レスポンス

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

エラー

エラーコード

エンドポイント固有のエラーコードはありません。共通エラーコードはメッセージコード一覧を参照してください。