Service Entries

Update Service Entry

Changed on

Update a Service Entry

patch/service_entries/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

completed_atstring date-time

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

started_atstring date-time

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

vehicle_idinteger
vehicle_vinstring

The VIN of the Vehicle associated with this Service Entry.

vendor_idinteger
referencestring

A reference number for this Service Entry.

label_liststring

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_notesstring

Any general notes about this Service Entry.

vmrs_repair_priority_class_idinteger
custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

issue_idsId[]

The IDs of any Issues associated with this Service Entry.

service_task_idsId[]

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

labor_subtotalnumber float

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

manual_total_amountboolean

When true, preserves the submitted total_amount as a manually entered value instead of recalculating it from subtotals, discounts, taxes, fees, and markups.

manual_parts_or_labor_subtotalboolean

When true, preserves the submitted parts_subtotal and labor_subtotal as manually entered values instead of recalculating them from Service Entry Line Item costs.

parts_subtotalnumber float

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

subtotalnumber 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.

discountnumber float

The total discount amount for this Service Entry.

discount_percentagenumber float

The total discount percentage for this Service Entry.

discount_type'fixed' | 'percentage' nullable

The type of discount applied to this record.

tax_1number float

The first tax amount for this Service Entry.

tax_1_percentagenumber float

The first tax percentage for this Service Entry.

tax_1_type'fixed' | 'percentage' nullable

The type of tax to apply to this record.

tax_2number float

The second tax amount for this Service Entry.

tax_2_percentagenumber float

The second tax percentage for this Service Entry.

tax_2_type'fixed' | 'percentage' nullable

The type of tax to apply to this record.

total_amountnumber float

The grand total of this Service Entry.

Example request

{
  "completed_at": "2023-03-14T13:46:27-06:00",
  "started_at": "2023-03-14T13:46:27-06:00",
  "label_list": "High Priority",
  "meter_entry_attributes": {
    "value": 108043
  },
  "secondary_meter_entry_attributes": {
    "value": 108043
  }
}

Response

OK

Changes

    • warning

      the // request property's maxLength was set to 100000

    • warning

      the request property's maxLength was set to 100000

    • warning

      the // request property's maxLength was set to 100000

    • info

      added the new optional request property

    • info

      added the new optional request property