ReCORE.co-api

レジ管理

レジ取引検索

概要

• レジの入出金取引履歴を検索する

基本情報

• リクエストパス: GET /cashier/transactions
• JWTスコープ: cashier:transaction:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	取引ID	整数のみ、カンマ区切りで複数指定可能
cashier_id	レジID	整数のみ
closing_on	営業日	YYYY-MM-DD形式
store_id	店舗ID	整数のみ
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大:250

例

• Request

GET /cashier/transactions?cashier_id=1&closing_on=2024-01-01

• Response

[
  {
    "id": 1001,
    "store": {
      "id": 100,
      "name": "渋谷店"
    },
    "staff": null,
    "cashier": {
      "id": 1,
      "name": "レジ1"
    },
    "txn_type": {
      "id": 1,
      "name": "備品"
    },
    "note": "釣銭補充",
    "amount": 50000,
    "created_at": 1704153600
  }
]

key	type	説明
*	-	取引
*.id	int	取引ID
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.staff	object | null	スタッフ
*.staff.id	int	スタッフID
*.staff.name	string	スタッフ名
*.cashier	object	レジ
*.cashier.id	int	レジID
*.cashier.name	string	レジ名
*.txn_type	object	取引種別
*.txn_type.id	int	取引種別ID
*.txn_type.name	string	取引種別名
*.note	string | null	備考
*.amount	int	金額 (*1)
*.created_at	int | null	作成日時

• *1) 入金はプラス、出金はマイナスの値

レジ取引登録

概要

• レジの入出金取引を登録する

基本情報

• リクエストパス: POST /cashier/transactions
• JWTスコープ: cashier:transaction:store
• 必須個別JWTパラメータ: store_id (またはX-Store-Idヘッダ)
• レートリミット: 2 rps

body

key	type	説明	制約など
staff_id	?int | null	スタッフID	-
status	string	入出金モード	DEPOSIT WITHDRAWAL
cashier_id	int	レジID	-
amount	int	金額	0以上 999,999,999以下
cashier_txn_type_id	int	取引種別ID	-
note	?string | null	備考	-

• 入出金モード
  • DEPOSIT 入金
  • WITHDRAWAL 出金

例

• Request

POST /cashier/transactions

{
  "status": "DEPOSIT",
  "cashier_id": 1,
  "amount": 50000,
  "cashier_txn_type_id": 1,
  "note": "釣銭補充"
}

• Response

(なし)

レジ締め検索

概要

• レジ締め処理の履歴を検索する

基本情報

• リクエストパス: GET /cashier/closings
• JWTスコープ: cashier:closing:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	締めID	整数のみ、カンマ区切りで複数指定可能
status	ステータス	OPEN INTERIM CLOSE
cashier_id	レジID	整数のみ
closing_on	営業日	YYYY-MM-DD形式
store_id	店舗ID	整数のみ
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大:250

例

• Request

GET /cashier/closings?cashier_id=1&status=OPEN

• Response

[
  {
    "id": 2001,
    "store": {
      "id": 100,
      "name": "渋谷店"
    },
    "cashier": {
      "id": 1,
      "name": "レジ1"
    },
    "staff": null,
    "status": "OPEN",
    "note": null,
    "opened_at": 1704153600,
    "created_at": 1704153600
  }
]

key	type	説明
*	-	締め処理
*.id	int	締めID
*.status	string	ステータス
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.cashier	object	レジ
*.cashier.id	int	レジID
*.cashier.name	string	レジ名
*.staff	object | null	スタッフ
*.staff.id	int	スタッフID
*.staff.name	string	スタッフ名
*.note	string | null	備考
*.opened_at	int	レジ開け日時
*.created_at	int | null	作成日時

• ステータス
  • OPEN レジ開け
  • INTERIM 中締め
  • CLOSE 本締め

レジ締め取得

概要

• レジ締め処理の詳細情報を取得する

基本情報

• リクエストパス: GET /cashier/closings/{closing_id}
• JWTスコープ: cashier:closing:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /cashier/closings/2001

• Response

レジ締め検索のresponse[0]と一部同様、差分を下記に示す

key	type	説明
cash_quantity_10000	int	10,000円札の枚数
cash_quantity_5000	int	5,000円札の枚数
cash_quantity_2000	int	2,000円札の枚数
cash_quantity_1000	int	1,000円札の枚数
cash_quantity_500	int	500円硬貨の枚数
cash_quantity_100	int	100円硬貨の枚数
cash_quantity_50	int	50円硬貨の枚数
cash_quantity_10	int	10円硬貨の枚数
cash_quantity_5	int	5円硬貨の枚数
cash_quantity_1	int	1円硬貨の枚数
prepared_change	int	釣り銭準備高
payments	array<object>	精算項目
payments.*.type	string	精算タイプ
payments.*.payment	object	精算金種
payments.*.payment.id	int	精算金種ID
payments.*.payment.name	string	精算金種名
payments.*.payment.type	string	精算金種タイプ
payments.*.count	int	精算件数
payments.*.amount	int	精算金額
txns	array<object>	入出金
txns.*.type	string	入出金モード
txns.*.txn_type	object	入出金種別
txns.*.txn_type.id	int	入出金種別ID
txns.*.txn_type.name	string	入出金種別名
txns.*.count	int	入出金件数
txns.*.amount	int	入出金金額
txn_deposit_total	int	入金合計
txn_withdrawal_total	int	出金合計
cash_calc_amount	int	現金理論残高
cash_real_amount	int	現金実残高
cash_diff_amount	int	現金過不足

• 精算タイプ
  • SELLING 販売
  • BUYING 買取

レジ締め登録

概要

• レジ開け、中締め、本締めを実行する

基本情報

• リクエストパス: POST /cashier/closings
• JWTスコープ: cashier:closing:store
• 必須個別JWTパラメータ: store_id (またはX-Store-Idヘッダ)
• レートリミット: 2 rps

body

key	type	説明	制約など
staff_id	?int | null	スタッフID	-
cashier_id	int	レジID	-
status	string	ステータス	OPEN INTERIM CLOSE
note	?string | null	備考	-
cash_quantity_10000	int	10,000円札の枚数	0以上 9,999以下
cash_quantity_5000	int	5,000円札の枚数	0以上 9,999以下
cash_quantity_2000	int	2,000円札の枚数	0以上 9,999以下
cash_quantity_1000	int	1,000円札の枚数	0以上 9,999以下
cash_quantity_500	int	500円硬貨の枚数	0以上 9,999以下
cash_quantity_100	int	100円硬貨の枚数	0以上 9,999以下
cash_quantity_50	int	50円硬貨の枚数	0以上 9,999以下
cash_quantity_10	int	10円硬貨の枚数	0以上 9,999以下
cash_quantity_5	int	5円硬貨の枚数	0以上 9,999以下
cash_quantity_1	int	1円硬貨の枚数	0以上 9,999以下

例

• Request

POST /cashier/closings

{
  "cashier_id": 1,
  "status": "OPEN",
  "note": "営業開始",
  "cash_quantity_10000": 5,
  "cash_quantity_5000": 10,
  "cash_quantity_2000": 0,
  "cash_quantity_1000": 20,
  "cash_quantity_500": 20,
  "cash_quantity_100": 50,
  "cash_quantity_50": 20,
  "cash_quantity_10": 100,
  "cash_quantity_5": 50,
  "cash_quantity_1": 100
}

• Response

なし

レジ締め初期データ取得

概要

• レジ締め処理実行前の初期データを取得する

基本情報

• リクエストパス: GET /cashier/closings/initial
• JWTスコープ: cashier:closing:initial:index
• 必須個別JWTパラメータ: store_id (またはX-Store-Idヘッダ)
• レートリミット: 5 rps

query

key	説明	制約など
status	ステータス	必須、OPEN INTERIM CLOSE
cashier_id	レジID	必須、整数のみ

例

• Request

GET /cashier/closings/initial?status=CLOSE&cashier_id=1

• Response

レジ締め取得と一部同様、差分を下記に示す

key	type	説明
cash_quantity_*	-	(削除)
cash_real_amount	-	(削除)
cash_diff_amount	-	(削除)