Skip to main content
POST
Create a maintenance quote

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
job
string
required

The ID of the job the quote is for.

supplier
string
required

The ID of the supplier the quote is from.

amount
integer | null

The quoted amount, in the smallest currency unit. Leave unset to record a quote the supplier has yet to price.

Required range: x >= 0
currency
enum<string>

The currency of the quote. Defaults to the currency of the unit the work is at.

Available options:
gbp,
usd,
eur,
sek
Example:

"gbp"

description
string | null

What the supplier is quoting for. Send null to clear it.

Maximum string length: 5000
expires_at
integer | null

The time after which the quoted price no longer stands.

files
string[]

IDs of files to attach to the quote.

request
boolean

Whether to email the supplier asking them to price the work. Defaults to false.

Response

200 - application/json

Returns the maintenance quote object if the request succeeded.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
maintenance.quote
amount
integer | null
required

The quoted amount, in the smallest currency unit. null until the supplier has submitted a price.

approved_at
integer | null
required

The time at which the quote was approved.

approved_by
required

The user who approved the quote.

currency
enum<string>
required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Available options:
gbp,
usd,
eur,
sek
Example:

"gbp"

description
string | null
required

What the supplier is quoting for, or any caveats they attached to the price.

expires_at
integer | null
required

The time after which the quoted price no longer stands.

files
string[]
required

IDs of files attached to the quote, such as the supplier’s own quote document.

issue
required

The maintenance issue the quote’s job belongs to.

job
required

The job the quote is for.

rejected_at
integer | null
required

The time at which the quote was rejected.

rejection_reason
string | null
required

Why the quote was rejected.

requested_at
integer | null
required

The time at which the quote was requested from the supplier.

status
enum<string>
required

The status of the quote.

Available options:
draft,
requested,
submitted,
approved,
rejected,
canceled
submitted_at
integer | null
required

The time at which the supplier last submitted a price.

supplier
required

The supplier the quote is from.

account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.