Create Work Order
Creates a new work order.
- application/json
Request Body
- issued_at date-time required
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 required
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 required
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 topercentage
. - tax_1_percentage float
The percentage of the first tax applied to this Work Order. Used if
tax_1_type
is set topercentage
. - 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 toamount
. - tax_2_percentage float
The percentage of the second tax applied to this Work Order. Used if
tax_2_type
is set topercentage
. - 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 toamount
. - 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 floatThe 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 booleanIf 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 floatThe 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 booleanIf 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 floatThe 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 booleanIf 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 floatThe 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 booleanIf 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 floatThe 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 booleanIf 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 floatThe 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 booleanIf 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 stringThe title of the comment.
comment stringThe comment text.
work_order_line_items_attributes object[]
A list of
Work Order Line Items
to be added to this Work Order.id integerThe ID of this Work Order Line Item. Required if this is a Work Order Line Item being updated.
item_type stringPossible values: [
Issue
,ServiceTask
]The Type of the item associated with this Work Order Line Item.
item_name stringThe name of the item associated with this Work Order Line Item.
description stringA description of this Work Order Line Item.
item_id integerThe ID of the item associated with this Work Order Line Item.
labor_cost floatThe cost of labor of this line item.
parts_cost floatThe cost of
Parts
of this line item.position integerThe position of this line item in a list of line items.
subtotal floatThe subtotal of this line item.
type stringPossible values: [
WorkOrderServiceTaskLineItem
,WorkOrderFreeTextLineItem
]vmrs_reason_for_repair_id integerThe ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integerThe ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integerThe ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integerThe ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integerThe 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 integerThe ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type stringPossible values: [
WorkOrderPartLineItem
,WorkOrderLaborLineItem
]item_id integerThe ID of the
Part
orContact
associated with this Work Order Line Item.item_type stringPossible values: [
Part
,Contact
]quantity floatThe quantity of the
Part
orContact
associated with this Work Order Line Item.part_location_detail_id integerThis ID refers to the details of the
Part
at a specificPart Location
. You can send a GET request tohttps://secure.fleetio.com/api/v1/parts/:id
to get anypart_location_detail_id
(s) for aPart
. Theid
attribute under thepart_locations
object is the value that corresponds to this parameter.position integerThe position of this Work Order Line Item in a list of line items.
description stringThe description of this Work Order Line Item.
inventory_set_id integerThe 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 integerThe ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integerThe ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integerThe ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integerThe ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integerThe ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-timeThe date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-timeThe date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableIdPossible values:
>= 1
work_order_part_line_items_attributes object[]
A list of any
Work Order Part Line Items
to be added.id integerThe ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type stringPossible values: [
WorkOrderPartLineItem
,WorkOrderLaborLineItem
]item_id integerThe ID of the
Part
orContact
associated with this Work Order Line Item.item_type stringPossible values: [
Part
,Contact
]quantity floatThe quantity of the
Part
orContact
associated with this Work Order Line Item.part_location_detail_id integerThis ID refers to the details of the
Part
at a specificPart Location
. You can send a GET request tohttps://secure.fleetio.com/api/v1/parts/:id
to get anypart_location_detail_id
(s) for aPart
. Theid
attribute under thepart_locations
object is the value that corresponds to this parameter.position integerThe position of this Work Order Line Item in a list of line items.
description stringThe description of this Work Order Line Item.
inventory_set_id integerThe 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 integerThe ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integerThe ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integerThe ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integerThe ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integerThe ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-timeThe date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-timeThe date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableIdPossible values:
>= 1
work_order_labor_line_items_attributes object[]
A list of any
Work Order Labor Line Items
to be added.id integerThe ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type stringPossible values: [
WorkOrderPartLineItem
,WorkOrderLaborLineItem
]item_id integerThe ID of the
Part
orContact
associated with this Work Order Line Item.item_type stringPossible values: [
Part
,Contact
]quantity floatThe quantity of the
Part
orContact
associated with this Work Order Line Item.part_location_detail_id integerThis ID refers to the details of the
Part
at a specificPart Location
. You can send a GET request tohttps://secure.fleetio.com/api/v1/parts/:id
to get anypart_location_detail_id
(s) for aPart
. Theid
attribute under thepart_locations
object is the value that corresponds to this parameter.position integerThe position of this Work Order Line Item in a list of line items.
description stringThe description of this Work Order Line Item.
inventory_set_id integerThe 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 integerThe ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integerThe ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integerThe ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integerThe ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integerThe ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-timeThe date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-timeThe date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableIdPossible 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 integerThe ID of this Work Order Sub Line Item. Required if this is a Work Order Sub Line Item being updated.
type stringPossible values: [
WorkOrderPartLineItem
,WorkOrderLaborLineItem
]item_id integerThe ID of the
Part
orContact
associated with this Work Order Line Item.item_type stringPossible values: [
Part
,Contact
]quantity floatThe quantity of the
Part
orContact
associated with this Work Order Line Item.part_location_detail_id integerThis ID refers to the details of the
Part
at a specificPart Location
. You can send a GET request tohttps://secure.fleetio.com/api/v1/parts/:id
to get anypart_location_detail_id
(s) for aPart
. Theid
attribute under thepart_locations
object is the value that corresponds to this parameter.position integerThe position of this Work Order Line Item in a list of line items.
description stringThe description of this Work Order Line Item.
inventory_set_id integerThe 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 integerThe ID of the VMRS Reason for Repair associated with this Work Order Line Item.
vmrs_system_group_id integerThe ID of the VMRS System Group associated with this Work Order Line Item.
vmrs_system_id integerThe ID of the VMRS System associated with this Work Order Line Item.
vmrs_assembly_id integerThe ID of the VMRS Assembly associated with this Work Order Line Item.
vmrs_component_id integerThe ID of the VMRS Component associated with this Work Order Line Item.
labor_time_entries_attributes object[]
started_at date-timeThe date and time at which this Labor Time Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-timeThe date and time at which this Labor Time Entry was ended. We recommend using ISO-8601 formatted dates to avoid ambiguity.
contact_id NullableIdPossible 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.
- 201
- 401
- 403
- 422
- 500
OK
Response Headers
- 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 theUser
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.
- expected_completed_at date-time
The date and time at which the Work Order is expected to be completed.
- contact_image_url string
The URL of the image associated with the
Contact
currently assigned to this Work Order. work_order_sub_line_items object[]
anyOf- Work Order Sub Line Item
- Work Order Sub Line Item
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
description stringThe description of the sub line item.
item_id integerPossible values:
>= 1
item_type stringPossible values: [
Contact
]work_order_line_item_id NullableIdPossible values:
>= 1
quantity floatThe quantity of this sub line item.
part_location_detail_id NullableIdPossible values:
>= 1
position integerThe position of this sub line item in a list of sub line items.
item_name stringThe name of this sub line item.
unit_cost floatThe unit cost of this sub line item.
contact object
A Contact
id integercreated_at date-timeupdated_at date-timeemail stringThe Contact's email address.
name stringThe Contact's full name.
first_name stringThe Contact's first name.
middle_name stringThe Contact's middle name.
last_name stringThe Contact's last name.
images_count integerThe number of images associated with this Contact.
documents_count integerThe number of documents associated with this Contact.
comments_count integerThe number of comments associated with this Contact.
group_id integerIf this Contact belongs to a Group, this will be the Fleetio ID of that
Group
.group_name stringIf this Contact belongs to a Group, this will be the
Group
's name.group_hierarchy stringIf this Contact belongs to a Group, this will be a pipe delimited string representing the
Group
hierarchy. EachGroup
in the list is the parent of theGroups
which follow.technician booleanWhether or not the Contact is a Technician.
vehicle_operator booleanWhether or not the Contact is a Vehicle Operator.
employee booleanWhether or not the Contact is an Employee.
birth_date dateThe Contact's birth date.
street_address stringThe Contact's street address.
street_address_line_2 stringThe Contact's street address line 2.
city stringThe Contact's city.
region stringThe Contact's region, state, or province.
postal_code stringThe Contact's postal code, zip code, or equivalent.
country stringThe Contact's country.
employee_number stringThe Contact's employee number.
job_title stringPossible values:
<= 255 characters
The Contact's job title.
license_class stringThe Contact's driver's license class.
license_number stringThe Contact's driver's license number.
license_state stringThe locality which issued the Contact's license.
license_expiration dateThe Contact's driver's license expiration date.
home_phone_number stringThe Contact's home phone number.
mobile_phone_number stringThe Contact's mobile phone number.
work_phone_number stringThe Contact's work phone number.
other_phone_number stringAny other phone number for this Contact.
start_date dateWhen the Contact started working for the company, if applicable.
leave_date dateWhen the Contact left or will leave the company, if applicable.
hourly_labor_rate floatThe Contact's hourly rate.
custom_fields object*Full details on working with Custom Fields here.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url stringThe URL of the Contact's default image/profile photo, if any.
user objectIf the Contact is a Fleetio
User
, those details will be included here.account_membership_id NullableIdPossible values:
>= 1
labor_time_entries object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
account_id integerPossible values:
>= 1
contact_id integerPossible values:
>= 1
duration_in_seconds integerended_at date-timelaborable_id integerPossible values:
>= 1
laborable_type stringPossible values: [
WorkOrderSubLineItem
]started_at date-timedata object
clock_in_latitude floatclock_in_longitude floatclock_out_latitude floatclock_out_longitude floatactive booleanIndicates whether this Labor Time Entry is active.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
description stringThe description of this sub line item.
item_id integerThe ID of the
Part
associated with this sub line item.item_type stringPossible values: [
Part
]work_order_line_item_id NullableIdPossible values:
>= 1
quantity floatThe quantity of this sub line item.
part_location_detail_id NullableIdPossible values:
>= 1
position integerThe position of this sub line item in a list of sub line items.
item_name stringThe name of this sub line item.
unit_cost floatThe unit cost of this sub line item.
part object
A Part
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
description stringA description of this Part.
manufacturer_part_number stringThe part number from this Part's manufacturer.
measurement_unit_id NullableIdPossible values:
>= 1
number stringThe part number being used for this Part within Fleetio.
part_category_id NullableIdPossible values:
>= 1
part_manufacturer_id NullableIdPossible values:
>= 1
upc stringThe Universal Product Code for this Part.
total_quantity floatThe total quantity on hand for this Part.
custom_fields object*Full details on working with Custom Fields here.
inventory_item booleanIndicates whether or not this Part is an inventory item.
part_category object
id integerPossible values:
>= 1
tire_category booleanIndicates whether part is a tire or not
part_category_name stringThe name of the part category associated with this Part.
part_manufacturer_name stringThe name of the Part's manufacturer.
measurement_unit_name stringThe measurement unit used by this Part.
unit_cost floatThe unit cost for this Part.
average_unit_cost floatThe average unit cost for this Part. FIFO/LIFO accounts only.
part_locations object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
active booleanWhether this Part Location is active.
aisle stringThe aisle in which the Part is located.
available_quantity floatHow many of this Part are available at this Part Location.
bin stringThe bin in which the Part is located.
inventory_sets_count integerThe number of Inventory Sets that this Part is included in. FIFO/LIFO accounts only.
has_been_used_in_work_orders booleanWhether this Part has been used in any Work Orders. FIFO/LIFO accounts only.
name stringAlias of
part_location_name
.part_location_name stringThe name of the Part Location for this Part.
part_location_id integerThe ID of the Part Location for this Part.
quantity_allocated_to_work_orders floatHow many of these Parts are currently allocated to
Work Orders
.quantity_on_order floatHow many of this Part are currently on order, if any.
reorder_point floatThe lower-threshold quantity at which this Part should be reordered.
reorder_point_enabled booleanWhether this Part will be reordered at the reorder point.
row stringThe row in which the Part is located.
track_inventory booleanIndicates whether inventory is tracked for this Part at this location.
available_quantity_updated_at date-timepart_location_archived_at date-timeThe date and time at which the
Part Location
was archived, if applicable.default_image_url stringdefault_image_url_medium stringdefault_image_url_small stringdefault_image_url_large stringarchived_at date-timeThe date and time at which this Part was archived.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
has_active_inventory_sets booleanIndicates whether this Part has any active Inventory Sets. FIFO/LIFO accounts only.
tire_config object
aspect_ratio floatAspect ratio of tire.
rim_diameter floatRim diameter of tire.
load_index floatLoad index of tire.
metric_type stringPossible values: [
EU
,P
,HL
,T
,LT
,C
,ST
]Metric type of tire.
width floatWidth of tire.
construction stringPossible values: [
B
,R
,D
]Construction type of tire.
speed_rating stringPossible values: [
A1
,A2
,A3
,A4
,A5
,A6
,A7
,A8
,B
,C
,D
,E
,F
,G
,H
,J
,K
,L
,M
,N
,P
,Q
,R
,S
,T
,U
,V
,W
,Y
]Speed rating of tire.
factory_tread_depth floatfactory_tread_depth support is currently in private beta.
Tread depth of tire in /32" when new, as specified by the manufacturer.
minimum_tread_depth floatminimum_tread_depth support is currently in private beta.
The legal minimum tread depth, in /32".
life_expectancy integerlife_expectancy support is currently in private beta.
The Life Expectancy or “Warranty” of a tire is the expected meter range, usually measured in miles, of a given tire as specified by the manufacturer.
comments object[]
A list of the comments made on this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
commentable_type CommentableTypePossible 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 integerPossible values:
>= 1
user_id integerPossible values:
>= 1
title string deprecatedThe title of the Comment.
comment stringThe content of the Comment message body.
user_full_name stringThe full name of the
User
who created the Comment.user_image_url stringThe image url for the
User
who created the Comment.rich_content objecthtml_content stringThe comment message body rendered as HTML.
with_mentions booleanIndicates if the message body contains @mentions.
comments_count integerThe number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
documentable_id integerPossible values:
>= 1
documentable_type DocumentableTypePossible values: [
ServiceEntry
,FuelEntry
,Issue
,WorkOrder
,ExpenseEntry
]file_name stringThe name of the file.
file_mime_type stringThe MIME type of the file.
file_size numberThe size of the file in bytes.
file_url stringThe URL to access the file.
full_file_url stringThe full URL to access the file, including any necessary authentication or parameters.
documents_count integerThe number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
imageable_id integerPossible values:
>= 1
imageable_type ImageableTypePossible values: [
ExpenseEntry
,WorkOrder
,Equipment
,IssueResolution
,ServiceEntry
,Vendor
,ServiceProgram
,Issue
,Contact
,Part
,Vehicle
,FuelEntry
,SubmittedInspectionItem
]file_name stringThe name of the image file.
file_mime_type Image MIME TypePossible values: [
image/jpeg
,image/gif
,image/jif
,image/jfif
,image/jfi
,image/tiff
,image/png
,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 numberThe size of the image file in bytes.
file_url stringThe URL to access the image file.
full_url stringThe full URL to access the image file, including any necessary authentication or parameters.
images_count integerThe number of images attached to this record.
- 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 integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
labor_cost floatThe cost of labor units worked.
parts_cost floatThe cost of parts.
parts_cost_cents integerThe parts cost amount in cents.
labor_cost_cents integerThe cost of labor units worked, in cents.
subtotal floatThe pre-tax subtotal amount.
subtotal_cents integerThe pre-tax subtotal amount in cents.
description stringA description of this Work Order Line Item.
title stringThe title of this Work Order Line Item.
item_id integerThe ID of the item associated with this Work Order Line Item.
item_type stringPossible values: [
Issue
,ServiceTask
]The type of item associated with this Work Order Line Item.
work_order_line_item_id integeritem_name stringThe name of the item associated with this Work Order Line Item.
position integerThe 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 integerThe ID of the
Issue
.name stringThe name of the
Issue
.vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectvmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectvmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectvmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectvmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectwork_order_sub_line_items object[]
anyOf- Work Order Sub Line Item
- Work Order Sub Line Item
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
description stringThe description of the sub line item.
item_id integerPossible values:
>= 1
item_type stringPossible values: [
Contact
]work_order_line_item_id NullableIdPossible values:
>= 1
quantity floatThe quantity of this sub line item.
part_location_detail_id NullableIdPossible values:
>= 1
position integerThe position of this sub line item in a list of sub line items.
item_name stringThe name of this sub line item.
unit_cost floatThe unit cost of this sub line item.
contact object
A Contact
id integercreated_at date-timeupdated_at date-timeemail stringThe Contact's email address.
name stringThe Contact's full name.
first_name stringThe Contact's first name.
middle_name stringThe Contact's middle name.
last_name stringThe Contact's last name.
images_count integerThe number of images associated with this Contact.
documents_count integerThe number of documents associated with this Contact.
comments_count integerThe number of comments associated with this Contact.
group_id integerIf this Contact belongs to a Group, this will be the Fleetio ID of that
Group
.group_name stringIf this Contact belongs to a Group, this will be the
Group
's name.group_hierarchy stringIf this Contact belongs to a Group, this will be a pipe delimited string representing the
Group
hierarchy. EachGroup
in the list is the parent of theGroups
which follow.technician booleanWhether or not the Contact is a Technician.
vehicle_operator booleanWhether or not the Contact is a Vehicle Operator.
employee booleanWhether or not the Contact is an Employee.
birth_date dateThe Contact's birth date.
street_address stringThe Contact's street address.
street_address_line_2 stringThe Contact's street address line 2.
city stringThe Contact's city.
region stringThe Contact's region, state, or province.
postal_code stringThe Contact's postal code, zip code, or equivalent.
country stringThe Contact's country.
employee_number stringThe Contact's employee number.
job_title stringPossible values:
<= 255 characters
The Contact's job title.
license_class stringThe Contact's driver's license class.
license_number stringThe Contact's driver's license number.
license_state stringThe locality which issued the Contact's license.
license_expiration dateThe Contact's driver's license expiration date.
home_phone_number stringThe Contact's home phone number.
mobile_phone_number stringThe Contact's mobile phone number.
work_phone_number stringThe Contact's work phone number.
other_phone_number stringAny other phone number for this Contact.
start_date dateWhen the Contact started working for the company, if applicable.
leave_date dateWhen the Contact left or will leave the company, if applicable.
hourly_labor_rate floatThe Contact's hourly rate.
custom_fields object*Full details on working with Custom Fields here.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url stringThe URL of the Contact's default image/profile photo, if any.
user objectIf the Contact is a Fleetio
User
, those details will be included here.account_membership_id NullableIdPossible values:
>= 1
labor_time_entries object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
account_id integerPossible values:
>= 1
contact_id integerPossible values:
>= 1
duration_in_seconds integerended_at date-timelaborable_id integerPossible values:
>= 1
laborable_type stringPossible values: [
WorkOrderSubLineItem
]started_at date-timedata object
clock_in_latitude floatclock_in_longitude floatclock_out_latitude floatclock_out_longitude floatactive booleanIndicates whether this Labor Time Entry is active.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
description stringThe description of this sub line item.
item_id integerThe ID of the
Part
associated with this sub line item.item_type stringPossible values: [
Part
]work_order_line_item_id NullableIdPossible values:
>= 1
quantity floatThe quantity of this sub line item.
part_location_detail_id NullableIdPossible values:
>= 1
position integerThe position of this sub line item in a list of sub line items.
item_name stringThe name of this sub line item.
unit_cost floatThe unit cost of this sub line item.
part object
A Part
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
description stringA description of this Part.
manufacturer_part_number stringThe part number from this Part's manufacturer.
measurement_unit_id NullableIdPossible values:
>= 1
number stringThe part number being used for this Part within Fleetio.
part_category_id NullableIdPossible values:
>= 1
part_manufacturer_id NullableIdPossible values:
>= 1
upc stringThe Universal Product Code for this Part.
total_quantity floatThe total quantity on hand for this Part.
custom_fields object*Full details on working with Custom Fields here.
inventory_item booleanIndicates whether or not this Part is an inventory item.
part_category object
id integerPossible values:
>= 1
tire_category booleanIndicates whether part is a tire or not
part_category_name stringThe name of the part category associated with this Part.
part_manufacturer_name stringThe name of the Part's manufacturer.
measurement_unit_name stringThe measurement unit used by this Part.
unit_cost floatThe unit cost for this Part.
average_unit_cost floatThe average unit cost for this Part. FIFO/LIFO accounts only.
part_locations object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
active booleanWhether this Part Location is active.
aisle stringThe aisle in which the Part is located.
available_quantity floatHow many of this Part are available at this Part Location.
bin stringThe bin in which the Part is located.
inventory_sets_count integerThe number of Inventory Sets that this Part is included in. FIFO/LIFO accounts only.
has_been_used_in_work_orders booleanWhether this Part has been used in any Work Orders. FIFO/LIFO accounts only.
name stringAlias of
part_location_name
.part_location_name stringThe name of the Part Location for this Part.
part_location_id integerThe ID of the Part Location for this Part.
quantity_allocated_to_work_orders floatHow many of these Parts are currently allocated to
Work Orders
.quantity_on_order floatHow many of this Part are currently on order, if any.
reorder_point floatThe lower-threshold quantity at which this Part should be reordered.
reorder_point_enabled booleanWhether this Part will be reordered at the reorder point.
row stringThe row in which the Part is located.
track_inventory booleanIndicates whether inventory is tracked for this Part at this location.
available_quantity_updated_at date-timepart_location_archived_at date-timeThe date and time at which the
Part Location
was archived, if applicable.default_image_url stringdefault_image_url_medium stringdefault_image_url_small stringdefault_image_url_large stringarchived_at date-timeThe date and time at which this Part was archived.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
has_active_inventory_sets booleanIndicates whether this Part has any active Inventory Sets. FIFO/LIFO accounts only.
tire_config object
aspect_ratio floatAspect ratio of tire.
rim_diameter floatRim diameter of tire.
load_index floatLoad index of tire.
metric_type stringPossible values: [
EU
,P
,HL
,T
,LT
,C
,ST
]Metric type of tire.
width floatWidth of tire.
construction stringPossible values: [
B
,R
,D
]Construction type of tire.
speed_rating stringPossible values: [
A1
,A2
,A3
,A4
,A5
,A6
,A7
,A8
,B
,C
,D
,E
,F
,G
,H
,J
,K
,L
,M
,N
,P
,Q
,R
,S
,T
,U
,V
,W
,Y
]Speed rating of tire.
factory_tread_depth floatfactory_tread_depth support is currently in private beta.
Tread depth of tire in /32" when new, as specified by the manufacturer.
minimum_tread_depth floatminimum_tread_depth support is currently in private beta.
The legal minimum tread depth, in /32".
life_expectancy integerlife_expectancy support is currently in private beta.
The Life Expectancy or “Warranty” of a tire is the expected meter range, usually measured in miles, of a given tire as specified by the manufacturer.
comments object[]
A list of the comments made on this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
commentable_type CommentableTypePossible 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 integerPossible values:
>= 1
user_id integerPossible values:
>= 1
title string deprecatedThe title of the Comment.
comment stringThe content of the Comment message body.
user_full_name stringThe full name of the
User
who created the Comment.user_image_url stringThe image url for the
User
who created the Comment.rich_content objecthtml_content stringThe comment message body rendered as HTML.
with_mentions booleanIndicates if the message body contains @mentions.
comments_count integerThe number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
documentable_id integerPossible values:
>= 1
documentable_type DocumentableTypePossible values: [
ServiceEntry
,FuelEntry
,Issue
,WorkOrder
,ExpenseEntry
]file_name stringThe name of the file.
file_mime_type stringThe MIME type of the file.
file_size numberThe size of the file in bytes.
file_url stringThe URL to access the file.
full_file_url stringThe full URL to access the file, including any necessary authentication or parameters.
documents_count integerThe number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
imageable_id integerPossible values:
>= 1
imageable_type ImageableTypePossible values: [
ExpenseEntry
,WorkOrder
,Equipment
,IssueResolution
,ServiceEntry
,Vendor
,ServiceProgram
,Issue
,Contact
,Part
,Vehicle
,FuelEntry
,SubmittedInspectionItem
]file_name stringThe name of the image file.
file_mime_type Image MIME TypePossible values: [
image/jpeg
,image/gif
,image/jif
,image/jfif
,image/jfi
,image/tiff
,image/png
,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 numberThe size of the image file in bytes.
file_url stringThe URL to access the image file.
full_url stringThe full URL to access the image file, including any necessary authentication or parameters.
images_count integerThe number of images attached to this record.
labor_time_entries object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
account_id integerPossible values:
>= 1
contact_id integerPossible values:
>= 1
duration_in_seconds integerended_at date-timelaborable_id integerPossible values:
>= 1
laborable_type stringPossible values: [
WorkOrderSubLineItem
]started_at date-timedata object
clock_in_latitude floatclock_in_longitude floatclock_out_latitude floatclock_out_longitude floatactive booleanIndicates whether this Labor Time Entry is active.
meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
starting_meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
ending_meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
secondary_meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
starting_secondary_meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
ending_secondary_meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates 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 integerThe ID of the VMRS Repair Priority Class.
code stringThe code of the VMRS Repair Priority Class.
name stringThe name of the VMRS Repair Priority Class.
color stringThe color of the VMRS Repair Priority Class.
labels object[]
id integerPossible values:
>= 1
name stringissues object[]
Any
Issues
associated with this Work Order.id integerThe ID of the
Issue
.name stringThe name of the
Issue
.- watchers_count integer
The number of
Users
watching this Work Order. - is_watched boolean
Indicates whether the current
User
is watching this Work Order. - discount_type DiscountType
Possible values: [
fixed
,percentage
]Default value:
percentage
The type of discount applied to this record.
- discount_percentage float
The discount percentage. This field should be present when
discount_type
is set topercentage
. - discount float
The discount amount.
- parts_subtotal float
The total cost of parts for this record.
- labor_subtotal float
The total cost of labor for this record.
- subtotal float
The pre-tax subtotal amount.
- tax_1_type string
Possible values: [
fixed
,percentage
]Default value:
percentage
The type of tax to apply to this record.
- tax_1_percentage float
The primary tax percentage amount. This field should be present when
tax_1_type
is set topercentage
. - tax_2_type string
Possible values: [
fixed
,percentage
]Default value:
percentage
The type of tax to apply to this record.
- tax_2_percentage float
The secondary tax percentage amount. This field should be present when
tax_2_type
is set topercentage
. Note that this secondary tax must be configured in your Account Settings. - tax_1 float
The primary tax amount.
- tax_2 float
The secondary tax amount. Note that this secondary tax must be configured in your Account Settings.
- total_amount float
The total amount.
- labor_time_in_seconds integer
The sum, in seconds, of the duration of all labor line items of a
completed
Work Order. comments object[]
A list of the comments made on this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
commentable_type CommentableTypePossible 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 integerPossible values:
>= 1
user_id integerPossible values:
>= 1
title string deprecatedThe title of the Comment.
comment stringThe content of the Comment message body.
user_full_name stringThe full name of the
User
who created the Comment.user_image_url stringThe image url for the
User
who created the Comment.rich_content objecthtml_content stringThe comment message body rendered as HTML.
with_mentions booleanIndicates 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 integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
imageable_id integerPossible values:
>= 1
imageable_type ImageableTypePossible values: [
ExpenseEntry
,WorkOrder
,Equipment
,IssueResolution
,ServiceEntry
,Vendor
,ServiceProgram
,Issue
,Contact
,Part
,Vehicle
,FuelEntry
,SubmittedInspectionItem
]file_name stringThe name of the image file.
file_mime_type Image MIME TypePossible values: [
image/jpeg
,image/gif
,image/jif
,image/jfif
,image/jfi
,image/tiff
,image/png
,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 numberThe size of the image file in bytes.
file_url stringThe URL to access the image file.
full_url stringThe 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 integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
documentable_id integerPossible values:
>= 1
documentable_type DocumentableTypePossible values: [
ServiceEntry
,FuelEntry
,Issue
,WorkOrder
,ExpenseEntry
]file_name stringThe name of the file.
file_mime_type stringThe MIME type of the file.
file_size numberThe size of the file in bytes.
file_url stringThe URL to access the file.
full_file_url stringThe 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",
"expected_completed_at": "2023-03-14T13:46:27-06:00",
"contact_image_url": "string",
"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": "2024-09-06",
"updated_at": "2024-09-06",
"email": "string",
"name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"images_count": 0,
"documents_count": 0,
"comments_count": 0,
"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",
"license_expiration": "2023-03-14",
"home_phone_number": "string",
"mobile_phone_number": "string",
"work_phone_number": "string",
"other_phone_number": "string",
"start_date": "2024-09-06",
"leave_date": "2024-09-06",
"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
},
"labor_time_entries": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"account_id": 0,
"contact_id": 0,
"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",
"data": {
"clock_in_latitude": 0,
"clock_in_longitude": 0,
"clock_out_latitude": 0,
"clock_out_longitude": 0
},
"active": true
}
]
},
{
"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,
"name": "string",
"part_location_name": "string",
"part_location_id": 0,
"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": "2024-09-06"
}
],
"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
},
"has_active_inventory_sets": true,
"tire_config": {
"aspect_ratio": 0,
"rim_diameter": 0,
"load_index": 0,
"metric_type": "EU",
"width": 0,
"construction": "B",
"speed_rating": "A1",
"factory_tread_depth": 0,
"minimum_tread_depth": 0,
"life_expectancy": 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
}
}
],
"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": 0,
"labor_cost_cents": 0,
"subtotal": 1.23,
"subtotal_cents": 0,
"description": "string",
"title": "string",
"item_id": 0,
"item_type": "Issue",
"work_order_line_item_id": 0,
"item_name": "string",
"position": 0,
"issues": [
{
"id": 0,
"name": "string"
}
],
"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": "2024-09-06",
"updated_at": "2024-09-06",
"email": "string",
"name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"images_count": 0,
"documents_count": 0,
"comments_count": 0,
"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",
"license_expiration": "2023-03-14",
"home_phone_number": "string",
"mobile_phone_number": "string",
"work_phone_number": "string",
"other_phone_number": "string",
"start_date": "2024-09-06",
"leave_date": "2024-09-06",
"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
},
"labor_time_entries": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"account_id": 0,
"contact_id": 0,
"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",
"data": {
"clock_in_latitude": 0,
"clock_in_longitude": 0,
"clock_out_latitude": 0,
"clock_out_longitude": 0
},
"active": true
}
]
},
{
"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,
"name": "string",
"part_location_name": "string",
"part_location_id": 0,
"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": "2024-09-06"
}
],
"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
},
"has_active_inventory_sets": true,
"tire_config": {
"aspect_ratio": 0,
"rim_diameter": 0,
"load_index": 0,
"metric_type": "EU",
"width": 0,
"construction": "B",
"speed_rating": "A1",
"factory_tread_depth": 0,
"minimum_tread_depth": 0,
"life_expectancy": 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",
"account_id": 0,
"contact_id": 0,
"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",
"data": {
"clock_in_latitude": 0,
"clock_in_longitude": 0,
"clock_out_latitude": 0,
"clock_out_longitude": 0
},
"active": true
}
],
"meter_entry": {
"id": 0,
"created_at": "2024-09-06",
"updated_at": "2024-09-06",
"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": "2024-09-06",
"updated_at": "2024-09-06",
"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": "2024-09-06",
"updated_at": "2024-09-06",
"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": "2024-09-06",
"updated_at": "2024-09-06",
"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": "2024-09-06",
"updated_at": "2024-09-06",
"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": "2024-09-06",
"updated_at": "2024-09-06",
"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": [
{
"id": 0,
"name": "string"
}
],
"issues": [
{
"id": 0,
"name": "string"
}
],
"watchers_count": 0,
"is_watched": true,
"discount_type": "percentage",
"discount_percentage": 1.23,
"discount": 1.23,
"parts_subtotal": 1.23,
"labor_subtotal": 1.23,
"subtotal": 1.23,
"tax_1_type": "percentage",
"tax_1_percentage": 1.23,
"tax_2_type": "percentage",
"tax_2_percentage": 1.23,
"tax_1": 1.23,
"tax_2": 1.23,
"total_amount": 1.23,
"labor_time_in_seconds": 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,
"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"
}
Unprocessable Entity
- application/json
- Schema
- Example (from schema)
- Example
Schema
errors object
typeitems 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"
}