DisposeTransaction
取引を打消取消します。指定された取引に対して、返品する取引情報を作成します。※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。
Input
| Name | Type | Required | Description |
| TransactionHeadId | Integer | True | 取引ID |
| TerminalTranDateTime | Datetime | False | 端末で設定された取引日時。未設定の場合、自動で設定されます。 |
| DipositOthers | String | False | 個別アプリ専用支払方法IDを指定した取引を打消取消する際に、取消伝票番号を設定するのに利用します。キャンセル伝票は消込レコードに記録されます※現状は最大１つしか指定できません |
Result Set Columns
| Name | Type | Description |
| TransactionHeadId | Integer | 取引ID |
| TransactionDateTime | Datetime | 取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD] |
| TransactionHeadDivision | String | 取引を識別する区分。（1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証）※ 10:取置きについては、取置き登録APIをご使用ください。 ※ 8:ポイント失効、9:回数券、11:チップ、15:バリューカード入金、16:領収証は対応しておりません。 |
| CancelDivision | String | 取引の取消を識別する区分。 (0:通常、1取消） |
| UnitNonDiscountsubtotal | Integer | 取引明細の、値引き前計の合計。明細より自動算出。※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計 |
| UnitDiscountsubtotal | Integer | 単品値引き小計：取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。（例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。）※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。4:バンドル (親)、5:セット売り(親)、6:簡易セット(親)、8:バンドル値引(子) |
| UnitStaffDiscountsubtotal | Integer | 単品社員販売値引き計 |
| UnitBargainDiscountsubtotal | Integer | 単品セール販売値引き計 |
| Subtotal | Integer | 取引明細の値引き後小計の合計。 |
| SubtotalForDiscount | Integer | 取引明細の割引値引対象区分が対象の小計金額 |
| SubtotalDiscountPrice | Integer | 小計の値引き金額を設定。 |
| SubtotalDiscountRate | Integer | 小計の割引を設定 （単位％） デフォルトは未設定。設定された場合、小計値引は必須。※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。 |
| SubtotalDiscountDivision | Integer | 小計値引き/割引時に指定された区分を設定。管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。 |
| PointDiscount | Integer | |
| CouponDiscount | Integer | クーポン値引き：その取引で使用された各クーポンの値引き・割引額の合計値。 |
| Total | Integer | 小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定 |
| TaxInclude | Integer | 内税商品計 / 110 * 10。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り |
| TaxExclude | Integer | 外税商品計 * 10 / 100。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り |
| RoundingDivision | String | 販売時の合計金額の端数を丸めるか否かを設定する。00:なし、11:一の位を四捨五入、12:一の位を切捨、13:一の位を切上、21:十の位を四捨五入、22:十の位を切捨、23:十の位を切上31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上41:千の位を四捨五入、42:千の位を切捨、43:千の位を切上、99:手入力 |
| RoundingPrice | Integer | 端数値引額 |
| CashTotal | Integer | 合計金額の内訳 （現金払い） |
| CreditTotal | Integer | 合計金額の内訳 （クレジット払い） |
| Deposit | Integer | 会計時に預かった金額。 |
| DepositCash | Integer | 会計時に預かった現金金額。 |
| DepositCredit | Integer | 会計時に預かったクレジット金額。 |
| Change | Integer | 釣銭。 |
| TipCash | Integer | 現金チップ |
| TipCredit | Integer | クレジットチップ |
| Amount | Integer | 取引明細の返品以外の数量の合計 （取引明細区分が2返品以外の数量） |
| ReturnAmount | Integer | 取引明細の返品の数量の合計 （取引明細区分が2返品の数量） |
| CostTotal | Decimal | 明細の原価計の合計 |
| SalesHeadDivision | String | 売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む) |
| InTaxSalesTotal | Integer | 売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。 |
| OutTaxSalesTotal | Integer | 売上対象商品の外税販売の税抜き商品合計金額 |
| NonTaxSalesTotal | Integer | 売上対象商品の非課税商品の合計金額。 |
| NonSalesTargetTotal | Integer | 売上対象外商品の合計。 外税販売の場合、税を含まない。 |
| NonSalesTargetInTaxTotal | Integer | 売上対象外商品の外税合計。 |
| NonSalesTargetOutTaxTotal | Integer | 売上対象外商品の内税合計。 |
| NonSalesTargetTaxFreeTotal | Integer | 売上対象外商品の免税額合計。 |
| NonSalesTargetCostTotal | Decimal | 売上対象外商品の原価合計。 |
| NonSalesTargetAmount | Integer | 取引明細の返品以外かつ売上対象外の数量の合計。 （取引明細区分が2返品以外の数量） |
| NonSalesTargetReturnAmount | Integer | 取引明細の返品かつ売上対象外の数量の合計。 （取引明細区分が2返品の数量） |
| NewPoint | Integer | 取引で付与されるポイント。 合計 * ポイント付与率 |
| SpendPoint | Integer | 取引で使用したポイント。 |
| Point | Integer | 取引前のポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 |
| TotalPoint | Integer | 取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 |
| CurrentMile | Integer | 現在マイル。取引前のマイル ※マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 |
| EarnMile | Integer | 獲得マイル。取引で付与されるマイル。合計 * ポイント付与率 ※ 会員販売でない場合、nullが返されます。 |
| TotalMile | Integer | 合計マイル。取引後のマイル。現在マイル + 獲得マイル + 調整マイル ※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMile | Integer | 調整マイル。取引で手動で付与されるマイル※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMileDivision | String | 調整マイル区分。1:0マイル （マイルを付与しない。「調整マイル = -1 * 獲得マイル」）2:マイル指定（指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」）3:マイル加算（マイルを加算/減算する。「調整マイル =入力値」）4:マイルｎ倍（指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMileValue | Integer | 調整マイル区分値 ※ 会員販売でない場合、nullが返されます。 |
| StoreId | Integer | 店舗毎に付与するID。※店舗情報が存在しない場合エラー ※休止中の店舗IDを指定するとエラー |
| TerminalId | Integer | 店舗の端末毎に付与するID。※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり) |
| CustomerId | Long | 会員毎に付与するID。※設定されている場合、会員販売とみなし会員ポイント情報を更新します。※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。 |
| TerminalTranId | Integer | 端末で設定された取引ID。 |
| TerminalTranDateTime | Datetime | 端末で設定された取引日時 |
| SumDivision | String | 締め処理を実施したかの区分。 （0:未処理、1:精算処理済み、2:締め処理済み） |
| AdjustmentDateTime | Datetime | 精算をした日時が入る |
| SumDate | Date | 締めをした年月日が入る |
| CustomerRank | String | 会員ランク。管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。 |
| CustomerGroupId | Integer | 客層ID。客層セクションIDが1の客層IDを設定。 |
| CustomerGroupId2 | Integer | 客層ID2。客層セクションIDが2の客層IDを設定。 |
| CustomerGroupId3 | Integer | 客層ID3。客層セクションIDが3の客層IDを設定。 |
| CustomerGroupId4 | Integer | 客層ID4。客層セクションIDが4の客層IDを設定。 |
| CustomerGroupId5 | Integer | 客層ID5。客層セクションIDが5の客層IDを設定。 |
| StaffId | Integer | 販売員ID（スタッフID） |
| StaffName | String | スタッフIDがある場合、スタッフマスタのスタッフ名（販売員名）を設定 |
| CreditDivision | String | クレジット区分：クレジット会社を識別する区分 |
| PaymentCount | String | クレジットの支払回数。※ゼウス、ペイメントマイスターご利用時（1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い） |
| SlipNumber | String | クレジットの伝票番号。 |
| CancelSlipNumber | String | クレジットの取消伝票番号。 |
| AuthNumber | String | クレジットの承認番号。 |
| AuthDate | Date | クレジットのセンター処理日。 |
| CardCompany | String | クレジットカード会社 例） VISA、JCB、MASTER、AMEX、DINERSなど |
| Denomination | String | 11:磁気クレジットカード、12:ＩＣクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー ※ペイメント・マイスターで使用 |
| Memo | String | 入出金時のメモなどを設定。 1000文字以内。 |
| ReceiptMemo | String | レシートに印字するメモを設定。100文字以内。 |
| Carriage | Integer | EC連携用送料。 |
| Commission | Integer | EC連携用手数料 |
| GuestNumbers | Integer | 客数 |
| GuestNumbersMale | Integer | 客数（男） |
| GuestNumbersFemale | Integer | 客数（女） |
| GuestNumbersUnknown | Integer | 客数（不明） |
| EnterDateTime | Datetime | 入店日時 |
| TaxFreeSalesDivision | String | 免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算)) ※未設定の場合、0:通常販売 |
| NetTaxFreeGeneralTaxInclude | Integerg | 内税商品の一般品免税額。 |
| NetTaxFreeGeneralTaxExclude | Integerg | 外税商品の一般品免税額。 |
| NetTaxFreeConsumableTaxInclude | Integerg | 内税商品の消耗品免税額。 |
| NetTaxFreeConsumableTaxExclude | Integerg | 外税商品の消耗品免税額。 |
| Tags | String | レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。※複数ある場合は、カンマ区切りで設定 |
| PointGivingDivision | String | 1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない ※省略時、店舗マスタから設定。 |
| PointGivingUnitPrice | Integer | ポイント付与の設定 n円をnポイントの「n円」の部分。 （設定範囲1円～99999円)（例10円ごとに2ポイントの場合、10円）※未設定の場合は店舗マスタから設定。 |
| PointGivingUnit | Decimal | ポイント付与の設定 n円をnポイントの「nポイント」の部分 （設定範囲0.00ポイント～99999.99ポイント)（例10円ごとに0.2ポイントの場合、0.2ポイント）※未設定の場合は店舗マスタから設定。 |
| PointSpendDivision | String | ポイント利用時の税を含む／含まないを判定。1:ポイント利用を現金として扱う (税を含む値引き)、2:ポイント利用を値引として扱う (税を含まない値引き) ※未設定の場合は店舗マスタから設定。 初期値:1。 |
| MileageDivision | String | マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)※未設定の場合は店舗マスタから設定。 初期値:0。 |
| MileageLabel | String | マイレージの名称。未設定の場合は「マイル」 |
| CustomerPinCode | String | 自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。 |
| ReturnSales | String | 0:通常、1:返品販売 |
| DisposeDivision | String | 0:通常、1:打消元レコード、2:打消レコード※0:通常と2:打消レコードのみ設定可能（省略時は０:通常を設定）※打消レコードの場合、取引明細区分は、（通常、部門売り）→返品に変換させて設定してください。 |
| DisposeServerTransactionHeadId | Integer | 打消元取引ID ※打消し区分が2の場合必須 ※打消元取引IDが存在しない場合エラー。省略時はnullを設定 |
| CancelDateTime | Datetime | 取消／打消しの場合自動設定。[YYYY-MM-DDThh:mm:ssTZD] |
| SellDivision | String | 取引が外税販売、内税販売かを識別する区分。 （0:内税販売、1:外税販売）※省略時は0:内税販売を設定 |
| TaxRate | Decimal | 税率 （単位％）※省略時は、スマレジに設定されている消費税を設定（端末取引日時より算出） |
| TaxRounding | String | 税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ※省略時はスマレジに設定されている税の丸め方式を設定 |
| DiscountRoundingDivision | String | 割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ※省略時はスマレジに設定されている税の丸め方式を設定 |
| TransactionUuid | String | レシートに印字する番号。※省略時は、1970年から計算した現在秒の末尾9桁＋端末IDゼロ詰め4桁 |
| ExchangeTicketNo | String | 引換券番号 |
| GiftReceiptValidDays | Integer | 有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 |
| UpdDateTime | Datetime | 登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD] |
| Details | String | 取引明細 |
| DepositOthers | String | その他支払取引 |
| Coupons | String | 取引クーポン明細 |
| CouponItems | String | 取引クーポン商品付与明細 |
| RecordedStaff | String | 取引スタッフ |