Skip to main content

Create Service Entry

Creates a new Service Entry

Request Body

  • completed_at date-time required

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

  • started_at date-time

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

  • vehicle_id integer required

    Possible values: >= 1

  • vehicle_vin string

    Possible values: <= 17 characters

    The VIN of the Vehicle associated with this Service Entry.

  • vendor_id integer

    Possible values: >= 1

  • reference string

    Possible values: <= 255 characters

    A reference number for this Service Entry.

  • label_list string

    Possible values: <= 255 characters

    A comma separated list of tags associated with this record. The only delimiter allowed is a comma (,). Please remove any commas from your labels before saving the record.

  • general_notes string

    Any general notes about this Service Entry.

  • vmrs_repair_priority_class_id integer

    Possible values: >= 1

  • custom_fields object

    *Full details on working with Custom Fields here.

  • meter_entry_attributes object required

    A Service Entry may be associated with a Meter Entry

  • value float

    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.

  • void boolean

    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

  • value float

    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.

  • void boolean

    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[]
  • id integer

    Possible values: >= 1

  • service_task_id integer

    Possible values: >= 1

  • type string

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

    Denotes the type of the ServiceEntryLineItem

  • description string

    Free text field, used for notes or description.

  • labor_cost float

    Total labor cost for this line item.

  • parts_cost float

    Total parts cost for this line item.

  • subtotal float

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

  • service_entry_line_item_id integer

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

  • issue_ids string[]

    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_id integer

    Possible values: >= 1

  • vmrs_system_group_id integer

    Possible values: >= 1

  • vmrs_system_id integer

    Possible values: >= 1

  • vmrs_component_id integer

    Possible values: >= 1

  • vmrs_assembly_id integer

    Possible values: >= 1

  • issue_ids integer[]

    Possible values: >= 1

    The IDs of any Issues associated with this Service Entry.

  • service_task_ids integer[]

    Possible values: >= 1

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

  • comments_attributes object[]
  • title string

    The title of the comment.

  • comment string

    The comment text.

  • documents_attributes object[]

    An array of one or more document objects to add to the record. You may provide your own file_url, or follow our Attaching Documents and Images guide to upload to our third party storage provider.

  • name string

    Possible values: <= 255 characters

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

  • file_url string

    Possible values: <= 255 characters

    The URL pointing to the file.

  • file_mime_type string

    Possible values: <= 255 characters

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

  • file_name string

    Possible values: <= 255 characters

    The name of the file.

  • file_size integer

    The size of the file in bytes.

  • images_attributes object[]

    An array of one or more image objects to add to the record. You may provide your own file_url, or follow our Attaching Documents and Images guide to upload to our third party storage provider.

  • name string

    Possible values: <= 255 characters

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

  • file_url string

    Possible values: <= 255 characters

    The URL pointing to the image.

  • file_mime_type string

    Possible values: <= 255 characters

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

  • file_name string

    Possible values: <= 255 characters

    The name of the image.

  • file_size integer

    The size of the image file in bytes.

  • labor_subtotal float

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

  • parts_subtotal float

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

  • subtotal float

    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.

  • discount float

    The total discount amount for this Service Entry.

  • discount_percentage float

    The total discount percentage for this Service Entry.

  • discount_type DiscountType

    Possible values: [fixed, percentage]

    Default value: percentage

    The type of discount applied to this record.

  • tax_1 float

    The first tax amount for this Service Entry.

  • tax_1_percentage float

    The first tax percentage for this Service Entry.

  • tax_1_type string

    Possible values: [fixed, percentage]

    Default value: percentage

    The type of tax to apply to this record.

  • tax_2 float

    The second tax amount for this Service Entry.

  • tax_2_percentage float

    The second tax percentage for this Service Entry.

  • tax_2_type string

    Possible values: [fixed, percentage]

    Default value: percentage

    The type of tax to apply to this record.

  • total_amount float

    The grand total of this Service Entry.

Responses

OK

Response Headers

    Schema

    • id integer
    • created_at date-time
    • updated_at date-time
    • tax_free_labor boolean

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

    • completed_at date-time

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

    • reference string

      A reference number for this Service Entry.

    • started_at date-time

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

    • status string

      Possible values: [pending, completed]

      The status of this Service Entry.

    • custom_fields object

      *Full details on working with Custom Fields here.

    • general_notes string

      General notes for this Service Entry.

    • vehicle_id integer

      Possible values: >= 1

    • vehicle_name string

      The name of the Vehicle associated with this Service Entry.

    • vendor_id NullableId

      Possible values: >= 1

    • vendor_name string

      The name of the Vendor associated with this Service Entry.

    • work_order_id NullableId

      Possible values: >= 1

    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

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

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

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

    • is_sample boolean

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

    • work_order_number integer

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

    • date date-time

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

    • service_entry_line_items object[]
    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • description string

      A description of the service performed for this line item.

    • type string

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

      Denotes the type of the ServiceEntryLineItem

    • service_entry_line_item_id integer

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

    • service_reminder_id integer

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

    • service_task object

      A Service Task

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • name string

      Possible values: <= 255 characters

      A name for this Service Task.

    • description string

      A description of this Service Task.

    • expected_duration_in_seconds integer

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

    • archived_at date-time

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

    • subtasks object[]
    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • name string

      The name of this subtask.

    • description string

      A description of this subtask.

    • expected_duration_in_seconds integer

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

    • subtasks array

      The subtasks array at this level will always be empty.

    • default_vmrs_reason_for_repair object
    • account_id integer
    • alias string
    • code string
    • enabled boolean
    • id integer
    • name string
    • repair_type string
    • standard boolean
    • standard_name string
    • type string
    • vmrs_standard_reason_for_repair object
    • default_vmrs_system_group object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_system object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_assembly object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_component object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • usage integer

      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 object
    • account_id integer
    • alias string
    • code string
    • enabled boolean
    • id integer
    • name string
    • repair_type string
    • standard boolean
    • standard_name string
    • type string
    • vmrs_standard_reason_for_repair object
    • default_vmrs_system_group object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_system object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_assembly object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_component object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • service_task_parts object[]

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

    • id integer
    • quantity float

      The quantity of this Part related to the Service Task.

    • part_id integer

      The ID of this Part related to the Service Task.

    • part_archived_at date-time

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

    • position integer

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

    • issues object[]

      Any Issues this line item is linked to.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • number string

      A unique identifier for the Issue.

    • name string

      The name of the Issue.

    • summary string

      A summary of the Issue.

    • description string

      A longer description of the Issue.

    • state string

      Possible values: [Open, Closed, Resolved]

      The Issue's current state.

    • reported_at date-time

      The date and time at which the issue was reported.

    • reported_by_id NullableId

      Possible values: >= 1

    • reported_by_name string

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

    • fault_id NullableId

      Possible values: >= 1

    • due_date date

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

    • due_meter_value string

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

    • due_secondary_meter_value float

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

    • overdue boolean

      Indicates whether the Issue is overdue.

    • vehicle_id integer

      Possible values: >= 1

    • vehicle_name string

      The name of the Vehicle associated with this Issue.

    • is_sample boolean

      Indicates whether this Issue is sample data.

    • created_by_workflow boolean

      Indicates whether this Issue was created by a workflow.

    • submitted_inspection_form_id NullableId

      Possible values: >= 1

    • custom_fields object

      *Full details on working with Custom Fields here.

    • valid_required_custom_fields boolean
    • dtc_alert_id NullableId

      Possible values: >= 1

    • assigned_contacts object[]

      An array of assigned Contacts related to the Issue.

    • id integer
    • created_at date-time
    • updated_at date-time
    • email string

      The Contact's email address.

    • name string

      The Contact's full name.

    • first_name string

      The Contact's first name.

    • middle_name string

      The Contact's middle name.

    • last_name string

      The Contact's last name.

    • images_count integer

      The number of images associated with this Contact.

    • documents_count integer

      The number of documents associated with this Contact.

    • comments_count integer

      The number of comments associated with this Contact.

    • group_id integer

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

    • group_name string

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

    • group_hierarchy string

      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.

    • technician boolean

      Whether or not the Contact is a Technician.

    • vehicle_operator boolean

      Whether or not the Contact is a Vehicle Operator.

    • employee boolean

      Whether or not the Contact is an Employee.

    • birth_date date

      The Contact's birth date.

    • street_address string

      The Contact's street address.

    • street_address_line_2 string

      The Contact's street address line 2.

    • city string

      The Contact's city.

    • region string

      The Contact's region, state, or province.

    • postal_code string

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

    • country string

      The Contact's country.

    • employee_number string

      The Contact's employee number.

    • job_title string

      Possible values: <= 255 characters

      The Contact's job title.

    • license_class string

      The Contact's driver's license class.

    • license_number string

      The Contact's driver's license number.

    • license_state string

      The locality which issued the Contact's license.

    • license_expiration date

      The Contact's driver's license expiration date.

    • home_phone_number string

      The Contact's home phone number.

    • mobile_phone_number string

      The Contact's mobile phone number.

    • work_phone_number string

      The Contact's work phone number.

    • other_phone_number string

      Any other phone number for this Contact.

    • start_date date

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

    • leave_date date

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

    • hourly_labor_rate float

      The Contact's hourly rate.

    • custom_fields object

      *Full details on working with Custom Fields here.

    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

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

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

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

    • default_image_url string

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

    • user object

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

    • account_membership_id NullableId

      Possible values: >= 1

    • labels object[]
    • id integer

      Possible values: >= 1

    • name string
    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

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

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

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

    • is_watched boolean

      Default value: false

      Indicates whether the Issue is watched.

    • vehicle_image_url string

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

    • vehicle_image_url_medium string

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

    • vehicle_image_url_small string

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

    • vehicle_image_url_large string

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

    • watchers_count integer

      The count of watchers related to the Issue.

    • linked_work_orders object[]

      Summative information of linked Work Orders related to the Issue.

    • id integer

      Possible values: >= 1

    • number integer

      The Work Order number.

    • issued_at date-time

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

    • source object

      Inspection source information.

    • inspection_form object
    • id NullableId

      Possible values: >= 1

    • color string
    • title string
    • inspection_submissions_count integer

      The count of inspection submissions related to the Issue.

    • last_inspection_submission_at date-time

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

    • failed_inspection_item_label string

      The label associated with a failed inspection item.

    • comments object[]

      A list of the comments made on this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • commentable_type CommentableType

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

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

    • commentable_id integer

      Possible values: >= 1

    • user_id integer

      Possible values: >= 1

    • title string deprecated

      The title of the Comment.

    • comment string

      The content of the Comment message body.

    • user_full_name string

      The full name of the User who created the Comment.

    • user_image_url string

      The image url for the User who created the Comment.

    • rich_content object
    • html_content string

      The comment message body rendered as HTML.

    • with_mentions boolean

      Indicates if the message body contains @mentions.

    • comments_count integer

      The number of comments made on this record.

    • documents object[]

      A list of the documents attached to this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • documentable_id integer

      Possible values: >= 1

    • documentable_type DocumentableType

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

    • file_name string

      The name of the file.

    • file_mime_type string

      The MIME type of the file.

    • file_size number

      The size of the file in bytes.

    • file_url string

      The URL to access the file.

    • full_file_url string

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

    • documents_count integer

      The number of documents attached to this record.

    • images object[]

      A list of the images attached to this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • imageable_id integer

      Possible values: >= 1

    • imageable_type ImageableType

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

    • file_name string

      The name of the image file.

    • file_mime_type Image MIME Type

      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_size number

      The size of the image file in bytes.

    • file_url string

      The URL to access the image file.

    • full_url string

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

    • images_count integer

      The number of images attached to this record.

    • labor_cost float

      The total cost of labor for this line item.

    • parts_cost float

      The total cost of parts for this line item.

    • subtotal float

      The pre-tax cost of this line item.

    • vmrs_reason_for_repair object
    • account_id integer
    • alias string
    • code string
    • enabled boolean
    • id integer
    • name string
    • repair_type string
    • standard boolean
    • standard_name string
    • type string
    • vmrs_standard_reason_for_repair object
    • vmrs_system_group object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • vmrs_system object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • vmrs_assembly object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • vmrs_component object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • service_tasks object[]
    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • name string

      Possible values: <= 255 characters

      A name for this Service Task.

    • description string

      A description of this Service Task.

    • expected_duration_in_seconds integer

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

    • archived_at date-time

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

    • subtasks object[]
    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • name string

      The name of this subtask.

    • description string

      A description of this subtask.

    • expected_duration_in_seconds integer

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

    • subtasks array

      The subtasks array at this level will always be empty.

    • default_vmrs_reason_for_repair object
    • account_id integer
    • alias string
    • code string
    • enabled boolean
    • id integer
    • name string
    • repair_type string
    • standard boolean
    • standard_name string
    • type string
    • vmrs_standard_reason_for_repair object
    • default_vmrs_system_group object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_system object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_assembly object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_component object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • usage integer

      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 object
    • account_id integer
    • alias string
    • code string
    • enabled boolean
    • id integer
    • name string
    • repair_type string
    • standard boolean
    • standard_name string
    • type string
    • vmrs_standard_reason_for_repair object
    • default_vmrs_system_group object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_system object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_assembly object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • default_vmrs_component object
    • account_id number
    • assembly_code string
    • assembly_name string
    • code_type string

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

    • component_code string
    • component_name string
    • enabled boolean
    • id integer
    • permissions object
    • destroy boolean
    • standard boolean
    • system_code string
    • system_group string
    • system_group_code string
    • system_name string
    • type string
    • vmrs_standard_system_assembly_component object
    • service_task_parts object[]

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

    • id integer
    • quantity float

      The quantity of this Part related to the Service Task.

    • part_id integer

      The ID of this Part related to the Service Task.

    • part_archived_at date-time

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

    • position integer

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

    • issues object[]
    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • number string

      A unique identifier for the Issue.

    • name string

      The name of the Issue.

    • summary string

      A summary of the Issue.

    • description string

      A longer description of the Issue.

    • state string

      Possible values: [Open, Closed, Resolved]

      The Issue's current state.

    • reported_at date-time

      The date and time at which the issue was reported.

    • reported_by_id NullableId

      Possible values: >= 1

    • reported_by_name string

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

    • fault_id NullableId

      Possible values: >= 1

    • due_date date

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

    • due_meter_value string

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

    • due_secondary_meter_value float

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

    • overdue boolean

      Indicates whether the Issue is overdue.

    • vehicle_id integer

      Possible values: >= 1

    • vehicle_name string

      The name of the Vehicle associated with this Issue.

    • is_sample boolean

      Indicates whether this Issue is sample data.

    • created_by_workflow boolean

      Indicates whether this Issue was created by a workflow.

    • submitted_inspection_form_id NullableId

      Possible values: >= 1

    • custom_fields object

      *Full details on working with Custom Fields here.

    • valid_required_custom_fields boolean
    • dtc_alert_id NullableId

      Possible values: >= 1

    • assigned_contacts object[]

      An array of assigned Contacts related to the Issue.

    • id integer
    • created_at date-time
    • updated_at date-time
    • email string

      The Contact's email address.

    • name string

      The Contact's full name.

    • first_name string

      The Contact's first name.

    • middle_name string

      The Contact's middle name.

    • last_name string

      The Contact's last name.

    • images_count integer

      The number of images associated with this Contact.

    • documents_count integer

      The number of documents associated with this Contact.

    • comments_count integer

      The number of comments associated with this Contact.

    • group_id integer

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

    • group_name string

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

    • group_hierarchy string

      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.

    • technician boolean

      Whether or not the Contact is a Technician.

    • vehicle_operator boolean

      Whether or not the Contact is a Vehicle Operator.

    • employee boolean

      Whether or not the Contact is an Employee.

    • birth_date date

      The Contact's birth date.

    • street_address string

      The Contact's street address.

    • street_address_line_2 string

      The Contact's street address line 2.

    • city string

      The Contact's city.

    • region string

      The Contact's region, state, or province.

    • postal_code string

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

    • country string

      The Contact's country.

    • employee_number string

      The Contact's employee number.

    • job_title string

      Possible values: <= 255 characters

      The Contact's job title.

    • license_class string

      The Contact's driver's license class.

    • license_number string

      The Contact's driver's license number.

    • license_state string

      The locality which issued the Contact's license.

    • license_expiration date

      The Contact's driver's license expiration date.

    • home_phone_number string

      The Contact's home phone number.

    • mobile_phone_number string

      The Contact's mobile phone number.

    • work_phone_number string

      The Contact's work phone number.

    • other_phone_number string

      Any other phone number for this Contact.

    • start_date date

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

    • leave_date date

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

    • hourly_labor_rate float

      The Contact's hourly rate.

    • custom_fields object

      *Full details on working with Custom Fields here.

    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

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

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

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

    • default_image_url string

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

    • user object

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

    • account_membership_id NullableId

      Possible values: >= 1

    • labels object[]
    • id integer

      Possible values: >= 1

    • name string
    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

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

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

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

    • is_watched boolean

      Default value: false

      Indicates whether the Issue is watched.

    • vehicle_image_url string

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

    • vehicle_image_url_medium string

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

    • vehicle_image_url_small string

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

    • vehicle_image_url_large string

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

    • watchers_count integer

      The count of watchers related to the Issue.

    • linked_work_orders object[]

      Summative information of linked Work Orders related to the Issue.

    • id integer

      Possible values: >= 1

    • number integer

      The Work Order number.

    • issued_at date-time

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

    • source object

      Inspection source information.

    • inspection_form object
    • id NullableId

      Possible values: >= 1

    • color string
    • title string
    • inspection_submissions_count integer

      The count of inspection submissions related to the Issue.

    • last_inspection_submission_at date-time

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

    • failed_inspection_item_label string

      The label associated with a failed inspection item.

    • comments object[]

      A list of the comments made on this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • commentable_type CommentableType

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

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

    • commentable_id integer

      Possible values: >= 1

    • user_id integer

      Possible values: >= 1

    • title string deprecated

      The title of the Comment.

    • comment string

      The content of the Comment message body.

    • user_full_name string

      The full name of the User who created the Comment.

    • user_image_url string

      The image url for the User who created the Comment.

    • rich_content object
    • html_content string

      The comment message body rendered as HTML.

    • with_mentions boolean

      Indicates if the message body contains @mentions.

    • comments_count integer

      The number of comments made on this record.

    • documents object[]

      A list of the documents attached to this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • documentable_id integer

      Possible values: >= 1

    • documentable_type DocumentableType

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

    • file_name string

      The name of the file.

    • file_mime_type string

      The MIME type of the file.

    • file_size number

      The size of the file in bytes.

    • file_url string

      The URL to access the file.

    • full_file_url string

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

    • documents_count integer

      The number of documents attached to this record.

    • images object[]

      A list of the images attached to this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • imageable_id integer

      Possible values: >= 1

    • imageable_type ImageableType

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

    • file_name string

      The name of the image file.

    • file_mime_type Image MIME Type

      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_size number

      The size of the image file in bytes.

    • file_url string

      The URL to access the image file.

    • full_url string

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

    • images_count integer

      The number of images attached to this record.

    • meter_entry object

      A Meter Entry

    • id integer
    • created_at date-time
    • updated_at date-time
    • auto_voided_at date-time

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

    • category string

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

      A category to describe the function of this Meter Entry.

    • meter_type string

      Possible values: [secondary]

      Indicates whether or not this Meter is a secondary Meter.

    • meterable_id NullableId

      Possible values: >= 1

    • meterable_type string

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

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

    • value string

      The current value of the meter.

    • vehicle_id NullableId

      Possible values: >= 1

    • void boolean

      Default value: false

      Indicates whether or not this Meter Entry has been voided.

    • type string

      Possible values: [GpsMeterEntry]

    • date date

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

    • secondary_meter_entry object

      A Meter Entry

    • id integer
    • created_at date-time
    • updated_at date-time
    • auto_voided_at date-time

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

    • category string

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

      A category to describe the function of this Meter Entry.

    • meter_type string

      Possible values: [secondary]

      Indicates whether or not this Meter is a secondary Meter.

    • meterable_id NullableId

      Possible values: >= 1

    • meterable_type string

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

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

    • value string

      The current value of the meter.

    • vehicle_id NullableId

      Possible values: >= 1

    • void boolean

      Default value: false

      Indicates whether or not this Meter Entry has been voided.

    • type string

      Possible values: [GpsMeterEntry]

    • date date

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

    • vmrs_repair_priority_class object

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

    • id integer

      The ID of the VMRS Repair Priority Class.

    • code string

      The code of the VMRS Repair Priority Class.

    • name string

      The name of the VMRS Repair Priority Class.

    • color string

      The color of the VMRS Repair Priority Class.

    • labels object[]
    • id integer

      Possible values: >= 1

    • name string
    • auto_integrate_ro_id NullableId

      Possible values: >= 1

    • auto_integrate_ro_link string

      The Auto Integrate Repair Order link for this Service Entry.

    • auto_integrate_repair_order_status string

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

      The Auto Integrate Repair Order status for this Service Entry.

    • auto_integrate_repair_order_status_color string

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

    • invoice object

      An MSI Repair Order Invoice (pass expand[]=invoice in query to include in response)

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time when the Invoice was created.

    • po_number string

      The PO number for the Invoice.

    • updated_at date-time

      The date and time when the Invoice was last updated.

    • discount float

      The discount amount.

    • discount_type DiscountType

      Possible values: [fixed, percentage]

      Default value: percentage

      The type of discount applied to this record.

    • discount_percentage float

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

    • fees float

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

    • subtotal float

      The pre-tax subtotal amount.

    • parts_subtotal float

      The pre-tax subtotal amount for parts.

    • labor_subtotal float

      The pre-tax subtotal amount for labor.

    • tax_1 float

      The primary tax amount.

    • tax_1_percentage float

      The primary tax percentage.

    • tax_1_type string

      The primary tax type.

    • tax_2 float

      The secondary tax amount.

    • tax_2_percentage float

      The secondary tax percentage.

    • tax_2_type string

      The secondary tax type.

    • total_amount float

      The total amount.

    • comments object[]

      A list of the comments made on this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • commentable_type CommentableType

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

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

    • commentable_id integer

      Possible values: >= 1

    • user_id integer

      Possible values: >= 1

    • title string deprecated

      The title of the Comment.

    • comment string

      The content of the Comment message body.

    • user_full_name string

      The full name of the User who created the Comment.

    • user_image_url string

      The image url for the User who created the Comment.

    • rich_content object
    • html_content string

      The comment message body rendered as HTML.

    • with_mentions boolean

      Indicates if the message body contains @mentions.

    • comments_count integer

      The number of comments made on this record.

    • labor_time_in_seconds integer

      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.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • documentable_id integer

      Possible values: >= 1

    • documentable_type DocumentableType

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

    • file_name string

      The name of the file.

    • file_mime_type string

      The MIME type of the file.

    • file_size number

      The size of the file in bytes.

    • file_url string

      The URL to access the file.

    • full_file_url string

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

    • documents_count integer

      The number of documents attached to this record.

    • images object[]

      A list of the images attached to this record.

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • imageable_id integer

      Possible values: >= 1

    • imageable_type ImageableType

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

    • file_name string

      The name of the image file.

    • file_mime_type Image MIME Type

      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_size number

      The size of the image file in bytes.

    • file_url string

      The URL to access the image file.

    • full_url string

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

    • images_count integer

      The number of images attached to this record.

    Loading...