linxio-js
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
required
JWT bearer token returned by login or token refresh.

Request query parameters

number
optional
Number of records per page.
number
optional
Page number to read.
FuelRecordField[]
optional
Fuel transaction fields to include in the response projection.
Possible enum values
transactionDate

Fuel transaction timestamp.

vehicleIds

Related vehicle identifiers.

driverId

Related driver identifier.

refueled

Fuel volume.

total

Total transaction amount.

fuelPrice

Unit fuel price.

petrolStation

Petrol station display name.

QueryValue
optional
Fuel report filters accepted by Linxio.

Response body fields

optional
Fuel transaction records for the current page.
Show child parameters
string | null
optional
Driver display name.
string | null
optional
Fuel card number.
number | null
optional
Fuel price.
LinxioId
required
Fuel transaction identifier.
string | null
optional
Petrol station display name.
number | null
optional
Fuel volume.
number | null
optional
Total transaction amount.
ISODateString
optional
Transaction timestamp.
LinxioRecord | null
optional
Vehicle payload when included by Linxio.
number
optional
Pagination 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
required
JWT bearer token returned by login or token refresh.

Request query parameters

number
optional
Number of records per page.
number
optional
Page number to read.
ISODateString
optional
Optional report date range when supported.
QueryValue
optional
Report filters accepted by Linxio.

Response body fields

string
optional
Vehicle registration number when supplied.
number
optional
Mileage when supplied.
number
optional
Refueled amount when supplied.
number
optional
Total 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
required
JWT bearer token returned by login or token refresh.

Request query parameters

LinxioId
optional
Optional vehicle filter.
number
optional
Number of records per page.
number
optional
Page number to read.
QueryValue
optional
Fuel filters accepted by Linxio.

Response body fields

optional
Fuel records for the current page.
Show child parameters
string | null
optional
Driver display name.
string | null
optional
Fuel card number.
number | null
optional
Fuel price.
LinxioId
required
Fuel transaction identifier.
string | null
optional
Petrol station display name.
number | null
optional
Fuel volume.
number | null
optional
Total transaction amount.
ISODateString
optional
Transaction timestamp.
LinxioRecord | null
optional
Vehicle 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
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response

LinxioRecord[]
optional
Fuel 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
required
JWT bearer token returned by login or token refresh.
application/json
required
Required when sending a JSON request body.

Path and body parameters

LinxioId
required
Fuel transaction record identifier.
LinxioId
required
Vehicle identifier sent in the JSON body.

Response body fields

LinxioId
optional
Updated fuel transaction identifier.

On this page