Read the office cash ledger

GET

/cash/ledger

const url = 'https://example.com/cash/ledger?settled=outstanding&days=7';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

The drops behind the office cash figures, optionally for one driver or including recent count-ins. Read-only office access; drivers cannot read this ledger.

Authorizations

sessionCookie
cash:read
apiKey
cash:read

Parameters

Query Parameters

driverUserId

string

settled

string

default: outstanding

Allowed values: outstanding all

days

integer

default: 7 >= 1 <= 365

Responses

200

Takings

application/json

object

items

required

Array<object>

object

required

UUID v7

string format: uuid

driverUserId

required

string | null

driverName

required

string | null

roundId

required

UUID v7

string | null format: uuid

orderId

required

UUID v7

string | null format: uuid

customerName

required

string | null

invoiceId

required

UUID v7

string | null format: uuid

invoiceNumber

required

string | null

amountPence

required

integer

<= 100000000

takenAt

required

string format: date-time

settledAt

required

string | null format: date-time

note

required

string | null

handoverId

required

UUID v7

string | null format: uuid

Example

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "invoiceId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "handoverId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

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