Skip to content

Expiry dates passed or coming up

GET
/asset-reports/expiring
curl --request GET \
--url 'https://example.com/asset-reports/expiring?productId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Cylinders whose dates the business warns about (a date detail with a warning or an action when it passes, such as the expiry date) have passed or fall within that detail’s warning, 30 days when it has none. Past dates first, then the soonest, with days left from today in London. Lost and retired cylinders are left out. Up to 500, with truncated set when there are more; the CSV has them all.

productId

Only cylinders of this product. Every tracked product when left out.

string format: uuid

Example

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

Only cylinders of this product. Every tracked product when left out.

Cylinders with dates passed or coming up

Media typeapplication/json
object
today
required
string format: date
details
required
Array<object>
object
definitionId
required

UUID v7

string format: uuid
name
required
string
days
required
integer
items
required
Array<object>
object
assetId
required

UUID v7

string format: uuid
serial
required
string | null
productName
required
string
state
required

Active: in use. review: something about it needs checking. faulty: out of use until repaired. lost: not where it should be. retired: no longer used.

string
Allowed values: active review faulty lost retired
holder
required
object
kind
required
string
Allowed values: place vehicle customer supplier nowhere transit
id
required

UUID v7

string | null format: uuid
name
required
string | null
definitionId
required

UUID v7

string format: uuid
name
required
string
date
required
string format: date
daysLeft
required
integer
truncated
required
boolean

Example

{
"details": [
{
"definitionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
],
"items": [
{
"assetId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"state": "active",
"holder": {
"kind": "place",
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"definitionId": "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 Assets

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Assets is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Assets is switched off

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