List Meter Entries

List your Meter Entries

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.
- category object
  include string required
- meterable_type object
  include string required
- meterable_id object
  eq string required
- vehicle_id object
  eq string required
- date object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  MOD5
  eq string required
- created_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- updated_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
sort object
The fields and direction to sort the results by.
- id string
  Possible values: [asc, desc]
  Default value: desc
- date string
  Possible values: [asc, desc]
- created_at string
  Possible values: [asc, desc]
- updated_at string
  Possible values: [asc, desc]

Responses

application/json

Schema
Example (from schema)

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
MOD1
MOD2
MOD3
MOD4
MOD5
MOD6
MOD7
category object
include string
sorted_by object[]
The sorts applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
MOD4
date string
Possible values: [asc, desc]
records object[]
id integer
auto_voided_at date-time
The date and time at which this Meter Entry was automatically voided.
category string
Possible values: [starting, ending, nightly, manual]
A category to describe the function of this Meter Entry.
meter_type string
Possible values: [primary, secondary]
Indicates whether this meter is a primary or secondary meter.
meterable_id integer
The id of the object with which this Meter Entry is associated.
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 integer
The id of the Vehicle associated with this meter entry, if any.
void boolean
Default value: false
Indicates whether or not this Meter Entry has been voided.
type string
Possible values: [GpsMeterEntry]
Indicates if this Meter Entry was submitted by a GPS provider.
gps_provider object
The GPS provider that submitted this Meter Entry.
date date
The date on which this Meter Entry was recorded.

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "category": {
        "include": "string"
      }
    },
    {
      "meterable_type": {
        "include": "string"
      }
    },
    {
      "meterable_id": {
        "eq": "string"
      }
    },
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "date": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "date": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "primary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "gps_provider": {},
      "date": "2023-03-14"
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (from schema)

Schema

errors object
type
items string

{
  "errors": {}
}

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"
}

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"
}