Skip to main content

List Service Entries

Returns a list of Service Entries belonging to your account.

Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return.

  • filter object

    The fields, operations, and values to filter the records by.

    • reference object
      oneOf
    • like string required
    • status object
    • include string required
    • labels object
    • include string required
    • completed_at object
      oneOf
    • lt string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • completed_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

    • created_at string

      Possible values: [asc, desc]

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

    The number of remaining records including the returned records, up to a maximum of 500.

  • filtered_by object[]

    The filters applied to the returned record set.

    anyOf
  • reference object
    oneOf
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • completed_at string

    Possible values: [asc, desc]

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

  • general_notes string

    General notes for this Service Entry.

  • vehicle_id integer
  • vendor_id integer
  • work_order_id integer
  • is_sample boolean

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

  • primary_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.

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

  • custom_fields object

    *Full details on working with Custom Fields here.

  • labels object[]
  • id integer

    Possible values: >= 1

  • name string
  • vendor object

    A Vendor

  • name string

    The name of the Vendor.

  • phone string

    The phone number of the Vendor.

  • city string

    The city of the Vendor.

  • region string

    The region, state, province, or territory of the Vendor.

  • postal_code string

    The postal code or ZIP code of the Vendor.

  • country string

    The country of the Vendor.

  • external_id string

    The external identifier of the Vendor.

  • vehicle object

    A Vehicle

  • id integer
  • name string

    This vehicle's name.

  • color string

    The color of this Vehicle.

  • license_plate string

    The license plate number of this Vehicle.

  • vin string

    The Vehicle Identification Number of this Vehicle.

  • year string

    This Vehicle's model year.

  • make string

    The name of this Vehicle's manufacturer.

  • model string

    The name of the model of this Vehicle.

  • trim string

    The trim level of this Vehicle.

  • registration_expiration_month integer

    Possible values: <= 12

    The month in which this Vehicle's registration expires.

  • registration_state string

    The state, province, or territory in which this Vehicle is registered.

  • default_image_url_small string

    The URL of a small-sized version of the default image for this Vehicle.

  • discount_type DiscountType

    Possible values: [fixed, percentage]

    Default value: percentage

    The type of discount applied to this record.

  • discount_percentage string

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

  • tax_1_type string

    The primary tax type.

  • tax_1_percentage string

    The primary tax percentage.

  • tax_2_type string

    The secondary tax type.

  • tax_2_percentage string

    The secondary tax percentage.

  • labor_subtotal_cents integer

    The pre-tax subtotal amount for labor.

  • parts_subtotal_cents integer

    The pre-tax subtotal amount for parts.

  • fees_cents integer

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

  • subtotal_cents integer

    The pre-tax subtotal amount.

  • discount_cents integer

    The discount amount.

  • tax_1_cents integer

    The primary tax amount.

  • tax_2_cents integer

    The secondary tax amount.

  • total_amount_cents integer

    The total amount.

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

Loading...