Skip to main content
Jobs

Create a one-time job

POST
/jobs
Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
customer_idstringrequired
discountsobject[]
line_itemsobject[]required
Required array length: 1 - 50
notesstring
notify_assigneesbooleandefault:false
notify_customerbooleandefault:false

Default false: the customer is not notified. Send true to notify them.

property_idinteger

An active property of the customer. Default: the customer's address.

Required range: 0 < x
service_typesstring[]

Matched case-insensitively to the company's service types.

sold_bystring | null

An active company member.

tax_rate_idstring
visitobjectrequired

Response

application/json

The new job with its first visit

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

amount_receivednumberrequired
balance_duenumberrequired
completed_atstring | nullrequired
created_atstring | nullrequired
customerobject | nullrequired
discountsobject[]required
first_visitobject | nullrequired

Start and end of the first visit; null when none is scheduled.

idstringrequired
in_progress_atstring | nullrequired
job_numberstring | nullrequired
line_itemsobject[]required
property_addressobjectrequired
sequenceinteger | nullrequired
service_plan_idstring | nullrequired

Null for one-time jobs.

statusenum<string>required
Available options: Unscheduled, Pending, Scheduled, In Progress, Completed, Cancelled
techniciansobject[]required
totalnumberrequired
updated_atstring | nullrequired
visit_idsinteger[]required
visitsobject[]