List Vehicle Fuel Entries
List a Vehicle's Fuel Entries
Path Parameters
- id string required
The Fleetio ID of the relevant Vehicle.
You may also look up Vehicles by their VIN, license plate, or other external ID. See the guide on External Vehicle Ids for information on how to set this up.
- 200
- 401
- 500
OK
Response Headers
X-PaginationLimit string
The per page limit. Currently set to 100 but subject to change at any time.
X-Pagination-Current-Page string
The current page. Defaults to 1.
X-Pagination-Total-Pages string
The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.
X-Pagination-Total-Count string
The total number of records in the result set (across all pages).
- application/json
- Schema
- Example (from schema)
Schema
array
- id integer
Possible values:
>= 1
- created_at date-time
The date and time at which this record was created.
- updated_at date-time
The date and time at which this record was most recently updated.
- total_amount float
The total amount.
- total_amount_cents integer
The total amount in cents.
- cost_per_hr float
The automatically calculated cost per hour since the last Fuel Entry.
- cost_per_km float
The automatically calculated cost per km since the last Fuel Entry.
- cost_per_mi float
The automatically calculated cost per mi since the last Fuel Entry.
- date date-time
The date and time at which this Fuel Entry was recorded.
- 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. - fuel_type_name string
The name of the Fuel Type associated with this Fuel Entry.
- kpl float
Running average recorded kilometers per liter (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 float
Running average recorded liters per hour (calculated automatically).
- lp100k float
Running average recorded liters per 100 kilometers (calculated automatically).
- mpg_uk float
Running average recorded miles per UK Gallon (calculated automatically).
- mpg_us float
Running average recorded miles per US Gallon (calculated automatically).
- 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.
- price_per_volume_unit float
The unit price for the Vehicle's volume unit.
- raw_transaction_data object
This object is dynamically populated by external fuel card integrations.
- 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
- 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 float
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 float
Running average of US gallons used per hour. Calculated automatically.
- 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.
- vehicle_id integer
Possible values:
>= 1
The Fleetio
id
of the Vehicle associated with this Fuel Entry. - vehicle_name string
The name of the Vehicle associated with this Fuel Entry.
- vendor_name string
The name of the Vendor associated with this Fuel Entry.
- custom_fields object
*Full details on working with Custom Fields here.
meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
geolocation object
gps_device stringoriginal_vendor stringexception_distance_in_mi numberexception_distance_in_km number
[
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"total_amount": 1.23,
"total_amount_cents": 0,
"cost_per_hr": 0,
"cost_per_km": 0,
"cost_per_mi": 0,
"date": "2023-03-14T13:46:27-06:00",
"external_id": "string",
"fuel_type_id": 0,
"fuel_type_name": "string",
"kpl": 0,
"liters": "string",
"liters_per_hr": 0,
"lp100k": 0,
"mpg_uk": 0,
"mpg_us": 0,
"partial": true,
"personal": true,
"price_per_volume_unit": 0,
"raw_transaction_data": {},
"reference": "string",
"region": "string",
"reset": false,
"uk_gallons": "string",
"uk_gallons_per_hr": 0,
"us_gallons": "string",
"us_gallons_per_hr": 0,
"usage_in_hr": "string",
"usage_in_km": "string",
"usage_in_mi": "string",
"vehicle_id": 0,
"vehicle_name": "string",
"vendor_id": 0,
"vendor_name": "string",
"custom_fields": {},
"meter_entry": {
"id": 0,
"created_at": "2024-11-21",
"updated_at": "2024-11-21",
"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"
},
"geolocation": {
"gps_device": "string",
"original_vendor": "string",
"exception_distance_in_mi": 0,
"exception_distance_in_km": 0
}
}
]
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"
}