Skip to main content

List Fuel Entries

Returns a list of Fuel 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.

    • external_id object
      oneOf
    • like string required
    • vehicle_id object
    • eq string required
    • vendor_id object
    • eq string required
    • date 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

    • date string

      Possible values: [asc, desc]

    • created_at string

      Possible values: [asc, desc]

    • updated_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
  • external_id object
    oneOf
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • date string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • external_id string

    Used to uniquely identify Fuel Entries that are imported from external systems, such as Fleetcor and Wex.

  • fuel_type_id integer

    Possible values: >= 1

    The Fleetio id of the Fuel Type associated with this Fuel Entry.

  • vehicle_id integer

    Possible values: >= 1

    The Fleetio id of the Vehicle associated with this Fuel Entry.

  • vendor_id integer

    Possible values: >= 1

    The Fleetio id of the Vendor associated with this Fuel Entry.

  • partial boolean

    Used to denote a partial fuel up as opposed to a complete fuel up. Learn more about partial Fuel Entries here.

  • personal boolean

    Used to denote a personal expense.

  • reference string

    Optional data field for collecting information such as the invoice number, transaction id, or receipt number, for example.

  • region string
  • reset boolean

    Default value: false

  • images_count integer

    The count of Images associated with this Fuel Entry.

  • documents_count integer

    The count of Documents associated with this Fuel Entry.

  • comments_count integer

    The count of Comments associated with this Fuel Entry.

  • watchers_count integer

    The count of Watchers associated with this Fuel Entry.

  • is_sample boolean
  • date date-time

    The date and time at which this Fuel Entry was recorded.

  • created_at date-time

    The date and time this Fuel Entry was created.

  • updated_at date-time

    The date and time this Fuel Entry was last updated.

  • cost_per_hr string

    The automatically calculated cost per hour since the last Fuel Entry.

  • cost_per_km string

    The automatically calculated cost per km since the last Fuel Entry.

  • cost_per_mi string

    The automatically calculated cost per mi since the last Fuel Entry.

  • kpl string

    Running average recorded kilometers per liter (calculated automatically).

  • uk_gallons string

    The fuel volume amount in UK gallons. This field will only be used if the Vehicle is configured to use UK Gallons, otherwise it will be ignored.

  • uk_gallons_per_hr string

    Running average of UK gallons used per hour. Calculated automatically.

  • us_gallons string

    The fuel volume amount in US gallons. This field will only be used if the Vehicle is configured to use US Gallons, otherwise it will be ignored.

  • us_gallons_per_hr string

    Running average of US gallons used per hour. Calculated automatically.

  • liters string

    The fuel volume amount in liters. This field will only be used if the Vehicle is configured to use liters, otherwise it will be ignored.

  • liters_per_hr string

    Running average recorded liters per hour (calculated automatically).

  • lp100k string

    Running average recorded liters per 100 kilometers (calculated automatically).

  • mpg_uk string

    Running average recorded miles per UK Gallon (calculated automatically).

  • mpg_us string

    Running average recorded miles per US Gallon (calculated automatically).

  • price_per_volume_unit string

    The unit price for the Vehicle's volume unit.

  • usage_in_hr string

    The automatically calculated usage in hours since the most recent Fuel Entry.

  • usage_in_km string

    The automatically calculated usage in kilometers since the most recent Fuel Entry.

  • usage_in_mi string

    The automatically calculated usage in miles since the most recent Fuel Entry.

  • total_amount_cents integer

    The total amount of the Fuel Entry in cents.

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

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

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

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

Loading...