API Reference
Fuel
Fuel transaction, summary, card, fuel type, and transaction assignment endpoints.
Fuel endpoints are dashboard-derived and can include tenant-specific fields.
GET /fuel-cards/json
GET
List fuel transactions
/fuel-cards/jsonlinxio.fuel.records(params)Returns a paginated list of fuel transactions. The SDK also exposes this
path as fuel.cards() for fuel-card-shaped reads.
Request headers
Bearer token
requiredJWT bearer token returned by login or token refresh.
Request query parameters
number
optionalNumber of records per page.
number
optionalPage number to read.
FuelRecordField[]
optionalFuel transaction fields to include in the response projection.
Possible enum values
transactionDateFuel transaction timestamp.
vehicleIdsRelated vehicle identifiers.
driverIdRelated driver identifier.
refueledFuel volume.
totalTotal transaction amount.
fuelPriceUnit fuel price.
petrolStationPetrol station display name.
QueryValue
optionalFuel report filters accepted by Linxio.
Response body fields
optional
Fuel transaction records for the current page.
Show child parameters
string | null
optionalDriver display name.
string | null
optionalFuel card number.
number | null
optionalFuel price.
LinxioId
requiredFuel transaction identifier.
string | null
optionalPetrol station display name.
number | null
optionalFuel volume.
number | null
optionalTotal transaction amount.
ISODateString
optionalTransaction timestamp.
LinxioRecord | null
optionalVehicle payload when included by Linxio.
number
optionalPagination metadata.
GET /fuel-summary-report
GET
List fuel summary rows
/fuel-summary-reportlinxio.fuel.summary(params)Returns paginated fuel summary report rows.
Request headers
Bearer token
requiredJWT bearer token returned by login or token refresh.
Request query parameters
number
optionalNumber of records per page.
number
optionalPage number to read.
ISODateString
optionalOptional report date range when supported.
QueryValue
optionalReport filters accepted by Linxio.
Response body fields
string
optionalVehicle registration number when supplied.
number
optionalMileage when supplied.
number
optionalRefueled amount when supplied.
number
optionalTotal cost when supplied.
GET /fuel-cards-by-vehicle/json
GET
List fuel records by vehicle
/fuel-cards-by-vehicle/jsonlinxio.fuel.recordsByVehicle(params)Returns fuel records grouped or filtered by vehicle.
Request headers
Bearer token
requiredJWT bearer token returned by login or token refresh.
Request query parameters
LinxioId
optionalOptional vehicle filter.
number
optionalNumber of records per page.
number
optionalPage number to read.
QueryValue
optionalFuel filters accepted by Linxio.
Response body fields
optional
Fuel records for the current page.
Show child parameters
string | null
optionalDriver display name.
string | null
optionalFuel card number.
number | null
optionalFuel price.
LinxioId
requiredFuel transaction identifier.
string | null
optionalPetrol station display name.
number | null
optionalFuel volume.
number | null
optionalTotal transaction amount.
ISODateString
optionalTransaction timestamp.
LinxioRecord | null
optionalVehicle payload when included by Linxio.
GET /fuel-types
GET
List fuel types
/fuel-typeslinxio.fuel.fuelTypes()Lists fuel types configured by Linxio.
Request headers
Bearer token
requiredJWT bearer token returned by login or token refresh.
Request query parameters
void
optionalNo query parameters are required.
Response
LinxioRecord[]
optionalFuel type records. Shape can vary by tenant.
PATCH /fuel-cards/record/{recordId}
PATCH
Assign fuel transaction to vehicle
/fuel-cards/record/{recordId}linxio.fuel.assignTransaction(recordId, vehicleId)Assigns a fuel transaction record to a vehicle.
Request headers
Bearer token
requiredJWT bearer token returned by login or token refresh.
application/json
requiredRequired when sending a JSON request body.
Path and body parameters
LinxioId
requiredFuel transaction record identifier.
LinxioId
requiredVehicle identifier sent in the JSON body.
Response body fields
LinxioId
optionalUpdated fuel transaction identifier.