Skip to main content

List Fuel Entries

GET 

https://secure.fleetio.com/api/v1/fuel_entries

Returns a list of Fuel Entries belonging to your account.

Request

Query Parameters

    start_cursor string

    The start cursor for Keyset pagination.

    per_page integer

    Possible values: >= 2 and <= 100

    The number of records per page to return.

    Default value: 50
    filter object

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

    external_id object
    oneOf
    likestringrequired
    vehicle_id object
    eqstringrequired
    vendor_id object
    eqstringrequired
    date object
    oneOf
    ltstringrequired
    created_at object
    oneOf
    ltstringrequired
    updated_at object
    oneOf
    ltstringrequired
    sort object

    The fields and direction to sort the results by.

    idSortAscDescDefaultDesc (string)

    Possible values: [asc, desc]

    Default value: desc
    dateSortAscDesc (string)

    Possible values: [asc, desc]

    created_atSortAscDesc (string)

    Possible values: [asc, desc]

    updated_atSortAscDesc (string)

    Possible values: [asc, desc]

Responses

OK

Schema
    start_cursorstringnullable

    The current start cursor of the records returned.

    next_cursorstringnullable

    The next cursor to retrieve the next page of records.

    per_pageinteger

    The maxumum number of records returned.

    estimated_remaining_countinteger

    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.

  • Array [
  • anyOf
    external_id object
    oneOf
    likestringrequired
  • ]
  • sorted_by object[]

    The sorts applied to the returned record set.

  • Array [
  • anyOf
    dateSortAscDesc (string)

    Possible values: [asc, desc]

  • ]
  • records object[]
  • Array [
  • idinteger
    external_idstringnullable

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

    fuel_type_idintegernullable

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

    Possible values: >= 1

    vehicle_idintegernullable

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

    Possible values: >= 1

    vendor_idintegernullable

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

    Possible values: >= 1

    partialboolean

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

    personalboolean

    Used to denote a personal expense.

    referencestringnullable

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

    regionstringnullable
    resetboolean
    Default value: false
    images_countinteger

    The count of Images associated with this Fuel Entry.

    documents_countinteger

    The count of Documents associated with this Fuel Entry.

    comments_countinteger

    The count of Comments associated with this Fuel Entry.

    watchers_countinteger

    The count of Watchers associated with this Fuel Entry.

    is_sampleboolean
    datedate-time

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

    Example: 2023-03-14T13:46:27-06:00
    created_atdate-time

    The date and time this Fuel Entry was created.

    updated_atdate-time

    The date and time this Fuel Entry was last updated.

    cost_per_hrstringnullable

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

    Example: 1.1
    cost_per_kmstringnullable

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

    Example: 1.1
    cost_per_mistringnullable

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

    Example: 1.1
    kplstringnullable

    Running average recorded kilometers per liter (calculated automatically).

    Example: 1.1
    uk_gallonsstring

    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_hrstringnullable

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

    Example: 1.1
    us_gallonsstring

    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_hrstringnullable

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

    Example: 1.1
    litersstringnullable

    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_hrstringnullable

    Running average recorded liters per hour (calculated automatically).

    Example: 1.1
    lp100kstringnullable

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

    Example: 1.1
    mpg_ukstringnullable

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

    Example: 1.1
    mpg_usstringnullable

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

    Example: 1.1
    price_per_volume_unitstringnullable

    The unit price for the Vehicle's volume unit.

    usage_in_hrstringnullable

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

    usage_in_kmstringnullable

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

    usage_in_mistringnullable

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

    total_amount_centsinteger

    The total amount of the Fuel Entry in cents.

    attachment_permissions objectnullable
    read_photosboolean

    Indicates whether the user has read permission for photos.

    manage_photosboolean

    Indicates whether the user has permission to manage (eg. upload, delete) photos.

    read_documentsboolean

    Indicates whether the user has read permission for documents.

    manage_documentsboolean

    Indicates whether the user has permission to manage (eg. upload, delete) documents.

    custom_fieldsobjectnullable

    *Full details on working with Custom Fields here.

    vehicle object

    A Vehicle

    idintegerrequired
    namestringrequired

    This vehicle's name.

    colorstringnullable

    The color of this Vehicle.

    license_platestringnullable

    The license plate number of this Vehicle.

    vinstringnullable

    The Vehicle Identification Number of this Vehicle.

    yearstringnullable

    This Vehicle's model year.

    makestringnullable

    The name of this Vehicle's manufacturer.

    modelstringnullable

    The name of the model of this Vehicle.

    trimstringnullable

    The trim level of this Vehicle.

    registration_expiration_monthintegernullable

    The month in which this Vehicle's registration expires.

    Possible values: >= 0 and <= 12

    registration_statestringnullable

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

    default_image_url_smallstringnullable

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

    meter_entry objectnullable

    A Meter Entry

    idinteger
    created_atdate-time
    updated_atdate-time
    auto_voided_atdate-timenullable

    The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.

    Example: 2023-03-14T13:46:27-06:00
    categorystringnullable

    A category to describe the function of this Meter Entry.

    Possible values: [starting, ending, nightly, manual]

    meter_typestringnullable

    Indicates whether or not this Meter is a secondary Meter.

    Possible values: [secondary]

    meterable_idNullableId (integer)nullable

    Possible values: >= 1

    meterable_typestringnullable

    The type of the object with which this Meter Entry is associated.

    Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]

    valuestring

    The current value of the meter.

    vehicle_idNullableId (integer)nullable

    Possible values: >= 1

    voidboolean

    Indicates whether or not this Meter Entry has been voided.

    Default value: false
    typestringnullable

    Possible values: [GpsMeterEntry]

    datedate

    The date on which this Meter Entry was recorded. Formatted according to ISO-8601.

    Example: 2023-03-14
    vendor objectnullable

    A Vendor

    namestringrequired

    The name of the Vendor.

    phonestringnullablerequired

    The phone number of the Vendor.

    citystringnullablerequired

    The city of the Vendor.

    regionstringnullablerequired

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

    postal_codestringnullablerequired

    The postal code or ZIP code of the Vendor.

    countrystringnullablerequired

    The country of the Vendor.

    external_idstringnullablerequired

    The external identifier of the Vendor.

  • ]

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).
name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)
curl -L 'https://secure.fleetio.com/api/v1/fuel_entries' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'
Request Collapse all
Base URL
https://secure.fleetio.com/api
Auth
Parameters
— query
— query
— query
external_id
vehicle_ideq
vendor_ideq
date
created_at
updated_at
— query
id
date
created_at
updated_at
ResponseClear

Click the Send API Request button above and see the response here!