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

精算実行

POST
/adjustments

精算を実行します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
storeId
required
店舗ID

店舗ID

string format: int
terminalId
端末ID

端末IDと端末UUIDのどちらかが必須。

string format: int
uuid
端末UUID

端末IDと端末UUIDのどちらかが必須。

string
cashAdjustment
現金精算情報

現金精算を行う際のレジ内の現金状況を保持する。
店舗IDで指定された店舗の「端末精算時の現金入力」が「入力する」になっている時のみ設定可能。

object
preparationCash
釣銭準備金

釣銭支払いのために、レジに用意されている現金。通常、前日の繰越準備金と一致します。店舗IDで指定された店舗の「端末精算時の現金入力」が「入力する」、「銀行預入金自動入力」が「自動入力しない」になっている時は必須。

string format: int
<= 99999999
saving
銀行預入金

レジから銀行に移した現金。店舗IDで指定された店舗の「端末精算時の現金入力」が「入力する」、「銀行預入金自動入力」が「自動入力しない」になっている時は必須。

string format: int
<= 99999999
tenThousandYen
required

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

string format: int
<= 99999
fiveThousandYen
required

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

string format: int
<= 99999
twoThousandYen
required

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

string format: int
<= 99999
oneThousandYen
required

千円札：千円札の枚数。

string format: int
<= 99999
fiveHundredYen
required

500円玉：500円玉の枚数。

string format: int
<= 99999
oneHundredYen
required

100円玉：100円玉の枚数。

string format: int
<= 99999
fiftyYen
required

50円玉：50円玉の枚数。

string format: int
<= 99999
tenYen
required

10円玉：10円玉の枚数。

string format: int
<= 99999
fiveYen
required

5円玉：5円玉の枚数。

string format: int
<= 99999
oneYen
required

1円玉：1円玉の枚数。

string format: int
<= 99999
Example
{
  "storeId": "1",
  "terminalId": "1",
  "uuid": "string",
  "cashAdjustment": {
    "preparationCash": "12345678",
    "saving": "12345678",
    "tenThousandYen": "12345",
    "fiveThousandYen": "12345",
    "twoThousandYen": "12345",
    "oneThousandYen": "12345",
    "fiveHundredYen": "12345",
    "oneHundredYen": "12345",
    "fiftyYen": "12345",
    "tenYen": "12345",
    "fiveYen": "12345",
    "oneYen": "12345"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
adjustmentDateTime

精算日時

string
storeId

店舗ID

string
terminalId

端末ID

string
Example
{
  "adjustmentDateTime": "string",
  "storeId": "string",
  "terminalId": "string"
}

400

Section titled “400 ”
  • 店舗IDで指定された店舗が存在しない場合
  • 倉庫を指定した場合
  • 受注店舗を指定した場合
  • 端末IDと端末UUIDが両方ともリクエストに存在しない場合
  • 端末IDまたは端末UUIDで指定された端末が存在しない場合
  • 端末IDと端末UUIDが端末データと一致しない場合
  • 子端末を指定した場合
  • 指定された店舗と端末が一致しない場合
  • 現金精算が有効な店舗を指定し、かつ現金精算情報がリクエストに存在しない場合
  • 現金精算が無効な店舗を指定し、かつ現金精算情報がリクエストに存在する場合
  • 稼働中のテーブルや未チェックアウトの仮販売データがある場合
  • 対象店舗の銀行預入金自動入力区分が「自動入力する」に設定されていて、釣銭準備金がリクエストに存在した場合
  • 対象店舗の銀行預入金自動入力区分が「自動入力しない」に設定されていて、釣銭準備金がリクエストに存在しない場合
  • 対象店舗の銀行預入金自動入力区分が「自動入力する」に設定されていて、銀行預入金がリクエストに存在した場合
  • 対象店舗の銀行預入金自動入力区分が「自動入力しない」に設定されていて、銀行預入金がリクエストに存在しない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない店舗IDが指定されています。",
  "status": 400
}