Skip to content

List services due

GET
/service-schedules
curl --request GET \
--url 'https://example.com/service-schedules?customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&typeId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&planId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&due=overdue&month=2027-03&limit=50&offset=0' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Every service due across every customer: one row for each plan on each piece of equipment, soonest first. A tracked cylinder is at the customer holding it, at that customer’s first address. booking is the open order it is already on, with its round. q finds part of the customer’s name, the item type, a serial number or an address. Paged with limit and offset; total counts every match.

q
string
<= 200 characters
customerId

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

typeId

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

planId

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

due

Overdue: past its date, or for a plan due within a month, past the end of its month. thisMonth: due by the end of this month and not overdue. next3Months: due by the end of the month after next and not overdue.

string
Allowed values: overdue thisMonth next3Months

Overdue: past its date, or for a plan due within a month, past the end of its month. thisMonth: due by the end of this month and not overdue. next3Months: due by the end of the month after next and not overdue.

month
string
/^\d{4}-(0[1-9]|1[0-2])$/u/

Example

2027-03
limit
integer
default: 50 >= 1 <= 200
offset
integer | null
0

Services due, soonest first

Media typeapplication/json
object
items
required
Array<object>
object
scheduleId
required

UUID v7

string format: uuid
customer
required
object
id
required

UUID v7

string format: uuid
name
required
string
where
required
string | null
item
required
object
id
required

UUID v7

string format: uuid
type
required
object
id
required

UUID v7

string format: uuid
name
required
string
kind
required
string
Allowed values: customer asset
customerId
required

UUID v7

string | null format: uuid
deliveryAddress
required
object
id
required

UUID v7

string format: uuid
label
required
string
asset
required
object
id
required

UUID v7

string format: uuid
productName
required
string
serial
required
string | null
product
required
object
id
required

UUID v7

string format: uuid
name
required
string
serial
required
string | null
installedOn
required
string | null format: date
details
required
object
key
additional properties
string
notes
required
string | null
schedules
required
Array<object>
object
id
required

UUID v7

string format: uuid
planId
required

UUID v7

string format: uuid
planName
required
string
dueRule
required

Day: due on the date. month: due within the month; the date held is the 1st of the month.

string
Allowed values: day month
nextDueOn
required
string format: date
lastDoneOn
required
string | null format: date
overdue
required
boolean
changes
required
Array<object>
object
from
required
string format: date
to
required
string format: date
at
required
string format: date-time
byName
required
string | null
note
required
string | null
notDone
required
object
on
required
string format: date
reason
required

Not_in: the customer was not in. item_missing: the item was not there. failed: it failed the service. other: said in the note.

string
Allowed values: not_in item_missing failed other
note
required
string | null
orderId
required

UUID v7

string | null format: uuid
planId
required

UUID v7

string format: uuid
planName
required
string
dueRule
required

Day: due on the date. month: due within the month; the date held is the 1st of the month.

string
Allowed values: day month
nextDueOn
required
string format: date
lastDoneOn
required
string | null format: date
overdue
required
boolean
booking
required
object
orderId
required

UUID v7

string format: uuid
wantedOn
required
string | null format: date
roundId
required

UUID v7

string | null format: uuid
total
required
integer

Example

{
"items": [
{
"scheduleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"customer": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"item": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"type": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"kind": "customer",
"customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"deliveryAddress": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"asset": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"product": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"installedOn": "2026-03-01",
"schedules": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"planId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"dueRule": "day",
"nextDueOn": "2026-03-01",
"lastDoneOn": "2026-03-01",
"changes": [
{
"from": "2026-03-01",
"to": "2026-03-01"
}
],
"notDone": {
"on": "2026-03-01",
"reason": "not_in",
"orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
}
]
},
"planId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"dueRule": "day",
"nextDueOn": "2026-03-01",
"lastDoneOn": "2026-03-01",
"booking": {
"orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"wantedOn": "2026-03-01",
"roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
}
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Not an owner or admin, missing scope, or the plan does not open Equipment servicing

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Not found, or Equipment servicing is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

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