Get fuel costs
Returns the list of vehicles with fuel management information.
The vehicles considered are the ones allowed by the filters that apply to the user that invoking the endpoint.
Parameters
df
The begining of the period, in UTC.
If a value for df
is not provided, then it is assumed that it's value is 7 days before dt
(Ending of period)
dt
Ending of the period in UTC.
If a value for dt
is not provided, then it is assumed that it's value is the current date/time.
Response Body
The body contains an array of records, each representing a vehicle, with details on fuel costs and consumption.
[
{
"vehicleId": 0,
"licensePlate": "string",
"mileage": 0,
"drivingTime": 0,
"fuelIni": 0,
"fuelEnd": 0,
"fuelRecords": 0,
"refuelDetection": 0,
"difference": 0,
"numberFuelRecords": 0,
"numberDetections": 0,
"drainage": 0,
"consumptionMeasured": 0,
"avgConsumptionPer100km": 0,
"fuelConsumptionIdling": 0,
"hasTotalFuelUsedHighResolution": true,
"avgConsumptionPerHour": 0
}
]
Field | Description |
vehicleId | The ID of the vehicle to which the cost is associated.
|
licensePlate | The ID of the vehicle to which the cost is associated.
|
mileage | The mileage traveled by the vehicle in the interval specified in the parameters ( df and dt ).
|
drivingTime | The time, in seconds, that the vehicle was driven.
|
fuelIni | The vehicle's fuel level at the start (df ) of the interval specified (or assumed) in the parameters.
|
fuelEnd | The vehicle's fuel level at the end (dt ) of the interval specified (or assumed) in the parameters.
|
fuelRecords | The ammount of fuel specified in the records of fuel costs.
|
refuelDetection | The ammount of fuel detected by Frotcom as being a refuel.
|
difference | The difference between the values of fields fuelRecords and refuelDetection
|
numberFuelRecords | The number of records of fuel costs found in the interval specified (or assumed) in the parameters.
|
numberDetections | The number of refuel events detected.
|
drainage | The fuel detected in drainage events in the interval specified (or assumed) in the parameters.
|
consumptionMeasured | The total fuel consumption measured in the interval specified (or assumed) in the parameters.
|
avgConsumptionPer100km | The average of fuel consumption per 100Km.avgConsumptionPer100km = consumptionMeasured x 100 / mileage
|
fuelConsumptionIdling | The fuel consumed by the vehicle whn in idle (speed bellow stop speed limit and ignition ON)
|
hasTotalFuelUsedHighResolution | Specifies if the vehicle has Total Fuel Used High Resolution.
|
avgConsumptionPerHour | The average of fuel consumption per hour, considering the consumptionMeasured and the time that the vehicle was driven
in the interval specified (or assumed) in the parameters.
|
Response HTTP Codes
204 - No content
- A valid response with records is returned.
204 - No content
- If the result of the search does not contain any record.
403 - Forbidden
- The authenticated user doesn't have at least one of the necessary permissions: Management Fuel and Management.