Close Register Session
POST/api/pos/register-sessions/:registerSession/close
Closes a register session and performs cash reconciliation.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Expected cash = opening float + cash takings for the shift. Variance = counted cash − expected cash (positive = over, negative = short). The response returns the computed expected_cash, counted_cash and cash_variance for the X/Z report.
Body fields:
counted_cash(numeric, required, min 0) — cash counted in the drawer at close.notes(string, optional, max 1000).
Returns 422 if the session is already closed.
Authentication: Requires Bearer token (PAT).
Requires permission: pos.operate (when granular permissions are enabled).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.