Skip to main content

Retrieve Work Order Line Items

GET 

https://secure.fleetio.com/api/v2/work_orders/:work_order_id/work_order_line_items/:id

Retrieve the details of an existing Work Order Line Item.

Request

Path Parameters

    work_order_id stringrequired

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the associated Work Order

    id stringrequired

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the relevant record

Responses

OK

Schema
    idinteger

    Possible values: >= 1

    created_atdate-time

    The date and time at which this record was created.

    Example: 2023-03-14T13:46:27-06:00
    updated_atdate-time

    The date and time at which this record was most recently updated.

    Example: 2023-03-14T13:46:27-06:00
    descriptionstringnullablerequired

    A description of this Work Order Line Item.

    titlestring

    The title of this Work Order Line Item.

    item_idintegerrequired

    The ID of the item associated with this Work Order Line Item.

    item_typestringrequired

    The type of item associated with this Work Order Line Item.

    Possible values: [Issue, ServiceTask]

    work_order_line_item_idintegernullablerequired
    item_namestringrequired

    The name of the item associated with this Work Order Line Item.

    positionintegernullablerequired

    The position of this Work Order Line Item in a list of Work Order Line Items.

    issues object[]required

    Any Issues associated with this Work Order Line Item.

  • Array [
  • idinteger

    The ID of the Issue.

    namestring

    The name of the Issue.

  • ]
  • vmrs_reason_for_repair objectnullablerequired
    account_idinteger
    aliasstringnullable
    codestringnullable
    enabledboolean
    idinteger
    namestring
    repair_typestringnullable
    standardboolean
    standard_namestringnullable
    typestring
    vmrs_standard_reason_for_repairobjectnullable
    vmrs_system_group objectnullablerequired
    account_idnumbernullable
    assembly_codestringnullable
    assembly_namestringnullable
    code_typestring

    Possible values: [system_group, system, assembly, component]

    component_codestringnullable
    component_namestringnullable
    enabledboolean
    idinteger
    permissions objectnullable
    destroyboolean
    standardboolean
    system_codestringnullable
    system_groupstringnullable
    system_group_codestringnullable
    system_namestringnullable
    typestring
    vmrs_standard_system_assembly_componentobjectnullable
    vmrs_system objectnullablerequired
    account_idnumbernullable
    assembly_codestringnullable
    assembly_namestringnullable
    code_typestring

    Possible values: [system_group, system, assembly, component]

    component_codestringnullable
    component_namestringnullable
    enabledboolean
    idinteger
    permissions objectnullable
    destroyboolean
    standardboolean
    system_codestringnullable
    system_groupstringnullable
    system_group_codestringnullable
    system_namestringnullable
    typestring
    vmrs_standard_system_assembly_componentobjectnullable
    vmrs_assembly objectnullablerequired
    account_idnumbernullable
    assembly_codestringnullable
    assembly_namestringnullable
    code_typestring

    Possible values: [system_group, system, assembly, component]

    component_codestringnullable
    component_namestringnullable
    enabledboolean
    idinteger
    permissions objectnullable
    destroyboolean
    standardboolean
    system_codestringnullable
    system_groupstringnullable
    system_group_codestringnullable
    system_namestringnullable
    typestring
    vmrs_standard_system_assembly_componentobjectnullable
    vmrs_component objectnullablerequired
    account_idnumbernullable
    assembly_codestringnullable
    assembly_namestringnullable
    code_typestring

    Possible values: [system_group, system, assembly, component]

    component_codestringnullable
    component_namestringnullable
    enabledboolean
    idinteger
    permissions objectnullable
    destroyboolean
    standardboolean
    system_codestringnullable
    system_groupstringnullable
    system_group_codestringnullable
    system_namestringnullable
    typestring
    vmrs_standard_system_assembly_componentobjectnullable
    work_order_sub_line_items object[]required
  • Array [
  • anyOf
    idId (integer)required

    Possible values: >= 1

    created_atdate-time

    The date and time at which this record was created.

    Example: 2023-03-14T13:46:27-06:00
    updated_atdate-time

    The date and time at which this record was most recently updated.

    Example: 2023-03-14T13:46:27-06:00
    descriptionstringnullable

    The description of the sub line item.

    item_idId (integer)

    Possible values: >= 1

    item_typestring

    Possible values: [Contact]

    work_order_line_item_idNullableId (integer)nullable

    Possible values: >= 1

    quantityfloat

    The quantity of this sub line item.

    part_location_detail_idNullableId (integer)nullable

    Possible values: >= 1

    positionintegernullable

    The position of this sub line item in a list of sub line items.

    Possible values: >= 0

    item_namestring

    The name of this sub line item.

    unit_costfloat

    The unit cost of this sub line item.

    contact objectnullable

    A Contact

    idinteger
    created_atdate-time
    updated_atdate-time
    emailstringnullable

    The Contact's email address.

    namestringnullable

    The Contact's full name.

    first_namestringnullable

    The Contact's first name.

    middle_namestringnullable

    The Contact's middle name.

    last_namestringnullable

    The Contact's last name.

    images_countinteger

    The number of images associated with this Contact.

    Possible values: >= 0

    documents_countinteger

    The number of documents associated with this Contact.

    Possible values: >= 0

    comments_countinteger

    The number of comments associated with this Contact.

    Possible values: >= 0

    group_idintegernullable

    If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

    group_namestringnullable

    If this Contact belongs to a Group, this will be the Group's name.

    group_hierarchystringnullable

    If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.

    Example: Group 1|Group 2|Group 3
    technicianbooleannullable

    Whether or not the Contact is a Technician.

    vehicle_operatorbooleannullable

    Whether or not the Contact is a Vehicle Operator.

    employeebooleannullable

    Whether or not the Contact is an Employee.

    birth_datedatenullable

    The Contact's birth date.

    Example: 2023-03-14
    street_addressstringnullable

    The Contact's street address.

    Example: 123 Main St
    street_address_line_2stringnullable

    The Contact's street address line 2.

    Example: Apt 1
    citystringnullable

    The Contact's city.

    regionstringnullable

    The Contact's region, state, or province.

    postal_codestringnullable

    The Contact's postal code, zip code, or equivalent.

    countrystringnullable

    The Contact's country.

    employee_numberstringnullable

    The Contact's employee number.

    job_titlestringnullable

    The Contact's job title.

    Possible values: <= 255 characters

    license_classstringnullable

    The Contact's driver's license class.

    license_numberstringnullable

    The Contact's driver's license number.

    license_statestringnullable

    The locality which issued the Contact's license.

    license_expirationdatenullable

    The Contact's driver's license expiration date.

    Example: 2023-03-14
    home_phone_numberstringnullable

    The Contact's home phone number.

    mobile_phone_numberstringnullable

    The Contact's mobile phone number.

    work_phone_numberstringnullable

    The Contact's work phone number.

    other_phone_numberstringnullable

    Any other phone number for this Contact.

    start_datedatenullable

    When the Contact started working for the company, if applicable.

    leave_datedatenullable

    When the Contact left or will leave the company, if applicable.

    hourly_labor_ratefloatnullable

    The Contact's hourly rate.

    custom_fieldsobjectnullable

    *Full details on working with Custom Fields here.

    attachment_permissions objectnullable
    read_photosboolean

    Indicates whether the user has read permission for photos.

    manage_photosboolean

    Indicates whether the user has permission to manage (eg. upload, delete) photos.

    read_documentsboolean

    Indicates whether the user has read permission for documents.

    manage_documentsboolean

    Indicates whether the user has permission to manage (eg. upload, delete) documents.

    default_image_urlstringnullable

    The URL of the Contact's default image/profile photo, if any.

    userobjectnullable

    If the Contact is a Fleetio User, those details will be included here.

    account_membership_idNullableId (integer)nullable

    Possible values: >= 1

    last_api_requestdate-timenullable

    The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.

    last_web_accessdate-timenullable

    The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.

    last_mobile_app_accessdate-timenullable

    The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.

    labor_time_entries object[]
  • Array [
  • idId (integer)required

    Possible values: >= 1

    created_atdate-time

    The date and time at which this record was created.

    Example: 2023-03-14T13:46:27-06:00
    updated_atdate-time

    The date and time at which this record was most recently updated.

    Example: 2023-03-14T13:46:27-06:00
    account_idId (integer)

    Possible values: >= 1

    contact_idId (integer)

    Possible values: >= 1

    duration_in_secondsinteger
    ended_atdate-timenullable
    Example: 2023-03-14T13:46:27-06:00
    laborable_idId (integer)

    Possible values: >= 1

    laborable_typestring

    Possible values: [WorkOrderSubLineItem]

    started_atdate-time
    Example: 2023-03-14T13:46:27-06:00
    data object
    clock_in_latitudefloat
    clock_in_longitudefloat
    clock_out_latitudefloat
    clock_out_longitudefloat
    activeboolean

    Indicates whether this Labor Time Entry is active.

  • ]
  • ]
  • subtotalfloatnullable

    The pre-tax subtotal amount.

    Example: 1.23
    subtotal_centsintegernullable

    The pre-tax subtotal amount in cents.

    labor_costfloatnullable

    The cost of labor units worked.

    Example: 1.23
    parts_costfloatnullable

    The cost of parts.

    Example: 1.23
    parts_cost_centsintegernullable

    The parts cost amount in cents.

    labor_cost_centsintegernullable

    The cost of labor units worked, in cents.

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).
name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)
curl -L 'https://secure.fleetio.com/api/v2/work_orders/:work_order_id/work_order_line_items/:id' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-H 'Account-Token: <Authorization>'
Request Collapse all
Base URL
https://secure.fleetio.com/api
Auth
Parameters
— pathrequired
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!