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.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
fields[]
string[]
optional
Optional fields such as transactionDate, vehicleIds, refueled, total, fuelPrice, or petrolStation.
[filter]
QueryValue
optional
Fuel report filters accepted by Linxio.

Response fields

data
LinxioFuelRecord[]
optional
Fuel transaction records for the current page.
page / limit / total
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.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
startDate / endDate
ISODateString
optional
Optional report date range when supported.
[filter]
QueryValue
optional
Report filters accepted by Linxio.

Response fields

regNo
string
optional
Vehicle registration number when supplied.
mileage
number
optional
Mileage when supplied.
refueled
number
optional
Refueled amount when supplied.
total
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.

Query parameters

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

Response fields

data
LinxioFuelRecord[]
optional
Fuel records for the current page.

GET /fuel-types

GET

List fuel types

/fuel-typeslinxio.fuel.fuelTypes()

Lists fuel types configured by Linxio.

Query parameters

none
void
optional
No query parameters are required.

Response

data
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.

Path and body parameters

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

Response fields

id
LinxioId
optional
Updated fuel transaction identifier.

On this page