created_by_staff_uuidstring uuid
UUID of the staff member who created this job. Records which staff member initially added the job to the system.
datestring
The date the job was created or scheduled. Used for organizing jobs chronologically and for reference in reports.
company_uuidstring 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_addressstring
The address where invoices and billing information should be sent. If not specified, defaults to the job address.
status'Quote' | 'Work Order' | 'Unsuccessful' | 'Completed' required
Current status of the job. Controls where the Job appears in the Dispatch Board.. Valid values are [Quote,Work Order,Unsuccessful,Completed]
lngnumber float
Longitude coordinate of the job location. Used for mapping and geolocation features. This is automatically populated based on the job address through geocoding.
latnumber float
Latitude coordinate of the job location. Used for mapping and geolocation features. This is automatically populated based on the job address through geocoding.
payment_datestring
Not used. Refer to JobPayment endpoint.
payment_actioned_by_uuidstring uuid
Not used. Refer to JobPayment endpoint.
payment_methodstring
Not used. Refer to JobPayment endpoint.
payment_amountstring
Not used. Refer to JobPayment endpoint.
category_uuidstring uuid
UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department.
payment_notestring
Not used. Refer to JobPayment endpoint.
geo_is_validstring
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_numberstring
Client purchase order reference number for this job. Used for cross-referencing with external accounting or order management systems.
invoice_sentstring
Boolean flag indicating whether an invoice has been sent to the client for this job.
invoice_sent_stampstring
Timestamp when the invoice was sent to the client. Format is YYYY-MM-DD HH:MM:SS.
{"stackTrail":"components:schemas:Job:properties:ready_to_invoice","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:Job:properties:ready_to_invoice_stamp","oasType":"schema","type":"unknown","description":"DEPRECATED"}
geo_countrystring
The country component extracted from the geocoded job address. Automatically populated when an address is geocoded.
geo_postcodestring
The postal/zip code component extracted from the geocoded job address. Automatically populated when an address is geocoded.
geo_statestring
The state/province component extracted from the geocoded job address. Automatically populated when an address is geocoded.
geo_citystring
The city/locality component extracted from the geocoded job address. Automatically populated when an address is geocoded.
geo_streetstring
The street name component extracted from the geocoded job address. Automatically populated when an address is geocoded.
geo_numberstring
The street number component extracted from the geocoded job address. Automatically populated when an address is geocoded.
queue_uuidstring uuid
UUID reference to the queue this job is assigned to. Jobs can be organized into queues for workflow management.
queue_expiry_datestring
Timestamp when this job's assignment to the current Queue expires. After this date passes, the job is no longer considered to be in the Queue, even though queue_uuid may still contain a value.
queue_assigned_staff_uuidstring uuid
UUID of a Staff Member who is responsible for managing this job while it is in the queue. Only populated when the job is in a Queue which tracks Staff assignment.
badgesstring
Comma-separated list of Badge UUIDs associated with this job. Badges are visual indicators that can be displayed on jobs in the dispatch board.
quote_datestring
Timestamp when the job was quoted. Automatically set when a job's status is changed to 'Quote'.
quote_sent0 | 1
Boolean flag indicating whether a quote has been sent to the client for this job. (Read only). Valid values are [0,1]
quote_sent_stampstring
Timestamp when the quote was sent to the client. Format is YYYY-MM-DD HH:MM:SS. (Read only)
work_order_datestring
Timestamp when the job was converted to a work order. Automatically set when a job's status is changed to 'Work Order'.
{"stackTrail":"components:schemas:Job:properties:active_network_request_uuid","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:Job:properties:related_knowledge_articles","oasType":"schema","type":"unknown","description":"DEPRECATED"}
uuidstring uuid
Unique identifier for this record
active0 | 1
Record active/deleted flag. Valid values are [0,1]
edit_datestring
Timestamp at which record was last modified
job_addressstring
Physical address where the job is to be performed. This address is used for geocoding to place the job on the map.
work_done_descriptionstring
generated_job_idstring
System-generated unique job identifier. This is read-only and automatically assigned when a job is created. (Read only)
total_invoice_amountstring
payment_processed_stampstring
payment_received_stampstring
completion_actioned_by_uuidstring uuid
UUID of the staff member who marked this job as completed. References a staff record in the system.
job_is_scheduled_until_stampstring