Cash Management | PurrOS Docs

Tenders, settlements, bank transactions, drawer counts, deposits and business-day close.

For how this area works day to day, see the Cash management guide.

Webhook events: cash.count_completed, cash.over_short_exceeded, cash.deposit_recorded, cash.deposit_mismatch, cash.settlement_mismatch, cash.business_day_closed. See Webhooks.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

POST/cash/bank-transactions
Send bank transactions for deposit verification
Keycash:write
Peoplenot allowed
Featurecash
GET/cash/business-days
Daily cash summary for a location
Keycash:read
Peoplecash.read
Featurecash
POST/cash/business-days/{locationId}/{date}:close
Close a business day
Keycash:write
Peoplecash.manage
Featurecash
GET/cash/counts
List counts
Keycash:read
Peoplecash.read
Featurecash
POST/cash/counts
Record a drawer, skim or safe count
Keycash:write
Peoplecash.count
Featurecash
GET/cash/deposits
List deposits
Keycash:read
Peoplecash.read
Featurecash
POST/cash/deposits
Record a bank deposit
Keycash:write
Peoplecash.deposits
Featurecash
POST/cash/settlements
Send card processor and platform payouts
Keycash:write
Peoplenot allowed
Featurecash
POST/cash/tenders
Send tender totals per drawer or shift from the POS
Keycash:write
Peoplenot allowed
Featurecash