Skip to content

Download services due as CSV

GET
/service-schedules.csv
curl --request GET \
--url 'https://example.com/service-schedules.csv?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. Every match, with the same filters; limit and offset are ignored. UTF-8 with a byte order mark and CRLF line ends. Any text cell a spreadsheet would run as a formula has a ' put in front.

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

The CSV file

Media typetext/csv
string

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