Retrieve Fuel Entry
Retrieve the details of an existing Fuel Entry.
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the relevant record
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- 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.
- 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 theFuel 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.
- is_sample boolean
- custom_fields object
*Full details on working with Custom Fields here.
- fuel_economy_for_current_user string
- fuel_economy_units_for_current_user string
Default value:
MPG
meter_entry object
geolocation object
map_previews object
attachment_permissions object
- total_amount float
The total amount of the Fuel Entry.
comments object[]
- comments_count integer
The number of comments made on this record.
images object[]
- images_count integer
The number of images attached to this record.
documents object[]
- documents_count integer
The number of documents attached to this record.
created_by object
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"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",
"is_sample": true,
"custom_fields": {},
"fuel_economy_for_current_user": "string",
"fuel_economy_units_for_current_user": "MPG",
"meter_entry": {
"id": 0,
"created_at": "2024-12-31",
"updated_at": "2024-12-31",
"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
},
"map_previews": {
"small": "string",
"large": "string",
"small_short": "string",
"large_short": "string"
},
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"total_amount": 0,
"comments": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"commentable_type": "Contact",
"commentable_id": 0,
"user_id": 0,
"comment": "string",
"user_full_name": "string",
"user_image_url": "string",
"rich_content": {},
"html_content": "string",
"with_mentions": true
}
],
"comments_count": 0,
"images": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"imageable_id": 0,
"imageable_type": "ExpenseEntry",
"file_name": "string",
"file_mime_type": "image/jpeg",
"file_size": 0,
"file_url": "string",
"full_url": "string"
}
],
"images_count": 0,
"documents": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"description": "string",
"documentable_id": 0,
"documentable_type": "ServiceEntry",
"file_name": "string",
"file_mime_type": "string",
"file_size": 0,
"file_url": "string",
"full_file_url": "string"
}
],
"documents_count": 0,
"created_by": {
"id": 0,
"email": "string",
"name": "string",
"group_id": 0,
"default_image_url": "string"
}
}
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"
}
Insufficient permission to perform this operation
- 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"
}
The requested resource could not be located
- 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"
}
GET /v1/fuel_entries/:id
Request
Request
curl -L -X GET 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'