Skip to main content

Create Service Entry

POST 

https://secure.fleetio.com/api/v2/service_entries

Creates a new Service Entry

Request

Body

    completed_atdate-timerequired

    The date and time at which the Service Entry was completed. We recommend using ISO-8601 formatted dates to avoid ambiguity.

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

    The date and time at which the Service Entry was started. We recommend using ISO-8601 formatted dates to avoid ambiguity.

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

    Possible values: >= 1

    vehicle_vinstring

    The VIN of the Vehicle associated with this Service Entry.

    Possible values: <= 17 characters

    vendor_idId (integer)

    Possible values: >= 1

    referencestring

    A reference number for this Service Entry.

    Possible values: <= 255 characters

    label_listLabelListParameters (string)

    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.

    Possible values: <= 255 characters

    Example: High Priority
    general_notesstring

    Any general notes about this Service Entry.

    vmrs_repair_priority_class_idId (integer)

    Possible values: >= 1

    custom_fieldsobjectnullable

    *Full details on working with Custom Fields here.

    meter_entry_attributes objectrequired

    A Service Entry may be associated with a Meter Entry

    valuefloat

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

    Example: 108043
    voidboolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

    secondary_meter_entry_attributes object

    A Service Entry may also be associated with a secondary Meter Entry

    valuefloat

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

    Example: 108043
    voidboolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

    service_entry_line_items_attributes object[]
  • Array [
  • idId (integer)

    Possible values: >= 1

    service_task_idId (integer)

    Possible values: >= 1

    typeServiceEntryLineItemType (string)

    Denotes the type of the ServiceEntryLineItem

    Possible values: [ServiceEntryServiceTaskLineItem, ServiceEntryLaborLineItem, ServiceEntryPartLineItem, ServiceEntryTaxLineItem, ServiceEntryFeeLineItem, ServiceEntryTireLineItem, ServiceEntryFreeTextLineItem]

    descriptionstring

    Free text field, used for notes or description.

    labor_costfloat

    Total labor cost for this line item.

    Default value: 0
    parts_costfloat

    Total parts cost for this line item.

    Default value: 0
    subtotalfloat

    Subtotal for this line item. If parts_cost or labor_cost are non-zero, this value is ignored.

    Default value: 0
    service_entry_line_item_idinteger

    For nested line items. This value denotes the parent Service Entry Line Item.

    issue_idsstring[]

    An array of issue IDs that you want the line item to be linked to. This field can be passed several times to the server if you wish to link more than one issue (see cURL example).

    vmrs_reason_for_repair_idId (integer)

    Possible values: >= 1

    vmrs_system_group_idId (integer)

    Possible values: >= 1

    vmrs_system_idId (integer)

    Possible values: >= 1

    vmrs_component_idId (integer)

    Possible values: >= 1

    vmrs_assembly_idId (integer)

    Possible values: >= 1

  • ]
  • issue_idsId (integer)[]

    The IDs of any Issues associated with this Service Entry.

    Possible values: >= 1

    service_task_idsId (integer)[]

    The IDs of any Service Tasks associated with this Service Entry.

    Possible values: >= 1

    comments_attributes object[]
  • Array [
  • titlestring

    The title of the comment.

    commentstring

    The comment text.

  • ]
  • documents_attributes object[]

    An array of one or more document objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.

  • Array [
  • namestring

    The name to give the file which will be shown in the UI.

    Possible values: <= 255 characters

    file_urlstring

    The URL obtained from our storage provider that points to the file.

    Possible values: <= 255 characters

    file_mime_typestring

    The MIME type of the file. For example, application/pdf.

    Possible values: <= 255 characters

    file_namestring

    The name of the file.

    Possible values: <= 255 characters

    file_sizeinteger

    The size of the file in bytes.

  • ]
  • images_attributes object[]

    An array of one or more image objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.

  • Array [
  • namestring

    The name to give the image which will be shown in the UI.

    Possible values: <= 255 characters

    file_urlstring

    The URL obtained from our storage provider that points to the image.

    Possible values: <= 255 characters

    file_mime_typestring

    The MIME type of the image. For example, image/png.

    Possible values: <= 255 characters

    file_namestring

    The name of the image.

    Possible values: <= 255 characters

    file_sizeinteger

    The size of the image file in bytes.

  • ]
  • labor_subtotalfloat

    The total cost of labor for this Service Entry. This is calculated by summing the labor_cost of each Service Entry Line Item.

    parts_subtotalfloat

    The total cost of Parts for this Service Entry. This is calculated by summing the parts_cost of each Service Entry Line Item.

    subtotalfloat

    The subtotal amount of this Service Entry before any discounts or taxes. This is calculated by summing the subtotal of each Service Entry Line Item.

    discountfloat

    The total discount amount for this Service Entry.

    discount_percentagefloat

    The total discount percentage for this Service Entry.

    discount_typeDiscountType (string)nullable

    The type of discount applied to this record.

    Possible values: [fixed, percentage]

    Default value: percentage
    tax_1float

    The first tax amount for this Service Entry.

    tax_1_percentagefloat

    The first tax percentage for this Service Entry.

    tax_1_typeTaxType (string)nullable

    The type of tax to apply to this record.

    Possible values: [fixed, percentage]

    Default value: percentage
    tax_2float

    The second tax amount for this Service Entry.

    tax_2_percentagefloat

    The second tax percentage for this Service Entry.

    tax_2_typeTaxType (string)nullable

    The type of tax to apply to this record.

    Possible values: [fixed, percentage]

    Default value: percentage
    total_amountfloat

    The grand total of this Service Entry.

Responses

OK

Response Headers
    Schema
      idinteger
      created_atdate-time
      updated_atdate-time
      tax_free_laborboolean

      Indicates whether or not to include labor subtotals in tax calculations.

      completed_atdate-timenullablerequired

      The date and time at which the Service Entry was completed.

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

      A reference number for this Service Entry.

      started_atdate-timenullablerequired

      The date and time at which the Service Entry was started.

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

      The status of this Service Entry.

      Possible values: [pending, completed]

      custom_fieldsobjectnullablerequired

      *Full details on working with Custom Fields here.

      general_notesstringnullablerequired

      General notes for this Service Entry.

      vehicle_idId (integer)required

      Possible values: >= 1

      vehicle_namestringnullablerequired

      The name of the Vehicle associated with this Service Entry.

      vendor_idNullableId (integer)nullablerequired

      Possible values: >= 1

      vendor_namestringnullablerequired

      The name of the Vendor associated with this Service Entry.

      work_order_idNullableId (integer)nullablerequired

      Possible values: >= 1

      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.

      is_samplebooleanrequired

      Indicates whether or not this Service Entry is a sample. Sample Service Entries are not included in reports.

      work_order_numberintegernullablerequired

      The number of the Work Order this Service Entry is associated with.

      datedate-timerequired

      The date of this Service Entry. Formatted according to ISO-8601 in User's local time.

      Example: 2023-03-14T13:46:27-06:00
      service_entry_line_items object[]required
    • Array [
    • 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 the service performed for this line item.

      typeServiceEntryLineItemType (string)required

      Denotes the type of the ServiceEntryLineItem

      Possible values: [ServiceEntryServiceTaskLineItem, ServiceEntryLaborLineItem, ServiceEntryPartLineItem, ServiceEntryTaxLineItem, ServiceEntryFeeLineItem, ServiceEntryTireLineItem, ServiceEntryFreeTextLineItem]

      service_entry_line_item_idintegernullablerequired

      For nested line items. This value denotes the parent Service Entry Line Item.

      service_reminder_idintegernullablerequired

      If this line item is linked to a Service Reminder, this ID will be set.

      service_task objectnullable

      A Service Task

      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
      namestringrequired

      A name for this Service Task.

      Possible values: <= 255 characters

      descriptionstringnullablerequired

      A description of this Service Task.

      expected_duration_in_secondsintegernullable

      The expected duration in seconds this Service Task should take to complete.

      archived_atdate-timenullable

      The date and time at which this Service Task was archived. null if this Service Task is active.

      subtasks object[]required
    • 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
      namestring

      The name of this subtask.

      descriptionstringnullable

      A description of this subtask.

      expected_duration_in_secondsintegernullable

      The expected duration in seconds this subtask should take to complete.

      subtasksarray

      The subtasks array at this level will always be empty.

      default_vmrs_reason_for_repair objectnullable
      account_idinteger
      aliasstringnullable
      codestringnullable
      enabledboolean
      idinteger
      namestring
      repair_typestringnullable
      standardboolean
      standard_namestringnullable
      typestring
      vmrs_standard_reason_for_repairobjectnullable
      default_vmrs_system_group objectnullable
      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
      default_vmrs_system objectnullable
      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
      default_vmrs_assembly objectnullable
      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
      default_vmrs_component objectnullable
      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
    • ]
    • usageinteger

      Indicates the number of times this Service Task has been used. Available by setting the include_usage query parameter to 1.

      default_vmrs_reason_for_repair objectnullablerequired
      account_idinteger
      aliasstringnullable
      codestringnullable
      enabledboolean
      idinteger
      namestring
      repair_typestringnullable
      standardboolean
      standard_namestringnullable
      typestring
      vmrs_standard_reason_for_repairobjectnullable
      default_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
      default_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
      default_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
      default_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
      service_task_parts object[]

      Any Parts associated with this Service Task. Available by setting the expand[] query parameter to service_task_parts.

    • Array [
    • idinteger
      quantityfloat

      The quantity of this Part related to the Service Task.

      part_idinteger

      The ID of this Part related to the Service Task.

      part_archived_atdate-timenullable

      The date and time at which the Part related to the Service Task was archived, if applicable.

      positioninteger

      The position of this Part in the list of Service Task Parts.

    • ]
    • issues object[]required

      Any Issues this line item is linked to.

    • 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
      numberstringrequired

      A unique identifier for the Issue.

      namestringrequired

      The name of the Issue.

      summarystringrequired

      A summary of the Issue.

      descriptionstringnullablerequired

      A longer description of the Issue.

      statestringrequired

      The Issue's current state.

      Possible values: [Open, Closed, Resolved]

      reported_atdate-timenullablerequired

      The date and time at which the issue was reported.

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

      Possible values: >= 1

      reported_by_namestringnullablerequired

      The name of the Contact associated with the User who reported this Issue.

      fault_idNullableId (integer)nullablerequired

      Possible values: >= 1

      due_datedatenullablerequired

      The date on which this Issue should be resolved by. Formatted according to ISO-8601 in User's local time zone.

      Example: 2023-03-14
      due_meter_valuestringnullablerequired

      The meter value at which this Issue should be resolved by.

      due_secondary_meter_valuefloatnullablerequired

      The secondary meter value at which this Issue should be resolved by.

      overduebooleanrequired

      Indicates whether the Issue is overdue.

      vehicle_idId (integer)required

      Possible values: >= 1

      vehicle_namestringrequired

      The name of the Vehicle associated with this Issue.

      is_sampleboolean

      Indicates whether this Issue is sample data.

      created_by_workflowbooleanrequired

      Indicates whether this Issue was created by a workflow.

      submitted_inspection_form_idNullableId (integer)nullablerequired

      Possible values: >= 1

      custom_fieldsobjectnullablerequired

      *Full details on working with Custom Fields here.

      valid_required_custom_fieldsbooleanrequired
      dtc_alert_idNullableId (integer)nullablerequired

      Possible values: >= 1

      assigned_contacts object[]required

      An array of assigned Contacts related to the Issue.

    • Array [
    • 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.

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

      Possible values: >= 1

      namestring
    • ]
    • 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.

      is_watchedbooleanrequired

      Indicates whether the Issue is watched.

      Default value: false
      vehicle_image_urlstringnullablerequired

      The URL to the image of the Vehicle associated with the Issue.

      vehicle_image_url_mediumstringnullablerequired

      The URL to a medium-sized Vehicle image associated with the Issue.

      vehicle_image_url_smallstringnullablerequired

      The URL to a small-sized Vehicle image associated with the Issue.

      vehicle_image_url_largestringnullablerequired

      The URL to a large-sized Vehicle image associated with the Issue.

      watchers_countinteger

      The count of watchers related to the Issue.

      linked_work_orders object[]nullablerequired

      Summative information of linked Work Orders related to the Issue.

    • Array [
    • idId (integer)

      Possible values: >= 1

      numberinteger

      The Work Order number.

      issued_atdate-time

      The date and time at which the Work Order was issued.

    • ]
    • source objectrequired

      Inspection source information.

      inspection_form object
      idNullableId (integer)nullable

      Possible values: >= 1

      colorstringnullable
      titlestringnullable
      inspection_submissions_countintegernullable

      The count of inspection submissions related to the Issue.

      last_inspection_submission_atdate-timenullable

      The date and time of the last inspection submission related to the Issue.

      failed_inspection_item_labelstringnullable

      The label associated with a failed inspection item.

      comments object[]

      A list of the comments made on this record.

    • 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
      commentable_typeCommentableType (string)required

      The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

      Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

      commentable_idId (integer)required

      Possible values: >= 1

      user_idId (integer)required

      Possible values: >= 1

      titlestringdeprecated

      The title of the Comment.

      commentstringrequired

      The content of the Comment message body.

      user_full_namestringrequired

      The full name of the User who created the Comment.

      user_image_urlstringnullablerequired

      The image url for the User who created the Comment.

      rich_contentobjectnullablerequired
      html_contentstringnullablerequired

      The comment message body rendered as HTML.

      with_mentionsbooleanrequired

      Indicates if the message body contains @mentions.

    • ]
    • comments_countinteger

      The number of comments made on this record.

      Possible values: >= 0

      documents object[]

      A list of the documents attached to this record.

    • 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
      namestringrequired

      The name of the document.

      descriptionstringrequired

      The description of the document.

      documentable_idId (integer)required

      Possible values: >= 1

      documentable_typeDocumentableType (string)required

      Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]

      file_namestringrequired

      The name of the file.

      file_mime_typestringrequired

      The MIME type of the file.

      file_sizenumberrequired

      The size of the file in bytes.

      file_urlstringrequired

      The URL to access the file.

      full_file_urlstringrequired

      The full URL to access the file, including any necessary authentication or parameters.

    • ]
    • documents_countinteger

      The number of documents attached to this record.

      Possible values: >= 0

      images object[]

      A list of the images attached to this record.

    • 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
      imageable_idId (integer)

      Possible values: >= 1

      imageable_typeImageableType (string)

      Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]

      file_namestring

      The name of the image file.

      file_mime_typeImage MIME Type (string)

      Possible 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_sizenumber

      The size of the image file in bytes.

      file_urlstring

      The URL to access the image file.

      full_urlstring

      The full URL to access the image file, including any necessary authentication or parameters.

    • ]
    • images_countinteger

      The number of images attached to this record.

      Possible values: >= 0

    • ]
    • labor_costfloat

      The total cost of labor for this line item.

      parts_costfloat

      The total cost of parts for this line item.

      subtotalfloat

      The pre-tax cost of this line item.

      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
    • ]
    • service_tasks object[]required
    • 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
      namestringrequired

      A name for this Service Task.

      Possible values: <= 255 characters

      descriptionstringnullablerequired

      A description of this Service Task.

      expected_duration_in_secondsintegernullable

      The expected duration in seconds this Service Task should take to complete.

      archived_atdate-timenullable

      The date and time at which this Service Task was archived. null if this Service Task is active.

      subtasks object[]required
    • 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
      namestring

      The name of this subtask.

      descriptionstringnullable

      A description of this subtask.

      expected_duration_in_secondsintegernullable

      The expected duration in seconds this subtask should take to complete.

      subtasksarray

      The subtasks array at this level will always be empty.

      default_vmrs_reason_for_repair objectnullable
      account_idinteger
      aliasstringnullable
      codestringnullable
      enabledboolean
      idinteger
      namestring
      repair_typestringnullable
      standardboolean
      standard_namestringnullable
      typestring
      vmrs_standard_reason_for_repairobjectnullable
      default_vmrs_system_group objectnullable
      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
      default_vmrs_system objectnullable
      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
      default_vmrs_assembly objectnullable
      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
      default_vmrs_component objectnullable
      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
    • ]
    • usageinteger

      Indicates the number of times this Service Task has been used. Available by setting the include_usage query parameter to 1.

      default_vmrs_reason_for_repair objectnullablerequired
      account_idinteger
      aliasstringnullable
      codestringnullable
      enabledboolean
      idinteger
      namestring
      repair_typestringnullable
      standardboolean
      standard_namestringnullable
      typestring
      vmrs_standard_reason_for_repairobjectnullable
      default_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
      default_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
      default_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
      default_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
      service_task_parts object[]

      Any Parts associated with this Service Task. Available by setting the expand[] query parameter to service_task_parts.

    • Array [
    • idinteger
      quantityfloat

      The quantity of this Part related to the Service Task.

      part_idinteger

      The ID of this Part related to the Service Task.

      part_archived_atdate-timenullable

      The date and time at which the Part related to the Service Task was archived, if applicable.

      positioninteger

      The position of this Part in the list of Service Task Parts.

    • ]
    • ]
    • issues object[]required
    • 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
      numberstringrequired

      A unique identifier for the Issue.

      namestringrequired

      The name of the Issue.

      summarystringrequired

      A summary of the Issue.

      descriptionstringnullablerequired

      A longer description of the Issue.

      statestringrequired

      The Issue's current state.

      Possible values: [Open, Closed, Resolved]

      reported_atdate-timenullablerequired

      The date and time at which the issue was reported.

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

      Possible values: >= 1

      reported_by_namestringnullablerequired

      The name of the Contact associated with the User who reported this Issue.

      fault_idNullableId (integer)nullablerequired

      Possible values: >= 1

      due_datedatenullablerequired

      The date on which this Issue should be resolved by. Formatted according to ISO-8601 in User's local time zone.

      Example: 2023-03-14
      due_meter_valuestringnullablerequired

      The meter value at which this Issue should be resolved by.

      due_secondary_meter_valuefloatnullablerequired

      The secondary meter value at which this Issue should be resolved by.

      overduebooleanrequired

      Indicates whether the Issue is overdue.

      vehicle_idId (integer)required

      Possible values: >= 1

      vehicle_namestringrequired

      The name of the Vehicle associated with this Issue.

      is_sampleboolean

      Indicates whether this Issue is sample data.

      created_by_workflowbooleanrequired

      Indicates whether this Issue was created by a workflow.

      submitted_inspection_form_idNullableId (integer)nullablerequired

      Possible values: >= 1

      custom_fieldsobjectnullablerequired

      *Full details on working with Custom Fields here.

      valid_required_custom_fieldsbooleanrequired
      dtc_alert_idNullableId (integer)nullablerequired

      Possible values: >= 1

      assigned_contacts object[]required

      An array of assigned Contacts related to the Issue.

    • Array [
    • 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.

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

      Possible values: >= 1

      namestring
    • ]
    • 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.

      is_watchedbooleanrequired

      Indicates whether the Issue is watched.

      Default value: false
      vehicle_image_urlstringnullablerequired

      The URL to the image of the Vehicle associated with the Issue.

      vehicle_image_url_mediumstringnullablerequired

      The URL to a medium-sized Vehicle image associated with the Issue.

      vehicle_image_url_smallstringnullablerequired

      The URL to a small-sized Vehicle image associated with the Issue.

      vehicle_image_url_largestringnullablerequired

      The URL to a large-sized Vehicle image associated with the Issue.

      watchers_countinteger

      The count of watchers related to the Issue.

      linked_work_orders object[]nullablerequired

      Summative information of linked Work Orders related to the Issue.

    • Array [
    • idId (integer)

      Possible values: >= 1

      numberinteger

      The Work Order number.

      issued_atdate-time

      The date and time at which the Work Order was issued.

    • ]
    • source objectrequired

      Inspection source information.

      inspection_form object
      idNullableId (integer)nullable

      Possible values: >= 1

      colorstringnullable
      titlestringnullable
      inspection_submissions_countintegernullable

      The count of inspection submissions related to the Issue.

      last_inspection_submission_atdate-timenullable

      The date and time of the last inspection submission related to the Issue.

      failed_inspection_item_labelstringnullable

      The label associated with a failed inspection item.

      comments object[]

      A list of the comments made on this record.

    • 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
      commentable_typeCommentableType (string)required

      The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

      Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

      commentable_idId (integer)required

      Possible values: >= 1

      user_idId (integer)required

      Possible values: >= 1

      titlestringdeprecated

      The title of the Comment.

      commentstringrequired

      The content of the Comment message body.

      user_full_namestringrequired

      The full name of the User who created the Comment.

      user_image_urlstringnullablerequired

      The image url for the User who created the Comment.

      rich_contentobjectnullablerequired
      html_contentstringnullablerequired

      The comment message body rendered as HTML.

      with_mentionsbooleanrequired

      Indicates if the message body contains @mentions.

    • ]
    • comments_countinteger

      The number of comments made on this record.

      Possible values: >= 0

      documents object[]

      A list of the documents attached to this record.

    • 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
      namestringrequired

      The name of the document.

      descriptionstringrequired

      The description of the document.

      documentable_idId (integer)required

      Possible values: >= 1

      documentable_typeDocumentableType (string)required

      Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]

      file_namestringrequired

      The name of the file.

      file_mime_typestringrequired

      The MIME type of the file.

      file_sizenumberrequired

      The size of the file in bytes.

      file_urlstringrequired

      The URL to access the file.

      full_file_urlstringrequired

      The full URL to access the file, including any necessary authentication or parameters.

    • ]
    • documents_countinteger

      The number of documents attached to this record.

      Possible values: >= 0

      images object[]

      A list of the images attached to this record.

    • 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
      imageable_idId (integer)

      Possible values: >= 1

      imageable_typeImageableType (string)

      Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]

      file_namestring

      The name of the image file.

      file_mime_typeImage MIME Type (string)

      Possible 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_sizenumber

      The size of the image file in bytes.

      file_urlstring

      The URL to access the image file.

      full_urlstring

      The full URL to access the image file, including any necessary authentication or parameters.

    • ]
    • images_countinteger

      The number of images attached to this record.

      Possible values: >= 0

    • ]
    • meter_entry objectnullablerequired

      A Meter Entry

      idinteger
      created_atdate-time
      updated_atdate-time
      auto_voided_atdate-timenullable

      The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.

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

      A category to describe the function of this Meter Entry.

      Possible values: [starting, ending, nightly, manual]

      meter_typestringnullable

      Indicates whether or not this Meter is a secondary Meter.

      Possible values: [secondary]

      meterable_idNullableId (integer)nullable

      Possible values: >= 1

      meterable_typestringnullable

      The type of the object with which this Meter Entry is associated.

      Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]

      valuestring

      The current value of the meter.

      vehicle_idNullableId (integer)nullable

      Possible values: >= 1

      voidboolean

      Indicates whether or not this Meter Entry has been voided.

      Default value: false
      typestringnullable

      Possible values: [GpsMeterEntry]

      datedate

      The date on which this Meter Entry was recorded. Formatted according to ISO-8601.

      Example: 2023-03-14
      secondary_meter_entry objectnullable

      A Meter Entry

      idinteger
      created_atdate-time
      updated_atdate-time
      auto_voided_atdate-timenullable

      The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.

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

      A category to describe the function of this Meter Entry.

      Possible values: [starting, ending, nightly, manual]

      meter_typestringnullable

      Indicates whether or not this Meter is a secondary Meter.

      Possible values: [secondary]

      meterable_idNullableId (integer)nullable

      Possible values: >= 1

      meterable_typestringnullable

      The type of the object with which this Meter Entry is associated.

      Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]

      valuestring

      The current value of the meter.

      vehicle_idNullableId (integer)nullable

      Possible values: >= 1

      voidboolean

      Indicates whether or not this Meter Entry has been voided.

      Default value: false
      typestringnullable

      Possible values: [GpsMeterEntry]

      datedate

      The date on which this Meter Entry was recorded. Formatted according to ISO-8601.

      Example: 2023-03-14
      vmrs_repair_priority_class objectnullablerequired

      The Vehicle Maintenance Reporting Standards (VMRS) Repair Priority Class for this Service Entry.

      idinteger

      The ID of the VMRS Repair Priority Class.

      codestring

      The code of the VMRS Repair Priority Class.

      namestring

      The name of the VMRS Repair Priority Class.

      colorstring

      The color of the VMRS Repair Priority Class.

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

      Possible values: >= 1

      namestring
    • ]
    • auto_integrate_ro_idNullableId (integer)nullablerequired

      Possible values: >= 1

      auto_integrate_ro_linkstringnullable

      The Auto Integrate Repair Order link for this Service Entry.

      auto_integrate_repair_order_statusstringnullablerequired

      The Auto Integrate Repair Order status for this Service Entry.

      Possible values: [approved, auto_approved, awaiting_reconciliation, completed, failed_reconciliation, invoiced, needs_approval, needs_reapproval, paid, rejected]

      auto_integrate_repair_order_status_colorstringnullablerequired

      The color applied to the Auto Integrate Repair Order status for this Service Entry.

      invoice objectnullable

      A Repair Order Invoice

      idId (integer)

      Possible values: >= 1

      created_atdate-time

      The date and time when the Invoice was created.

      po_numberstring

      The PO number for the Invoice.

      updated_atdate-time

      The date and time when the Invoice was last updated.

      discountfloatnullable

      The discount amount.

      discount_typeDiscountType (string)nullable

      The type of discount applied to this record.

      Possible values: [fixed, percentage]

      Default value: percentage
      discount_percentagefloatnullable

      The discount percentage. This field should be present when discount_type is set to percentage.

      feesfloat

      The fees amount. This is the sum of any ServiceEntryFeeLineItems present.

      subtotalfloat

      The pre-tax subtotal amount.

      parts_subtotalfloat

      The pre-tax subtotal amount for parts.

      labor_subtotalfloat

      The pre-tax subtotal amount for labor.

      tax_1floatnullable

      The primary tax amount.

      tax_1_percentagefloatnullable

      The primary tax percentage.

      tax_1_typestringnullable

      The primary tax type.

      tax_2floatnullable

      The secondary tax amount.

      tax_2_percentagefloatnullable

      The secondary tax percentage.

      tax_2_typestringnullable

      The secondary tax type.

      parts_markup_typePartMarkupType (string)

      The type of parts markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans

      Possible values: [fixed, percentage]

      parts_markupfloat

      The parts markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans

      Example: 1.23
      parts_markup_percentagefloat

      The parts markup percentage amount. This field should be present when parts_markup_type is set to percentage.

      Note that this is a readonly value that will default to 0.0 for non-premium plans

      Example: 1.23
      labor_markup_typeLaborMarkupType (string)

      The type of labor markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans

      Possible values: [fixed, percentage]

      labor_markupfloat

      The labor markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans

      Example: 1.23
      labor_markup_percentagefloat

      The labor markup percentage amount. This field should be present when labor_markup_type is set to percentage.

      Note that this is a readonly value that will default to 0.0 for non-premium plans

      Example: 1.23
      total_amountfloat

      The total amount.

      comments object[]required

      A list of the comments made on this record.

    • 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
      commentable_typeCommentableType (string)required

      The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

      Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

      commentable_idId (integer)required

      Possible values: >= 1

      user_idId (integer)required

      Possible values: >= 1

      titlestringdeprecated

      The title of the Comment.

      commentstringrequired

      The content of the Comment message body.

      user_full_namestringrequired

      The full name of the User who created the Comment.

      user_image_urlstringnullablerequired

      The image url for the User who created the Comment.

      rich_contentobjectnullablerequired
      html_contentstringnullablerequired

      The comment message body rendered as HTML.

      with_mentionsbooleanrequired

      Indicates if the message body contains @mentions.

    • ]
    • comments_countintegerrequired

      The number of comments made on this record.

      Possible values: >= 0

      labor_time_in_secondsintegernullable

      The sum, in seconds, of the duration of all labor line items of the Work Order that created this Service Entry, if applicable. This field is only relevant when the Service Entry is created from a Work Order.

      documents object[]

      A list of the documents attached to this record.

    • 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
      namestringrequired

      The name of the document.

      descriptionstringrequired

      The description of the document.

      documentable_idId (integer)required

      Possible values: >= 1

      documentable_typeDocumentableType (string)required

      Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]

      file_namestringrequired

      The name of the file.

      file_mime_typestringrequired

      The MIME type of the file.

      file_sizenumberrequired

      The size of the file in bytes.

      file_urlstringrequired

      The URL to access the file.

      full_file_urlstringrequired

      The full URL to access the file, including any necessary authentication or parameters.

    • ]
    • documents_countintegerrequired

      The number of documents attached to this record.

      Possible values: >= 0

      images object[]required

      A list of the images attached to this record.

    • 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
      imageable_idId (integer)

      Possible values: >= 1

      imageable_typeImageableType (string)

      Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]

      file_namestring

      The name of the image file.

      file_mime_typeImage MIME Type (string)

      Possible 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_sizenumber

      The size of the image file in bytes.

      file_urlstring

      The URL to access the image file.

      full_urlstring

      The full URL to access the image file, including any necessary authentication or parameters.

    • ]
    • images_countintegerrequired

      The number of images attached to this record.

      Possible values: >= 0

    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)

    Request Collapse all
    Base URL
    https://secure.fleetio.com/api
    Auth
    Body
    {
      "completed_at": "2023-03-14T13:46:27-06:00",
      "started_at": "2023-03-14T13:46:27-06:00",
      "vehicle_id": 0,
      "vehicle_vin": "string",
      "vendor_id": 0,
      "reference": "string",
      "label_list": "High Priority",
      "general_notes": "string",
      "vmrs_repair_priority_class_id": 0,
      "custom_fields": {},
      "meter_entry_attributes": {
        "value": "108043",
        "void": true
      },
      "secondary_meter_entry_attributes": {
        "value": "108043",
        "void": true
      },
      "service_entry_line_items_attributes": [
        {
          "id": 0,
          "service_task_id": 0,
          "type": "ServiceEntryServiceTaskLineItem",
          "description": "string",
          "labor_cost": 0,
          "parts_cost": 0,
          "subtotal": 0,
          "service_entry_line_item_id": 0,
          "issue_ids": [
            "string"
          ],
          "vmrs_reason_for_repair_id": 0,
          "vmrs_system_group_id": 0,
          "vmrs_system_id": 0,
          "vmrs_component_id": 0,
          "vmrs_assembly_id": 0
        }
      ],
      "issue_ids": [
        0
      ],
      "service_task_ids": [
        0
      ],
      "comments_attributes": [
        {
          "title": "string",
          "comment": "string"
        }
      ],
      "documents_attributes": [
        {
          "name": "string",
          "file_url": "string",
          "file_mime_type": "string",
          "file_name": "string",
          "file_size": 0
        }
      ],
      "images_attributes": [
        {
          "name": "string",
          "file_url": "string",
          "file_mime_type": "string",
          "file_name": "string",
          "file_size": 0
        }
      ],
      "labor_subtotal": 0,
      "parts_subtotal": 0,
      "subtotal": 0,
      "discount": 0,
      "discount_percentage": 0,
      "discount_type": "percentage",
      "tax_1": 0,
      "tax_1_percentage": 0,
      "tax_1_type": "percentage",
      "tax_2": 0,
      "tax_2_percentage": 0,
      "tax_2_type": "percentage",
      "total_amount": 0
    }
    
    ResponseClear

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