Fuel

Fuel transaction records, summaries, vehicle fuel rows, cards, fuel types, and transaction assignment.

Important

Fuel endpoints are dashboard-derived and can include tenant-specific columns. The SDK keeps the common fields typed and leaves additional columns available on the returned record.

fuel.records()

GET

List fuel transactions

/fuel-cards/jsonlinxio.fuel.records(params)

Loads one page of fuel transaction records.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Number of records to request.

number

optional

Page number to request.

Default: 1

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

Additional fuel report filters forwarded as query parameters.

Returns

LinxioFuelRecord[] | null

optional

Fuel transaction records for the requested page.

Show child fields

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.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when records cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

List fuel records

const records = await linxio.fuel.records({
  fields: ["transactionDate", "vehicleIds", "total"],
  limit: 100,
});

if (records.error) {
  throw records.error;
}

Example response


{
  "data": [
    {
      "driver": {
        "id": "36541",
        "email": "driver@example.com.au",
        "name": "Example",
        "surname": "Driver",
        "role": {
          "id": 6,
          "name": "admin",
          "displayName": "Admin"
        },
        "phone": "+61401000123",
        "status": "active",
        "lastLoggedAt": "2026-05-24T08:31:46+00:00",
        "driverSensorId": "F4CFB22527B2",
        "driverFOBId": "1"
      },
      "fuelCardNumber": "string",
      "fuelPrice": 123,
      "id": 64553,
      "petrolStation": "string",
      "refueled": 123,
      "total": 2,
      "transactionDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {}
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

fuel.iterateRecords()

GET

Load all fuel transactions

/fuel-cards/jsonlinxio.fuel.iterateRecords(params)

Auto-paginates fuel transaction records into one result object.

Input

LinxioFuelListParams

optional

Same filters and field projection as fuel.records().

Show child parameters

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.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

Returns

LinxioFuelRecord[] | null

optional

Flat array containing every loaded fuel record.

Show child fields

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.

LinxioError | null

optional

Typed SDK error if any page fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Iterate fuel records

const { data: records, error } = await linxio.fuel.iterateRecords({
  limit: 100,
});

if (error) {
  throw error;
}

Example response


{
  "data": [
    {
      "driver": {
        "id": "36541",
        "email": "driver@example.com.au",
        "name": "Example",
        "surname": "Driver",
        "role": {
          "id": 6,
          "name": "admin",
          "displayName": "Admin"
        },
        "phone": "+61401000123",
        "status": "active",
        "lastLoggedAt": "2026-05-24T08:31:46+00:00",
        "driverSensorId": "F4CFB22527B2",
        "driverFOBId": "1"
      },
      "fuelCardNumber": "string",
      "fuelPrice": 123,
      "id": 64553,
      "petrolStation": "string",
      "refueled": 123,
      "total": 2,
      "transactionDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {}
    }
  ],
  "error": null
}

fuel.streamRecords()

GET

Stream fuel transactions

/fuel-cards/jsonlinxio.fuel.streamRecords(params)

Streams fuel records lazily across pages.

Input

LinxioFuelListParams

optional

Same filters and field projection as fuel.records().

Show child parameters

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.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

Returns

LinxioFuelRecord

optional

One fuel record at a time.

Show child fields

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.

LinxioError

optional

Thrown if a page request fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Stream fuel records

for await (const record of linxio.fuel.streamRecords({ limit: 100 })) {
  console.log(record.transactionDate, record.total);
}

Example response


{
  "yield": {
    "driver": {
      "id": "36541",
      "email": "driver@example.com.au",
      "name": "Example",
      "surname": "Driver",
      "role": {
        "id": 6,
        "name": "admin",
        "displayName": "Admin"
      },
      "phone": "+61401000123",
      "status": "active",
      "lastLoggedAt": "2026-05-24T08:31:46+00:00",
      "driverSensorId": "F4CFB22527B2",
      "driverFOBId": "1"
    },
    "fuelCardNumber": "string",
    "fuelPrice": 123,
    "id": 64553,
    "petrolStation": "string",
    "refueled": 123,
    "total": 2,
    "transactionDate": "2026-06-08T12:00:00+08:00",
    "vehicle": {}
  }
}

fuel.summary()

GET

List fuel summary rows

/fuel-summary-reportlinxio.fuel.summary(params)

Loads one page of fuel summary report rows.

Input

LinxioFuelListParams

optional

Pagination, field projection, and report filters such as date range or vehicle filters when supported.

Show child parameters

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.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

Returns

LinxioFuelSummaryRecord[] | null

optional

Summary rows with depot, groups, mileage, refueled, regNo, and total when supplied.

Show child fields

string | null

optional

Depot label.

string | null

optional

Vehicle groups label.

number | null

optional

Mileage in the summary period.

number | null

optional

Fuel volume in the summary period.

string | null

optional

Vehicle registration number.

number | null

optional

Total fuel cost in the summary period.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when summary rows cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Fuel summary

const summary = await linxio.fuel.summary({
  limit: 100,
  startDate: "2026-06-01T00:00:00+08:00",
  endDate: "2026-06-08T00:00:00+08:00",
});

if (summary.error) {
  throw summary.error;
}

Example response


{
  "data": [
    {
      "depot": {
        "id": 1128,
        "name": "Westminster Depot",
        "status": 1,
        "createdAt": "2026-01-15T03:59:25+00:00",
        "color": "#0065d1"
      },
      "groups": [
        {
          "id": 1391,
          "name": "North Metropolitan",
          "color": "#009221"
        }
      ],
      "mileage": 123,
      "refueled": 123,
      "regNo": "1ABC234",
      "total": 2
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

fuel.recordsByVehicle()

GET

List fuel records by vehicle

/fuel-cards-by-vehicle/jsonlinxio.fuel.recordsByVehicle(params)

Loads fuel transaction rows grouped or filtered by vehicle.

Input

LinxioFuelListParams

optional

Pagination, field projection, and vehicle/date filters accepted by Linxio.

Show child parameters

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.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

Returns

LinxioFuelRecord[] | null

optional

Fuel records from the by-vehicle endpoint.

Show child fields

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.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when records cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Fuel by vehicle

const records = await linxio.fuel.recordsByVehicle({
  vehicleId,
  limit: 100,
});

if (records.error) {
  throw records.error;
}

Example response


{
  "data": [
    {
      "driver": {
        "id": "36541",
        "email": "driver@example.com.au",
        "name": "Example",
        "surname": "Driver",
        "role": {
          "id": 6,
          "name": "admin",
          "displayName": "Admin"
        },
        "phone": "+61401000123",
        "status": "active",
        "lastLoggedAt": "2026-05-24T08:31:46+00:00",
        "driverSensorId": "F4CFB22527B2",
        "driverFOBId": "1"
      },
      "fuelCardNumber": "string",
      "fuelPrice": 123,
      "id": 64553,
      "petrolStation": "string",
      "refueled": 123,
      "total": 2,
      "transactionDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {}
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

fuel.cards()

GET

List fuel cards

/fuel-cards/jsonlinxio.fuel.cards(params)

Lists fuel card records. This endpoint shares the dashboard path used by fuel transaction records, so returned columns can depend on tenant setup.

Input

LinxioFuelListParams

optional

Pagination, field projection, sorting, and dashboard-derived filters.

Show child parameters

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.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

Returns

LinxioFuelCard[] | null

optional

Fuel card records with id, cardNumber, and vehicleId when supplied.

Show child fields

string

optional

Fuel card number.

LinxioId

required

Fuel card identifier.

LinxioId | null

optional

Assigned vehicle identifier.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when cards cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Fuel cards

const cards = await linxio.fuel.cards({ limit: 100 });

if (cards.error) {
  throw cards.error;
}

Example response


{
  "data": [
    {
      "cardNumber": "string",
      "id": 64553,
      "vehicleId": 64553
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

fuel.fuelTypes()

GET

List fuel types

/fuel-typeslinxio.fuel.fuelTypes()

Lists fuel types configured by Linxio.

Input

void

optional

fuelTypes() does not take parameters.

Returns

LinxioRecord[] | null

optional

Fuel type records. Shape can vary by tenant.

LinxioError | null

optional

Typed SDK error when fuel types cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

fuel.assignTransaction()

PATCH

Assign fuel transaction to vehicle

/fuel-cards/record/{recordId}linxio.fuel.assignTransaction(recordId, vehicleId)

Assigns a fuel transaction record to a vehicle.

Input

LinxioId

required

Fuel transaction record identifier.

LinxioId

required

Vehicle identifier to assign to the transaction.

Returns

LinxioFuelRecord | null

optional

Updated fuel transaction record.

Show child fields

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.

LinxioError | null

optional

Typed SDK error when assignment fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Assign fuel transaction

const assigned = await linxio.fuel.assignTransaction(recordId, vehicleId);

if (assigned.error) {
  throw assigned.error;
}

Example response


{
  "data": {
    "driver": {
      "id": "36541",
      "email": "driver@example.com.au",
      "name": "Example",
      "surname": "Driver",
      "role": {
        "id": 6,
        "name": "admin",
        "displayName": "Admin"
      },
      "phone": "+61401000123",
      "status": "active",
      "lastLoggedAt": "2026-05-24T08:31:46+00:00",
      "driverSensorId": "F4CFB22527B2",
      "driverFOBId": "1"
    },
    "fuelCardNumber": "string",
    "fuelPrice": 123,
    "id": 64553,
    "petrolStation": "string",
    "refueled": 123,
    "total": 2,
    "transactionDate": "2026-06-08T12:00:00+08:00",
    "vehicle": {}
  },
  "error": null
}

Fuel

List fuel transactions

Input

Returns

Load all fuel transactions

Input

Returns

Stream fuel transactions

Input

Returns

List fuel summary rows

Input

Returns

List fuel records by vehicle

Input

Returns

List fuel cards

Input

Returns

List fuel types

Input

Returns

Assign fuel transaction to vehicle

Input

Returns

On this page