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

精算一覧取得

GET
/adjustments

指定された店舗の精算情報を取得します。

※ 精算日、精算日時、精算日時(from)・精算日時(to)のいずれかの指定が必須です

対象プラン

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
fields
array

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

store_id
required
integer

店舗ID

terminal_id
integer

端末ID

adjustment_date
string

精算日：精算を実施した日。 [YYYY-MM-DD]
※ 精算日時 もしくは 精算日時(From)・精算日時(To) と同時に指定できません

adjustment_date_time
string

精算日時：精算を実施した日時。 [YYYY-MM-DDThh:mm:ssTZD]
※ 精算日 もしくは 精算日時(From)・精算日時(To) と同時に指定できません

adjustment_date_time-from
string

精算日時(From)：[YYYY-MM-DDThh:mm:ssTZD]
※ 精算日時(To)と合わせて指定してください
※ From〜Toの期間は最大31日間です(1ヶ月ではありません)
※ 精算日 もしくは 精算日時 と同時に指定できません

adjustment_date_time-to
string

精算日時(To)：[YYYY-MM-DDThh:mm:ssTZD]
※ 精算日時(From)と合わせて指定してください
※ From〜Toの期間は最大31日間です(1ヶ月ではありません)
※ 精算日 もしくは 精算日時 と同時に指定できません

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

Array<object>
object
storeId

店舗ID：数字9桁以内。

string
terminalId

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

string
adjustmentDateTime

精算日時：[YYYY-MM-DDThh:mm:ssTZD]

string
childTerminals

子端末リスト：精算実施時の子端末の一覧。
※ 子端末リストが設定されている場合
親端末の店舗ID・精算日時と子端末の端末IDの組み合わせを持つデータが子端末情報になります。
(親端末のスマレジ・アプリにて、精算一覧 > 子端末を含む で確認できる合算値を確認したい場合は子端末情報を合算する必要があります)

Array<object>
object
terminalId

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

string
transactionCount

通常取引数：通常取引の合計。

string
preparationCash

釣銭準備金：釣銭準備金。

string
cashSales

現金売上：現金売上額。

string
creditSales

クレジット売上：クレジット売上。

string
otherSalesList

その他支払いリスト

Array<object>
object
id

その他支払方法ID：その他支払方法ID。

string
name

その他支払方法名：その他支払方法名。

string
paymentMethodDivision

その他支払方法分類区分：汎用マスタのコードを設定する。(汎用区分：8 [支払方法分類]) ※未設定の場合、空文字

string
paymentMethodDivisionName

その他支払方法分類名：汎用マスタの名称を設定する。(汎用区分：8 [支払方法分類])

string
sales

金額

string
partPayment

前受金：取置き時の前受金受領額。

string
partPaymentCash

前受金(現金)：取置き時の前受金受領額。(現金)

string
partPaymentCredit

前受金(クレジット)：取置き時の前受金受領額。(クレジット)

string
receivedDeposit

前受金(受領済金額)：取置き時の前受金を売上として計上した金額。

string
receivedDepositCash

前受金(受領済金額)(現金)：取置き時の前受金を売上として計上した金額。(現金)

string
receivedDepositCredit

前受金(受領済金額)(クレジット)：取置き時の前受金を売上として計上した金額。(クレジット)

string
partPaymentCancel

前受金(取消)：取置き時の前受金をキャンセルした金額。

string
partPaymentCashCancel

前受金(取消)(現金)：取置き時の前受金をキャンセルした金額。(現金)

string
partPaymentCreditCancel

前受金(取消)(クレジット)：取置き時の前受金をキャンセルした金額。(クレジット)

string
tip

チップ：チップの合計額。

string
tipCash

チップ現金：チップの現金合計額。

string
tipCredit

チップクレジット：チップのクレジット合計額。

string
deposit

預かり金：取引区分が(4：預かり金) の合計額。

string
returnDeposit

預かり金返金：取引区分が(5：預かり金返金) の取引合計額。

string
receipt

入金：取引区分が(2：入金) の取引合計額。

string
payment

出金：取引区分が(3：出金) の取引合計額。

string
nonSalesCashTotal

売上対象外現金：売上対象外の現金受領額。

string
nonSalesCreditTotal

売上対象外クレジット：売上対象外のクレジット受領額。

string
nonSalesOtherTotal

売上対象外その他：売上対象外のその他支払方法受領額。

string
calculateBalance

計算現金残高： 釣銭準備金 + 現金売上 + 前受金 - 前受金(取消) + 預かり金 - 預かり金返金 + 入金 - 出金

string
cashAdjustment

現金精算情報

object
realBalance

実現金残高：1万円札から1円玉の枚数の合計金額。

string
difference

現金過不足：現金過不足。

string
saving

銀行預入金：銀行預入金。

string
carryOver

繰越準備金：繰越準備金。

string
tenThousandYen

1万円札：1万円札の枚数。

string
fiveThousandYen

5千円札：5千円札の枚数。

string
twoThousandYen

2千円札：2千円札の枚数。

string
oneThousandYen

千円札：千円札の枚数。

string
fiveHundredYen

500円玉：500円玉の枚数。

string
oneHundredYen

100円玉：100円玉の枚数。

string
fiftyYen

50円玉：50円玉の枚数。

string
tenYen

10円玉：10円玉の枚数。

string
fiveYen

5円玉：5円玉の枚数。

string
oneYen

1円玉：1円玉の枚数。

string
Example
[
  {
    "storeId": "string",
    "terminalId": "string",
    "adjustmentDateTime": "string",
    "childTerminals": [
      {
        "terminalId": "string"
      }
    ],
    "transactionCount": "string",
    "preparationCash": "string",
    "cashSales": "string",
    "creditSales": "string",
    "otherSalesList": [
      {
        "id": "string",
        "name": "string",
        "paymentMethodDivision": "string",
        "paymentMethodDivisionName": "string",
        "sales": "string"
      }
    ],
    "partPayment": "string",
    "partPaymentCash": "string",
    "partPaymentCredit": "string",
    "receivedDeposit": "string",
    "receivedDepositCash": "string",
    "receivedDepositCredit": "string",
    "partPaymentCancel": "string",
    "partPaymentCashCancel": "string",
    "partPaymentCreditCancel": "string",
    "tip": "string",
    "tipCash": "string",
    "tipCredit": "string",
    "deposit": "string",
    "returnDeposit": "string",
    "receipt": "string",
    "payment": "string",
    "nonSalesCashTotal": "string",
    "nonSalesCreditTotal": "string",
    "nonSalesOtherTotal": "string",
    "calculateBalance": "string",
    "cashAdjustment": {
      "realBalance": "string",
      "difference": "string",
      "saving": "string",
      "carryOver": "string",
      "tenThousandYen": "string",
      "fiveThousandYen": "string",
      "twoThousandYen": "string",
      "oneThousandYen": "string",
      "fiveHundredYen": "string",
      "oneHundredYen": "string",
      "fiftyYen": "string",
      "tenYen": "string",
      "fiveYen": "string",
      "oneYen": "string"
    }
  }
]

400

Section titled “400 ”
  • 必須検索条件の設定が必要で、必須検索条件が1つも設定されていない場合
  • 必須検索条件の設定が必要で、範囲指定の必須検索条件のうちFrom/To片方しか設定されていない場合
  • 必須検索条件の設定が必要で、範囲指定の必須検索条件におけるFrom-Toの範囲が上限を超えている場合
  • 精算日時と精算日を同時に指定した場合
  • 精算日と精算日時(from)及び精算日時(to)を同時に指定した場合
  • 精算日時と精算日時(from)及び精算日時(to)を同時に指定した場合
  • 指定された店舗IDが存在しない場合
    object
    type
    required
    string
    title
    required
    string
    detail
    string
    status
    integer
    Examples
    {
      "type": "about:blank",
      "title": "Bad Request",
      "detail": "[QUERY PARAMETERS] {QUERY PARAMETERS}のうちいずれかが必須です。",
      "status": 400
    }