Update Fuel Entry

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

Update a Fuel Entry

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the relevant record

application/json

Body

vehicle_idId (integer)

Possible values: >= 1

vendor_idinteger

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

Possible values: >= 1

fuel_type_idinteger

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

Possible values: >= 1

datedate-time

We recommend using ISO-8601 formatted dates to avoid ambiguity.

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

us_gallonsfloat

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.

Example: 14.78

uk_gallonsfloat

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.

Example: 12.36

litersfloat

The fuel volume amount in liters. This field will be used if the Vehicle is configured to use liters.

price_per_volume_unitfloat

The unit price for the Vehicle's configured volume unit.

Example: 2.98

meter_entry_attributes object

referencestring

A reference number or identifier for this Fuel Entry. This field is often used to store a receipt number or other unique identifier.

partialboolean

Indicates whether this Fuel Entry is a partial fill-up. Partial fill-ups are used to record Fuel Entries that are not full fill-ups. This field is false if not provided.

personalboolean

Indicates whether this Fuel Entry is personal. Personal Fuel Entries are used to record fuel purchases that are not associated with a specific Vehicle or Equipment. This field is false if not provided.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

documents_attributes object[]

images_attributes object[]

Responses

Response Headers

application/json

Schema
Example (auto)

Schema

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

geolocation objectnullablerequired

map_previews objectrequired

attachment_permissions objectnullable

total_amountfloatrequired

The total amount of the Fuel Entry.

comments object[]required

comments_countintegerrequired

The number of comments made on this record.

Possible values: >= 0

images object[]

images_countintegerrequired

The number of images attached to this record.

Possible values: >= 0

documents object[]

documents_countintegerrequired

The number of documents attached to this record.

Possible values: >= 0

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

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

Insufficient permission to perform this operation

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

The requested resource could not be located

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

Unprocessable Entity

application/json

Schema
Example (auto)
Example

Schema

errors object

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

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 -X PATCH 'https://secure.fleetio.com/api/v1/fuel_entries/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "vehicle_id": 0,
  "vendor_id": 0,
  "fuel_type_id": 0,
  "date": "2023-03-14T13:46:27-06:00",
  "us_gallons": 14.78,
  "uk_gallons": 12.36,
  "liters": 0,
  "price_per_volume_unit": 2.98,
  "meter_entry_attributes": {
    "value": "108043",
    "void": true
  },
  "reference": "string",
  "partial": true,
  "personal": true,
  "custom_fields": {},
  "documents_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ],
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}'

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

Body

{
  "vehicle_id": 0,
  "vendor_id": 0,
  "fuel_type_id": 0,
  "date": "2023-03-14T13:46:27-06:00",
  "us_gallons": 14.78,
  "uk_gallons": 12.36,
  "liters": 0,
  "price_per_volume_unit": 2.98,
  "meter_entry_attributes": {
    "value": "108043",
    "void": true
  },
  "reference": "string",
  "partial": true,
  "personal": true,
  "custom_fields": {},
  "documents_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ],
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}

ResponseClear

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

Update Fuel Entry

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

Request​

Path Parameters

Body

Responses​

Authorization: Authorization

Request

Responses