List Fuel Entries

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

Returns a list of Fuel Entries belonging to your account.

Request

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

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

The total number of records in the result set (across all pages).

application/json

Schema

Schema

Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
cost_per_hrfloatnullablerequired
The automatically calculated cost per hour since the last Fuel Entry.
cost_per_kmfloatnullablerequired
The automatically calculated cost per km since the last Fuel Entry.
cost_per_mifloatnullablerequired
The automatically calculated cost per mi since the last Fuel Entry.
datedate-timerequired
The date and time at which this Fuel Entry was recorded.
Example: 2023-03-14T13:46:27-06:00
external_idstringnullablerequired
Used to uniquely identify Fuel Entries that are imported from external systems, such as Fleetcor and Wex.
fuel_type_idintegernullablerequired
The Fleetio id of the Fuel Type associated with this Fuel Entry.
Possible values: >= 1
fuel_type_namestringnullablerequired
The name of the Fuel Type associated with this Fuel Entry.
kplfloatnullablerequired
Running average recorded kilometers per liter (calculated automatically).
litersstringnullablerequired
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_hrfloatnullablerequired
Running average recorded liters per hour (calculated automatically).
lp100kfloatnullablerequired
Running average recorded liters per 100 kilometers (calculated automatically).
mpg_ukfloatnullablerequired
Running average recorded miles per UK Gallon (calculated automatically).
mpg_usfloatnullablerequired
Running average recorded miles per US Gallon (calculated automatically).
partialbooleanrequired
Used to denote a partial fuel up as opposed to a complete fuel up. Learn more about partial Fuel Entries here.
personalbooleanrequired
Used to denote a personal expense.
price_per_volume_unitfloatnullablerequired
The unit price for the Vehicle's volume unit.
raw_transaction_dataobjectnullablerequired
This object is dynamically populated by external fuel card integrations.
referencestringnullablerequired
Optional data field for collecting information such as the invoice number, transaction id, or receipt number, for example.
regionstringnullablerequired
resetbooleanrequired
Default value: false
uk_gallonsstringrequired
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_hrfloatnullablerequired
Running average of UK gallons used per hour. Calculated automatically.
us_gallonsstringrequired
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_hrfloatnullablerequired
Running average of US gallons used per hour. Calculated automatically.
usage_in_hrstringnullablerequired
The automatically calculated usage in hours since the most recent Fuel Entry.
usage_in_kmstringnullablerequired
The automatically calculated usage in kilometers since the most recent Fuel Entry.
usage_in_mistringnullablerequired
The automatically calculated usage in miles since the most recent Fuel Entry.
vehicle_idintegernullablerequired
The Fleetio id of the Vehicle associated with this Fuel Entry.
Possible values: >= 1
vehicle_namestringrequired
The name of the Vehicle associated with this Fuel Entry.
vendor_idintegernullablerequired
The Fleetio id of the Vendor associated with this Fuel Entry.
Possible values: >= 1
vendor_namestringnullablerequired
The name of the Vendor associated with this Fuel Entry.
is_samplebooleanrequired
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
fuel_economy_for_current_userstringnullable
fuel_economy_units_for_current_userstring
Default value: MPG
meter_entry objectnullablerequired
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
geolocation objectnullablerequired
gps_devicestringnullable
original_vendorstringnullable
exception_distance_in_minumbernullable
exception_distance_in_kmnumbernullable
map_previews objectrequired
smallstringnullable
largestringnullable
small_shortstringnullable
large_shortstringnullable
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.
total_amountfloatrequired
The total amount of the Fuel Entry.
comments object[]required
A list of the comments made on this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
commentable_typeCommentableType (string)required
The type of record that the Comment will be left on. Must be associated with a matching commentable_id.
Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]
commentable_idId (integer)required
Possible values: >= 1
user_idId (integer)required
Possible values: >= 1
titlestringdeprecated
The title of the Comment.
commentstringrequired
The content of the Comment message body.
user_full_namestringrequired
The full name of the User who created the Comment.
user_image_urlstringnullablerequired
The image url for the User who created the Comment.
rich_contentobjectnullablerequired
html_contentstringnullablerequired
The comment message body rendered as HTML.
with_mentionsbooleanrequired
Indicates if the message body contains @mentions.
]
comments_countintegerrequired
The number of comments made on this record.
Possible values: >= 0
images object[]
A list of the images attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
imageable_idId (integer)
Possible values: >= 1
imageable_typeImageableType (string)
Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]
file_namestring
The name of the image file.
file_mime_typeImage MIME Type (string)
Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]
file_sizenumber
The size of the image file in bytes.
file_urlstring
The URL to access the image file.
full_urlstring
The full URL to access the image file, including any necessary authentication or parameters.
]
images_countintegerrequired
The number of images attached to this record.
Possible values: >= 0
documents object[]
A list of the documents attached to this record.
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
namestringrequired
The name of the document.
descriptionstringrequired
The description of the document.
documentable_idId (integer)required
Possible values: >= 1
documentable_typeDocumentableType (string)required
Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]
file_namestringrequired
The name of the file.
file_mime_typestringrequired
The MIME type of the file.
file_sizenumberrequired
The size of the file in bytes.
file_urlstringrequired
The URL to access the file.
full_file_urlstringrequired
The full URL to access the file, including any necessary authentication or parameters.
]
documents_countintegerrequired
The number of documents attached to this record.
Possible values: >= 0
]

Example (auto)

[
  {
    "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-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"
    },
    "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
  }
]

401

Request could not be authenticated

application/json

Schema

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.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

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.

Example (auto)

{
  "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
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

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

apiKey

accountToken

ResponseClear

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