Skip to main content
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.job
approved_quote
required

The quote that was approved for the job, if the job was costed by quoting.

assignee
required

The user responsible for the job.

billed_to
enum<string>
required

Who is charged when the job is completed: the landlord via an account collection, or the tenant via an invoice or deposit charge.

Available options:
landlord,
tenant
billing
object
required

The money moved when the job was completed. Empty until then.

canceled_at
integer | null
required

The time at which the job was canceled.

cancellation_reason
string | null
required

Why the job was canceled.

completed_at
integer | null
required

The time at which the job was completed.

completion_notes
string | null
required

What was done, recorded when the job was completed.

cost
object | null
required

What the job will cost, from the approved quote or entered directly for work done in house. null until the job has been costed.

description
string | null
required

A description of the work to be done.

in_house
boolean
required

Whether the work is being done in house rather than by an external supplier.

invoices
string[]
required

IDs of files uploaded as invoices for the job.

issue
required

The maintenance issue the job belongs to.

landlord_approval
object
required

Where the job stands with the landlord whose property it is.

name
string
required

The name of the job.

scheduled_end_at
integer | null
required

When the visit is expected to finish.

scheduled_start_at
integer | null
required

When the visit is expected to start.

started_at
integer | null
required

The time at which work started.

status
enum<string>
required

The status of the job.

Available options:
draft,
quoting,
approved,
scheduled,
in_progress,
completed,
canceled
supplier
required

The supplier carrying out the work.

unit
required

The unit the work is at, taken from the issue.

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.