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
Query Parameters
- start_cursor string
The start cursor for Keyset pagination.
- per_page integer
Possible values:
>= 2and<= 100Default value:
50The number of records per page to return.
- sort object
The fields and direction to sort the results by.
- id string
Possible values: [
asc,desc]Default value:
desc
Responses
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- start_cursor string
The current start cursor of the records returned.
- next_cursor string
The next cursor to retrieve the next page of records.
- per_page integer
The maxumum number of records returned.
- estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
- filtered_by object[]
The filters applied to the returned record set.
sorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
id stringPossible values: [
asc,desc]- records object[]
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{}
],
"sorted_by": [
{
"id": "asc"
}
],
"records": [
{
"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
}
}
]
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400and<= 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:
>= 400and<= 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"
}
Loading...