コンテンツにスキップ

取引登録

POST
/transactions

取引を登録します。

対象プラン

  • スタンダード
  • プレミアム
  • プレミアムプラス
  • フードビジネス
  • リテールビジネス
object
transactionHeadDivision
required
取引区分

取引を識別する区分。
(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)
※ 10:取置きについては、取置き登録APIをご使用ください。
※ 8:ポイント失効、9:回数券、11:チップ、15バリューカード入金、16:領収証は対応しておりません。

string
Allowed values: 1 2 3 4 5 6 7 13 14
cancelDivision
取消区分

取引の取消を識別する区分。 (0:通常、1取消)

string
0
Allowed values: 0 1
subtotal
required
小計

取引明細の値引き後小計の合計。
※明細合計と異なる場合エラー

string format: int
>= -999999999 <= 999999999
subtotalDiscountPrice
小計値引き

小計の値引き金額を設定。

string format: int
>= -999999999 <= 999999999
subtotalDiscountRate
小計割引率

小計の割引を設定 (単位%) デフォルトは未設定。
設定された場合、小計値引は必須。
※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

string format: int
>= -999 <= 999
subtotalDiscountDivision
小計値引き/割引区分

小計値引き/割引時に指定された区分を設定。
管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

string format: int
>= 1 <= 999999999
pointDiscount
ポイント値引き

使用ポイント * ポイント還元率。

string format: int
>= -999999999 <= 999999999
total
required
合計

小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定
※ 端数値引き機能は現在ご利用いただけません

string format: int
>= -999999999 <= 999999999
taxInclude
内税額

内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string format: int
>= -999999999 <= 999999999
taxExclude
外税額

外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string format: int
>= -999999999 <= 999999999
roundingDivision
端数値引区分

販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力

string
Allowed values: 00 11 12 13 21 22 23 31 32 33 41 42 43 99
roundingPrice
端数値引額
string format: int
>= -999999999 <= 999999999
deposit
預かり金

会計時に預かった金額。(預かり金現金 + 預かり金クレジット + 預かり金その他)
※預かり金を正しく設定しないと、日報が正しく表示されません。

string format: int
>= -999999999 <= 999999999
depositCash
預かり金現金

会計時に預かった現金金額。
※現金支払の場合必ず設定。(預かり金現金 - 釣銭)が現金支払額に設定されます。
※預かり金を正しく設定しないと、日報が正しく表示されません。

string format: int
>= -999999999 <= 999999999
depositCredit
預かり金クレジット

会計時に預かったクレジット金額。
※クレジット払いの場合必ず設定。預かり金クレジットが内クレジット支払金額に設定されます。
※預かり金を正しく設定しないと、日報が正しく表示されません。

string format: int
>= -999999999 <= 999999999
change
釣銭

釣銭。現金の返却金額。
※預かり金を正しく設定しないと、日報が正しく表示されません。

string format: int
>= -999999999 <= 999999999
newPoint
付与ポイント

取引で付与されるポイント。 合計 * ポイント付与率
会員IDが設定されている場合、会員ポイント情報を更新。
※省略時は0を設定

1. スマレジのポイント算出方式について
  1. カード会社・支払方法にポイント付与単位(金額)とポイント付与単位(ポイント)の設定がない場合
    • 付与されるポイントはポイント対象金額 / ポイント付与単位(金額) * ポイント付与単位(ポイント)で計算されます。(端数切り捨て) スマレジ・アプリから取引登録された時に採用されるポイント付与情報は会員のポイント付与率が未設定だった場合は会員ランクを、 会員ランクも未設定だった場合は店舗のポイント付与単位(金額)及びポイント付与単位(ポイント)が採用されます。
      • 会員ランクのポイント付与単位(金額)及びポイント付与単位(金額)については、スマレジ管理画面の[設定]->[会員設定]->[会員ランク]よりご確認ください。
      • 店舗のポイント付与単位(金額)については店舗登録APIのRequest Body記載のpointCondition.pointGivingUnitPriceをご確認ください。
      • 会員のポイント付与単位(金額)については会員登録APIのRequest Body記載のpointGivingUnitPriceをご確認ください。
  2. カード会社・支払方法にポイント付与単位と付与ポイント数の設定がある場合
    • 下記の「2. カード会社・支払方法にポイント付与単位と付与ポイント数の設定がある場合のポイント計算例」をご参照ください。
2. カード会社・支払方法にポイント付与単位と付与ポイント数の設定がある場合のポイント計算例

支払い方法毎のポイント付与率

支払方法 TransactionHead上の金額対象項目 TransactionHead.depositOthers上の金額対象項目 ポイント付与単位(金額) ポイント付与単位(ポイント)
現金 depositCash - change + tax(※1) + pointDiscount(※2) - 100 1
提携クレジットカード depositCredit - 100 5
電子マネー - depositOthers 100 3
(※1)
取引(TransactionHead)の98: ポイント付与区分(pointGivingDivision)が
1 or 3のときはtax = taxExclude
2 or 4のときは tax = -1 * taxInclude
となります。
(※2)
取引(TransactionHead)の98: ポイント付与区分(pointGivingDivision)が
1 or 2のときはpointDiscount = TransactionHead.pointDiscount
3 or 4のときはpointDiscount = 0
となります。

1取引におけるポイント付与状況

各支払方法に対するポイントを計算します。
また、付与ポイント計算時に生じた端数金額については合算し、
その取引で最も高いポイント付与率を使用して再付与を行います。
支払方法 金額(円) 付与ポイント 端数金額(円) ポイント付与率(%) 端数金額より算出されるポイント
現金 1050 1050 / 100 * 1 = 10 1050 % 100 * 1 = 50 1 0 (付与率が最も高くないため)
提携クレジットカード 2070 2070 / 100 * 5 = 100 2070 % 100 * 5 = 70 5 (50 + 70 + 80) / 100 * 5 = 10
電子マネー 80 80 / 100 * 3 = 0 80 % 100 * 3 = 80 3 0 (付与率が最も高くないため)

合計ポイントの計算

合計付与ポイント: 10 + 100 + 0 + 10 = 120ポイント
<h3>注意事項</h3>

<ol>
  <li>
    スマレジ管理画面にて、指定のカード情報にポイント付与情報が設定されている場合は、そのポイント付与情報が優先されます。<br />
  </li>
  <li>
    1つの取引の中で釣銭を発生させる支払方法を指定した場合でも、発生した釣銭はdepositCash(現金)より減算されます。
  </li>
</ol>
string format: int
0 >= -999999999 <= 999999999
spendPoint
使用ポイント

取引で使用したポイント。
会員IDが設定されている場合、会員ポイント情報を更新。
※省略時は0を設定

string format: int
>= -999999999 <= 999999999
point
現在ポイント

取引前のポイント。

string format: int
>= -999999999 <= 999999999
totalPoint
合計ポイント

取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。

string format: int
>= -999999999 <= 999999999
currentMile
現在マイル

取引前のマイル

string format: int
>= -999999999 <= 999999999
earnMile
獲得マイル

取引で付与されるマイル
合計 * ポイント付与率

string format: int
>= -999999999 <= 999999999
totalMile
合計マイル

取引後のマイル
現在マイル + 獲得マイル + 調整マイル

string format: int
>= -999999999 <= 999999999
adjustmentMile
調整マイル

取引で手動で付与されるマイル

string format: int
>= -999999999 <= 999999999
adjustmentMileDivision
調整マイル区分

調整マイルの区分
1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)
2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)
3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)
4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」

string
Allowed values: 1 2 3 4
adjustmentMileValue
調整マイル区分値

調整マイルの入力値

string format: int
>= 1 <= 99999999
storeId
required
店舗ID

店舗毎に付与するID。
※店舗情報が存在しない場合エラー
※休止中の店舗IDを指定するとエラー

string format: int
>= 1 <= 999999999
terminalId
required
端末ID

店舗の端末毎に付与するID。
※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり)

string format: int
>= 1 <= 999999999
customerId
会員ID

会員毎に付与するID。
※設定されている場合、会員販売とみなし会員ポイント情報を更新します。
※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。

string format: int
>= 1 <= 9999999999
customerCode
会員コード

会員毎に付与する一意のコード。
※設定された場合、会員IDは必須。
※会員マスタに存在する会員IDが設定されている場合、会員情報の会員コードと一致しないとエラー。
※省略時、会員IDが設定されている場合、会員マスタの会員コードを設定。(スマレジ管理画面ver.4.12.0リリース以降)

string
<= 20 characters //^[ -~]+$//
terminalTranId
required
端末取引ID

端末で設定された取引ID。(連携元システムで任意の連番を設定してください)

string format: int
<= 10 characters
terminalTranDateTime
required
端末取引日時

端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD](連携元システムで処理日時を設定してください)

string format: date-time
sumDivision
締め区分

締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み)
※省略時は、店舗情報の締め方式区分に合わせて設定します。
※0:未処理または1:精算処理済みは、店舗の締め方式区分が「手動締め処理」のときのみ設定可能。
※存在しない端末IDを設定した場合、2:締め処理済みを設定してください。

string
0
Allowed values: 0 1 2
sumDate
締め日

締めをしたら年月日が入る。 [YYYY-MM-DD]
※締め区分を2に設定した場合必須。締め区分を0に設定した場合設定不可。

string format: date
customerRank
会員ランク

管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。
存在しないコードを設定するとエラーになります。

string
<= 20 characters
customerGroupId
客層ID

客層ID。客層セクションIDが1の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int
>= 1 <= 999999999
customerGroupId2
客層ID2

客層ID2。客層セクションIDが2の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int
>= 1 <= 999999999
customerGroupId3
客層ID3

客層ID3。客層セクションIDが3の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int
>= 1 <= 999999999
customerGroupId4
客層ID4

客層ID4。客層セクションIDが4の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int
>= 1 <= 999999999
customerGroupId5
客層ID5

客層ID5。客層セクションIDが5の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int
>= 1 <= 999999999
staffId
販売員ID

販売員ID(スタッフID)
※スタッフ情報が存在しない場合エラー
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗の販売員IDを指定してください。

string format: int
>= 1 <= 999999999
memo
メモ

入出金時のメモなどを設定。 1000文字以内。

string
<= 1000 characters
receiptMemo
レシートメモ

レシートに印字するメモを設定。100文字以内。

string
<= 100 characters
carriage
送料

EC連携用送料。

string format: int
>= -999999999 <= 999999999
commission
手数料

EC連携用手数料。

string format: int
>= -999999999 <= 999999999
guestNumbers
客数

客数。

string format: int
<= 9999
guestNumbersMale
客数(男)

客数(男)。

string format: int
<= 9999
guestNumbersFemale
客数(女)

客数(女)。

string format: int
<= 9999
guestNumbersUnknown
客数(不明)

客数(不明)。

string format: int
<= 9999
enterDateTime
入店日時

入店日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
taxFreeSalesDivision
免税販売区分

免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
※未設定の場合、0:通常販売

string
0
Allowed values: 0 1 2 3 4 5
netTaxFreeGeneralTaxInclude
内税商品の一般品免税額

内税商品の一般品免税額。

string format: int
>= -999999999 <= 999999999
netTaxFreeGeneralTaxExclude
外税商品の一般品免税額

外税商品の一般品免税額。

string format: int
>= -999999999 <= 999999999
netTaxFreeConsumableTaxInclude
内税商品の消耗品免税額

内税商品の消耗品免税額。

string format: int
>= -999999999 <= 999999999
netTaxFreeConsumableTaxExclude
外税商品の消耗品免税額

外税商品の消耗品免税額。

string format: int
>= -999999999 <= 999999999
tags
取引タグ

レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。

string
<= 255 characters
pointGivingDivision
ポイント付与税区分

1:税額を含める + 利用ポイント分を含める、
2:税額を含めない + 利用ポイント分を含める、
3:税額を含める + 利用ポイント分を含めない、
4:税額を含めない + 利用ポイント分を含めない
※省略時、店舗マスタから設定。

string
Allowed values: 1 2 3 4
pointGivingUnitPrice
ポイント付与単位(金額)

ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)
(例10円ごとに2ポイントの場合、10円)
※未設定の場合は店舗マスタから設定。

string format: int
>= 1 <= 99999
pointGivingUnit
ポイント付与単位(ポイント)

ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2ポイント)
※未設定の場合は店舗マスタから設定。

string format: decimal
<= 99999.99
pointSpendDivision
ポイント利用区分

ポイント利用時の税を含む/含まないを判定。
1:ポイント利用を現金として扱う (税を含む値引き)
2:ポイント利用を値引として扱う (税を含まない値引き)
※未設定の場合は店舗マスタから設定。 初期値:1。

string
default: 1
Allowed values: 1 2
mileageDivision
マイレージ利用区分

マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
※未設定の場合は店舗マスタから設定。 初期値:0。

string
0
Allowed values: 0 1 2
mileageLabel
マイレージラベル

マイレージの名称。未設定の場合は「マイル」

string
<= 32 characters
customerPinCode
PINコード

自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。

string
<= 32 characters
sellDivision
販売区分

取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)
※省略時は0:内税販売を設定

string
Allowed values: 0 1
taxRate
税率

税率 (単位%)
※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出)

string format: decimal
<= 99999.999
taxRounding
税の丸め方式

税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定

string
Allowed values: 0 1 2
discountRoundingDivision
割引丸め区分

割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時は店舗マスタに設定されている税の丸め方式を設定

string
Allowed values: 0 1 2
transactionUuid
レシート番号

レシートに印字する番号。ユニークな値を設定してください。
※レシート番号が重複するとスマレジ・アプリにて取引データの呼び出しができなくなる可能性があります
※省略時は、1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁

string
<= 20 characters
exchangeTicketNo
引換券番号
string
<= 20 characters
giftReceiptValidDays
ギフトレシート引換有効日数

有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。

string format: int
<= 999999999
discountCalculateDivision
割引額計算対象

小計に対する値引または割引の上にさらに割引を行う際の、割引額の算出方法を指定する区分。
0:小計(明細から算出された、値引・割引前の小計を一律対象に割引率を乗算したものを割引額とします。)
1:他の値引割引に追従した小計(小計に対し他の値引・割引で変動した後の金額を都度対象に割引率を乗算したものを割引額とします。小計値引・割引 → クーポン値引・割引 の順番で計算されます。)
※割引額計算対象の設定値は取引登録後にスマレジ・アプリにて取引を編集する際の割引額算出に使用します。
※(注)取引登録APIでは、自動算出した値ではなくsubtotalDiscountPrice(小計値引き)の設定値を割引額に登録します。そのため、APIで登録される取引の割引額が割引額計算対象の設定値によって変動することはありません。

string
0
Allowed values: 0 1
barcode
バーコード

仮販売のバーコード。
※ 複数ある場合はカンマ区切り。

string
<= 255 characters
layawayServerTransactionHeadId
取置き取引ID

取置きの取引ID。
※ 指定した取置き取引を引取済にします。

string format: int
>= 1 <= 999999999999
details
取引明細
Array<object>
object
transactionDetailId
required
取引明細ID

ユニーク値 取引毎の明細に付与するID。
設定する場合は1〜999まで。
取引明細を指定する場合必須。

string format: int
>= 1 <= 999
parentTransactionDetailId
親取引明細ID

紐付く親の取引明細がある場合、その取引明細IDを設定。
※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、2(オプション商品)の場合はオプション元の取引明細IDを、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の取引明細IDを設定しなければならない。

string format: int
>= 1 <= 999
transactionDetailDivision
required
取引明細区分

取引明細を識別する区分。
(1:通常、2:返品、3:部門売り)
取引明細を指定する場合必須。

string
Allowed values: 1 2 3
productId
商品ID

商品毎に付与するID
※ 存在しない商品IDが設定されている場合、nullを登録。
※ 商品IDで指定された商品の持つ商品区分が 1:回数券 の明細は登録できません。
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

string format: int
>= 1 <= 999999999999999
productCode
商品コード

商品コード。(半角英数記号 20桁以内)
省略時、商品IDが設定されている場合、マスタから設定。その他の場合はnull。

string
<= 20 characters /^[ -~]+$/
productName
商品名

省略時、商品区分が0:通常、2:オプション商品、7:バンドル商品(子)、8:バンドル値引(子)で商品IDが設定されている場合、商品マスタから設定。商品区分が4:バンドル (親)で商品バンドルグループIDが設定されている場合、商品バンドルグループマスタから設定。その他の場合はnull。

string
<= 85 characters
printReceiptProductName
レシート印字商品名

省略時、商品IDが設定されている場合、マスタから設定。その他の場合はnull。

string
<= 85 characters
taxDivision
税区分

(0:税込、1:税抜、2:非課税)
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。その他の場合は0:税込。

string
Allowed values: 0 1 2
price
商品単価

※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。その他の場合は0円。

string format: int
>= -999999999 <= 999999999
salesPrice
required
販売単価

販売時の単価を設定。
取引明細を指定する場合必須。

string format: int
>= -999999999 <= 999999999
unitDiscountPrice
単品値引

販売単価の値引き金額を設定。

string format: int
>= -999999999 <= 999999999
unitDiscountRate
単品割引率

単品の割引率を設定。(単位:%)
※このフィールドはラベルであり、販売単価の値引き金額の算出には利用されません。
※設定された場合、単品値引は必須

string format: int
>= -999 <= 999
unitDiscountDivision
単品値引き/割引区分

単品値引き/割引時に指定された割引区分を設定。

string format: int
>= 1 <= 999999999
quantity
required
数量

購入数
取引明細を指定する場合必須。

string format: int
>= 1 <= 999999
categoryId
部門ID

商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合、エラー
※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー
※省略時、商品IDが設定されている場合、商品マスタの部門IDを設定

string format: int
>= 1 <= 999999999
categoryName
部門名

商品に紐付く部門名。(85文字以内)
※設定時、そのまま設定。
※省略時、部門IDが設定されている場合、マスタから設定。その他の場合はnull。

string
<= 85 characters
discriminationNo
識別番号

明細行を識別できる番号。

string
<= 20 characters
salesDivision
売上区分

売上計上するか否かの区分。(0:売上対象、1:売上対象外)
省略時、商品IDが設定されている場合、商品マスタから設定。その他の場合は0:売上対象を設定。

string
Allowed values: 0 1
productDivision
商品区分

商品区分 (0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル (親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値 引(子)、A:プラン(子)、B:コース(子)) ※0, 2, 4, 7, 8のみ許可。商品区分を0, 4にする場合、親取引明細IDは設定不可。また、商品区分を2(オプション商品)にする場合は親取引明細IDにオプション元の取引明細IDの、7, 8にする場合はバンドル(親)の取引明細IDの設定が必要
※A,Bはウェイターでのみ利用する区分。

string
Allowed values: 0 2 4 7 8
calcDiscount
値引割引計算対象

小計値引/割引(クーポン、ポイント値引き含む)の対象かどうかを設定。(0:対象外、1:対象)
※省略時、商品IDが設定されている場合、商品マスタから設定。その他の場合は1:対象を設定。
※スマレジ・アプリver.4.27.0以降では取引明細区分が2:返品の取引明細には値引割引計算対象に0:対象外が指定されていることを前提としています。
取引明細区分が1:通常の取引明細と2:返品の取引明細が混在している取引の販売レシートを再印刷する場合、取引明細区分が1:通常の取引明細にのみ値引・割引が行われているように見える形式で印字されます。

string
Allowed values: 0 1
taxFreeDivision
免税区分

免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品区分が0:通常、2:オプション商品、7:バンドル商品(子)、8:バンドル値引(子)で商品IDが設定されている場合、商品マスタから設定。商品区分が4:バンドル (親)で商品バンドルグループIDが設定されている場合、商品バンドルグループマスタから設定。その他の場合は0:対象外を設定。

string
Allowed values: 0 1 2
taxFreeCommodityPrice
免税対象額

免税後の税抜金額を設定。(税抜価格x数量)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string format: int
>= -999999999 <= 999999999
taxFree
免税額

免税額を設定。(免税対象額 x 税率)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string format: int
>= -999999999 <= 999999999
productBundleGroupId
商品バンドルグループID

商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。
商品バンドルグループに存在するIDを指定しなければならない。
この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない

string format: int
>= 1 <= 999999999
reduceTaxId
軽減税率ID(税設定)

軽減税率ID
標準:null(または未設定)
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

※軽減税率販売時のみ設定。
※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。

string format: int
>= 1 <= 999999999
memo
メモ

返品販売時などのメモなどを設定。 1000文字以内。

string
<= 1000 characters
depositOthers
その他支払方法
Array<object>
object
no
項番

1から順番に設定してください。最大3まで。
その他支払方法を指定する場合必須。

string
Allowed values: 1 2 3
paymentMethodId
支払方法ID

支払方法マスタのID。
その他支払方法を指定する場合必須。
※スマレジ・アプリから登録された取引では9桁の支払方法IDが設定されることがあります。
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で取扱いしている支払方法IDを指定してください。

string format: int
>= 1 <= 99999999
paymentMethodName
支払方法名

支払方法名。
nullまたは空文字の指定不可。
※省略時、支払方法マスタから設定。

string
>= 1 characters <= 20 characters
depositOthers
預かり金その他

会計時に預かった金額。
その他支払方法を指定する場合必須。

string format: int
>= -999999999 <= 999999999
denominationCode
支払金種コード

※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定必須です
※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定可能です

支払金種コード対応表

支払金種コード対応表

支払金種コード 支払金種名 カード会社名指定(可: ○、不可: ×)
CREDIT クレジット
DEBIT デビット
JDEBIT J-Debit ×
PREPAID プリペイド
STORE ストアカード
UNIONPAY 銀聯
CONTACTLESS タッチ決済
SUICA 交通系IC ×
PITAPA PiTaPa ×
SAPICA SAPICA ×
QUICPAY QUICPay ×
ID iD ×
WAON WAON ×
RAKUTENEDY 楽天Edy ×
NANACO nanaco ×
AEONPAY AEON Pay ×
ALIPAY Alipay+ ×
AMAZONPAY Amazon Pay ×
ATONEPAY atone ×
AUPAY au PAY ×
BANKIT BANKIT ×
BANKPAY Bank Pay ×
DPAY d払い ×
EGIFTEE e街ギフト ×
FAMIPAY FamiPay ×
GINKOPAY 銀行Pay ×
GLNPAY GLN Pay ×
GOTOEAT GoToEat ×
JCOINPAY J-Coin Pay ×
JKOPAY JKO Pay ×
LINEPAY LINE Pay ×
MBBANK MBBank ×
MERPAY メルペイ ×
MICROPAY WeChat Pay ×
NISSENREN 日専連 ×
ORIGAMIPAY Origami Pay ×
PAYPAY PayPay ×
PROMPTPAY PromptPay ×
QUOPAY Quo カード Pay ×
RAKUTENPAY 楽天ペイ ×
SGTDASH VIA-Dash ×
SGTGLB VIA-MPay(Global Pay) ×
SMARTCODE Smart Code ×
UPICPM 銀聯 QR コード ×
ATOKARA アトカラ ×
TOTTEIPAY TOTTEI PAY ×
WESMO Wesmo! ×
string
Allowed values: CREDIT DEBIT JDEBIT PREPAID STORE UNIONPAY CONTACTLESS SUICA PITAPA SAPICA QUICPAY ID WAON RAKUTENEDY NANACO AEONPAY ALIPAY AMAZONPAY ATONEPAY AUPAY BANKIT BANKPAY DPAY EGIFTEE FAMIPAY GINKOPAY GLNPAY GOTOEAT JCOINPAY JKOPAY LINEPAY MBBANK MERPAY MICROPAY NISSENREN ORIGAMIPAY PAYPAY PROMPTPAY QUOPAY RAKUTENPAY SGTDASH SGTGLB SMARTCODE UPICPM ATOKARA TOTTEIPAY WESMO
cardCompanyName
クレジットカード会社名

支払金種コードの「支払金種コード対応表」でカード会社指定名指定が可能なもののみ指定可能です。 ※個別アプリ専用支払方法登録APIで登録した支払方法IDを指定した場合しか利用できません

string
<= 64 characters
slipNumber
キャッシュレス決済時の伝票番号

キャッシュレス決済時の伝票番号を設定してください
※個別アプリ専用支払方法登録APIで登録した支払方法IDを指定した場合しか利用できません

string
<= 50 characters
pointGivingUnitPrice
ポイント付与単位(金額)

ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)
(例10円ごとに2ポイントの場合、10円)
※未設定の場合は支払方法マスタから設定。

string format: int
>= 1 <= 99999
pointGivingUnit
ポイント付与単位(ポイント)

ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2ポイント)
※未設定の場合は支払方法マスタから設定。

string format: decimal
<= 99999.99
coupons
クーポン明細

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス

Array<object>
object
terminalTranCouponId
required
端末取引クーポンID

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
ユニーク値 取引毎のクーポン明細に付与するID。
クーポン明細を指定する場合必須。

string format: int
>= 1 <= 999999999999
couponId
required
クーポンID

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンID。

string format: int
>= 1 <= 999999999999999
couponName
クーポン名

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン名。
※省略時、クーポンマスタから設定。

string
<= 85 characters
serialNumber
シリアル番号

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
シリアル番号。
※gifteeクーポンを指定した場合は入力必須。その他の場合は省略時、クーポンマスタから設定。
※gifteeクーポンを指定した場合、最大24文字のgifteeから受領したコードをそのまま設定。通常クーポンの場合、最大20文字。

string
<= 24 characters
awardType
特典タイプ

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンの特典タイプ。(1:値引き, 2:割引, 3:商品付与)
※省略時、クーポンマスタから設定。

string
Allowed values: 1 2 3
awardValue
特典値

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンの特典値。特典タイプが値引きの場合は値引き額[円]、割引の場合は割引率[%]、商品付与の場合は0を設定。
※省略時、クーポンマスタから設定。

string format: int
<= 9999999999
discountPrice
値引額

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き・割引額の合計
※特典タイプが値引き、割引の場合は必須、商品付与の場合は0を設定。

string format: int
<= 9999999999
couponItems
クーポン商品付与明細

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス

Array<object>
object
terminalTranCouponId
required
端末取引クーポンID

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引毎のクーポン明細に付与するID。
クーポン商品付与明細を指定する場合必須。

string format: int
>= 1 <= 999999999999
transactionDetailId
required
取引明細ID

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引毎の明細に付与するID。

string format: int
>= 1 <= 999
couponItemId
required
クーポンアイテムID

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンに紐づくアイテムを特定するためのID。

string format: int
>= 1 <= 999999999999
Example
{
"transactionHeadDivision": "1",
"cancelDivision": "0",
"subtotal": "123456789",
"subtotalDiscountPrice": "123456789",
"subtotalDiscountRate": "123",
"subtotalDiscountDivision": "123456789",
"pointDiscount": "123456789",
"total": "123456789",
"taxInclude": "123456789",
"taxExclude": "123456789",
"roundingDivision": "00",
"roundingPrice": "123456789",
"deposit": "123456789",
"depositCash": "123456789",
"depositCredit": "123456789",
"change": "123456789",
"newPoint": "123456789",
"spendPoint": "123456789",
"point": "123456789",
"totalPoint": "123456789",
"currentMile": "123456789",
"earnMile": "123456789",
"totalMile": "123456789",
"adjustmentMile": "123456789",
"adjustmentMileDivision": "1",
"adjustmentMileValue": "12345678",
"storeId": "123456789",
"terminalId": "123456789",
"customerId": "1234567890",
"customerCode": "string",
"terminalTranId": "1234567890",
"terminalTranDateTime": "2000-01-23T01:23:45+09:00",
"sumDivision": "0",
"sumDate": "2000-01-23",
"customerRank": "string",
"customerGroupId": "123456789",
"customerGroupId2": "123456789",
"customerGroupId3": "123456789",
"customerGroupId4": "123456789",
"customerGroupId5": "123456789",
"staffId": "123456789",
"memo": "string",
"receiptMemo": "string",
"carriage": "123456789",
"commission": "123456789",
"guestNumbers": "1234",
"guestNumbersMale": "1234",
"guestNumbersFemale": "1234",
"guestNumbersUnknown": "1234",
"enterDateTime": "2000-01-23T01:23:45+09:00",
"taxFreeSalesDivision": "0",
"netTaxFreeGeneralTaxInclude": "123456789",
"netTaxFreeGeneralTaxExclude": "123456789",
"netTaxFreeConsumableTaxInclude": "123456789",
"netTaxFreeConsumableTaxExclude": "123456789",
"tags": "string",
"pointGivingDivision": "1",
"pointGivingUnitPrice": "12345",
"pointGivingUnit": "99999.99",
"pointSpendDivision": "1",
"mileageDivision": "0",
"mileageLabel": "string",
"customerPinCode": "string",
"sellDivision": "0",
"taxRate": "99999.999",
"taxRounding": "0",
"discountRoundingDivision": "0",
"transactionUuid": "string",
"exchangeTicketNo": "string",
"giftReceiptValidDays": "123456789",
"discountCalculateDivision": "0",
"barcode": "string",
"layawayServerTransactionHeadId": "123456789012",
"details": [
{
"transactionDetailId": "123",
"parentTransactionDetailId": "123",
"transactionDetailDivision": "1",
"productId": "123456789012345",
"productCode": "string",
"productName": "string",
"printReceiptProductName": "string",
"taxDivision": "0",
"price": "123456789",
"salesPrice": "123456789",
"unitDiscountPrice": "123456789",
"unitDiscountRate": "123",
"unitDiscountDivision": "123456789",
"quantity": "123456",
"categoryId": "123456789",
"categoryName": "string",
"discriminationNo": "string",
"salesDivision": "0",
"productDivision": "0",
"calcDiscount": "0",
"taxFreeDivision": "0",
"taxFreeCommodityPrice": "123456789",
"taxFree": "123456789",
"productBundleGroupId": "123456789",
"reduceTaxId": "10000001",
"memo": "string"
}
],
"depositOthers": [
{
"no": "1",
"paymentMethodId": "12345678",
"paymentMethodName": "string",
"depositOthers": "123456789",
"denominationCode": "CREDIT",
"cardCompanyName": "string",
"slipNumber": "string",
"pointGivingUnitPrice": "12345",
"pointGivingUnit": "99999.99"
}
],
"coupons": [
{
"terminalTranCouponId": "123456789012",
"couponId": "123456789012345",
"couponName": "string",
"serialNumber": "string",
"awardType": "1",
"awardValue": "1234567890",
"discountPrice": "1234567890"
}
],
"couponItems": [
{
"terminalTranCouponId": "123456789012",
"transactionDetailId": "123",
"couponItemId": "123456789012"
}
]
}

更新成功

object
transactionHeadId

取引ID

string
transactionDateTime

取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

string
transactionHeadDivision

取引を識別する区分。
(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)
※ 10:取置きについては、取置き登録APIをご使用ください。
※ 8:ポイント失効、9:回数券、11:チップ、15:バリューカード入金、16:領収証は対応しておりません。

string
cancelDivision

取引の取消を識別する区分。 (0:通常、1取消)

string
unitNonDiscountsubtotal

取引明細の、値引き前計の合計。明細より自動算出。
※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計

string
unitDiscountsubtotal

単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。

※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。
(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)
※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。
4:バンドル (親)
5:セット売り(親)
6:簡易セット(親)
8:バンドル値引(子)

string
unitStaffDiscountsubtotal

単品社員販売値引き計

string
unitBargainDiscountsubtotal

単品セール販売値引き計

string
subtotal

取引明細の値引き後小計の合計。

string
subtotalForDiscount

取引明細の割引値引対象区分が対象の小計金額

string
subtotalDiscountPrice

小計の値引き金額を設定。

string
subtotalDiscountRate

小計の割引を設定 (単位%) デフォルトは未設定。
設定された場合、小計値引は必須。
※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

string
subtotalDiscountDivision

小計値引き/割引時に指定された区分を設定。
管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

string
pointDiscount

使用ポイント * ポイント還元率。

string
couponDiscount

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き:その取引で使用された各クーポンの値引き・割引額の合計値。

string
total

小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定
※ 端数値引き機能は現在ご利用いただけません。

string
taxInclude

内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string
taxExclude

外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string
roundingDivision

販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力

string
roundingPrice

端数値引額

string
cashTotal

合計金額の内訳 (現金払い)

string
creditTotal

合計金額の内訳 (クレジット払い)

string
deposit

会計時に預かった金額。

string
depositCash

会計時に預かった現金金額。

string
depositCredit

会計時に預かったクレジット金額。

string
change

釣銭。

string
tipCash

現金チップ

string
tipCredit

クレジットチップ

string
amount

取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量)

string
returnAmount

取引明細の返品の数量の合計 (取引明細区分が2返品の数量)

string
costTotal

明細の原価計の合計

string
salesHeadDivision

売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む)

string
inTaxSalesTotal

売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。

string
outTaxSalesTotal

売上対象商品の外税販売の税抜き商品合計金額

string
nonTaxSalesTotal

売上対象商品の非課税商品の合計金額。

string
nonSalesTargetTotal

売上対象外商品の合計。 外税販売の場合、税を含まない。

string
nonSalesTargetInTaxTotal

売上対象外商品の外税合計。

string
nonSalesTargetOutTaxTotal

売上対象外商品の内税合計。

string
nonSalesTargetTaxFreeTotal

売上対象外商品の免税額合計。

string
nonSalesTargetCostTotal

売上対象外商品の原価合計。

string
nonSalesTargetAmount

取引明細の返品以外かつ売上対象外の数量の合計。 (取引明細区分が2返品以外の数量)

string
nonSalesTargetReturnAmount

取引明細の返品かつ売上対象外の数量の合計。 (取引明細区分が2返品の数量)

string
newPoint

取引で付与されるポイント。 合計 * ポイント付与率

string
spendPoint

取引で使用したポイント。

string
point

取引前のポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。

string
totalPoint

取引後のポイント。 現在ポイント + 付与ポイント - 使用ポイント
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。

string
currentMile

現在マイル。取引前のマイル
※ 会員販売でない場合、nullが返されます。

string
earnMile

獲得マイル。取引で付与されるマイル
合計 * ポイント付与率
※ 会員販売でない場合、nullが返されます。

string
totalMile

合計マイル。取引後のマイル
現在マイル + 獲得マイル + 調整マイル
※ 会員販売でない場合、nullが返されます。

string
adjustmentMile

調整マイル。取引で手動で付与されるマイル
※ 会員販売でない場合、nullが返されます。

string
adjustmentMileDivision

調整マイル区分。
1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)
2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)
3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)
4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」
※ 会員販売でない場合、nullが返されます。

string
adjustmentMileValue

調整マイル区分値
※ 会員販売でない場合、nullが返されます。

string
storeId

店舗毎に付与するID。
※店舗情報が存在しない場合エラー
※休止中の店舗IDを指定するとエラー

string
terminalId

店舗の端末毎に付与するID。
※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり)

string
customerId

会員毎に付与するID。
※設定されている場合、会員販売とみなし会員ポイント情報を更新します。
※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。

string
terminalTranId

端末で設定された取引ID。

string
terminalTranDateTime

端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

string
sumDivision

締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み)

string
adjustmentDateTime

精算をしたら日時が入る。[YYYY-MM-DDThh:mm:ssTZD]

string
sumDate

締めをしたら年月日が入る。 [YYYY-MM-DD]

string
customerRank

会員ランク。管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。

string
customerGroupId

客層ID。客層セクションIDが1の客層IDを設定。

string
customerGroupId2

客層ID2。客層セクションIDが2の客層IDを設定。

string
customerGroupId3

客層ID3。客層セクションIDが3の客層IDを設定。

string
customerGroupId4

客層ID4。客層セクションIDが4の客層IDを設定。

string
customerGroupId5

客層ID5。客層セクションIDが5の客層IDを設定。

string
staffId

販売員ID(スタッフID)

string
staffName

スタッフIDがある場合、スタッフマスタのスタッフ名(販売員名)を設定

string
creditDivision

クレジット区分:クレジット会社を識別する区分

  • 11: Smaregi Payment (ScanJacket)
  • 12: Smaregi Payment (shuttle)
  • 13: Smaregi Payment (IC)
  • 14: Smaregi Payment (VEGA3000)
  • 15: PAYGATE Station
  • 21: ペイメント・マイスター for FLIGHT
  • 22: ペイメント・マイスター
  • 23: ペイメント・マイスター for Thincacloud
  • 24: ペイメント・マイスター for FG-Center
  • 31: 楽天
  • 41: STORES (Coiney)
  • 51: スクエア
  • 61: JET-S (CATS300/CATS330)
  • 62: JET-S (JT-C17U)
  • 71: J-Mups (JT-C30L)
  • 81: おてがるPay クレジット
  • 82: おてがるPay 電子マネー
  • 83: J-Mups II Pocket
  • 91: INFOX (JT-C16U)
  • A1: VEGA3000 Mobile2
  • B1: stera terminal
  • C1: SATURN1000E/SATURN1000L (CAFIS Arch)
string
Allowed values: 11 12 13 14 15 21 22 23 24 31 41 51 61 62 71 81 82 83 91 A1 B1 C1
paymentCount

クレジットの支払回数。
※ゼウス、ペイメントマイスターご利用時
(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い)

string
slipNumber

クレジットの伝票番号。

string
cancelSlipNumber

クレジットの取消伝票番号。

string
authNumber

クレジットの承認番号。

string
authDate

クレジットのセンター処理日。

string
cardCompany

クレジットカード会社 例) VISA、JCB、MASTER、AMEX、DINERSなど

string
denomination

11:磁気クレジットカード、12:ICクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー
※ペイメント・マイスターで使用

string
memo

入出金時のメモなどを設定。 1000文字以内。

string
receiptMemo

レシートに印字するメモを設定。100文字以内。

string
carriage

EC連携用送料。

string
commission

EC連携用手数料。

string
guestNumbers

客数。

string
guestNumbersMale

客数(男)。

string
guestNumbersFemale

客数(女)。

string
guestNumbersUnknown

客数(不明)。

string
enterDateTime

入店日時。[YYYY-MM-DDThh:mm:ssTZD]

string
taxFreeSalesDivision

免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
※未設定の場合、0:通常販売

string
netTaxFreeGeneralTaxInclude

内税商品の一般品免税額。

string
netTaxFreeGeneralTaxExclude

外税商品の一般品免税額。

string
netTaxFreeConsumableTaxInclude

内税商品の消耗品免税額。

string
netTaxFreeConsumableTaxExclude

外税商品の消耗品免税額。

string
tags

レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
※複数ある場合は、カンマ区切りで設定

string
pointGivingDivision

1:税額を含める + 利用ポイント分を含める、
2:税額を含めない + 利用ポイント分を含める、
3:税額を含める + 利用ポイント分を含めない、
4:税額を含めない + 利用ポイント分を含めない
※省略時、店舗マスタから設定。

string
pointGivingUnitPrice

ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)
(例10円ごとに2ポイントの場合、10円)
※未設定の場合は店舗マスタから設定。

string
pointGivingUnit

ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2ポイント)
※未設定の場合は店舗マスタから設定。

string
pointSpendDivision

ポイント利用時の税を含む/含まないを判定。
1:ポイント利用を現金として扱う (税を含む値引き)
2:ポイント利用を値引として扱う (税を含まない値引き)
※未設定の場合は店舗マスタから設定。 初期値:1。

string
mileageDivision

マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
※未設定の場合は店舗マスタから設定。 初期値:0。

string
mileageLabel

マイレージの名称。未設定の場合は「マイル」

string
customerPinCode

自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。

string
returnSales

0:通常、1:返品販売

string
disposeDivision

0:通常、1:打消元レコード、2:打消レコード
※0:通常と2:打消レコードのみ設定可能(省略時は0:通常を設定)
※打消レコードの場合、取引明細区分は、(通常、部門売り)→返品に変換させて設定してください。

string
disposeServerTransactionHeadId

打消元取引ID
※打消し区分が2の場合必須
※打消元取引IDが存在しない場合エラー。省略時はnullを設定

string
cancelDateTime

取消/打消しの場合自動設定。[YYYY-MM-DDThh:mm:ssTZD]

string
sellDivision

取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)
※省略時は0:内税販売を設定

string
taxRate

税率 (単位%)
※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出)

string
taxRounding

税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定

string
discountRoundingDivision

割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定

string
transactionUuid

レシートに印字する番号。
※省略時は、1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁

string
exchangeTicketNo

引換券番号

string
giftReceiptValidDays

有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。

string
discountCalculateDivision

小計に対する値引または割引の上にさらに割引を行う際の、割引額の算出方法を指定する区分。
0:小計(明細から算出された、値引・割引前の小計を一律対象に割引率を乗算したものを割引額とします。)
1:他の値引割引に追従した小計(小計に対し他の値引・割引で変動した後の金額を都度対象に割引率を乗算したものを割引額とします。小計値引・割引 → クーポン値引・割引 の順番で計算されます。)
※割引額計算対象の設定値は取引登録後にスマレジ・アプリにて取引を編集する際の割引額算出に使用します。

string
barcode

仮販売のバーコード。
※ 複数ある場合はカンマ区切り。

string
updDateTime

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

string
details

取引明細

Array<object>
object
transactionHeadId

取引ID

string
transactionDetailId

ユニーク値 取引毎の明細に付与するID。
設定する場合は1〜999まで。
取引明細を指定する場合必須。

string
parentTransactionDetailId

紐付く親の取引明細がある場合、その取引明細IDを設定。
※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の取引明細IDを設定しなければならない。

string
transactionDetailDivision

取引明細を識別する区分。
(1:通常、2:返品、3:部門売り)

string
productId

商品ID

string
productCode

商品コード

string
productName

商品名

string
printReceiptProductName

レシート印字商品名

string
color

カラー

string
size

サイズ

string
groupCode

グループコード

string
supplierProductNo

品番

string
taxDivision

税区分。(0:税込、1:税抜、2:非課税)
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。その他の場合は0:税込。

string
price

※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。その他の場合は0円。

string
salesPrice

販売時の単価を設定。

string
unitDiscountPrice

販売単価の値引き金額を設定。
単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。

string
unitDiscountRate

単品の割引率を設定。(単位:%)
※設定された場合、単品値引は必須

string
unitDiscountDivision

単品値引き/割引時に指定された割引区分を設定。

string
cost

商品原価。整数部分8桁、少数部5桁。

string
quantity

購入数
取引明細を指定する場合必須。

string
unitNonDiscountSum

販売価格×数量

string
unitDiscountSum

単品値引き×数量
※管理画面の取引履歴CSVで対応する項目: 単価値引き計

string
unitDiscountedSum

値引き前計 - 単品値引き計

string
costSum

原価×数量

string
categoryId

商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合、エラー
※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー
※省略時、商品IDが設定されている場合、商品マスタの部門IDを設定

string
categoryName

商品に紐付く部門名。(85文字以内)
※設定時、そのまま設定。
※省略時、部門IDが設定されている場合、マスタから設定。その他の場合はnull。

string
discriminationNo

明細行を識別できる番号。

string
salesDivision

売上計上するか否かの区分。(0:売上対象、1:売上対象外)
省略時、商品IDが設定されている場合、商品マスタから設定。その他の場合は0:売上対象を設定。

string
productDivision

商品区分 (0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル (親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値 引(子)、A:プラン(子)、B:コース(子)) ※0, 4, 7, 8のみ許可。商品区分を0, 4にする場合、親取引明細IDは設定不可。 また、商品区分を7, 8にする場合、親取引明細IDにバンドル(親)の取引明細ID の設定が必要 ※A,Bはウェイターでのみ利用する区分。

string
inventoryReservationDivision

在庫引当商品か否かの区分(0:通常商品、1:在庫引当商品)
自動で設定します。商品IDが設定されている場合、商品マスタから設定。その他の場合は0:通常商品を設定。

string
pointNotApplicable

ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)
自動で設定します。商品IDが設定されている場合、商品マスタから設定。その他の場合は0:ポイント対象を設定。

string
calcDiscount

小計値引/割引(クーポン、ポイント値引き含む)の対象かどうかを設定。(0:対象外、1:対象)
※省略時、商品IDが設定されている場合、商品マスタから設定。その他の場合は1:対象を設定。
※スマレジ・アプリver.4.27.0以降では取引明細区分が2:返品の取引明細には値引割引計算対象に0:対象外が指定されていることを前提としています。
取引明細区分が1:通常の取引明細と2:返品の取引明細が混在している取引の販売レシートを再印刷する場合、取引明細区分が1:通常の取引明細にのみ値引・割引が行われているように見える形式で印字されます。

string
taxFreeDivision

免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品区分が0:通常、2:オプション商品、7:バンドル商品(子)、8:バンドル値引(子)で商品IDが設定されている場合、商品マスタから設定。商品区分が4:バンドル (親)で商品バンドルグループIDが設定されている場合、商品バンドルグループマスタから設定。その他の場合は0:対象外を設定。

string
taxFreeCommodityPrice

免税後の税抜金額を設定。(税抜価格x数量)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string
taxFree

免税額を設定。(免税対象額 x 税率)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string
productBundleGroupId

商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。
商品バンドルグループに存在するIDを指定しなければならない。
この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない

string
discountPriceProportional

端数処理は銀行丸め。誤差は最終行で調整。

string
discountPointProportional

端数処理は銀行丸め。誤差は最終行で調整。

string
discountCouponProportional

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き按分:クーポン値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整します。

string
taxIncludeProportional

端数処理は銀行丸め。誤差は按分時に誤差が多きものから順に調整。

string
taxExcludeProportional

端数処理は銀行丸め。誤差は按分時に誤差が多きものから順に調整。

string
productBundleProportional

端数処理は銀行丸め。誤差は最終行で調整。

string
staffDiscountProportional

端数処理は銀行丸め。誤差は最終行で調整。

string
bargainDiscountProportional

端数処理は銀行丸め。誤差は最終行で調整。

string
roundingPriceProportional

端数処理は銀行丸め。誤差は最終行で調整。

string
productStaffDiscountRate

社員販売時のみ設定 商品の社販販売割引率

string
staffRank

社員販売時のみ設定 社員ランクのコードを設定

string
staffRankName

社員販売時のみ設定 社員ランクの名称を設定

string
staffDiscountRate

社員販売時のみ設定 社員販売の割引率

string
staffDiscountDivision

社員販売時のみ設定 1ビット目: 商品マスタの社員販売最大値引率を考慮(する or しない) 2ビット目: セール価格と社員販売割引を掛け合わせて適用(する or しない) 3ビット目: セール価格と社員販売価格を比較して安い方を適用(する or しない) 4ビット目: セール価格と社員販売価格を比較して高い方を適用(する or しない) 8ビット目: セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用(する or しない)

string
applyStaffDiscountRate

セール販売時のみ設定 適用した社員販売の割引率

string
applyStaffDiscountPrice

セール販売時のみ設定 適用した社員販売の値引き額

string
bargainId

セール販売時のみ設定。適用したセールのID ※セール商品ID(bargainProductId)の値が設定されます。

string
bargainName

セール販売時のみ設定 適用したセールの名称

string
bargainDivision

セール販売時のみ設定 (1:割引、2:値引、3:価格指定)

string
bargainValue

セール販売時のみ設定 割引、値引、価格指定の値

string
applyBargainValue

セール販売時のみ設定 適用したセール販売の割引、値引き、価格指定の値

string
applyBargainDiscountPrice

セール販売時のみ設定 適用したセール販売の値引き額

string
taxRate

適用した税率
軽減税率IDがある場合、軽減税率マスタの税率を設定。その他の場合は、取引ヘッダの税率を設定。

string
standardTaxRate

標準税率
取引ヘッダの税率を設定

string
modifiedTaxRate

修正した税率(設定不可)

string
reduceTaxId

軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])

string
reduceTaxName

軽減税率IDがある場合、軽減税率マスタの軽減税率名を設定。

string
reduceTaxRate

軽減税率IDがある場合、軽減税率マスタの軽減税率を設定。

string
reduceTaxPrice

商品IDがある場合、商品マスタの軽減税率用商品単価を設定。

string
reduceTaxMemberPrice

商品IDがある場合、商品マスタの軽減税率用会員商品単価を設定。

string
memo

返品販売時などのメモなどを設定。 1000文字以内。

string
productAttributes

取引時の商品属性情報

Array<object>
object
transactionHeadId

取引ID

string
transactionDetailId

取引明細ID

string
code

コード:数字9桁以内。

string
name

名称:30文字以内

string
depositOthers

その他支払取引

Array<object>
object
transactionHeadId

取引ID

string
no

1から順番に設定してください。最大3まで

string
paymentMethodId

支払方法マスタのID

string
paymentMethodCode

支払方法コード。半角英数字20文字以内。

string
paymentMethodName

支払方法名。省略時、支払方法マスタの支払方法名を自動設定。

string
depositOthers

会計時に預かった金額

string
paymentUnitPrice

単価の設定の有無により、スマレジアプリでのその他支払いの預り金の入力方式が変わります。単価を設定しない場合、支払方法に応じた金額を入力します。(例 5,000円商品券 10,000円)
単価を設定する場合、支払方法の利用枚数を入力します。(例 5,000円商品券 2枚)※単価は支払方法の利用枚数の計算に用いられます。変更した場合、利用枚数の計算が正しく行われなくなります。
支払方法マスタの単価を自動設定。

string
paymentChangeFlag

(0:釣銭なし、1:釣銭あり)
支払方法マスタの釣銭フラグを自動設定。

string
paymentDivision

支払方法マスタの支払方法分類を自動設定。

string
paymentSecuritiesFlag

(0:有価証券以外、1:有価証券)
支払方法マスタの有価証券フラグを自動設定。

string
denomination

支払金種(名称がそのまま入る)※未設定

string
denominationCode
支払金種コード

※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定必須です
※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定可能です

支払金種コード対応表

支払金種コード対応表

支払金種コード 支払金種名 カード会社名指定(可: ○、不可: ×)
CREDIT クレジット
DEBIT デビット
JDEBIT J-Debit ×
PREPAID プリペイド
STORE ストアカード
UNIONPAY 銀聯
CONTACTLESS タッチ決済
SUICA 交通系IC ×
PITAPA PiTaPa ×
SAPICA SAPICA ×
QUICPAY QUICPay ×
ID iD ×
WAON WAON ×
RAKUTENEDY 楽天Edy ×
NANACO nanaco ×
AEONPAY AEON Pay ×
ALIPAY Alipay+ ×
AMAZONPAY Amazon Pay ×
ATONEPAY atone ×
AUPAY au PAY ×
BANKIT BANKIT ×
BANKPAY Bank Pay ×
DPAY d払い ×
EGIFTEE e街ギフト ×
FAMIPAY FamiPay ×
GINKOPAY 銀行Pay ×
GLNPAY GLN Pay ×
GOTOEAT GoToEat ×
JCOINPAY J-Coin Pay ×
JKOPAY JKO Pay ×
LINEPAY LINE Pay ×
MBBANK MBBank ×
MERPAY メルペイ ×
MICROPAY WeChat Pay ×
NISSENREN 日専連 ×
ORIGAMIPAY Origami Pay ×
PAYPAY PayPay ×
PROMPTPAY PromptPay ×
QUOPAY Quo カード Pay ×
RAKUTENPAY 楽天ペイ ×
SGTDASH VIA-Dash ×
SGTGLB VIA-MPay(Global Pay) ×
SMARTCODE Smart Code ×
UPICPM 銀聯 QR コード ×
ATOKARA アトカラ ×
TOTTEIPAY TOTTEI PAY ×
WESMO Wesmo! ×
string
Allowed values: CREDIT DEBIT JDEBIT PREPAID STORE UNIONPAY CONTACTLESS SUICA PITAPA SAPICA QUICPAY ID WAON RAKUTENEDY NANACO AEONPAY ALIPAY AMAZONPAY ATONEPAY AUPAY BANKIT BANKPAY DPAY EGIFTEE FAMIPAY GINKOPAY GLNPAY GOTOEAT JCOINPAY JKOPAY LINEPAY MBBANK MERPAY MICROPAY NISSENREN ORIGAMIPAY PAYPAY PROMPTPAY QUOPAY RAKUTENPAY SGTDASH SGTGLB SMARTCODE UPICPM ATOKARA TOTTEIPAY WESMO
denominationName

支払金種名。詳細は、支払金種コードの「支払金種コード対応表」をご参照ください
※現状、個別アプリ専用支払方法ID利用時のみ対応

string
cardCompanyName

クレジットカード会社名
※現状、個別アプリ専用支払方法ID利用時のみ対応

string
slipNumber

伝票番号

string
pointGivingUnitPrice

ポイント付与単位(金額):ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)
(例10円ごとに2ポイントの場合、10円)

string
pointGivingUnit

ポイント付与単位(ポイント):ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2ポイント)

string
coupons

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポン明細

Array<object>
object
transactionCouponId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポンID

string
terminalTranCouponId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
端末取引クーポンID

string
couponId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンID

string
couponName

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン名

string
couponDivision

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン区分:クーポン区分(0:通常、1:giftee)

string
serialNumber

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
シリアル番号:クーポンのシリアル番号。端末側でのクーポンの入力にはこちらが用いられます。

string
awardType

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
特典タイプ:そのクーポンのタイプ。(1:値引、2:割引、3:商品付与)

string
awardValue

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
特典値: 特典タイプが値引きの場合は値引き額[円]、割引の場合は割引率[%]、商品付与の場合は0が入ります。

string
discountPrice

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
値引額:その取引でのクーポン値引き・割引額の合計。

string
couponItems

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポン商品付与明細

Array<object>
object
transactionCouponDetailId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポン明細ID

string
transactionCouponId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポンID

string
terminalTranCouponId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
端末取引クーポンID

string
transactionDetailId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引明細ID

string
couponItemId

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンアイテムID

string
layaway

取置き情報:取置き時の詳細情報

object
transactionHeadId

取引ID:取引毎に付与するID。サーバー側で付与する。

string
pickUpDate

受取日

string
status

ステータス:取置取引のステータス(1:引取済み)

string
partPayment

前受金

string
partPaymentClass

前受金区分(1:現金、2:クレジット)

string
pickUpTransactionHeadId

引取取引ヘッダーID

string
disabledEdit

変更不可能設定:変更不可能設定(0:変更可、 1:変更不可)

string
layawayPickUp

取置き引取情報:取置き引取時の詳細情報

object
transactionHeadId

取引ID

string
layawayServerTransactionHeadId

取置き取引ID:取置きの取引ID

string
receivedDepositCash

受領済金額:取置きの内金/手付金(現金)

string
receivedDepositCredit

受領済クレジット金額:取置きの内金/手付金(クレジット)

string
Example
{
"transactionHeadId": "string",
"transactionDateTime": "string",
"transactionHeadDivision": "string",
"cancelDivision": "string",
"unitNonDiscountsubtotal": "string",
"unitDiscountsubtotal": "string",
"unitStaffDiscountsubtotal": "string",
"unitBargainDiscountsubtotal": "string",
"subtotal": "string",
"subtotalForDiscount": "string",
"subtotalDiscountPrice": "string",
"subtotalDiscountRate": "string",
"subtotalDiscountDivision": "string",
"pointDiscount": "string",
"couponDiscount": "string",
"total": "string",
"taxInclude": "string",
"taxExclude": "string",
"roundingDivision": "string",
"roundingPrice": "string",
"cashTotal": "string",
"creditTotal": "string",
"deposit": "string",
"depositCash": "string",
"depositCredit": "string",
"change": "string",
"tipCash": "string",
"tipCredit": "string",
"amount": "string",
"returnAmount": "string",
"costTotal": "string",
"salesHeadDivision": "string",
"inTaxSalesTotal": "string",
"outTaxSalesTotal": "string",
"nonTaxSalesTotal": "string",
"nonSalesTargetTotal": "string",
"nonSalesTargetInTaxTotal": "string",
"nonSalesTargetOutTaxTotal": "string",
"nonSalesTargetTaxFreeTotal": "string",
"nonSalesTargetCostTotal": "string",
"nonSalesTargetAmount": "string",
"nonSalesTargetReturnAmount": "string",
"newPoint": "string",
"spendPoint": "string",
"point": "string",
"totalPoint": "string",
"currentMile": "string",
"earnMile": "string",
"totalMile": "string",
"adjustmentMile": "string",
"adjustmentMileDivision": "string",
"adjustmentMileValue": "string",
"storeId": "string",
"terminalId": "string",
"customerId": "string",
"terminalTranId": "string",
"terminalTranDateTime": "string",
"sumDivision": "string",
"adjustmentDateTime": "string",
"sumDate": "string",
"customerRank": "string",
"customerGroupId": "string",
"customerGroupId2": "string",
"customerGroupId3": "string",
"customerGroupId4": "string",
"customerGroupId5": "string",
"staffId": "string",
"staffName": "string",
"creditDivision": "11",
"paymentCount": "string",
"slipNumber": "string",
"cancelSlipNumber": "string",
"authNumber": "string",
"authDate": "string",
"cardCompany": "string",
"denomination": "string",
"memo": "string",
"receiptMemo": "string",
"carriage": "string",
"commission": "string",
"guestNumbers": "string",
"guestNumbersMale": "string",
"guestNumbersFemale": "string",
"guestNumbersUnknown": "string",
"enterDateTime": "string",
"taxFreeSalesDivision": "string",
"netTaxFreeGeneralTaxInclude": "string",
"netTaxFreeGeneralTaxExclude": "string",
"netTaxFreeConsumableTaxInclude": "string",
"netTaxFreeConsumableTaxExclude": "string",
"tags": "string",
"pointGivingDivision": "string",
"pointGivingUnitPrice": "string",
"pointGivingUnit": "string",
"pointSpendDivision": "string",
"mileageDivision": "string",
"mileageLabel": "string",
"customerPinCode": "string",
"returnSales": "string",
"disposeDivision": "string",
"disposeServerTransactionHeadId": "string",
"cancelDateTime": "string",
"sellDivision": "string",
"taxRate": "string",
"taxRounding": "string",
"discountRoundingDivision": "string",
"transactionUuid": "string",
"exchangeTicketNo": "string",
"giftReceiptValidDays": "string",
"discountCalculateDivision": "string",
"barcode": "string",
"updDateTime": "string",
"details": [
{
"transactionHeadId": "string",
"transactionDetailId": "string",
"parentTransactionDetailId": "string",
"transactionDetailDivision": "string",
"productId": "string",
"productCode": "string",
"productName": "string",
"printReceiptProductName": "string",
"color": "string",
"size": "string",
"groupCode": "string",
"supplierProductNo": "string",
"taxDivision": "string",
"price": "string",
"salesPrice": "string",
"unitDiscountPrice": "string",
"unitDiscountRate": "string",
"unitDiscountDivision": "string",
"cost": "string",
"quantity": "string",
"unitNonDiscountSum": "string",
"unitDiscountSum": "string",
"unitDiscountedSum": "string",
"costSum": "string",
"categoryId": "string",
"categoryName": "string",
"discriminationNo": "string",
"salesDivision": "string",
"productDivision": "string",
"inventoryReservationDivision": "string",
"pointNotApplicable": "string",
"calcDiscount": "string",
"taxFreeDivision": "string",
"taxFreeCommodityPrice": "string",
"taxFree": "string",
"productBundleGroupId": "string",
"discountPriceProportional": "string",
"discountPointProportional": "string",
"discountCouponProportional": "string",
"taxIncludeProportional": "string",
"taxExcludeProportional": "string",
"productBundleProportional": "string",
"staffDiscountProportional": "string",
"bargainDiscountProportional": "string",
"roundingPriceProportional": "string",
"productStaffDiscountRate": "string",
"staffRank": "string",
"staffRankName": "string",
"staffDiscountRate": "string",
"staffDiscountDivision": "string",
"applyStaffDiscountRate": "string",
"applyStaffDiscountPrice": "string",
"bargainId": "string",
"bargainName": "string",
"bargainDivision": "string",
"bargainValue": "string",
"applyBargainValue": "string",
"applyBargainDiscountPrice": "string",
"taxRate": "string",
"standardTaxRate": "string",
"modifiedTaxRate": "string",
"reduceTaxId": "10000001",
"reduceTaxName": "string",
"reduceTaxRate": "string",
"reduceTaxPrice": "string",
"reduceTaxMemberPrice": "string",
"memo": "string",
"productAttributes": [
{
"transactionHeadId": "string",
"transactionDetailId": "string",
"code": "string",
"name": "string"
}
]
}
],
"depositOthers": [
{
"transactionHeadId": "string",
"no": "string",
"paymentMethodId": "string",
"paymentMethodCode": "string",
"paymentMethodName": "string",
"depositOthers": "string",
"paymentUnitPrice": "string",
"paymentChangeFlag": "string",
"paymentDivision": "string",
"paymentSecuritiesFlag": "string",
"denomination": "string",
"denominationCode": "CREDIT",
"denominationName": "string",
"cardCompanyName": "string",
"slipNumber": "string",
"pointGivingUnitPrice": "string",
"pointGivingUnit": "string"
}
],
"coupons": [
{
"transactionCouponId": "string",
"terminalTranCouponId": "string",
"couponId": "string",
"couponName": "string",
"couponDivision": "string",
"serialNumber": "string",
"awardType": "string",
"awardValue": "string",
"discountPrice": "string"
}
],
"couponItems": [
{
"transactionCouponDetailId": "string",
"transactionCouponId": "string",
"terminalTranCouponId": "string",
"transactionDetailId": "string",
"couponItemId": "string"
}
],
"layaway": {
"transactionHeadId": "string",
"pickUpDate": "string",
"status": "string",
"partPayment": "string",
"partPaymentClass": "string",
"pickUpTransactionHeadId": "string",
"disabledEdit": "string"
},
"layawayPickUp": {
"transactionHeadId": "string",
"layawayServerTransactionHeadId": "string",
"receivedDepositCash": "string",
"receivedDepositCredit": "string"
}
}
  • 小計割引率が設定されており、小計値引きが未指定の場合
  • 存在しない店舗IDを指定した場合
  • 店舗が倉庫の店舗IDを指定した場合
  • 店舗が休止中の店舗IDを指定した場合
  • 存在しない端末IDを指定し、締め区分を 2:締め処理済み 以外を指定した場合
  • 対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 1:清算処理済み を指定した場合
  • 対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 0:未処理 を指定した場合
  • 締め区分が 2:締め処理済み以外で、締め日を設定した場合
  • 締め区分が2:締め処理済で、締め日が未指定の場合
  • 会員コードを設定し、会員IDが未設定の場合
  • 現在の会員マスタの会員コードと、リクエストの会員コードが異なる場合
  • 客層IDが指定した客層セクションに存在しない場合
  • 存在しない販売員IDを指定した場合
  • レシート番号が重複した場合
  • 客数と客数(男)、客数(女)、客数(不明)の合計が一致しない場合
  • 1取引タグが64文字を超える場合
  • ステータスが通常以外のバーコードを指定した場合
  • バーコードを指定し、取引区分が 1:通常 以外を指定した場合
  • バーコードを指定し、取消区分が 0:通常 以外を指定した場合
  • バーコードが重複した場合
  • 取置き取引IDを指定し、取引区分が 1:通常 以外を指定した場合
  • 取置き取引IDを指定し、取消区分が 0:通常 以外を指定した場合
  • 取置き取引IDを指定し、対象の取置き取引データが存在しない場合
  • 取置き取引IDを指定し、対象の取置き取引データの取引区分が、10:取置き 以外の場合
  • 取置き取引IDを指定し、対象の取置き取引データが、取消済または引取済の場合
  • 基本設定が「取置き店舗でのみ受取り可」 かつ 取置き取引IDに指定された取置き取引の店舗IDと登録する店舗IDが同一ではない場合
  • 取引区分が 1:通常 以外で、取引明細が存在している場合
  • 取引区分が 1:通常 で、取引明細が存在しない場合
  • 取引区分が 1:通常 以外で、その他支払方法が存在している場合
  • その他支払方法が4リクエスト以上ある場合
  • 取引明細IDが明細間で重複した場合
  • 同じ取引の明細に存在しない親取引明細IDを指定した場合
  • 商品IDで指定された商品の持つ商品区分が回数券である場合
  • 商品区分が 0:通常/4:バンドル販売(親)であり、親取引明細IDを指定した場合
  • 商品区分が 2:オプション商品/7:バンドル商品(子)/8:バンドル値引(子)で親取引明細IDが未指定の場合
  • 商品区分が 2:オプション商品 であるが、商品IDで指定された商品の持つ商品区分が 2:オプション商品 でない場合
  • 商品区分が 2:オプション商品 の明細で、販売数が親取引明細における販売数の整数倍でない場合
  • 商品区分が 2:オプション商品 である取引明細とその親取引明細に対して、存在する商品IDがともに設定されており、かつ前者の商品が後者の商品に対して付与可能なオプショングループに所属していない場合
  • 商品区分が 4:バンドル販売(親)の明細以外で商品バンドルグループを指定した場合
  • 商品区分が 0:通常販売/4:バンドル(親) の場合に親取引明細IDを指定した場合
  • 商品区分が 4:バンドル(親) の場合で、同じ取引の明細に 7:バンドル子/8:バンドル値引 かつ親取引明細IDが親自身であるものが存在しない場合
  • 商品区分が 7:バンドル子/8:バンドル値引 で、親取引IDにバンドル(親)の取引明細IDが設定されていない場合
  • 商品バンドルグループIDを設定し、商品区分が 4:バンドル(親) でない場合
  • 単品割引率を設定し、単品値引が未設定の場合
  • 現在の商品マスタの部門IDと、リクエストの部門IDが異なる場合
  • 部門IDが存在しない場合
  • 小計が明細合計と一致しない場合
  • 合計が計算値と一致しない場合
  • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)が重複した場合
  • その他支払方法の項番が重複している場合
  • 同一のその他支払方法内で、ポイント付与単位(金額)とポイント付与単位(ポイント)のどちらか片方のみが指定されている場合
  • その他支払方法にて、支払方法IDに個別アプリ専用支払方法登録APIで登録していない支払方法IDを指定せずに、キャッシュレス伝票番号・支払金種コード・クレジットカード会社を設定した場合
  • その他支払方法にて、支払方法IDに個別アプリ専用支払方法登録APIで登録した支払方法IDを指定し、支払金種コードを設定しない場合
  • その他支払方法にて、クレジットカード会社名を指定できない支払金種コードを指定の上、クレジットカード会社名を指定した場合
  • その他支払方法にて、2つ以上の個別アプリ専用支払方法が指定された場合
  • 取引区分が 1:通常 以外で、クーポン明細が存在している場合
  • 取引区分が 1:通常 以外で、クーポン商品付与明細が存在している場合
  • クーポン商品付与明細を指定し、クーポン明細が存在しない場合
  • 端末取引クーポンIDが明細間で重複した場合
  • クーポンIDが明細間で重複した場合
  • クーポンIDに指定されたクーポンが存在しない場合
  • giftee連携の利用設定が「利用しない」の場合に、クーポン区分が 1:giftee のクーポンが指定された場合
  • クーポンIDに指定されたクーポンのクーポン区分が 1:giftee で、クーポン明細のシリアル番号が設定されていない場合
  • クーポンIDに指定されたクーポンの利用可能期間外の場合
  • クーポンIDに指定されたクーポンの指定商品条件を満たしていない場合
  • クーポンIDに指定されたクーポンの対象金額を満たしていない場合
  • 併用区分が 1:併用不可 のクーポンが他のクーポンと併用された場合
  • 併用区分が 2:一部のクーポン(3:併用可能)と併用可能 のクーポンが 3:併用可能 以外のクーポンと併用された場合
  • 特典タイプが 1:値引き/2:割引 で、値引額が設定されていない場合
  • 特典タイプが 3:商品付与 で、特典値に0以外が設定されている場合
  • 特典タイプが 3:商品付与 で、値引額に0以外が設定されている場合
  • クーポン商品付与明細に指定された端末取引クーポンIDがクーポン明細に存在しない場合
  • クーポン商品付与明細に指定された端末取引クーポンIDに紐つくクーポン明細の特典タイプが 3:商品付与 以外の場合
  • クーポン商品付与明細に指定された取引明細IDが重複している場合
  • クーポン商品付与明細に指定された取引明細IDが取引明細に存在しない場合
  • クーポン商品付与明細に指定されたクーポンアイテムIDが重複している場合
  • クーポンアイテムIDが存在しない場合
  • クーポン商品付与明細に指定された取引明細IDの商品IDとクーポンアイテムIDに紐つく商品IDが一致しない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
"type": "about:blank",
"title": "Bad Request",
"detail": "小計割引率を設定した場合、小計値引きは必須です。",
"status": 400
}
  • プレミアムプラスプラン未満で、クーポン区分が 1:giftee のクーポンが指定された場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
"type": "about:blank",
"title": "Forbidden",
"detail": "ご利用の契約では、gifteeクーポンは指定できません。(クーポンID-{クーポンID})",
"status": 403
}