Create a new Job

post

https://api.servicem8.com/api_1.0/job.json

OAuth Scope

This endpoint requires the following OAuth scope create_jobs.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

Body Params

Job record to create

created_by_staff_uuid

uuid

UUID of the staff member who created this job. Records which staff member initially added the job to the system.

date

string

The date the job was created or scheduled. Used for organizing jobs chronologically and for reference in reports.

company_uuid

uuid

UUID reference to the client/company record associated with this job. Links the job to a client in the system, establishing the client-job relationship for billing and contact purposes.

billing_address

string

length ≤ 500

The address where invoices and billing information should be sent. If not specified, defaults to the job address.

status

string

enum

required

length ≤ 20

Current status of the job. Controls where the Job appears in the Dispatch Board.. Valid values are [Quote,Work Order,Unsuccessful,Completed]

Allowed:

lng

string

Longitude coordinate of the job location. Used for mapping and geolocation features. This is automatically populated based on the job address through geocoding.

lat

string

Latitude coordinate of the job location. Used for mapping and geolocation features. This is automatically populated based on the job address through geocoding.

payment_date

string

Not used. Refer to JobPayment endpoint.

payment_actioned_by_uuid

uuid

Not used. Refer to JobPayment endpoint.

payment_method

string

Not used. Refer to JobPayment endpoint.

payment_amount

string

Not used. Refer to JobPayment endpoint.

category_uuid

uuid

UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department.

payment_note

string

Not used. Refer to JobPayment endpoint.

geo_is_valid

string

Indicates whether the geocoding for the job address was successful. When true, the latitude and longitude coordinates are considered accurate for mapping and location-based features.

purchase_order_number

string

length ≤ 100

Client purchase order reference number for this job. Used for cross-referencing with external accounting or order management systems.

invoice_sent

integer

enum

Indicates whether an invoice has been sent for this job.. Valid values are [0,1]

Allowed:

invoice_sent_stamp

string

Timestamp when the invoice was sent to the client. Format is YYYY-MM-DD HH:MM:SS.

ready_to_invoice

string

DEPRECATED

ready_to_invoice_stamp

string

DEPRECATED

geo_country

string

The country component extracted from the geocoded job address. Automatically populated when an address is geocoded.

geo_postcode

string

The postal/zip code component extracted from the geocoded job address. Automatically populated when an address is geocoded.

geo_state

string

The state/province component extracted from the geocoded job address. Automatically populated when an address is geocoded.

geo_city

string

The city/locality component extracted from the geocoded job address. Automatically populated when an address is geocoded.

geo_street

string

The street name component extracted from the geocoded job address. Automatically populated when an address is geocoded.

geo_number

string

The street number component extracted from the geocoded job address. Automatically populated when an address is geocoded.

queue_uuid

uuid

The UUID of the queue this job belongs to.

queue_expiry_date

string

The date and time when the job expires from the queue.

queue_assigned_staff_uuid

uuid

The UUID of the staff member assigned to this job in the queue.

badges

string

JSON Array of Badge UUIDs

quote_date

string

The date and time that the job status was changed to Quote.

quote_sent

integer

enum

Boolean flag indicating whether a quote has been sent to the client for this job.. Valid values are [0,1]

Allowed:

quote_sent_stamp

string

Timestamp when the quote was sent to the client. Format is YYYY-MM-DD HH:MM:SS.

work_order_date

string

The date and time that the job status was changed to Work Order.

active_network_request_uuid

string

DEPRECATED

related_knowledge_articles

string

DEPRECATED

uuid

uuid

Unique identifier for this record

job_address

string

length ≤ 500

Physical address where the job is to be performed. This address is used for geocoding to place the job on the map.

job_description

string

work_done_description

string

Email Address

payment_processed

integer

enum

Indicates whether the job has been exported to the connected Accounting Package.. Valid values are [0,1]

Allowed:

payment_received

integer

enum

Indicates whether full payment has been received for this job.. Valid values are [0,1]

Allowed:

completion_date

string

The date and time that the job status was changed to Completed.

unsuccessful_date

string

The date and time that the job status was changed to Unsuccessful.

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json