List Vehicle Fuel Entries

GET https://secure.fleetio.com/api/vehicles/:vehicle_id/fuel_entries

List a Vehicle's Fuel Entries

Request

Path Parameters

vehicle_id integer

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

sort object

Responses

application/json

Schema
Example (auto)

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[]

sorted_by object[]

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

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

vehicle object

meter_entry objectnullable

vendor objectnullable

]

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "external_id": {
        "like": "string"
      }
    },
    {
      "vendor_id": {
        "eq": "string"
      }
    },
    {
      "date": {
        "lt": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "date": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "external_id": "string",
      "fuel_type_id": 0,
      "vehicle_id": 0,
      "vendor_id": 0,
      "partial": true,
      "personal": true,
      "reference": "string",
      "region": "string",
      "reset": false,
      "images_count": 0,
      "documents_count": 0,
      "comments_count": 0,
      "watchers_count": 0,
      "is_sample": true,
      "date": "2023-03-14T13:46:27-06:00",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "cost_per_hr": "1.1",
      "cost_per_km": "1.1",
      "cost_per_mi": "1.1",
      "kpl": "1.1",
      "uk_gallons": "string",
      "uk_gallons_per_hr": "1.1",
      "us_gallons": "string",
      "us_gallons_per_hr": "1.1",
      "liters": "string",
      "liters_per_hr": "1.1",
      "lp100k": "1.1",
      "mpg_uk": "1.1",
      "mpg_us": "1.1",
      "price_per_volume_unit": "string",
      "usage_in_hr": "string",
      "usage_in_km": "string",
      "usage_in_mi": "string",
      "total_amount_cents": 0,
      "attachment_permissions": {
        "read_photos": true,
        "manage_photos": true,
        "read_documents": true,
        "manage_documents": true
      },
      "custom_fields": {},
      "vehicle": {
        "id": 0,
        "name": "string",
        "color": "string",
        "license_plate": "string",
        "vin": "string",
        "year": "string",
        "make": "string",
        "model": "string",
        "trim": "string",
        "registration_expiration_month": 0,
        "registration_state": "string",
        "default_image_url_small": "string"
      },
      "meter_entry": {
        "id": 0,
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "auto_voided_at": "2023-03-14T13:46:27-06:00",
        "category": "starting",
        "meter_type": "secondary",
        "meterable_id": 0,
        "meterable_type": "FuelEntry",
        "value": "string",
        "vehicle_id": 0,
        "void": false,
        "type": "GpsMeterEntry",
        "date": "2023-03-14"
      },
      "vendor": {
        "name": "string",
        "phone": "string",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string",
        "external_id": "string"
      }
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (auto)

Schema

errors object

{
  "errors": {}
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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 (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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

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

curl -L 'https://secure.fleetio.com/api/vehicles/:vehicle_id/fuel_entries' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

ResponseClear

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

List Vehicle Fuel Entries

https://secure.fleetio.com/api/vehicles/:vehicle_id/fuel_entries

Request​

Path Parameters

Query Parameters

Responses​

Authorization: Authorization

Request

Responses