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
- application/json
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 floatThe 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 booleanIf 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 floatThe 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 booleanIf 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 integerPossible values:
>= 1
service_task_id integerPossible values:
>= 1
type stringPossible values: [
ServiceEntryServiceTaskLineItem
,ServiceEntryLaborLineItem
,ServiceEntryPartLineItem
,ServiceEntryTaxLineItem
,ServiceEntryFeeLineItem
,ServiceEntryTireLineItem
,ServiceEntryFreeTextLineItem
]Denotes the type of the ServiceEntryLineItem
description stringFree text field, used for notes or description.
labor_cost floatTotal labor cost for this line item.
parts_cost floatTotal parts cost for this line item.
subtotal floatSubtotal for this line item. If
parts_cost
orlabor_cost
are non-zero, this value is ignored.service_entry_line_item_id integerFor 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 integerPossible values:
>= 1
vmrs_system_group_id integerPossible values:
>= 1
vmrs_system_id integerPossible values:
>= 1
vmrs_component_id integerPossible values:
>= 1
vmrs_assembly_id integerPossible 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 stringThe title of the comment.
comment stringThe comment text.
documents_attributes object
name stringPossible values:
<= 255 characters
file_url stringPossible values:
<= 255 characters
file_mime_type stringPossible values:
<= 255 characters
file_name stringPossible values:
<= 255 characters
file_size stringimages_attributes object
name stringPossible values:
<= 255 characters
file_url stringPossible values:
<= 255 characters
file_mime_type stringPossible values:
<= 255 characters
file_name stringPossible values:
<= 255 characters
file_size number- labor_subtotal float
The total cost of labor for this Service Entry. This is calculated by summing the
labor_cost
of eachService Entry Line Item
. - parts_subtotal float
The total cost of
Parts
for this Service Entry. This is calculated by summing theparts_cost
of eachService 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 eachService 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.
- 204
- 401
- 403
- 404
- 422
- 500
OK
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
The requested resource could not be located
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Unprocessable Entity
- application/json
- Schema
- Example (from schema)
- Example
Schema
errors object
typeitems string
{
"errors": {}
}
{
"errors": {
"field1": [
"error1",
"error2"
],
"field2": [
"error3"
]
}
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}