FLfleetio
Service Entries

Retrieve Service Entry

Retrieve the details of an existing Service Entry.

get/service_entries/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger
created_atstring date-time
updated_atstring date-time
tax_free_laborboolean

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

completed_atstring date-time nullable required

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

referencestring nullable required

A reference number for this Service Entry.

started_atstring date-time nullable required

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

status'pending' | 'completed' required

The status of this Service Entry.

custom_fieldsCustomFields nullable required

*Full details on working with Custom Fields here.

general_notesstring nullable required

General notes for this Service Entry.

vehicle_idinteger required
vehicle_namestring nullable required

The name of the Vehicle associated with this Service Entry.

vendor_idinteger nullable required
vendor_namestring nullable required

The name of the Vendor associated with this Service Entry.

work_order_idinteger nullable required
is_sampleboolean required

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

work_order_numberinteger nullable required

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

datestring date-time required

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

auto_integrate_ro_idinteger nullable required
auto_integrate_ro_linkstring nullable

The Auto Integrate Repair Order link for this Service Entry.

auto_integrate_repair_order_status'approved' | 'auto_approved' | 'awaiting_reconciliation' | 'awaiting_invoice' | 'awaiting_payment' | 'completed' | 'failed_reconciliation' | 'invoiced' | 'needs_approval' | 'needs_reapproval' | 'paid' | 'rejected' nullable required

The Auto Integrate Repair Order status for this Service Entry.

auto_integrate_repair_order_status_colorstring nullable required

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

discountnumber float nullable

The discount amount.

discount_type'fixed' | 'percentage' nullable

The type of discount applied to this record.

discount_percentagenumber float nullable

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

feesnumber float

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

subtotalnumber float

The pre-tax subtotal amount.

parts_subtotalnumber float

The pre-tax subtotal amount for parts.

labor_subtotalnumber float

The pre-tax subtotal amount for labor.

tax_1number float nullable

The primary tax amount.

tax_1_percentagenumber float nullable

The primary tax percentage.

tax_1_typestring nullable

The primary tax type.

tax_2number float nullable

The secondary tax amount.

tax_2_percentagenumber float nullable

The secondary tax percentage.

tax_2_typestring nullable

The secondary tax type.

parts_markup_type'fixed' | 'percentage'

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

parts_markupnumber float

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

parts_markup_percentagenumber float

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

labor_markup_type'fixed' | 'percentage'

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

labor_markupnumber float

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

labor_markup_percentagenumber float

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

total_amountnumber float

The total amount.

comments_countinteger required

The number of comments made on this record.

labor_time_in_secondsinteger nullable

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_countinteger required

The number of documents attached to this record.

images_countinteger required

The number of images attached to this record.

Example response

{
  "completed_at": "2023-03-14T13:46:27-06:00",
  "started_at": "2023-03-14T13:46:27-06:00",
  "date": "2023-03-14T13:46:27-06:00",
  "service_entry_line_items": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "service_task": {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "subtasks": [
          {
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00"
          }
        ]
      },
      "issues": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "reported_at": "2023-03-14T13:46:27-06:00",
          "due_date": "2023-03-14",
          "assigned_contacts": [
            {
              "group_hierarchy": "Group 1|Group 2|Group 3",
              "birth_date": "2023-03-14",
              "street_address": "123 Main St",
              "street_address_line_2": "Apt 1",
              "license_expiration": "2023-03-14"
            }
          ],
          "comments": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00"
            }
          ],
          "documents": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00"
            }
          ],
          "images": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00"
            }
          ]
        }
      ]
    }
  ],
  "service_tasks": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "subtasks": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00"
        }
      ]
    }
  ],
  "issues": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "reported_at": "2023-03-14T13:46:27-06:00",
      "due_date": "2023-03-14",
      "assigned_contacts": [
        {
          "group_hierarchy": "Group 1|Group 2|Group 3",
          "birth_date": "2023-03-14",
          "street_address": "123 Main St",
          "street_address_line_2": "Apt 1",
          "license_expiration": "2023-03-14"
        }
      ],
      "comments": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00"
        }
      ],
      "documents": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00"
        }
      ],
      "images": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00"
        }
      ]
    }
  ],
  "meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "secondary_meter_entry": {
    "auto_voided_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14"
  },
  "parts_markup": 1.23,
  "parts_markup_percentage": 1.23,
  "labor_markup": 1.23,
  "labor_markup_percentage": 1.23,
  "comments": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "documents": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "images": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.