Skip to content
Bottle

Say cash has been handed in

POST
/cash/handovers
curl --request POST \
  --url https://example.com/cash/handovers \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "takingIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "amountPence": 1, "note": "example" }'

A driver saying they handed cash to the office: the drops named, or everything they owe that is not already waiting. It stays theirs until the office confirms it. An amount may be given and must match the drops.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
takingIds
Array<string>
<= 500 items
amountPence
integer
<= 100000000
note
string | null
<= 500 characters

Responses

Section titled “Responses”

201

Section titled “201”

Waiting for the office

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
driverUserId
required
string
driverName
required
string | null
amountPence
required
integer
<= 100000000
drops
required
integer
startedBy
required
string
Allowed values: driver office
startedByName
required
string | null
status
required
string
Allowed values: waiting agreed disputed cancelled
note
required
string | null
answeredByName
required
string | null
answeredAt
required
string | null format: date-time
answerNote
required
string | null
createdAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "startedBy": "driver",
  "status": "waiting"
}

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"
}

409

Section titled “409”

Nothing to hand in, or the amount does not match

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"
    }
  ]
}