取引打消取消

POST

/transactions/{transaction_id}/dispose

• サンドボックス
• 本番

取引を打消取消します。

指定された取引に対して、返品する取引情報を作成します。

※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。

対象プラン

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

Authorizations

• AppAccessToken
  pos.transactions:write
• UserAccessToken
  pos.transactions:write

Parameters

Path Parameters

transaction_id

required

string

取引ID

Request Body

object

terminalTranDateTime

端末取引日時

端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
未設定の場合、自動で設定されます。

string format: date-time

depositOthers

その他支払方法

個別アプリ専用支払方法IDを指定した取引を打消取消する際に、取消伝票番号を設定するのに利用します。
※キャンセル伝票は消込レコードに記録されます
※現状は最大１つしか指定できません

Array<object>

object

no

項番

個別アプリ専用支払方法IDを設定した項番を指定してください

string

Allowed values: 1 2 3

cancelSlipNumber

取消伝票番号

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

string

<= 50 characters

Example

{
  "terminalTranDateTime": "2000-01-23T01:23:45+09:00",
  "depositOthers": [
    {
      "no": "1",
      "cancelSlipNumber": "string"
    }
  ]
}

Responses

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

現在マイル。取引前のマイル
※ マイルの直接入力は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の場合、そのまま会員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:ＩＣクレジットカード、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:打消レコードのみ設定可能（省略時は０:通常を設定）
※打消レコードの場合、取引明細区分は、（通常、部門売り）→返品に変換させて設定してください。

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

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:対象）。

string

taxFreeDivision

免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品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

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

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

支払金種コード
※現状、個別アプリ専用支払方法ID利用時のみ対応

支払金種コード対応表

支払金種コード対応表

支払金種コード	支払金種名
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

denominationName

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

string

cardCompanyName

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

string

slipNumber

伝票番号

string

cancelSlipNumber

取消伝票番号

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：商品付与、P1：0ポイント、P2：ポイント指定（上書き）、P3：ポイント追加（加算）、P4：ポイントN倍、M1：0マイル、M2：マイル指定（上書き）、M3：マイル追加（加算）、M4：マイルN倍）

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

recordedStaff

取引スタッフ

Array<object>

object

staffDivision

スタッフ区分：取引生成および更新時のスタッフの担当業務。
1: 販売員IDと同じスタッフ。
2: 取消。取引取消および打消取消（消込レコード作成）を実施したスタッフ。

string

staffId

スタッフID

string

staffCode

スタッフコード

string

staffName

スタッフ名

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",
  "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"
    }
  ],
  "depositOthers": [
    {
      "transactionHeadId": "string",
      "no": "string",
      "paymentMethodId": "string",
      "paymentMethodCode": "string",
      "paymentMethodName": "string",
      "depositOthers": "string",
      "paymentUnitPrice": "string",
      "paymentChangeFlag": "string",
      "paymentDivision": "string",
      "paymentSecuritiesFlag": "string",
      "denomination": "string",
      "denominationCode": "string",
      "denominationName": "string",
      "cardCompanyName": "string",
      "slipNumber": "string",
      "cancelSlipNumber": "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"
    }
  ],
  "recordedStaff": [
    {
      "staffDivision": "string",
      "staffId": "string",
      "staffCode": "string",
      "staffName": "string"
    }
  ]
}

400

• ユニークキー（店舗ID、端末ID、端末取引日時、端末取引ID）と同じ取引データが存在しない場合
• ユニークキー（店舗ID、端末ID、端末取引日時、端末取引ID）と同じ取引データが取消済の場合
• ユニークキー（店舗ID、端末ID、端末取引日時、端末取引ID）と同じ取引データが打消取消済の場合
• 取消対象の取引データの取引区分が、1,2,3,4,5,6,7,13,14 以外の場合
• 取消対象の取引データが、国税庁に免税データを送信している場合
• 取消対象の取引データが、回数券を購入している取引の場合
• 指定した項番のその他支払方法が存在しない場合
• その他支払方法の項番が重複している場合
• 項番で指定したその他支払方法に含まれる支払方法IDが個別アプリ専用支払方法IDではない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一キーの取引データが存在する為、打消取引データを作成できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一キーの取引データが取消済みの為、打消取消できません。'",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一キーの取引データが打消取消済みの為、打消取消できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "対象の取引データの取引区分が、1,2,3,4,5,6,7,13,14 以外は打消取消できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "対象の取引データは、国税庁に免税データを送信している為、打消取消できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "対象の取引データは、回数券を購入した取引データの為、打消取消できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された項番のその他支払は存在しません(項番-{項番}。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "その他支払方法の項番が重複しています。(項番-{項番})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "項番で指定したその他支払の支払方法IDが個別アプリ専用支払方法IDではないため、取消伝票番号を登録できません。",
  "status": 400
}

404

• URI指定された取引IDが存在しなかった場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}