Skip to main content

Update Service Entry

Update a Service Entry

Path Parameters

  • id string required

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

    The id of the relevant record

Request Body

  • completed_at date-time

    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

    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

    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

Loading...