取置き一覧取得
GET /transactions/layaways
取置き一覧を取得します。
対象プラン
- スタンダード
- プレミアム
- プレミアムプラス
- フードビジネス
- リテールビジネス
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可
並び順（カンマ区切りで指定可）
- 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します。
指定可能なパラメータ
- transactionHeadId : 取引ID
- transactionDateTime : 取引日時
- storeId : 店舗ID
- terminalId : 端末ID
- customerId : 会員ID
- terminalTranId : 端末取引ID
- terminalTranDateTime : 端末取引日時
- sumDate : 締め日
- updDateTime : 更新日時
上限数
ページ
取引ID(From)
取引ID(To)
取引日時(From):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
店舗ID:店舗毎に付与するID。
端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
<※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
精算日時 [YYYY-MM-DDThh:mm:ssTZD]
締め日:締めをしたら年月日が入る。 [YYYY-MM-DD]
締め日(From) :[YYYY-MM-DD]
※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
締め日(To) :[YYYY-MM-DD]
※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
会員コード
レシート番号：指定した値を完全一致で検索します
更新日時(From)：登録時・更新時の日時。締め日(From)[YYYY-MM-DD]
※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
更新日時(To)：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します
※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします
取置き情報を付加するか(付加する場合はall, しない場合はnone)
取置き引取情報を付加するか(付加する場合はall, しない場合はnone)
Responses
Section titled “ Responses ”取得成功
object
取引ID
取引日時:サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
取引区分:取引を識別する区分。
（1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証）
取消区分:取引の取消を識別する区分。 (0:通常、1取消）
単品値引き前小計:取引明細の、値引き前計の合計。明細より自動算出。
※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計
単品値引き小計：取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。
※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。
（例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。）
※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。
4:バンドル (親)
5:セット売り(親)
6:簡易セット(親)
8:バンドル値引(子)
単品社員販売値引き計
単品セール販売値引き計
小計:取引明細の値引き後小計の合計。
値引対象金額:取引明細の割引値引対象区分が対象の小計金額
小計値引き:小計の値引き金額を設定。 単品割引率が設定された場合、その割合から値引き金額を設定。（切捨て）
小計割引率:小計の割引を設定 （単位％） デフォルトは未設定。
設定された場合、小計計値引きに自動的に設定(切り捨て)
集計は、小計値引きしか見ない。
小計値引き/割引区分:小計値引き/割引時に指定された区分を設定。
ポイント値引き:使用ポイント * ポイント還元率。
※消費税含む
合計:小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定
内税額:内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定
外税額:外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り
端数値引区分:販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力
端数値引額
内現金支払金額:合計金額の内訳 （現金払い）
内クレジット支払金額:合計金額の内訳 （クレジット払い）
預かり金:会計時に預かった金額。
預かり金現金:会計時に預かった現金金額。
預かり金クレジット:会計時に預かったクレジット金額。
釣銭:預かり金 - 合計。
現金チップ
クレジットチップ
数量合計:取引明細の返品以外の数量の合計 （取引明細区分が2返品以外の数量）
返品数量合計:取引明細の返品の数量の合計 （取引明細区分が2返品の数量）
原価合計:明細の原価計の合計
売上ヘッダ区分:売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む)
内税対象額:売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。
外税対象額:売上対象商品の外税販売の税抜き商品合計金額
非課税対象額:売上対象商品の非課税商品の合計金額。
売上対象外合計:売上対象外商品の合計。 外税販売の場合、税を含まない。
売上対象外内税合計:売上対象外商品の外税合計。
売上対象外外税合計:売上対象外商品の内税合計。
売上対象外免税額合計:売上対象外商品の免税額合計。
売上対象外原価合計:売上対象外商品の原価合計。
売上対象外数量合計:取引明細の返品以外かつ売上対象外の数量の合計。 （取引明細区分が2返品以外の数量）
売上対象外返品数量合計:取引明細の返品かつ売上対象外の数量の合計。 （取引明細区分が2返品の数量）
付与ポイント:取引で付与されるポイント。 合計 * ポイント付与率
使用ポイント:取引で使用したポイント。
現在ポイント:取引前のポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。
合計ポイント:取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。
現在マイル:取引前のマイル
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。
獲得マイル:取引で付与されるマイル
合計 * ポイント付与率
※ 会員販売でない場合、nullが返されます。
合計マイル:取引後のマイル
現在マイル + 獲得マイル + 調整マイル
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。
調整マイル:取引で手動で付与されるマイル
※ 会員販売でない場合、nullが返されます。
調整マイル区分:調整マイルの区分
1:0マイル （マイルを付与しない。「調整マイル = -1 * 獲得マイル」）
2:マイル指定（指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」）
3:マイル加算（マイルを加算/減算する。「調整マイル =入力値」）
4:マイルｎ倍（指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」
※ 会員販売でない場合、nullが返されます。
調整マイル区分値:調整マイルの入力値
※ 会員販売でない場合、nullが返されます。
店舗ID:店舗毎に付与するID。
店舗コード
端末ID:店舗の端末毎に付与するID。
会員ID:会員毎に付与するID。数字10桁以内。
会員コード
端末取引ID:端末で設定された取引ID。
端末取引日時:端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
締め区分:締め処理を実施したかの区分。 （0未処理、1精算処理済み、2締め処理済み）
精算日時:精算をしたら日時が入る。[YYYY-MM-DDThh:mm:ssTZD]
締め日:締めをしたら年月日が入る。 [YYYY-MM-DD]
会員ランク:管理画面の[設定]→[会員設定]→[会員ランク]で設定した値
客層ID:客層ID。客層セクションIDが1の客層IDを設定。
客層ID2:客層ID2。客層セクションIDが2の客層IDを設定。
客層ID3:客層ID3。客層セクションIDが3の客層IDを設定。
客層ID4:客層ID4。客層セクションIDが4の客層IDを設定。
客層ID5:客層ID5。客層セクションIDが5の客層IDを設定。
スタッフID:販売員ID。（スタッフID）
販売員コード
スタッフ名:販売員名。（スタッフ名）
クレジット区分：クレジット会社を識別する区分
- 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)
支払回数:クレジットの支払回数。
※ゼウス、ペイメントマイスターご利用時
（1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い）
伝票番号:クレジットの伝票番号。
取消伝票番号:クレジットの取消伝票番号。
承認番号:クレジットの承認番号。
センター処理日:クレジットのセンター処理日。
取扱カード会社:クレジットカード会社 例） VISA、JCB、MASTER、AMEX、DINERSなど
金種:11:磁気クレジットカード、12:ＩＣクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー
※ペイメント・マイスターで使用
メモ:入出金時のメモなどを設定。 1000文字以内。
レシートメモ:レシートに印字するメモを設定。
送料:EC連携用送料。
手数料:EC連携用手数料。
客数:客数。
客数（男）:客数（男）。
客数（女）:客数（女）。
客数（不明）:客数（不明）。
入店日時:[YYYY-MM-DDThh:mm:ssTZD]
免税販売区分:免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
内税商品の一般品免税額:内税商品の一般品免税額。
外税商品の一般品免税額:外税商品の一般品免税額。
内税商品の消耗品免税額:内税商品の消耗品免税額。
外税商品の消耗品免税額:外税商品の消耗品免税額。
取引タグ:レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
※複数ある場合は、カンマ区切りで設定
ポイント付与税区分:1:税額を含める + 利用ポイント分を含める、
2:税額を含めない + 利用ポイント分を含める、
3:税額を含める + 利用ポイント分を含めない、
4:税額を含めない + 利用ポイント分を含めない
※未設定の場合は店舗マスタから設定
ポイント付与単位(金額):ポイント付与の設定 n円をnポイントの「n円」の部分。 （設定範囲1円～99999円)
（例10円ごとに2ポイントの場合、10円）
ポイント付与単位(ポイント):ポイント付与の設定 n円をnポイントの「nポイント」の部分 （設定範囲0.00ポイント～99999.99ポイント)
（例10円ごとに0.2ポイントの場合、0.2ポイント）
ポイント利用区分:ポイント利用時の税を含む／含まないを判定。
1:ポイント利用を現金として扱う (税を含む値引き)
2:ポイント利用を値引として扱う (税を含まない値引き)
※未設定の場合、店舗のポイント利用区分に従う
マイレージ利用区分:マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
マイレージラベル:マイレージの名称。未設定の場合は「マイル」
PINコード:自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。
返品取引区分:(0:通常、1:返品販売)
打消区分:0通常、1打消元レコード、2打消レコード
※0:通常と2:打消レコードのみ設定可能（省略時は０:通常を設定）
※打消レコードの場合、取引明細区分は、（通常、部門売り）→返品に変換させて設定してください。
打消元取引ID:打消元取引ID
※打消し区分が2の場合必須
※打消元取引IDが存在しない場合エラー。省略時はnullを設定
取消日時:取消／打消しの場合自動設定。[YYYY-MM-DDThh:mm:ssTZD]
販売区分:取引が外税販売、内税販売かを識別する区分。 （0:内税販売、1:外税販売）
税率:税率 （単位％）
※未入力の場合、スマレジに設定されている消費税を設定（端末取引日時より算出）
税の丸め方式:税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時は1:切り捨てを設定
割引丸め区分:割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
※2:切り上げを一律で設定
レシート番号:レシートに印字する番号。
※スマレジアプリの採番方法（1970年から計算した現在秒9桁＋端末IDゼロ詰め4桁)
引換券番号
ギフトレシート引換有効日数:有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。
更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
取置き時の詳細情報
object
取引ID:取引毎に付与するID。サーバー側で付与する。
受取日
ステータス:0：取置き中、1：引取済み、2：取消
前受金
前受金区分（1：現金、2：クレジット）
引取取引ヘッダーID
変更不可能設定:変更不可能設定(0:変更可、 1:変更不可)
取置き引取時の詳細情報
object
取引ID
取置きの取引ID
受領済金額:取置きの内金/手付金（現金）
受領済クレジット金額:取置きの内金/手付金（クレジット）
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", "storeCode": "string", "terminalId": "string", "customerId": "string", "customerCode": "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", "staffCode": "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", "updDateTime": "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" } }]