コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

取置き取得

GET
/transactions/layaways/{layaway_id}

取置き情報を取得します。

対象プラン

  • スタンダード
  • プレミアム
  • プレミアムプラス
  • フードビジネス
  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
layaway_id
required
string

取引ID

Query Parameters

Section titled “Query Parameters ”
fields
array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

with_details
string
default: none
Allowed values: all summary none

取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)

with_discounts
string
default: none
Allowed values: all none

小計値引／割引、単品値引／割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone)

with_store
string
default: none
Allowed values: all none

店舗情報を付加するか(付加する場合はall, しない場合はnone)

with_customer
string
default: none
Allowed values: all none

会員情報を付加するか(付加する場合はall, しない場合はnone)

with_customer_groups
string
default: none
Allowed values: all none

客層情報を付加するか(付加する場合はall, しない場合はnone)

with_staff
string
default: none
Allowed values: all none

スタッフ情報を付加するか(付加する場合はall, しない場合はnone)

with_layaway
string
default: none
Allowed values: all none

取置き情報を付加するか(付加する場合はall, しない場合はnone)

with_layaway_pick_up
string
default: none
Allowed values: all none

取置き引取情報を付加するか(付加する場合はall, しない場合はnone)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

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:領収証）

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

小計値引き/割引区分:小計値引き/割引時に指定された区分を設定。

string
pointDiscount

ポイント値引き:使用ポイント * ポイント還元率。
※消費税含む

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

現在マイル:取引前のマイル。
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。

string
earnMile

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

string
totalMile

合計マイル:取引後のマイル
現在マイル + 獲得マイル + 調整マイル
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。

string
adjustmentMile

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

string
adjustmentMileDivision

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

string
adjustmentMileValue

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

string
storeId

店舗ID:店舗毎に付与するID。

string
terminalId

端末ID:店舗の端末毎に付与するID。

string
customerId

会員ID:会員毎に付与するID。数字10桁以内。

string
terminalTranId

端末取引ID:端末で設定された取引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。客層セクションIDが1の客層IDを設定。

string
customerGroupId2

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

string
customerGroupId3

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

string
customerGroupId4

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

string
customerGroupId5

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

string
staffId

スタッフID:販売員ID。（スタッフID）

string
staffName

スタッフ名:販売員名。（スタッフ名）

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:ＩＣクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー
※ペイメント・マイスターで使用

string
memo

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

string
receiptMemo

レシートメモ:レシートに印字するメモを設定。

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:免税販売(自動計算・合算))

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:ポイント利用を値引として扱う (税を含まない値引き)
※未設定の場合、店舗のポイント利用区分に従う

string
mileageDivision

マイレージ利用区分:マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)

string
mileageLabel

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

string
customerPinCode

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

string
returnSales

返品取引区分:(0:通常、1:返品販売)

string
disposeDivision

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

string
disposeServerTransactionHeadId

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

string
cancelDateTime

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

string
sellDivision

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

string
taxRate

税率:税率 （単位％）
※未入力の場合、スマレジに設定されている消費税を設定（端末取引日時より算出）

string
taxRounding

税の丸め方式:税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時は1:切り捨てを設定

string
discountRoundingDivision

割引丸め区分:割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
※2:切り上げを一律で設定

string
transactionUuid

レシート番号:レシートに印字する番号。
※スマレジアプリの採番方法（1970年から計算した現在秒9桁＋端末IDゼロ詰め4桁)

string
exchangeTicketNo

引換券番号

string
giftReceiptValidDays

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

string
discountCalculateDivision

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

string
updDateTime

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

string
details

取引明細

Array<object>
object
transactionHeadId

取引ID

string
transactionDetailId

取引明細ID:取引毎の明細に付与するID。
未設定の場合、取引毎に1から採番。
設定する場合は0〜999まで。

string
parentTransactionDetailId

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

string
transactionDetailDivision

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

string
productId

商品ID

string
productCode

商品コード:省略時、商品IDが設定されている場合、マスタから設定。以外はnull

string
productName

商品名:省略時、商品IDが設定されている場合、マスタから設定。以外はnull

string
printReceiptProductName

レシート印字商品名:省略時、商品IDが設定されている場合、マスタから設定。以外はnull

string
color

カラー:商品IDが設定されている場合、商品マスタのカラーを設定します

string
size

サイズ:商品IDが設定されている場合、商品マスタのサイズを設定します

string
groupCode

グループコード:商品IDが設定されている場合、商品マスタのグループコードを設定します

string
taxDivision

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

string
price

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

string
salesPrice

販売単価:販売時の単価を設定。

string
unitDiscountPrice

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

string
unitDiscountRate

単品割引率:単品の割引率を設定。（単位：％）
※設定された場合、単品値引は必須

string
unitDiscountDivision

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

string
cost

商品原価:整数部分8桁、少数部5桁.。
省略時、商品IDが設定されている場合、マスタから設定。以外は0円

string
quantity

数量:購入数

string
unitNonDiscountSum

値引き前計:販売価格×数量

string
unitDiscountSum

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

string
unitDiscountedSum

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

string
costSum

原価計:原価×数量

string
categoryId

部門ID:商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合nullを設定。
　省略時、商品IDが設定されている場合、商品マスタから設定。以外はnull
※商品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:コース(子)) ※A,Bはウェイターでのみ利用する区分。

string
inventoryReservationDivision

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

string
pointNotApplicable

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

string
calcDiscount

小計値引／割引(クーポン、ポイント値引き含む)の対象かどうかを設定（0:対象外、1:対象）。

string
taxFreeDivision

免税区分:免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:対象外を設定

string
taxFreeCommodityPrice

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

string
taxFree

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

string
productBundleGroupId

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

string
discountPriceProportional

小計値引き按分:端数処理は銀行丸め。誤差は最終行で調整。

string
discountPointProportional

ポイント値引き按分:端数処理は銀行丸め。誤差は最終行で調整。

string
taxIncludeProportional

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

string
taxExcludeProportional

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

string
netTaxExcludeProportional

外税按分(計算用):外税(計算用)を按分した金額を設定
端数処理は銀行丸め。誤差は最終行で調整
※正確な外税の按分として使用する

string
productBundleProportional

商品バンドル値引按分:端数処理は銀行丸め。誤差は最終行で調整。

string
staffDiscountProportional

社員値引き按分:端数処理は銀行丸め。誤差は最終行で調整。

string
bargainDiscountProportional

セール値引き按分:端数処理は銀行丸め。誤差は最終行で調整。

string
roundingPriceProportional

端数値引額按分:端数処理は銀行丸め。誤差は最終行で調整。

string
productStaffDiscountRate

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

string
staffRank

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

string
staffRankName

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

string
staffDiscountRate

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

string
staffDiscountDivision

社員販売割引区分:社員販売時のみ設定 １ビット目: 商品マスタの社員販売最大値引率を考慮（する or しない） ２ビット目: セール価格と社員販売割引を掛け合わせて適用（する or しない） ３ビット目: セール価格と社員販売価格を比較して安い方を適用（する or しない） ４ビット目: セール価格と社員販売価格を比較して高い方を適用（する or しない） ８ビット目: セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用（する or しない）

string
applyStaffDiscountRate

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

string
applyStaffDiscountPrice

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

string
bargainId

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

string
bargainName

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

string
bargainDivision

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

string
bargainValue

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

string
applyBargainValue

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

string
applyBargainDiscountPrice

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

string
taxRate

適用税率:適用した税率（明細毎に税率変更可能な為）

string
standardTaxRate

標準税率:標準税率（明細毎に税率変更可能な為）

string
modifiedTaxRate

修正税率:修正した税率（明細毎に税率変更可能な為）

string
reduceTaxId

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

string
reduceTaxName

軽減税率名

string
reduceTaxRate

軽減税率

string
reduceTaxPrice

軽減税率用商品単価:軽減税率用商品単価

string
reduceTaxMemberPrice

軽減税率用会員商品単価:軽減税率用会員商品単価

string
discounts

小計値引／割引、単品値引／割引の詳細情報

Array<object>
object
transactionHeadId

取引ID

string
transactionDetailId

取引明細ID:取引毎の明細に付与するID。
※ 取引値引区分が小計の場合、nullが返されます。

string
transactionDiscountDivision

取引値引区分 (1:小計、2:単品)

string
discountDivision

値引／割引区分: 値引／割引時に指定された区分を設定。

string
discountDivisionName

値引／割引区分名称

string
awardType

特典タイプ：（1：値引・値増、2：割引）。

string
awardValue

特典値：特典タイプに応じた値を設定。

特典タイプ 設定値
1：値引 値引額[円]（※）
2：割引 割引率[%]

※ 値引は正の数、値増は負の数が設定されます

string
discountPrice

値引額

※ 値引は正の数、値増は負の数が設定されます
※ 取引値引区分が（1：小計）の場合、打消レコードに関連すると、値が正負が逆転して設定されます

string
layaway

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

object
transactionHeadId

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

string
pickUpDate

受取日

string
status

ステータス:0：取置き中、1：引取済み、2：取消

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
store

店舗
※ 現在の店舗マスタに登録されている店舗情報が設定されます。

object
storeId

店舗ID:店舗毎に付与するID。

string
storeCode

AppAccessToken(pos.stores:read) OR UserAccessToken(pos.stores:read)
店舗コード:店舗コード。半角英数記号20文字以内。

string
storeName

AppAccessToken(pos.stores:read) OR UserAccessToken(pos.stores:read)
店舗名:店舗名。(85文字以内)

string
storeAbbr

AppAccessToken(pos.stores:read) OR UserAccessToken(pos.stores:read)
店舗名略称:店舗名略称。85文字以内。

string
printReceiptStoreName

AppAccessToken(pos.stores:read) OR UserAccessToken(pos.stores:read)
レシート印刷用店舗名:レシート印刷用店舗名。(85文字以内)

string
displaySequence

AppAccessToken(pos.stores:read) OR UserAccessToken(pos.stores:read)
表示順:数字9桁以内。

string
customer

会員
※ 現在の会員マスタに登録されている会員情報が設定されます。

object
customerId

会員ID

string
customerCode

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
会員コード

string
customerNo

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
会員番号

string
rank

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
会員ランク

string
staffRank

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
社員ランク

string
firstName

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
名

string
lastName

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
姓

string
firstKana

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
名カナ

string
lastKana

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
姓カナ

string
sex

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
性別:0：不明、1：男、2：女

string
birthDate

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
生年月日

string
pointExpireDate

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
ポイント失効予定日

string
lastComeDateTime

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
最終来店日時

string
entryDate

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
入会日

string
leaveDate

AppAccessToken(pos.customers:read) OR UserAccessToken(pos.customers:read)
退会日

string
customerGroups

客層
※ 現在の客層マスタに登録されている客層情報が設定されます。

Array<object>
object
customerGroupId

客層ID

string
customerGroupSectionId

客層セクションID

string
label

ラベル

string
staff

スタッフ
※ 現在のスタッフマスタに登録されているスタッフ情報が設定されます。

object
staffId

スタッフID

string
staffCode

スタッフコード

string
staffName

スタッフ名

string
rank

ランク

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",
  "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",
  "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",
      "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",
      "taxIncludeProportional": "string",
      "taxExcludeProportional": "string",
      "netTaxExcludeProportional": "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"
    }
  ],
  "discounts": [
    {
      "transactionHeadId": "string",
      "transactionDetailId": "string",
      "transactionDiscountDivision": "string",
      "discountDivision": "string",
      "discountDivisionName": "string",
      "awardType": "string",
      "awardValue": "string",
      "discountPrice": "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"
  },
  "store": {
    "storeId": "string",
    "storeCode": "string",
    "storeName": "string",
    "storeAbbr": "string",
    "printReceiptStoreName": "string",
    "displaySequence": "string"
  },
  "customer": {
    "customerId": "string",
    "customerCode": "string",
    "customerNo": "string",
    "rank": "string",
    "staffRank": "string",
    "firstName": "string",
    "lastName": "string",
    "firstKana": "string",
    "lastKana": "string",
    "sex": "string",
    "birthDate": "string",
    "pointExpireDate": "string",
    "lastComeDateTime": "string",
    "entryDate": "string",
    "leaveDate": "string"
  },
  "customerGroups": [
    {
      "customerGroupId": "string",
      "customerGroupSectionId": "string",
      "label": "string"
    }
  ],
  "staff": {
    "staffId": "string",
    "staffCode": "string",
    "staffName": "string",
    "rank": "string"
  }
}