Update Work Order

Update a Work Order

Path Parameters

id string required
Possible values: Value must match regular expression ^[0-9]+$
The id of the relevant record

application/json

Request Body

issued_at date-time
The date and time at which this Work Order was issued. We recommend using ISO-8601 formatted dates to avoid ambiguity.
started_at date-time
The date and time at which this Work Order was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
completed_at date-time
The date and time at which this Work Order was completed. We recommend using ISO-8601 formatted dates to avoid ambiguity.
work_order_status_id integer
Possible values: >= 1
invoice_number string
Possible values: <= 255 characters
The number of the Invoice associated with this Work Order.
vendor_id NullableId
Possible values: >= 1
vendor_name string
Possible values: <= 255 characters
The name of the Vendor associated with this Work Order.
vehicle_id integer
Possible values: >= 1
vehicle_name string
Possible values: <= 255 characters
The name of the Vehicle associated with this Work Order.
discount_type string
Possible values: [percentage, amount]
The type of discount applied to this Work Order.
discount float
The discount amount in decimal currency units applied to this Work Order.
discount_percentage float
The percentage of the discount applied to this Work Order. Used if discount_type is set to percentage.
tax_1_percentage float
The percentage of the first tax applied to this Work Order. Used if tax_1_type is set to percentage.
tax_1_type string
Possible values: [fixed, percentage]
Default value: percentage
The type of tax to apply to this record.
tax_1 float
The amount of the first tax applied to this Work Order. Used if tax_1_type is set to amount.
tax_2_percentage float
The percentage of the second tax applied to this Work Order. Used if tax_2_type is set to percentage.
tax_2_type string
Possible values: [fixed, percentage]
Default value: percentage
The type of tax to apply to this record.
tax_2 float
The amount of the second tax applied to this Work Order. Used if tax_2_type is set to amount.
issued_by_id NullableId
Possible values: >= 1
contact_id NullableId
Possible values: >= 1
label_list string
Possible values: <= 255 characters
A comma separated list of tags associated with this record. The only delimiter allowed is a comma (,). Please remove any commas from your labels before saving the record.
purchase_order_number string
The number of the Purchase Order associated with this Work Order.
description string
A description of this Work Order.
number integer
The number to be applied to this Work Order. Must be unique.
meter_entry_attributes object
A Work Order may also be associated with a Meter Entry.
value float
The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.
void boolean
If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.
secondary_meter_entry_attributes object
A Work Order may also be associated with a secondary Meter Entry.
value float
The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.
void boolean
If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.
starting_meter_entry_attributes object
The meter reading at the start of this Work Order.
value float
The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.
void boolean
If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.
ending_meter_entry_attributes object
The meter reading at the end of this Work Order.
value float
The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.
void boolean
If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.
starting_secondary_meter_entry_attributes object
The secondary meter reading at the start of this Work Order.
value float
The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.
void boolean
If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.
ending_secondary_meter_entry_attributes object
The secondary meter reading at the end of this Work Order.
value float
The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.
void boolean
If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.
custom_fields object
*Full details on working with Custom Fields here.
ending_meter_same_as_start boolean
Use start meter for completion meter?
vmrs_repair_priority_class_id NullableId
Possible values: >= 1
scheduled_at date-time
The date and time at which this Work Order is scheduled. We recommend using ISO-8601 formatted dates to avoid ambiguity.
expected_completed_at date-time
The date and time at which this Work Order is expected to be completed. We recommend using ISO-8601 formatted dates to avoid ambiguity.
comments_attributes object[]
A list of Comments to be added to this Work Order.
title string
The title of the comment.
comment string
The comment text.
work_order_line_items_attributes object[]
A list of Work Order Line Items to be added to this Work Order.
id integer
The ID of this Work Order Line Item. Required if this is a Work Order Line Item being updated.
item_type string
Possible values: [Issue, ServiceTask]
The Type of the item associated with this Work Order Line Item.
item_name string
The name of the item associated with this Work Order Line Item.
description string
A description of this Work Order Line Item.
item_id integer
The ID of the item associated with this Work Order Line Item.
labor_cost float
The cost of labor of this line item.
parts_cost float
The cost of Parts of this line item.
position integer
The position of this line item in a list of line items.
subtotal float
The subtotal of this line item.
type string
Possible values: [WorkOrderServiceTaskLineItem, WorkOrderFreeTextLineItem]
vmrs_reason_for_repair_id integer
The ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integer
The ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integer
The ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integer
The ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integer
The ID of the VMRS Component associated with this Work Order Line Item.
issue_ids integer[]
The IDs of any Issues associated with this Work Order Line Item.
work_order_sub_line_items_attributes object[]
A list of any Work Order Sub Line Items to be added.
id integer
The ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type string
Possible values: [WorkOrderPartLineItem, WorkOrderLaborLineItem]
item_id integer
The ID of the Part or Contact associated with this Work Order Line Item.
item_type string
Possible values: [Part, Contact]
quantity float
The quantity of the Part or Contact associated with this Work Order Line Item.
part_location_detail_id integer
This ID refers to the details of the Part at a specific Part Location. You can send a GET request to https://secure.fleetio.com/api/v1/parts/:id to get any part_location_detail_id(s) for a Part. The id attribute under the part_locations object is the value that corresponds to this parameter.
position integer
The position of this Work Order Line Item in a list of line items.
description string
The description of this Work Order Line Item.
inventory_set_id integer
The ID of the Inventory Set associated with this Work Order Line Item. This is only required if the Part is associated with an Inventory Set.
vmrs_reason_for_repair_id integer
The ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integer
The ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integer
The ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integer
The ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integer
The ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-time
The date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-time
The date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableId
Possible values: >= 1
work_order_part_line_items_attributes object[]
A list of any Work Order Part Line Items to be added.
id integer
The ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type string
Possible values: [WorkOrderPartLineItem, WorkOrderLaborLineItem]
item_id integer
The ID of the Part or Contact associated with this Work Order Line Item.
item_type string
Possible values: [Part, Contact]
quantity float
The quantity of the Part or Contact associated with this Work Order Line Item.
part_location_detail_id integer
This ID refers to the details of the Part at a specific Part Location. You can send a GET request to https://secure.fleetio.com/api/v1/parts/:id to get any part_location_detail_id(s) for a Part. The id attribute under the part_locations object is the value that corresponds to this parameter.
position integer
The position of this Work Order Line Item in a list of line items.
description string
The description of this Work Order Line Item.
inventory_set_id integer
The ID of the Inventory Set associated with this Work Order Line Item. This is only required if the Part is associated with an Inventory Set.
vmrs_reason_for_repair_id integer
The ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integer
The ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integer
The ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integer
The ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integer
The ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-time
The date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-time
The date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableId
Possible values: >= 1
work_order_labor_line_items_attributes object[]
A list of any Work Order Labor Line Items to be added.
id integer
The ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type string
Possible values: [WorkOrderPartLineItem, WorkOrderLaborLineItem]
item_id integer
The ID of the Part or Contact associated with this Work Order Line Item.
item_type string
Possible values: [Part, Contact]
quantity float
The quantity of the Part or Contact associated with this Work Order Line Item.
part_location_detail_id integer
This ID refers to the details of the Part at a specific Part Location. You can send a GET request to https://secure.fleetio.com/api/v1/parts/:id to get any part_location_detail_id(s) for a Part. The id attribute under the part_locations object is the value that corresponds to this parameter.
position integer
The position of this Work Order Line Item in a list of line items.
description string
The description of this Work Order Line Item.
inventory_set_id integer
The ID of the Inventory Set associated with this Work Order Line Item. This is only required if the Part is associated with an Inventory Set.
vmrs_reason_for_repair_id integer
The ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integer
The ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integer
The ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integer
The ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integer
The ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-time
The date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-time
The date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableId
Possible values: >= 1
work_order_sub_line_items_attributes object[]
A list of Work Order Sub Line Items to be added to this Work Order.
id integer
The ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type string
Possible values: [WorkOrderPartLineItem, WorkOrderLaborLineItem]
item_id integer
The ID of the Part or Contact associated with this Work Order Line Item.
item_type string
Possible values: [Part, Contact]
quantity float
The quantity of the Part or Contact associated with this Work Order Line Item.
part_location_detail_id integer
This ID refers to the details of the Part at a specific Part Location. You can send a GET request to https://secure.fleetio.com/api/v1/parts/:id to get any part_location_detail_id(s) for a Part. The id attribute under the part_locations object is the value that corresponds to this parameter.
position integer
The position of this Work Order Line Item in a list of line items.
description string
The description of this Work Order Line Item.
inventory_set_id integer
The ID of the Inventory Set associated with this Work Order Line Item. This is only required if the Part is associated with an Inventory Set.
vmrs_reason_for_repair_id integer
The ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integer
The ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integer
The ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integer
The ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integer
The ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-time
The date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-time
The date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableId
Possible values: >= 1
issue_ids NullableId[]
Possible values: >= 1
A list of Issues to be added to this Work Order.
label_ids NullableId[]
Possible values: >= 1
A list of Labels to be added to this Work Order.

Responses

application/json

Schema
Example (from schema)

Schema

id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
number string
The unique number of this Work Order.
completed_at date-time
The date and time at which the Work Order was completed.
description string
A description of this Work Order.
ending_meter_same_as_start boolean
Indicates whether or not the ending meter is the same as the starting meter.
duration_in_seconds integer
The number of seconds elapsed between beginning this Work Order and completing it.
invoice_number string
The number of the Invoice associated with this Work Order.
state string
Possible values: [active, completed]
Indicates whether this Work Order is currently active or has already been completed.
issued_at date-time
The date and time at which the Work Order was issued.
issued_by_id NullableId
Possible values: >= 1
issued_by_name string
The name of the Contact associated with the User who issued this Work Order.
contact_id NullableId
Possible values: >= 1
contact_name string
The name of the Contact currently assigned to this Work Order.
purchase_order_number string
The number of any Purchase Order associated with this Work Order.
started_at date-time
The date and time at which the Work Order was started.
work_order_sub_line_items object[]
anyOf
Work Order Sub Line Item
Work Order Sub Line Item
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
description string
The description of the sub line item.
item_id integer
Possible values: >= 1
item_type string
Possible values: [Contact]
work_order_line_item_id NullableId
Possible values: >= 1
quantity float
The quantity of this sub line item.
part_location_detail_id NullableId
Possible values: >= 1
position integer
The position of this sub line item in a list of sub line items.
item_name string
The name of this sub line item.
unit_cost float
The unit cost of this sub line item.
contact object
A Contact
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
archived_at date-time
The date and time at which this Contact was archived.
email string
The Contact's email address.
name string
The Contact's full name.
first_name string
The Contact's first name.
middle_name string
The Contact's middle name.
last_name string
The Contact's last name.
group_id integer
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_name string
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchy string
If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
technician boolean
Whether or not the Contact is a Technician.
vehicle_operator boolean
Whether or not the Contact is a Vehicle Operator.
employee boolean
Whether or not the Contact is an Employee.
birth_date date
The Contact's birth date.
street_address string
The Contact's street address.
street_address_line_2 string
The Contact's street address line 2.
city string
The Contact's city.
region string
The Contact's region, state, or province.
postal_code string
The Contact's postal code, zip code, or equivalent.
country string
The Contact's country.
employee_number string
The Contact's employee number.
job_title string
Possible values: <= 255 characters
The Contact's job title.
license_class string
The Contact's driver's license class.
license_number string
The Contact's driver's license number.
license_state string
The locality which issued the Contact's license.
home_phone_number string
The Contact's home phone number.
mobile_phone_number string
The Contact's mobile phone number.
work_phone_number string
The Contact's work phone number.
other_phone_number string
Any other phone number for this Contact.
start_date date
When the Contact started working for the company, if applicable.
leave_date date
When the Contact left or will leave the company, if applicable.
hourly_labor_rate float
The Contact's hourly rate.
custom_fields object
*Full details on working with Custom Fields here.
attachment_permissions object
read_photos boolean
Indicates whether the user has read permission for photos.
manage_photos boolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents boolean
Indicates whether the user has read permission for documents.
manage_documents boolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url string
The URL of the Contact's default image/profile photo, if any.
user object
If the Contact is a Fleetio User, those details will be included here.
account_membership_id NullableId
Possible values: >= 1
comments object[]
A list of the comments made on this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
commentable_type CommentableType
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
commentable_id integer
Possible values: >= 1
user_id integer
Possible values: >= 1
title string deprecated
The title of the Comment.
comment string
The content of the Comment message body.
user_full_name string
The full name of the User who created the Comment.
user_image_url string
The image url for the User who created the Comment.
rich_content object
html_content string
The comment message body rendered as HTML.
with_mentions boolean
Indicates if the message body contains @mentions.
comments_count integer
The number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
documentable_id integer
Possible values: >= 1
documentable_type DocumentableType
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]
file_name string
The name of the file.
file_mime_type string
The MIME type of the file.
file_size number
The size of the file in bytes.
file_url string
The URL to access the file.
full_file_url string
The full URL to access the file, including any necessary authentication or parameters.
documents_count integer
The number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
imageable_id integer
Possible values: >= 1
imageable_type ImageableType
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_name string
The name of the image file.
file_mime_type Image MIME Type
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/gif, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_size number
The size of the image file in bytes.
file_url string
The URL to access the image file.
full_url string
The full URL to access the image file, including any necessary authentication or parameters.
images_count integer
The number of images attached to this record.
labor_time_entries object[]
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
contact_id integer
Possible values: >= 1
data object
duration_in_seconds int32
ended_at date-time
laborable_id integer
Possible values: >= 1
laborable_type string
Possible values: [WorkOrderSubLineItem]
started_at date-time
work_order_type_id NullableId deprecated
Possible values: >= 1
vehicle_archived_at date-time
The date and time at which the Vehicle associated with this Work Order was archived, if applicable.
send_email_notification_to_assignee boolean
Indicates whether an email notification should be sent to the assignee of this Work Order.
fees_cents integer
The sum of subtotals for any line items of the type ServiceEntryFeeLineItem.
scheduled_at date-time
The date and time at which the Work Order was scheduled.
vehicle_id integer
Possible values: >= 1
vehicle_name string
The name of the Vehicle associated with this Work Order.
vendor_id NullableId
Possible values: >= 1
vendor_name string
The name of the Vendor associated with this Work Order.
work_order_status_id integer
Possible values: >= 1
work_order_status_name string
The name of the Work Order Status associated with this Work Order.
work_order_status_color string
The color of the Work Order Status seen in the UI.
custom_fields object
*Full details on working with Custom Fields here.
work_order_line_items object[]
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
labor_cost object
The labor cost amount.
anyOf
MOD1
MOD2
number float
parts_cost object
The parts cost amount.
anyOf
MOD1
MOD2
number float
parts_cost_cents object
The parts cost amount in cents.
oneOf
MOD1
MOD2
string
labor_cost_cents object
The labor cost amount in cents.
oneOf
MOD1
MOD2
string
subtotal object
The pre-tax subtotal amount.
anyOf
MOD1
MOD2
number float
subtotal_cents object
The pre-tax subtotal amount in cents.
anyOf
MOD1
MOD2
integer
description string
A description of this Work Order Line Item.
title string
The title of this Work Order Line Item.
item_id integer
The ID of the item associated with this Work Order Line Item.
item_type string
Possible values: [Issue, ServiceTask]
The type of item associated with this Work Order Line Item.
work_order_line_item_id integer
item_name string
The name of the item associated with this Work Order Line Item.
position integer
The position of this Work Order Line Item in a list of Work Order Line Items.
issues object[]
Any Issues associated with this Work Order Line Item.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
number string
A unique identifier for the Issue.
name string
The name of the Issue.
summary string
A summary of the Issue.
description string
A longer description of the Issue.
state string
Possible values: [Open, Closed, Resolved]
The Issue's current state.
reported_at date-time
The date and time at which the issue was reported.
reported_by_id NullableId
Possible values: >= 1
reported_by_name string
The name of the Contact associated with the User who reported this Issue.
fault_id NullableId
Possible values: >= 1
due_date date
The date on which this Issue should be resolved by. Formatted according to ISO-8601 in User's local time zone.
due_meter_value string
The meter value at which this Issue should be resolved by.
due_secondary_meter_value float
The secondary meter value at which this Issue should be resolved by.
overdue boolean
Indicates whether the Issue is overdue.
vehicle_id integer
Possible values: >= 1
vehicle_name string
The name of the Vehicle associated with this Issue.
is_sample boolean
Indicates whether this Issue is sample data.
created_by_workflow boolean
Indicates whether this Issue was created by a workflow.
submitted_inspection_form_id NullableId
Possible values: >= 1
custom_fields object
*Full details on working with Custom Fields here.
valid_required_custom_fields boolean
dtc_alert_id NullableId
Possible values: >= 1
assigned_contacts object[]
An array of assigned Contacts related to the Issue.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
archived_at date-time
The date and time at which this Contact was archived.
email string
The Contact's email address.
name string
The Contact's full name.
first_name string
The Contact's first name.
middle_name string
The Contact's middle name.
last_name string
The Contact's last name.
group_id integer
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_name string
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchy string
If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
technician boolean
Whether or not the Contact is a Technician.
vehicle_operator boolean
Whether or not the Contact is a Vehicle Operator.
employee boolean
Whether or not the Contact is an Employee.
birth_date date
The Contact's birth date.
street_address string
The Contact's street address.
street_address_line_2 string
The Contact's street address line 2.
city string
The Contact's city.
region string
The Contact's region, state, or province.
postal_code string
The Contact's postal code, zip code, or equivalent.
country string
The Contact's country.
employee_number string
The Contact's employee number.
job_title string
Possible values: <= 255 characters
The Contact's job title.
license_class string
The Contact's driver's license class.
license_number string
The Contact's driver's license number.
license_state string
The locality which issued the Contact's license.
home_phone_number string
The Contact's home phone number.
mobile_phone_number string
The Contact's mobile phone number.
work_phone_number string
The Contact's work phone number.
other_phone_number string
Any other phone number for this Contact.
start_date date
When the Contact started working for the company, if applicable.
leave_date date
When the Contact left or will leave the company, if applicable.
hourly_labor_rate float
The Contact's hourly rate.
custom_fields object
*Full details on working with Custom Fields here.
attachment_permissions object
read_photos boolean
Indicates whether the user has read permission for photos.
manage_photos boolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents boolean
Indicates whether the user has read permission for documents.
manage_documents boolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url string
The URL of the Contact's default image/profile photo, if any.
user object
If the Contact is a Fleetio User, those details will be included here.
account_membership_id NullableId
Possible values: >= 1
comments object[]
A list of the comments made on this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
commentable_type CommentableType
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
commentable_id integer
Possible values: >= 1
user_id integer
Possible values: >= 1
title string deprecated
The title of the Comment.
comment string
The content of the Comment message body.
user_full_name string
The full name of the User who created the Comment.
user_image_url string
The image url for the User who created the Comment.
rich_content object
html_content string
The comment message body rendered as HTML.
with_mentions boolean
Indicates if the message body contains @mentions.
comments_count integer
The number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
documentable_id integer
Possible values: >= 1
documentable_type DocumentableType
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]
file_name string
The name of the file.
file_mime_type string
The MIME type of the file.
file_size number
The size of the file in bytes.
file_url string
The URL to access the file.
full_file_url string
The full URL to access the file, including any necessary authentication or parameters.
documents_count integer
The number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
imageable_id integer
Possible values: >= 1
imageable_type ImageableType
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_name string
The name of the image file.
file_mime_type Image MIME Type
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/gif, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_size number
The size of the image file in bytes.
file_url string
The URL to access the image file.
full_url string
The full URL to access the image file, including any necessary authentication or parameters.
images_count integer
The number of images attached to this record.
reported_by object
A Contact
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
archived_at date-time
The date and time at which this Contact was archived.
email string
The Contact's email address.
name string
The Contact's full name.
first_name string
The Contact's first name.
middle_name string
The Contact's middle name.
last_name string
The Contact's last name.
group_id integer
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_name string
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchy string
If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
technician boolean
Whether or not the Contact is a Technician.
vehicle_operator boolean
Whether or not the Contact is a Vehicle Operator.
employee boolean
Whether or not the Contact is an Employee.
birth_date date
The Contact's birth date.
street_address string
The Contact's street address.
street_address_line_2 string
The Contact's street address line 2.
city string
The Contact's city.
region string
The Contact's region, state, or province.
postal_code string
The Contact's postal code, zip code, or equivalent.
country string
The Contact's country.
employee_number string
The Contact's employee number.
job_title string
Possible values: <= 255 characters
The Contact's job title.
license_class string
The Contact's driver's license class.
license_number string
The Contact's driver's license number.
license_state string
The locality which issued the Contact's license.
home_phone_number string
The Contact's home phone number.
mobile_phone_number string
The Contact's mobile phone number.
work_phone_number string
The Contact's work phone number.
other_phone_number string
Any other phone number for this Contact.
start_date date
When the Contact started working for the company, if applicable.
leave_date date
When the Contact left or will leave the company, if applicable.
hourly_labor_rate float
The Contact's hourly rate.
custom_fields object
*Full details on working with Custom Fields here.
attachment_permissions object
read_photos boolean
Indicates whether the user has read permission for photos.
manage_photos boolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents boolean
Indicates whether the user has read permission for documents.
manage_documents boolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url string
The URL of the Contact's default image/profile photo, if any.
user object
If the Contact is a Fleetio User, those details will be included here.
account_membership_id NullableId
Possible values: >= 1
comments object[]
A list of the comments made on this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
commentable_type CommentableType
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
commentable_id integer
Possible values: >= 1
user_id integer
Possible values: >= 1
title string deprecated
The title of the Comment.
comment string
The content of the Comment message body.
user_full_name string
The full name of the User who created the Comment.
user_image_url string
The image url for the User who created the Comment.
rich_content object
html_content string
The comment message body rendered as HTML.
with_mentions boolean
Indicates if the message body contains @mentions.
comments_count integer
The number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
documentable_id integer
Possible values: >= 1
documentable_type DocumentableType
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]
file_name string
The name of the file.
file_mime_type string
The MIME type of the file.
file_size number
The size of the file in bytes.
file_url string
The URL to access the file.
full_file_url string
The full URL to access the file, including any necessary authentication or parameters.
documents_count integer
The number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
imageable_id integer
Possible values: >= 1
imageable_type ImageableType
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_name string
The name of the image file.
file_mime_type Image MIME Type
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/gif, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_size number
The size of the image file in bytes.
file_url string
The URL to access the image file.
full_url string
The full URL to access the image file, including any necessary authentication or parameters.
images_count integer
The number of images attached to this record.
labels array[]
An array of labels related to the Issue.
attachment_permissions object
read_photos boolean
Indicates whether the user has read permission for photos.
manage_photos boolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents boolean
Indicates whether the user has read permission for documents.
manage_documents boolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
vehicle_image_url string
The URL to the image of the Vehicle associated with the Issue.
vehicle_image_url_medium string
The URL to a medium-sized Vehicle image associated with the Issue.
vehicle_image_url_small string
The URL to a small-sized Vehicle image associated with the Issue.
vehicle_image_url_large string
The URL to a large-sized Vehicle image associated with the Issue.
watchers_count integer
The count of watchers related to the Issue.
linked_work_orders object[]
Summative information of linked Work Orders related to the Issue.
id integer
Possible values: >= 1
number integer
The Work Order number.
issued_at date-time
The date and time at which the Work Order was issued.
source object
Inspection source information.
inspection_form object
id NullableId
Possible values: >= 1
color string
title string
inspection_submissions_count integer
The count of inspection submissions related to the Issue.
last_inspection_submission_at date-time
The date and time of the last inspection submission related to the Issue.
failed_inspection_item_label string
The label associated with a failed inspection item.
comments object[]
A list of the comments made on this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
commentable_type CommentableType
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
commentable_id integer
Possible values: >= 1
user_id integer
Possible values: >= 1
title string deprecated
The title of the Comment.
comment string
The content of the Comment message body.
user_full_name string
The full name of the User who created the Comment.
user_image_url string
The image url for the User who created the Comment.
rich_content object
html_content string
The comment message body rendered as HTML.
with_mentions boolean
Indicates if the message body contains @mentions.
comments_count integer
The number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
documentable_id integer
Possible values: >= 1
documentable_type DocumentableType
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]
file_name string
The name of the file.
file_mime_type string
The MIME type of the file.
file_size number
The size of the file in bytes.
file_url string
The URL to access the file.
full_file_url string
The full URL to access the file, including any necessary authentication or parameters.
documents_count integer
The number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
imageable_id integer
Possible values: >= 1
imageable_type ImageableType
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_name string
The name of the image file.
file_mime_type Image MIME Type
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/gif, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_size number
The size of the image file in bytes.
file_url string
The URL to access the image file.
full_url string
The full URL to access the image file, including any necessary authentication or parameters.
images_count integer
The number of images attached to this record.
vmrs_reason_for_repair object
account_id int32
alias string
code string
enabled boolean
id int32
name string
repair_type string
standard boolean
standard_name string
type string
vmrs_standard_reason_for_repair object
vmrs_system_group object
account_id number
assembly_code string
assembly_name string
code_type string
Possible values: [system_group, system, assembly, component]
component_code string
component_name string
enabled boolean
id int32
permissions object
destroy boolean
standard boolean
system_code string
system_group string
system_group_code string
system_name string
type string
vmrs_standard_system_assembly_component object
vmrs_system object
account_id number
assembly_code string
assembly_name string
code_type string
Possible values: [system_group, system, assembly, component]
component_code string
component_name string
enabled boolean
id int32
permissions object
destroy boolean
standard boolean
system_code string
system_group string
system_group_code string
system_name string
type string
vmrs_standard_system_assembly_component object
vmrs_assembly object
account_id number
assembly_code string
assembly_name string
code_type string
Possible values: [system_group, system, assembly, component]
component_code string
component_name string
enabled boolean
id int32
permissions object
destroy boolean
standard boolean
system_code string
system_group string
system_group_code string
system_name string
type string
vmrs_standard_system_assembly_component object
vmrs_component object
account_id number
assembly_code string
assembly_name string
code_type string
Possible values: [system_group, system, assembly, component]
component_code string
component_name string
enabled boolean
id int32
permissions object
destroy boolean
standard boolean
system_code string
system_group string
system_group_code string
system_name string
type string
vmrs_standard_system_assembly_component object
work_order_sub_line_items object[]
oneOf
Work Order Sub Line Item
Work Order Sub Line Item
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
description string
The description of the sub line item.
item_id integer
Possible values: >= 1
item_type string
Possible values: [Contact]
work_order_line_item_id NullableId
Possible values: >= 1
quantity float
The quantity of this sub line item.
part_location_detail_id NullableId
Possible values: >= 1
position integer
The position of this sub line item in a list of sub line items.
item_name string
The name of this sub line item.
unit_cost float
The unit cost of this sub line item.
contact object
A Contact
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
archived_at date-time
The date and time at which this Contact was archived.
email string
The Contact's email address.
name string
The Contact's full name.
first_name string
The Contact's first name.
middle_name string
The Contact's middle name.
last_name string
The Contact's last name.
group_id integer
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_name string
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchy string
If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
technician boolean
Whether or not the Contact is a Technician.
vehicle_operator boolean
Whether or not the Contact is a Vehicle Operator.
employee boolean
Whether or not the Contact is an Employee.
birth_date date
The Contact's birth date.
street_address string
The Contact's street address.
street_address_line_2 string
The Contact's street address line 2.
city string
The Contact's city.
region string
The Contact's region, state, or province.
postal_code string
The Contact's postal code, zip code, or equivalent.
country string
The Contact's country.
employee_number string
The Contact's employee number.
job_title string
Possible values: <= 255 characters
The Contact's job title.
license_class string
The Contact's driver's license class.
license_number string
The Contact's driver's license number.
license_state string
The locality which issued the Contact's license.
home_phone_number string
The Contact's home phone number.
mobile_phone_number string
The Contact's mobile phone number.
work_phone_number string
The Contact's work phone number.
other_phone_number string
Any other phone number for this Contact.
start_date date
When the Contact started working for the company, if applicable.
leave_date date
When the Contact left or will leave the company, if applicable.
hourly_labor_rate float
The Contact's hourly rate.
custom_fields object
*Full details on working with Custom Fields here.
attachment_permissions object
read_photos boolean
Indicates whether the user has read permission for photos.
manage_photos boolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents boolean
Indicates whether the user has read permission for documents.
manage_documents boolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url string
The URL of the Contact's default image/profile photo, if any.
user object
If the Contact is a Fleetio User, those details will be included here.
account_membership_id NullableId
Possible values: >= 1
comments object[]
A list of the comments made on this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
commentable_type CommentableType
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
commentable_id integer
Possible values: >= 1
user_id integer
Possible values: >= 1
title string deprecated
The title of the Comment.
comment string
The content of the Comment message body.
user_full_name string
The full name of the User who created the Comment.
user_image_url string
The image url for the User who created the Comment.
rich_content object
html_content string
The comment message body rendered as HTML.
with_mentions boolean
Indicates if the message body contains @mentions.
comments_count integer
The number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
documentable_id integer
Possible values: >= 1
documentable_type DocumentableType
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]
file_name string
The name of the file.
file_mime_type string
The MIME type of the file.
file_size number
The size of the file in bytes.
file_url string
The URL to access the file.
full_file_url string
The full URL to access the file, including any necessary authentication or parameters.
documents_count integer
The number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
imageable_id integer
Possible values: >= 1
imageable_type ImageableType
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_name string
The name of the image file.
file_mime_type Image MIME Type
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/gif, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_size number
The size of the image file in bytes.
file_url string
The URL to access the image file.
full_url string
The full URL to access the image file, including any necessary authentication or parameters.
images_count integer
The number of images attached to this record.
labor_time_entries object[]
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
contact_id integer
Possible values: >= 1
data object
duration_in_seconds int32
ended_at date-time
laborable_id integer
Possible values: >= 1
laborable_type string
Possible values: [WorkOrderSubLineItem]
started_at date-time
labor_time_entries object[]
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
contact_id integer
Possible values: >= 1
data object
duration_in_seconds int32
ended_at date-time
laborable_id integer
Possible values: >= 1
laborable_type string
Possible values: [WorkOrderSubLineItem]
started_at date-time
meter_entry object
A Meter Entry
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
auto_voided_at date-time
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
category string
Possible values: [starting, ending, nightly, manual]
A category to describe the function of this Meter Entry.
meter_type string
Possible values: [secondary]
Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableId
Possible values: >= 1
meterable_type string
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
The type of the object with which this Meter Entry is associated.
value string
The current value of the meter.
vehicle_id NullableId
Possible values: >= 1
void boolean
Default value: false
Indicates whether or not this Meter Entry has been voided.
type string
Possible values: [GpsMeterEntry]
date date
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
starting_meter_entry object
A Meter Entry
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
auto_voided_at date-time
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
category string
Possible values: [starting, ending, nightly, manual]
A category to describe the function of this Meter Entry.
meter_type string
Possible values: [secondary]
Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableId
Possible values: >= 1
meterable_type string
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
The type of the object with which this Meter Entry is associated.
value string
The current value of the meter.
vehicle_id NullableId
Possible values: >= 1
void boolean
Default value: false
Indicates whether or not this Meter Entry has been voided.
type string
Possible values: [GpsMeterEntry]
date date
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
ending_meter_entry object
A Meter Entry
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
auto_voided_at date-time
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
category string
Possible values: [starting, ending, nightly, manual]
A category to describe the function of this Meter Entry.
meter_type string
Possible values: [secondary]
Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableId
Possible values: >= 1
meterable_type string
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
The type of the object with which this Meter Entry is associated.
value string
The current value of the meter.
vehicle_id NullableId
Possible values: >= 1
void boolean
Default value: false
Indicates whether or not this Meter Entry has been voided.
type string
Possible values: [GpsMeterEntry]
date date
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
secondary_meter_entry object
A Meter Entry
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
auto_voided_at date-time
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
category string
Possible values: [starting, ending, nightly, manual]
A category to describe the function of this Meter Entry.
meter_type string
Possible values: [secondary]
Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableId
Possible values: >= 1
meterable_type string
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
The type of the object with which this Meter Entry is associated.
value string
The current value of the meter.
vehicle_id NullableId
Possible values: >= 1
void boolean
Default value: false
Indicates whether or not this Meter Entry has been voided.
type string
Possible values: [GpsMeterEntry]
date date
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
starting_secondary_meter_entry object
A Meter Entry
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
auto_voided_at date-time
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
category string
Possible values: [starting, ending, nightly, manual]
A category to describe the function of this Meter Entry.
meter_type string
Possible values: [secondary]
Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableId
Possible values: >= 1
meterable_type string
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
The type of the object with which this Meter Entry is associated.
value string
The current value of the meter.
vehicle_id NullableId
Possible values: >= 1
void boolean
Default value: false
Indicates whether or not this Meter Entry has been voided.
type string
Possible values: [GpsMeterEntry]
date date
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
ending_secondary_meter_entry object
A Meter Entry
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
auto_voided_at date-time
The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.
category string
Possible values: [starting, ending, nightly, manual]
A category to describe the function of this Meter Entry.
meter_type string
Possible values: [secondary]
Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableId
Possible values: >= 1
meterable_type string
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
The type of the object with which this Meter Entry is associated.
value string
The current value of the meter.
vehicle_id NullableId
Possible values: >= 1
void boolean
Default value: false
Indicates whether or not this Meter Entry has been voided.
type string
Possible values: [GpsMeterEntry]
date date
The date on which this Meter Entry was recorded. Formatted according to ISO-8601.
attachment_permissions object
read_photos boolean
Indicates whether the user has read permission for photos.
manage_photos boolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents boolean
Indicates whether the user has read permission for documents.
manage_documents boolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
vmrs_repair_priority_class object
The VMRS Repair Priority Class associated with this Work Order.
id integer
The ID of the VMRS Repair Priority Class.
code string
The code of the VMRS Repair Priority Class.
name string
The name of the VMRS Repair Priority Class.
color string
The color of the VMRS Repair Priority Class.
labels string[]
Any labels applied to this Work Order.
issues object[]
Any Issues associated with this Work Order.
id integer
The ID of the Issue.
name string
The name of the Issue.
currency string
Default value: USD
The currency code used for monetary values in this Work Order.
tax_free_labor boolean
Indicates whether or not to include labor subtotals in tax calculations.
discount_type DiscountType
Possible values: [fixed, percentage]
Default value: percentage
The type of discount applied to this record.
discount_percentage object
The discount percentage. This field should be present when discount_type
is set to percentage.
anyOf
MOD1
MOD2
number float
discount_cents object
The discount amount in cents.
anyOf
MOD1
MOD2
integer
discount object
The discount amount.
anyOf
MOD1
MOD2
number float
labor_subtotal object
The total cost of labor for this record.
anyOf
MOD1
MOD2
number
labor_subtotal_cents int32
The total cost of labor in cents.
parts_subtotal object
The total cost of parts for this record.
anyOf
MOD1
MOD2
number
parts_subtotal_cents int32
The total cost of parts in cents.
subtotal object
The pre-tax subtotal amount.
anyOf
MOD1
MOD2
number float
subtotal_cents object
The pre-tax subtotal amount in cents.
anyOf
MOD1
MOD2
integer
tax_1_type string
Possible values: [fixed, percentage]
Default value: percentage
The type of tax to apply to this record.
tax_1_percentage object
The primary tax percentage amount. This field should be present when tax_1_type is set to percentage.
anyOf
MOD1
MOD2
number float
tax_1_cents integer
The primary tax amount in cents.
tax_2_type string
Possible values: [fixed, percentage]
Default value: percentage
The type of tax to apply to this record.
tax_2_percentage object
The secondary tax percentage amount. This field should be present when tax_2_type is set to percentage. Note that this secondary tax must be configured in your Account Settings.
anyOf
MOD1
MOD2
number float
tax_2_cents object
The secondary tax amount in cents.
oneOf
MOD1
MOD2
string
tax_1 object
The primary tax amount.
anyOf
MOD1
MOD2
number float
tax_2 object
The secondary tax amount. Note that this secondary tax must be configured in your Account Settings.
anyOf
MOD1
MOD2
number float
total_amount object
The total amount.
anyOf
MOD1
MOD2
number
total_amount_cents object
The total amount in cents.
anyOf
MOD1
MOD2
number
watchers_count int32
The count of watchers associated with the record.
watchable_options object
Options related to watching the record.
bulk_watch_record boolean
Indicates if a bulk watch record is created.
skip_automatic_watchers_callbacks boolean
Indicates if automatic watchers callbacks are skipped.
is_watched boolean
Indicates whether the record is being watched.
comments object[]
A list of the comments made on this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
commentable_type CommentableType
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
commentable_id integer
Possible values: >= 1
user_id integer
Possible values: >= 1
title string deprecated
The title of the Comment.
comment string
The content of the Comment message body.
user_full_name string
The full name of the User who created the Comment.
user_image_url string
The image url for the User who created the Comment.
rich_content object
html_content string
The comment message body rendered as HTML.
with_mentions boolean
Indicates if the message body contains @mentions.
comments_count integer
The number of comments made on this record.
images object[]
A list of the images attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
imageable_id integer
Possible values: >= 1
imageable_type ImageableType
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_name string
The name of the image file.
file_mime_type Image MIME Type
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/gif, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_size number
The size of the image file in bytes.
file_url string
The URL to access the image file.
full_url string
The full URL to access the image file, including any necessary authentication or parameters.
images_count integer
The number of images attached to this record.
documents object[]
A list of the documents attached to this record.
id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
documentable_id integer
Possible values: >= 1
documentable_type DocumentableType
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]
file_name string
The name of the file.
file_mime_type string
The MIME type of the file.
file_size number
The size of the file in bytes.
file_url string
The URL to access the file.
full_file_url string
The full URL to access the file, including any necessary authentication or parameters.
documents_count integer
The number of documents attached to this record.

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "number": "string",
  "completed_at": "2023-03-14T13:46:27-06:00",
  "description": "string",
  "ending_meter_same_as_start": true,
  "duration_in_seconds": 0,
  "invoice_number": "string",
  "state": "active",
  "issued_at": "2023-03-14T13:46:27-06:00",
  "issued_by_id": 0,
  "issued_by_name": "string",
  "contact_id": 0,
  "contact_name": "string",
  "purchase_order_number": "string",
  "started_at": "2023-03-14T13:46:27-06:00",
  "work_order_sub_line_items": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "description": "string",
      "item_id": 0,
      "item_type": "Contact",
      "work_order_line_item_id": 0,
      "quantity": 0,
      "part_location_detail_id": 0,
      "position": 0,
      "item_name": "string",
      "unit_cost": 0,
      "contact": {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "archived_at": "2023-03-14T13:46:27-06:00",
        "email": "string",
        "name": "string",
        "first_name": "string",
        "middle_name": "string",
        "last_name": "string",
        "group_id": 0,
        "group_name": "string",
        "group_hierarchy": "Group 1|Group 2|Group 3",
        "technician": true,
        "vehicle_operator": true,
        "employee": true,
        "birth_date": "2023-03-14",
        "street_address": "123 Main St",
        "street_address_line_2": "Apt 1",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string",
        "employee_number": "string",
        "job_title": "string",
        "license_class": "string",
        "license_number": "string",
        "license_state": "string",
        "home_phone_number": "string",
        "mobile_phone_number": "string",
        "work_phone_number": "string",
        "other_phone_number": "string",
        "start_date": "2023-11-30",
        "leave_date": "2023-11-30",
        "hourly_labor_rate": 0,
        "custom_fields": {},
        "attachment_permissions": {
          "read_photos": true,
          "manage_photos": true,
          "read_documents": true,
          "manage_documents": true
        },
        "default_image_url": "string",
        "user": {},
        "account_membership_id": 0,
        "comments": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "commentable_type": "Contact",
            "commentable_id": 0,
            "user_id": 0,
            "comment": "string",
            "user_full_name": "string",
            "user_image_url": "string",
            "rich_content": {},
            "html_content": "string",
            "with_mentions": true
          }
        ],
        "comments_count": 0,
        "documents": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "documentable_id": 0,
            "documentable_type": "ServiceEntry",
            "file_name": "string",
            "file_mime_type": "string",
            "file_size": 0,
            "file_url": "string",
            "full_file_url": "string"
          }
        ],
        "documents_count": 0,
        "images": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "imageable_id": 0,
            "imageable_type": "ExpenseEntry",
            "file_name": "string",
            "file_mime_type": "image/jpeg",
            "file_size": 0,
            "file_url": "string",
            "full_url": "string"
          }
        ],
        "images_count": 0
      },
      "labor_time_entries": [
        {
          "id": 0,
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "contact_id": 0,
          "data": {},
          "duration_in_seconds": 0,
          "ended_at": "2023-03-14T13:46:27-06:00",
          "laborable_id": 0,
          "laborable_type": "WorkOrderSubLineItem",
          "started_at": "2023-03-14T13:46:27-06:00"
        }
      ]
    },
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "description": "string",
      "item_id": 0,
      "item_type": "Part",
      "work_order_line_item_id": 0,
      "quantity": 0,
      "part_location_detail_id": 0,
      "position": 0,
      "item_name": "string",
      "unit_cost": 0,
      "part": {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "description": "string",
        "manufacturer_part_number": "string",
        "measurement_unit_id": 0,
        "number": "string",
        "part_category_id": 0,
        "part_manufacturer_id": 0,
        "upc": "string",
        "total_quantity": 0,
        "custom_fields": {},
        "inventory_item": true,
        "part_category": {
          "id": 0,
          "tire_category": true
        },
        "part_category_name": "string",
        "part_manufacturer_name": "string",
        "measurement_unit_name": "string",
        "unit_cost": 0,
        "average_unit_cost": 0,
        "part_locations": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "active": true,
            "aisle": "string",
            "available_quantity": 0,
            "bin": "string",
            "inventory_sets_count": 0,
            "has_been_used_in_work_orders": true,
            "part_location_name": "string",
            "quantity_allocated_to_work_orders": 0,
            "quantity_on_order": 0,
            "reorder_point": 0,
            "reorder_point_enabled": true,
            "row": "string",
            "track_inventory": true,
            "available_quantity_updated_at": "2023-03-14T13:46:27-06:00",
            "part_location_archived_at": "2023-11-30"
          }
        ],
        "part_location_name": "string",
        "part_location_id": 0,
        "aisle": "string",
        "row": "string",
        "bin": "string",
        "default_image_url": "string",
        "default_image_url_medium": "string",
        "default_image_url_small": "string",
        "default_image_url_large": "string",
        "archived_at": "2023-03-14T13:46:27-06:00",
        "attachment_permissions": {
          "read_photos": true,
          "manage_photos": true,
          "read_documents": true,
          "manage_documents": true
        },
        "measurement_unit": {
          "id": 0,
          "name": "string",
          "description": "string",
          "symbol": "string"
        },
        "has_active_inventory_sets": true,
        "tire_config": {
          "id": 0,
          "account_id": 0,
          "part_id": 0,
          "aspect_ratio": 0,
          "rim_diameter": 0,
          "load_index": 0,
          "metric_type": "EU",
          "width": 0,
          "construction": "B",
          "speed_rating": "A1"
        },
        "comments": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "commentable_type": "Contact",
            "commentable_id": 0,
            "user_id": 0,
            "comment": "string",
            "user_full_name": "string",
            "user_image_url": "string",
            "rich_content": {},
            "html_content": "string",
            "with_mentions": true
          }
        ],
        "comments_count": 0,
        "documents": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "documentable_id": 0,
            "documentable_type": "ServiceEntry",
            "file_name": "string",
            "file_mime_type": "string",
            "file_size": 0,
            "file_url": "string",
            "full_file_url": "string"
          }
        ],
        "documents_count": 0,
        "images": [
          {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "imageable_id": 0,
            "imageable_type": "ExpenseEntry",
            "file_name": "string",
            "file_mime_type": "image/jpeg",
            "file_size": 0,
            "file_url": "string",
            "full_url": "string"
          }
        ],
        "images_count": 0
      }
    }
  ],
  "vehicle_archived_at": "2023-03-14T13:46:27-06:00",
  "send_email_notification_to_assignee": true,
  "fees_cents": 0,
  "scheduled_at": "2023-03-14T13:46:27-06:00",
  "vehicle_id": 0,
  "vehicle_name": "string",
  "vendor_id": 0,
  "vendor_name": "string",
  "work_order_status_id": 0,
  "work_order_status_name": "string",
  "work_order_status_color": "string",
  "custom_fields": {},
  "work_order_line_items": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "labor_cost": 1.23,
      "parts_cost": 1.23,
      "parts_cost_cents": "string",
      "labor_cost_cents": "string",
      "subtotal": 1.23,
      "subtotal_cents": 1.23,
      "description": "string",
      "title": "string",
      "item_id": 0,
      "item_type": "Issue",
      "work_order_line_item_id": 0,
      "item_name": "string",
      "position": 0,
      "issues": [
        {
          "id": 0,
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "number": "string",
          "name": "string",
          "summary": "string",
          "description": "string",
          "state": "Open",
          "reported_at": "2023-03-14T13:46:27-06:00",
          "reported_by_id": 0,
          "reported_by_name": "string",
          "fault_id": 0,
          "due_date": "2023-03-14",
          "due_meter_value": "string",
          "due_secondary_meter_value": 0,
          "overdue": true,
          "vehicle_id": 0,
          "vehicle_name": "string",
          "is_sample": true,
          "created_by_workflow": true,
          "submitted_inspection_form_id": 0,
          "custom_fields": {},
          "valid_required_custom_fields": true,
          "dtc_alert_id": 0,
          "assigned_contacts": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "archived_at": "2023-03-14T13:46:27-06:00",
              "email": "string",
              "name": "string",
              "first_name": "string",
              "middle_name": "string",
              "last_name": "string",
              "group_id": 0,
              "group_name": "string",
              "group_hierarchy": "Group 1|Group 2|Group 3",
              "technician": true,
              "vehicle_operator": true,
              "employee": true,
              "birth_date": "2023-03-14",
              "street_address": "123 Main St",
              "street_address_line_2": "Apt 1",
              "city": "string",
              "region": "string",
              "postal_code": "string",
              "country": "string",
              "employee_number": "string",
              "job_title": "string",
              "license_class": "string",
              "license_number": "string",
              "license_state": "string",
              "home_phone_number": "string",
              "mobile_phone_number": "string",
              "work_phone_number": "string",
              "other_phone_number": "string",
              "start_date": "2023-11-30",
              "leave_date": "2023-11-30",
              "hourly_labor_rate": 0,
              "custom_fields": {},
              "attachment_permissions": {
                "read_photos": true,
                "manage_photos": true,
                "read_documents": true,
                "manage_documents": true
              },
              "default_image_url": "string",
              "user": {},
              "account_membership_id": 0,
              "comments": [
                {
                  "id": 0,
                  "created_at": "2023-03-14T13:46:27-06:00",
                  "updated_at": "2023-03-14T13:46:27-06:00",
                  "commentable_type": "Contact",
                  "commentable_id": 0,
                  "user_id": 0,
                  "comment": "string",
                  "user_full_name": "string",
                  "user_image_url": "string",
                  "rich_content": {},
                  "html_content": "string",
                  "with_mentions": true
                }
              ],
              "comments_count": 0,
              "documents": [
                {
                  "id": 0,
                  "created_at": "2023-03-14T13:46:27-06:00",
                  "updated_at": "2023-03-14T13:46:27-06:00",
                  "documentable_id": 0,
                  "documentable_type": "ServiceEntry",
                  "file_name": "string",
                  "file_mime_type": "string",
                  "file_size": 0,
                  "file_url": "string",
                  "full_file_url": "string"
                }
              ],
              "documents_count": 0,
              "images": [
                {
                  "id": 0,
                  "created_at": "2023-03-14T13:46:27-06:00",
                  "updated_at": "2023-03-14T13:46:27-06:00",
                  "imageable_id": 0,
                  "imageable_type": "ExpenseEntry",
                  "file_name": "string",
                  "file_mime_type": "image/jpeg",
                  "file_size": 0,
                  "file_url": "string",
                  "full_url": "string"
                }
              ],
              "images_count": 0
            }
          ],
          "reported_by": {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "archived_at": "2023-03-14T13:46:27-06:00",
            "email": "string",
            "name": "string",
            "first_name": "string",
            "middle_name": "string",
            "last_name": "string",
            "group_id": 0,
            "group_name": "string",
            "group_hierarchy": "Group 1|Group 2|Group 3",
            "technician": true,
            "vehicle_operator": true,
            "employee": true,
            "birth_date": "2023-03-14",
            "street_address": "123 Main St",
            "street_address_line_2": "Apt 1",
            "city": "string",
            "region": "string",
            "postal_code": "string",
            "country": "string",
            "employee_number": "string",
            "job_title": "string",
            "license_class": "string",
            "license_number": "string",
            "license_state": "string",
            "home_phone_number": "string",
            "mobile_phone_number": "string",
            "work_phone_number": "string",
            "other_phone_number": "string",
            "start_date": "2023-11-30",
            "leave_date": "2023-11-30",
            "hourly_labor_rate": 0,
            "custom_fields": {},
            "attachment_permissions": {
              "read_photos": true,
              "manage_photos": true,
              "read_documents": true,
              "manage_documents": true
            },
            "default_image_url": "string",
            "user": {},
            "account_membership_id": 0,
            "comments": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "commentable_type": "Contact",
                "commentable_id": 0,
                "user_id": 0,
                "comment": "string",
                "user_full_name": "string",
                "user_image_url": "string",
                "rich_content": {},
                "html_content": "string",
                "with_mentions": true
              }
            ],
            "comments_count": 0,
            "documents": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "documentable_id": 0,
                "documentable_type": "ServiceEntry",
                "file_name": "string",
                "file_mime_type": "string",
                "file_size": 0,
                "file_url": "string",
                "full_file_url": "string"
              }
            ],
            "documents_count": 0,
            "images": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "imageable_id": 0,
                "imageable_type": "ExpenseEntry",
                "file_name": "string",
                "file_mime_type": "image/jpeg",
                "file_size": 0,
                "file_url": "string",
                "full_url": "string"
              }
            ],
            "images_count": 0
          },
          "labels": [
            [
              {
                "id": 0,
                "name": "string"
              }
            ]
          ],
          "attachment_permissions": {
            "read_photos": true,
            "manage_photos": true,
            "read_documents": true,
            "manage_documents": true
          },
          "vehicle_image_url": "string",
          "vehicle_image_url_medium": "string",
          "vehicle_image_url_small": "string",
          "vehicle_image_url_large": "string",
          "watchers_count": 0,
          "linked_work_orders": [
            {
              "id": 0,
              "number": 0,
              "issued_at": "2023-11-30"
            }
          ],
          "source": {
            "inspection_form": {
              "id": 0,
              "color": "string",
              "title": "string"
            },
            "inspection_submissions_count": 0,
            "last_inspection_submission_at": "2023-11-30",
            "failed_inspection_item_label": "string"
          },
          "comments": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "commentable_type": "Contact",
              "commentable_id": 0,
              "user_id": 0,
              "comment": "string",
              "user_full_name": "string",
              "user_image_url": "string",
              "rich_content": {},
              "html_content": "string",
              "with_mentions": true
            }
          ],
          "comments_count": 0,
          "documents": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "documentable_id": 0,
              "documentable_type": "ServiceEntry",
              "file_name": "string",
              "file_mime_type": "string",
              "file_size": 0,
              "file_url": "string",
              "full_file_url": "string"
            }
          ],
          "documents_count": 0,
          "images": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "imageable_id": 0,
              "imageable_type": "ExpenseEntry",
              "file_name": "string",
              "file_mime_type": "image/jpeg",
              "file_size": 0,
              "file_url": "string",
              "full_url": "string"
            }
          ],
          "images_count": 0
        }
      ],
      "vmrs_reason_for_repair": {
        "account_id": 0,
        "alias": "string",
        "code": "string",
        "enabled": true,
        "id": 0,
        "name": "string",
        "repair_type": "string",
        "standard": true,
        "standard_name": "string",
        "type": "string",
        "vmrs_standard_reason_for_repair": {}
      },
      "vmrs_system_group": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      },
      "vmrs_system": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      },
      "vmrs_assembly": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      },
      "vmrs_component": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      },
      "work_order_sub_line_items": [
        {
          "id": 0,
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "description": "string",
          "item_id": 0,
          "item_type": "Contact",
          "work_order_line_item_id": 0,
          "quantity": 0,
          "part_location_detail_id": 0,
          "position": 0,
          "item_name": "string",
          "unit_cost": 0,
          "contact": {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "archived_at": "2023-03-14T13:46:27-06:00",
            "email": "string",
            "name": "string",
            "first_name": "string",
            "middle_name": "string",
            "last_name": "string",
            "group_id": 0,
            "group_name": "string",
            "group_hierarchy": "Group 1|Group 2|Group 3",
            "technician": true,
            "vehicle_operator": true,
            "employee": true,
            "birth_date": "2023-03-14",
            "street_address": "123 Main St",
            "street_address_line_2": "Apt 1",
            "city": "string",
            "region": "string",
            "postal_code": "string",
            "country": "string",
            "employee_number": "string",
            "job_title": "string",
            "license_class": "string",
            "license_number": "string",
            "license_state": "string",
            "home_phone_number": "string",
            "mobile_phone_number": "string",
            "work_phone_number": "string",
            "other_phone_number": "string",
            "start_date": "2023-11-30",
            "leave_date": "2023-11-30",
            "hourly_labor_rate": 0,
            "custom_fields": {},
            "attachment_permissions": {
              "read_photos": true,
              "manage_photos": true,
              "read_documents": true,
              "manage_documents": true
            },
            "default_image_url": "string",
            "user": {},
            "account_membership_id": 0,
            "comments": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "commentable_type": "Contact",
                "commentable_id": 0,
                "user_id": 0,
                "comment": "string",
                "user_full_name": "string",
                "user_image_url": "string",
                "rich_content": {},
                "html_content": "string",
                "with_mentions": true
              }
            ],
            "comments_count": 0,
            "documents": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "documentable_id": 0,
                "documentable_type": "ServiceEntry",
                "file_name": "string",
                "file_mime_type": "string",
                "file_size": 0,
                "file_url": "string",
                "full_file_url": "string"
              }
            ],
            "documents_count": 0,
            "images": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "imageable_id": 0,
                "imageable_type": "ExpenseEntry",
                "file_name": "string",
                "file_mime_type": "image/jpeg",
                "file_size": 0,
                "file_url": "string",
                "full_url": "string"
              }
            ],
            "images_count": 0
          },
          "labor_time_entries": [
            {
              "id": 0,
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00",
              "contact_id": 0,
              "data": {},
              "duration_in_seconds": 0,
              "ended_at": "2023-03-14T13:46:27-06:00",
              "laborable_id": 0,
              "laborable_type": "WorkOrderSubLineItem",
              "started_at": "2023-03-14T13:46:27-06:00"
            }
          ]
        },
        {
          "id": 0,
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "description": "string",
          "item_id": 0,
          "item_type": "Part",
          "work_order_line_item_id": 0,
          "quantity": 0,
          "part_location_detail_id": 0,
          "position": 0,
          "item_name": "string",
          "unit_cost": 0,
          "part": {
            "id": 0,
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "description": "string",
            "manufacturer_part_number": "string",
            "measurement_unit_id": 0,
            "number": "string",
            "part_category_id": 0,
            "part_manufacturer_id": 0,
            "upc": "string",
            "total_quantity": 0,
            "custom_fields": {},
            "inventory_item": true,
            "part_category": {
              "id": 0,
              "tire_category": true
            },
            "part_category_name": "string",
            "part_manufacturer_name": "string",
            "measurement_unit_name": "string",
            "unit_cost": 0,
            "average_unit_cost": 0,
            "part_locations": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "active": true,
                "aisle": "string",
                "available_quantity": 0,
                "bin": "string",
                "inventory_sets_count": 0,
                "has_been_used_in_work_orders": true,
                "part_location_name": "string",
                "quantity_allocated_to_work_orders": 0,
                "quantity_on_order": 0,
                "reorder_point": 0,
                "reorder_point_enabled": true,
                "row": "string",
                "track_inventory": true,
                "available_quantity_updated_at": "2023-03-14T13:46:27-06:00",
                "part_location_archived_at": "2023-11-30"
              }
            ],
            "part_location_name": "string",
            "part_location_id": 0,
            "aisle": "string",
            "row": "string",
            "bin": "string",
            "default_image_url": "string",
            "default_image_url_medium": "string",
            "default_image_url_small": "string",
            "default_image_url_large": "string",
            "archived_at": "2023-03-14T13:46:27-06:00",
            "attachment_permissions": {
              "read_photos": true,
              "manage_photos": true,
              "read_documents": true,
              "manage_documents": true
            },
            "measurement_unit": {
              "id": 0,
              "name": "string",
              "description": "string",
              "symbol": "string"
            },
            "has_active_inventory_sets": true,
            "tire_config": {
              "id": 0,
              "account_id": 0,
              "part_id": 0,
              "aspect_ratio": 0,
              "rim_diameter": 0,
              "load_index": 0,
              "metric_type": "EU",
              "width": 0,
              "construction": "B",
              "speed_rating": "A1"
            },
            "comments": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "commentable_type": "Contact",
                "commentable_id": 0,
                "user_id": 0,
                "comment": "string",
                "user_full_name": "string",
                "user_image_url": "string",
                "rich_content": {},
                "html_content": "string",
                "with_mentions": true
              }
            ],
            "comments_count": 0,
            "documents": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "documentable_id": 0,
                "documentable_type": "ServiceEntry",
                "file_name": "string",
                "file_mime_type": "string",
                "file_size": 0,
                "file_url": "string",
                "full_file_url": "string"
              }
            ],
            "documents_count": 0,
            "images": [
              {
                "id": 0,
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00",
                "imageable_id": 0,
                "imageable_type": "ExpenseEntry",
                "file_name": "string",
                "file_mime_type": "image/jpeg",
                "file_size": 0,
                "file_url": "string",
                "full_url": "string"
              }
            ],
            "images_count": 0
          }
        }
      ]
    }
  ],
  "labor_time_entries": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "contact_id": 0,
      "data": {},
      "duration_in_seconds": 0,
      "ended_at": "2023-03-14T13:46:27-06:00",
      "laborable_id": 0,
      "laborable_type": "WorkOrderSubLineItem",
      "started_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "meter_entry": {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "category": "starting",
    "meter_type": "secondary",
    "meterable_id": 0,
    "meterable_type": "FuelEntry",
    "value": "string",
    "vehicle_id": 0,
    "void": false,
    "type": "GpsMeterEntry",
    "date": "2023-03-14"
  },
  "starting_meter_entry": {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "category": "starting",
    "meter_type": "secondary",
    "meterable_id": 0,
    "meterable_type": "FuelEntry",
    "value": "string",
    "vehicle_id": 0,
    "void": false,
    "type": "GpsMeterEntry",
    "date": "2023-03-14"
  },
  "ending_meter_entry": {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "category": "starting",
    "meter_type": "secondary",
    "meterable_id": 0,
    "meterable_type": "FuelEntry",
    "value": "string",
    "vehicle_id": 0,
    "void": false,
    "type": "GpsMeterEntry",
    "date": "2023-03-14"
  },
  "secondary_meter_entry": {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "category": "starting",
    "meter_type": "secondary",
    "meterable_id": 0,
    "meterable_type": "FuelEntry",
    "value": "string",
    "vehicle_id": 0,
    "void": false,
    "type": "GpsMeterEntry",
    "date": "2023-03-14"
  },
  "starting_secondary_meter_entry": {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "category": "starting",
    "meter_type": "secondary",
    "meterable_id": 0,
    "meterable_type": "FuelEntry",
    "value": "string",
    "vehicle_id": 0,
    "void": false,
    "type": "GpsMeterEntry",
    "date": "2023-03-14"
  },
  "ending_secondary_meter_entry": {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "category": "starting",
    "meter_type": "secondary",
    "meterable_id": 0,
    "meterable_type": "FuelEntry",
    "value": "string",
    "vehicle_id": 0,
    "void": false,
    "type": "GpsMeterEntry",
    "date": "2023-03-14"
  },
  "attachment_permissions": {
    "read_photos": true,
    "manage_photos": true,
    "read_documents": true,
    "manage_documents": true
  },
  "vmrs_repair_priority_class": {
    "id": 0,
    "code": "string",
    "name": "string",
    "color": "string"
  },
  "labels": [
    "string"
  ],
  "issues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "currency": "USD",
  "tax_free_labor": true,
  "discount_type": "percentage",
  "discount_percentage": 1.23,
  "discount_cents": 1.23,
  "discount": 1.23,
  "labor_subtotal": 1.23,
  "labor_subtotal_cents": 0,
  "parts_subtotal": 1.23,
  "parts_subtotal_cents": 0,
  "subtotal": 1.23,
  "subtotal_cents": 1.23,
  "tax_1_type": "percentage",
  "tax_1_percentage": 1.23,
  "tax_1_cents": 123,
  "tax_2_type": "percentage",
  "tax_2_percentage": 1.23,
  "tax_2_cents": "123",
  "tax_1": 1.23,
  "tax_2": 1.23,
  "total_amount": 1.23,
  "total_amount_cents": 123,
  "watchers_count": 0,
  "watchable_options": {},
  "bulk_watch_record": true,
  "skip_automatic_watchers_callbacks": true,
  "is_watched": true,
  "comments": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "commentable_type": "Contact",
      "commentable_id": 0,
      "user_id": 0,
      "comment": "string",
      "user_full_name": "string",
      "user_image_url": "string",
      "rich_content": {},
      "html_content": "string",
      "with_mentions": true
    }
  ],
  "comments_count": 0,
  "images": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "imageable_id": 0,
      "imageable_type": "ExpenseEntry",
      "file_name": "string",
      "file_mime_type": "image/jpeg",
      "file_size": 0,
      "file_url": "string",
      "full_url": "string"
    }
  ],
  "images_count": 0,
  "documents": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "documentable_id": 0,
      "documentable_type": "ServiceEntry",
      "file_name": "string",
      "file_mime_type": "string",
      "file_size": 0,
      "file_url": "string",
      "full_file_url": "string"
    }
  ],
  "documents_count": 0
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

The requested resource could not be located

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (from schema)
Example

Schema

errors object
type
items string

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}