TransactionHeads
取引情報:取引
Select
本製品 は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE::リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、過去30日分のUpdDateTime に設定されています。
- Transaction ID [TransactionHeadId] ID specification, From-To (From-To can be specified within 100, 000).
- Transaction Date Time [TransactionDateTime] From-To (Period is 31 days (not 1 month)).
- Terminal transaction date and time [TerminalTranDateTime] From-To (Period is 31 days (not 1 month)).
- Adjustment date and time [AdjustmentDateTime] From-To (Period is 31 days (not 1 month)).
- Sum date and time [SumDateTime] From-To (Period is 31 days (not 1 month)).
- Cancel date and time [CancelDateTime] From-To (Period is 31 days (not 1 month)).
- Updated date and time [UpdDateTime] From-To (Period is 31 days (not 1 month)).
SELECT * FROM TransactionHeads WHERE TransactionHeadId >= 1 AND TransactionHeadId <= 100000 SELECT * FROM TransactionHeads WHERE TransactionDateTime >= '2021/03/01 00:00:00' AND TransactionDateTime <= '2021/03/31 00:00:00' SELECT * FROM TransactionHeads WHERE TerminalTranDateTime >= '2021/03/01 00:00:00' AND TerminalTranDateTime <= '2021/03/31 00:00:00' SELECT * FROM TransactionHeads WHERE SumDateTime >= '2021/03/01 00:00:00' AND SumDateTime <= '2021/03/31 00:00:00' SELECT * FROM TransactionHeads WHERE UpdDateTime >= '2021/03/01 00:00:00' AND UpdDateTime <= '2021/03/31 00:00:00'
Insert
Storage を追加するには、SupplierId、StorageStoreId およびDetailAggregate フィールドを指定します。
テンポラリテーブルの使用:
INSERT INTO TransactionDetails#TEMP (TransactionDetailId, ParentTransactionDetailId, TransactionDetailDivision, SalesPrice, Quantity) VALUES (1, 1, 2, 400, 4) INSERT INTO TransactionHeads (SumDivision, SumDateTime, StoreId, TerminalId, TerminalTranId, CancelDivision, TransactionDateTime, TerminalTranDateTime, TransactionHeadDivision, Subtotal, Total, DetailAggregate) VALUES (2, '2019/08/06 00:00:00', 1, 23, 6, 0, '2019/08/21', '2019-08-11', '1',-1600,-1600, 'TransactionDetails#TEMP')
集計の使用:
INSERT INTO TransactionHeads (SumDivision, SumDateTime, StoreId, TerminalId, TerminalTranId, CancelDivision, TransactionDateTime, TerminalTranDateTime, TransactionHeadDivision, Subtotal, Total, DetailAggregate) VALUES (2, '2019/08/06 00:00:00', 1, 23, 6, 0, '2019/08/21', '2019-08-14', '1', 159, 159, ' { "table_name": "TransactionDetail", "rows": [ { "parentTransactionDetailId": "1", "transactionDetailDivision": "1", "salesPrice": "159", "quantity": "1" } ] } ')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
Upsert
アップサートは、このテーブルではサポートされていません。
Update
UPDATE は、このテーブルではサポートされていません。
Delete
削除はこのテーブルではサポートされていません。
Columns
Name | Type | ReadOnly | References | Description |
TransactionHeadId | Long | True |
取引ID : 取引毎に付与するID。【自動更新】自動採番 | |
TransactionDateTime | Datetime | True |
取引日時 : 取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。【自動更新】サーバー時間 | |
TransactionHeadDivision | String | False |
取引区分 : 取引を識別する区分。(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、 7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、 14:マイル減算)※1:取引、10:取置きの場合、取引明細が必要。以外は不要(無視する) | |
CancelDivision | Integer | False |
取消区分 : 取引の取消を識別する区分。(0:通常、1:取消) | |
UnitNonDiscountsubtotal | Decimal | True | ||
UnitDiscountsubtotal | Decimal | True |
単価値引き小計 : 取引明細の、マイナス値の単価値引きの合計。【自動更新】明細より自動算出 | |
Subtotal | Decimal | False |
小計 : 取引明細の値引き後小計の合計。※明細合計と異なる場合エラー | |
SubtotalDiscountPrice | Decimal | False |
小計値引き : 小計の値引き金額を設定。単価割引率が設定された場合、その割合から値引き金額を設定。(切捨て) | |
SubtotalDiscountRate | Decimal | False |
小計割引率 : 小計の割引を設定 (単位:%)デフォルトは未設定。集計は、小計値引きしか見ない。※設定された場合、小計計値引きは必須 | |
SubtotalDiscountDivision | Integer | True | ||
PointDiscount | Decimal | False |
ポイント値引き : 使用ポイント * ポイント還元率。※消費税含む | |
Total | Decimal | False |
合計 : 小計 - 小計値引き - ポイント引き + 外税額 + 手数料 + 送料 を設定※算出合計と異なる場合エラー | |
TaxExclude | Decimal | False |
外税額 : 外税商品計 * 5 / 100。 ※税率が5%の場合※ 省略時は0を設定※ 小数点以下は税の丸め方式で指定の通り | |
TaxInclude | Decimal | False |
内税額 : 合計 / 105 * 5。※税率が5%の場合※省略時は0を設定※ver.2.0.0でtaxはtaxIncludeに項目名が変更になりました。※小数点以下は税の丸め方式で指定の通り | |
RoundingDivision | String | True |
端数値引区分 : 販売時の合計金額の端数を丸めるか否かを設定する(ver.2.5.0で追加)00:なし【初期値】11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上99:手入力 | |
RoundingPrice | Decimal | True |
端数値引額 : 端数値引金額(ver.2.5.0で追加) | |
CashTotal | Decimal | True |
内現金支払金額 : 合計金額の内訳 (現金払い)【自動更新】※預かり金現金 - 釣銭 | |
CreditTotal | Decimal | True |
内クレジット支払金額 : 合計金額の内訳 (クレジット払い)【自動更新】※預かり金クレジット | |
Deposit | Decimal | False |
預かり金 : 会計時に預かった金額。(預かり金現金 + 預かり金クレジット + 預かり金その他1-3)※預かり金を正しく設定しないと、日報が正しく表示されません。 | |
DepositCash | Decimal | False |
預かり金現金 : 会計時に預かった現金金額。※現金支払の場合必ず設定。(預かり金現金 - 釣銭)が現金支払額に設定されます。 | |
DepositCredit | Decimal | False |
預かり金クレジット : 会計時に預かったクレジット金額。※クレジット払いの場合必ず設定。預かり金クレジットが内クレジット支払金額に設定されます。※預かり金を正しく設定しないと、日報が正しく表示されません。 | |
Charge | Decimal | False |
釣銭 : 現金の返却金額※預かり金を正しく設定しないと、日報が正しく表示されません。 | |
ChangeDifference | Decimal | True |
釣銭差額 : 合計 + 釣銭 ー 会計時に預かった金額 (ver.2.7.0で追加) | |
Amount | Integer | True |
数量合計 : 取引明細の返品以外の数量の合計(取引明細区分が2:返品以外の数量)【自動更新】 | |
ReturnAmount | Integer | True |
返品数量合計 : 取引明細の返品の数量の合計(取引明細区分が2:返品の数量)【自動更新】 | |
CostTotal | Decimal | True |
原価合計 : 明細の原価計の合計【自動更新】明細より算出 | |
SalesHeadDivision | Integer | True |
売上ヘッダ区分 : 売上明細に売上対象がい商品を含むか否かの区分。(0:売上対象のみ、1:売上対象外含む)【自動更新】明細より算出 | |
InTaxSalesTotal | Decimal | True |
内税対象額 : 売上対象商品の内税販売合計金額内税販売の場合は、税込・税抜き商品を対象 | |
OutTaxSalesTotal | Decimal | True |
外税対象額 : 売上対象外商品の合計外税販売の税抜き商品を対象 | |
NonTaxSalesTotal | Decimal | True |
非課税対象額 : 売上対象外商品の合計非課税商品の合計を対象 | |
NonSalesTargetTotal | Decimal | True |
売上対象外合計 : 売上対象外商品の合計外税販売の場合、税を含まない | |
NonSalesTargetOutTaxTotal | Decimal | True |
売上対象外外税合計 : 売上対象外商品の外税合計 | |
NonSalesTargetInTaxTotal | Decimal | True |
売上対象外内税合計 : 売上対象外商品の内税合計(ver.2.0.0で追加) | |
NonSalesTargetTaxFreeTotal | Decimal | True | ||
NonSalesTargetCostTotal | Decimal | True |
売上対象外原価合計 : 売上対象外商品の原価合計 | |
NonSalesTargetAmount | Integer | True |
売上対象外数量合計 : 取引明細の返品以外かつ売上対象外の数量の合計(取引明細区分が2:返品以外の数量) | |
NonSalesTargetReturnAmount | Integer | True | ||
NewPoint | Decimal | False |
付与ポイント : 取引で付与されるポイント。合計 * ポイント率会員IDが設定されている場合、会員情報を更新。※省略時は0を設定※取置区分が10:取置きの場合、設定不可。 | |
SpendPoint | Decimal | False |
使用ポイント : 取引で使用したポイント。会員IDが設定されている場合、会員情報に更新。※省略時は0を設定 | |
Point | Decimal | False |
現在ポイント : 取引前のポイント※取引データには設定した値がそのまま設定されます。(変更前のスマレジの会員ポイントに上書き設定されません。) | |
TotalPoint | Decimal | False |
合計ポイント : 取引後のポイント現在ポイント + 付与ポイント - 使用ポイント。※取引データには設定した値がそのまま設定されます。(変更後のスマレジの会員ポイントに上書き設定されません。) | |
CurrentMile | Decimal | False |
現在マイル : 取引前のマイル(ver.2.3.0で追加) | |
EarnMile | Decimal | False |
獲得マイル : 取引で付与されるマイル(ver.2.3.0で追加)合計 * ポイント付与率 | |
TotalMile | Decimal | False |
合計マイル : 取引後のマイル(ver.2.3.0で追加)現在マイル + 獲得マイル + 調整マイル | |
AdjustmentMile | Decimal | False |
調整マイル : 取引で手動で付与されるマイル(ver.2.3.0で追加) | |
AdjustmentMileDivision | Integer | False |
調整マイル区分 : 調整マイルの区分(ver.2.3.0で追加)1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」) 3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」 | |
AdjustmentMileValue | Integer | False |
調整マイル区分値 : 調整マイルの入力値(ver.2.3.0で追加) | |
StoreId [KEY] | Integer | False |
店舗ID (PK) : 店舗毎に付与するID。※店舗情報が存在しない場合エラー※休止中の店舗IDを指定するとエラー(ver.2.7.0で追加) | |
StoreCode | String | True |
店舗コード : 店舗コード(ver.2.1.1で追加)※店舗マスタの店舗コードを参照 | |
TerminalId [KEY] | Integer | False |
端末ID (PK) : 店舗の端末毎に付与するID。※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みにする必要がある。) | |
CustomerId | Long | False |
会員ID : 会員毎に付与するID。数字10桁以内。※設定されている場合、会員取引とみなし、会員情報を更新します。※存在しない会員IDの場合、会員情報を更新しません。 | |
CustomerCode | String | True |
会員コード : 半角英数記号20文字以内。ユニークキーとなる為重複不可。(2013/5/1追加) | |
TerminalTranId [KEY] | String | False |
端末取引ID (PK) : 端末で設定された取引ID。(連携元システムで採番してください。) | |
TerminalTranDateTime [KEY] | Datetime | False |
端末取引日時 (PK) : 端末で設定された取引日時。(連携元システムで処理日時を設定してください。) | |
SumDivision | Integer | False |
締め区分 : 締め処理を実施したかの区分。(0:未処理、1:精算処理済み、2:締め処理済み)※省略時は0を設定※1:精算処理済みは、店舗の締め方式区分が「利用する」のときのみ設定可能(ver.2.10.0で追記)※存在しない端末IDの場合、2:締め処理済みとする事 | |
AdjustmentDateTime | Datetime | True |
精算日時 : 精算をしたら日時が入る。 | |
SumDateTime | Datetime | False |
締め日時 : 締めをしたら日時が入る。(YYYY-MM-DD形式)※締め区分を2に設定した場合必須。締め区分を0の場合null | |
CustomerRank | String | False |
会員ランク : 汎用マスタの「会員ランク」で登録しているコードを設定してください。汎用マスタに登録されていないコードを設定するとエラーになります。 | |
CustomerGroupId | Integer | False |
客層ID : 客層ID。客層セクションIDが1の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId2 | Integer | False |
客層ID2 : 客層ID2。客層セクションIDが2の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId3 | Integer | False |
客層ID3 : 客層ID3。客層セクションIDが3の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId4 | Integer | False |
客層ID4 : 客層ID4。客層セクションIDが4の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId5 | Integer | False |
客層ID5 : 客層ID5。客層セクションIDが5の客層IDを設定。※客層情報が存在しない場合エラー | |
StaffId | Integer | False |
販売員ID : 販売員ID。※販売員情報が存在しない場合エラー | |
StaffName | String | True |
販売員名 : 販売員名。【自動更新】販売員情報より自動設定 | |
StaffCode | String | True |
販売員コード : 販売員コード(ver.2.1.2で追加)※販売員マスタの販売員コードを参照 | |
PaymentCount | String | True |
支払回数 : クレジットの支払回数。※ゼウス、ペイメントマイスターご利用時(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い) | |
SlipNumber | String | True |
伝票番号 : クレジットの伝票番号。 | |
CancelSlipNumber | String | True |
取消伝票番号 : クレジットの取消伝票番号。 | |
AuthNumber | String | True |
承認番号 : クレジットの承認番号。 | |
AuthDate | String | True |
センター処理日 : クレジットのセンター処理日。 | |
CardCompany | String | True |
取扱カード会社 : クレジットカード会社例) VISA、JCB、MASTER、AMEX、DINERSなど | |
Memo | String | False |
メモ : 入出金時のメモなどを設定。1000文字以内 | |
ReceiptMemo | String | False |
レシートメモ : レシートに印字するメモを設定(ver.2.7.0で追加) | |
PaymentMethodId1 | Integer | False |
支払方法ID1 : 支払方法ID1。※支払情報が存在しない場合エラー | |
PaymentMethodName1 | String | True |
支払方法名1 : 支払方法名1。【自動更新】支払方法情報より自動設定 | |
DepositOthers1 | Decimal | False |
預かり金その他1 : 会計時に預かった金額 支払方法は支払方法1。※支払方法ID1が設定されている場合必須※取置区分が10:取置きの場合、設定不可。 | |
PaymentMethodId2 | Integer | False |
支払方法ID2 : 支払方法ID2。※支払情報が存在しない場合エラー | |
PaymentMethodName2 | String | True |
支払方法名2 : 支払方法名2。【自動更新】支払方法情報より自動設定 | |
DepositOthers2 | Decimal | False |
預かり金その他2 : 会計時に預かった金額 支払方法は支払方法2。※支払方法ID2が設定されている場合必須※取置区分が10:取置きの場合、設定不可。 | |
PaymentMethodId3 | Integer | False |
支払方法ID3 : 支払方法ID3。※支払情報が存在しない場合エラー | |
PaymentMethodName3 | String | True |
支払方法名3 : 支払方法名3。【自動更新】支払方法情報より自動設定 | |
DepositOthers3 | Decimal | False |
預かり金その他3 : 会計時に預かった金額 支払方法は支払方法3。※支払方法ID3が設定されている場合必須※取置区分が10:取置きの場合、設定不可。 | |
Carriage | Decimal | False |
送料 : EC連携用送料。 | |
Commission | Decimal | False |
手数料 : EC連携用手数料。 | |
GuestNumbers | Integer | False |
客数 : 客数。(0以上の整数値)※省略時は0を設定 | |
TaxFreeSalesDivision | Integer | False |
免税販売区分 : 免税販売区分(0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算)) | |
NetTaxFreeGeneralTaxInclude | Decimal | False | ||
NetTaxFreeGeneralTaxExclude | Decimal | False | ||
NetTaxFreeConsumableTaxInclude | Decimal | False | ||
NetTaxFreeConsumableTaxExclude | Decimal | False | ||
Tags | String | False |
取引タグ : レジ端末よりクイックコマンドを押下した値を設定。和名を設定する。※複数ある場合は、カンマ区切りで設定 | |
PointGivingDivision | Integer | False |
ポイント付与区分 : (1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない)(ver.2.1.1で追加)※未設定の場合、nullを設定 | |
PointGivingUnitPrice | Integer | False |
ポイント付与単位(金額) : ポイント付与の設定 n円をnポイントの「n円」の部分(ver.2.1.1で追加)(設定範囲:1円?99999円)(例:10円ごとに2ポイントの場合、10円) | |
PointGivingUnit | Decimal | False |
ポイント付与単位(ポイント) : ポイント付与の設定 n円をnポイントの「nポイント」の部分(ver.2.1.1で追加)(設定範囲:0.01ポイント?99999.99ポイント) | |
PointSpendDivision | Integer | False |
ポイント利用区分 : ポイント利用時の税を含む/含まないを判定(ver.2.1.5で追加)1:ポイント利用を現金として扱う (税を含む値引き)2:ポイント利用を値引として扱う (税を含まない値引き)※未設定の場合、1:ポイント利用を現金として扱う。 | |
MileageDivision | Integer | False |
マイレージ利用区分 : マイレージ機能を利用するか否か(ver.2.3.0で追加)(0: 利用しない, 1: 利用する, 2: ポイントの代わりに貯める)※未設定の場合、「0: 利用しない」を設定 | |
MileageLabel | String | False |
マイレージ名称 : マイレージの名称(ver.2.3.0で追加)例:rejiマイル | |
CustomerPinCode | String | False |
PINコード : 自由な文字列(ver.2.1.1で追加)PINコードなど会員を識別する任意の文字列を設定してください。 | |
DisposeDivision | Integer | False |
打消区分 : 0:通常、1:打消元レコード、2:打消レコード※0:通常と2:打消しレコードのみ設定可能(省略時は0:通常を設定)※打消しレコードの場合、取引明細区分は、(通常、部門売り)→返品に変換させて設定してください。 | |
DisposeServerTransactionHeadId | Long | False | ||
CancelDateTime | Datetime | True |
取消日時 : 取消したサーバー日時を設定。【自動更新】取消/打消しの場合自動設定 | |
SellDivision | Integer | False |
販売区分 : 取引が外税販売、内税販売かを識別する区分。(0:内税販売、1:外税販売)※省略時は0:内税販売を設定 | |
TaxRate | Decimal | False |
税率 : 税率 (単位:%)※未入力の場合、スマレジに設定されている消費税を設定(端末取引日時より算出) | |
TaxRounding | Integer | False |
税の丸め方式 : 税の丸めを判定(ver.2.1.5で追加)0:四捨五入、1:切り捨て、2:切り上げ※省略時は1:切り捨てを設定 | |
DiscountRoundingDivision | Integer | True | ||
TransactionUuid | String | False |
レシート番号 : レシートに印字する番号(ver.2.1.2で追加)※未設定の場合(1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁) | |
GiftReceiptValidDays | Integer | False |
ギフトレシート有効日数 : ギフトレシートの有効日数(ver.3.0.0で追加)有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 | |
ReceiptIssueNumberOfTimes | Integer | True |
領収書発行回数 : 領収書発行回数(ver.2.7.0で追加) | |
PickUpDate | Date | False |
受取予定日 : 受取予定日。(YYYY-MM-DD形式)(ver.2.4.0で追加)取置き、および、取置きを引取りした取引の場合設定されます。※取置区分が10:取置きの場合、設定可能。(任意) | |
PartPayment | Decimal | False |
前受金 : 前受金。(ver.2.4.0で追加)取置き、および、取置きを引取りした取引の場合設定されます。※取置区分が10:取置きの場合、設定可能。(任意)※前受金 = 受領金額 - お釣り にならないとエラーになります。 | |
PartPaymentClass | Integer | True |
前受金区分 : 前受金区分。(ver.3.0.0で追加)1:現金、 2:クレジットカード取置き、および、取置きを引取りした取引の場合設定されます。支払方法におうじて、前受金区分は設定されます。(支払方法がない場合、1:現金が設定されます。) | |
LayawayServerTransactionHeadId | Long | False |
取置取引ID : 取置きを引取りした取引の取置取引IDを設定します。(ver.2.4.0で追加)※設定されていれば、取置きを引取りした取引となります。※取置き中の取引を取置き済にしたい場合、取置き中の取引IDを指定してください。取置き中以外(引取済み、取消済み)はエラーになります。 | |
DisabledEdit | Integer | False |
取置き販売変更不可区分 : 取置き販売変更不可区分(ver.2.9.0で追加)0:変更可、 1:変更不可※取置きの取引(取引区分:10)のみ設定されます。※省略時は0:変更可を設定※ 1:変更不可を設定した場合、取置き販売時に商品の追加削除や会員の変更ができなくなります。 | |
UpdDateTime | Datetime | True |
更新日時 : 取引履歴の更新日時。作成時/修正時に日付が設定されます。 | |
PickupTransactionHeadId | Long | True | ||
DetailAggregate | String | False |
A JSON aggregate of details associated with the transaction head. | |
CouponDiscount | Decimal | False |
取引で使用された各クーポンの割引総額 |