Skip to content
Bottle

List cash owed by drivers

GET
/cash
curl --request GET \
  --url 'https://example.com/cash?days=7' \
  --cookie bottle.session_token=<bottle.session_token>

Who is carrying what, since when, and how many days old the oldest note is. Everything outstanding however old, because cash does not come in at the end of every day: a driver on a week of rural rounds hands over on Friday. The taken and counted-in figures cover the last days days, seven by default. Needs cash:write, because seeing what every driver is carrying is the office half of this rather than a driver reading their own.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
days
integer
default: 7 >= 1 <= 90

Responses

Section titled “Responses”

200

Section titled “200”

What is out there

Media typeapplication/json
object
drivers
required
Array<object>
object
driverUserId
required
string
driverName
required
string | null
outstandingPence
required
integer
drops
required
integer
since
required
string | null format: date-time
oldestDays
required
integer
handingInPence
required
integer
outstandingPence
required
integer
oldestDays
required
integer
overDays
required
integer
> 0
settledPence
required
integer
takenPence
required
integer
Examplegenerated
{
  "drivers": [
    {
      "driverUserId": "example",
      "driverName": "example",
      "outstandingPence": 1,
      "drops": 1,
      "since": "2026-04-15T12:00:00Z",
      "oldestDays": 1,
      "handingInPence": 1
    }
  ],
  "outstandingPence": 1,
  "oldestDays": 1,
  "overDays": 1,
  "settledPence": 1,
  "takenPence": 1
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}