List Work Order Line Items
Returns a list of Line Items for a given Work Order.
Path Parameters
- work_order_id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the associated Work Order
- 200
- 401
- 500
OK
Response Headers
X-PaginationLimit string
The per page limit. Currently set to 100 but subject to change at any time.
X-Pagination-Current-Page string
The current page. Defaults to 1.
X-Pagination-Total-Pages string
The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.
X-Pagination-Total-Count string
The total number of records in the result set (across all pages).
- application/json
- Schema
- Example (from schema)
Schema
array
- 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 float
The cost of labor units worked.
- parts_cost float
The cost of parts.
- parts_cost_cents integer
The parts cost amount in cents.
- labor_cost_cents integer
The cost of labor units worked, in cents.
- subtotal float
The pre-tax subtotal amount.
- subtotal_cents integer
The pre-tax subtotal amount in cents.
- 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 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.
[
{
"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-10-02",
"updated_at": "2024-10-02",
"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-10-02",
"leave_date": "2024-10-02",
"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-10-02"
}
],
"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
}
}
]
}
]
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"
}
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"
}