Type shapes

SDK response, payload, parameter, and shared object shapes used across the reference.

This page collects the bespoke TypeScript shapes used by SDK and API reference tables. Open any object row in the method reference for the inline shape, or follow the linked type name here when you want the full contract in one place.

Result envelopes

LinxioResult

Standard result returned by SDK service methods.

Fields

TData | null

optional

Returned data on success, or null on failure.

LinxioError | null

optional

Typed SDK error when the operation 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.

LinxioPageResult

Paginated result returned by SDK list and report methods.

Fields

TData[] | null

optional

Records for the current page on success, or null on failure.

LinxioError | null

optional

Typed SDK error when the operation 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.

LinxioPaginationMeta | null

optional

Normalized pagination metadata on success.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

number | null

optional

Current page number on success.

number | null

optional

Page size on success.

number | null

optional

Total matching record count on success.

unknown

optional

Aggregation payload when Linxio returns one.

Record<string, unknown>

optional

Additional page envelope fields retained by the SDK.

LinxioPaginationMeta

Normalized pagination metadata returned by SDK list methods.

Fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError

Base class for all SDK-defined errors.

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.

LinxioApiError

Error thrown when Linxio returns a non-2xx HTTP response.

Fields

string

required

Safe error message derived from the API response.

number

required

HTTP status code returned by Linxio.

string

optional

HTTP status text returned by Linxio when available.

unknown

optional

Parsed error response body.

string

optional

HTTP method associated with the failed request.

string

optional

API path associated with the failed request.

string

optional

Request identifier from X-Request-Id when Linxio supplies one.

Authentication

LinxioLoginRequest

Credentials for client.auth.login().

Fields

string

optional

Optional tenant-domain hint accepted by some login flows.

string

required

Email address for the Linxio user.

string

required

Password for the Linxio user.

LinxioLoginResponse

Response returned by the documented /login endpoint.

Fields

ISODateString

optional

Token expiry timestamp when supplied.

boolean

optional

Whether the login flow was resolved by identifier.

boolean

optional

Whether OTP verification is required before the session is usable.

string

optional

Refresh token used to renew the session.

LinxioId

optional

Role identifier when supplied.

LinxioTeamType

optional

Team type returned by Linxio.

Possible enum values

admin

Administrative team.

client

Client-account team.

reseller

Reseller-account team.

string

required

JWT bearer token for authenticated requests.

LinxioRefreshTokenResponse

Response returned by /token/refresh.

Fields

ISODateString

optional

Token expiry timestamp when supplied.

string

optional

New refresh token when Linxio rotates it.

string

required

New JWT bearer token.

LinxioSession

In-memory token state used by LinxioClient.

Fields

ISODateString

optional

Token expiry timestamp.

string

optional

Refresh token.

string

optional

JWT bearer token.

LinxioCurrentUser

Current-user object returned by /me; fields vary by role and requested selectors.

Fields

string

optional

User date format when supplied.

string

optional

Current user email address.

string

optional

Current user display name.

LinxioId

optional

Current user identifier.

string[]

optional

Permission keys when supplied.

JsonObject

optional

Current team details.

Show child fields

LinxioId

optional

Client account identifier when the user belongs to a client team.

LinxioId

optional

Team identifier.

string

optional

Team display name.

LinxioId

optional

Reseller identifier when the user belongs to a reseller team.

LinxioTeamType

optional

Current team type.

Possible enum values

admin

Administrative team.

client

Client-account team.

reseller

Reseller-account team.

Vehicles and routes

LinxioVehicle

Vehicle record returned by Linxio vehicle endpoints.

Fields

LinxioId

required

Vehicle identifier.

LinxioId | null

optional

Owning team identifier.

LinxioRecord | null

optional

Owning team object.

LinxioRecord | null

optional

Depot object, typically including id, name, status, createdAt, and color.

string | null

optional

Vehicle type key.

LinxioId | null

optional

Vehicle type identifier.

string | null

optional

Vehicle type display name.

string | null

optional

Vehicle manufacturer.

string | null

optional

Manufacturer model label returned by Linxio.

string | null

optional

Vehicle model text.

string | null

optional

Registration number or fleet identifier.

string | null

optional

Default display label.

string | null

optional

Vehicle identification number.

ISODateString | null

optional

Vehicle registration date when supplied.

string | null

optional

Registration certificate number when supplied.

number | null

optional

Vehicle model year when supplied.

number | null

optional

Engine power rating when supplied.

number | null

optional

Engine capacity when supplied.

number | null

optional

Accumulated engine-on time.

LinxioId | null

optional

Fuel type identifier.

number | null

optional

Fuel tank capacity.

number | null

optional

Average fuel value returned by Linxio.

string | null

optional

Emission class when supplied.

number | null

optional

CO2 emissions value when supplied.

number | null

optional

Gross vehicle weight when supplied.

LinxioRecord[]

optional

Vehicle group objects with id, name, and color.

LinxioRecord[]

optional

Current area assignments with arrival/departure timestamps.

string | null

optional

Vehicle status, such as online or offline.

LinxioRecord | null

optional

Assigned driver object. Optional extras such as driverSensorId and driverFOBId appear only when configured.

LatLng & { ts?: ISODateString } | null

optional

Last known vehicle coordinates.

Show child fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

ISODateString | null

optional

Last telemetry timestamp.

LinxioId | null

optional

Installed device identifier.

{ avgSpeed?: number; distance?: number; duration?: number; idleDuration?: number } | null

optional

Current-day telemetry summary when selected.

Show child fields

number

optional

Average speed for the current-day summary.

number

optional

Distance for the current-day summary.

number

optional

Duration for the current-day summary.

number

optional

Idle duration for the current-day summary.

number | null

optional

Tenant-configured economical speed threshold when supplied.

number | null

optional

Tenant-configured excessive idling threshold when supplied.

number | null

optional

Average daily mileage value returned by Linxio.

ISODateString | null

optional

Vehicle creation timestamp.

LinxioRecord | null

optional

User object for the creator when supplied.

ISODateString | null

optional

Vehicle update timestamp.

LinxioRecord | null

optional

User object for the last updater when supplied.

string | null

optional

Vehicle picture URL when supplied.

string | null

optional

Unavailable reason when supplied.

LinxioVehiclePayload

Payload for creating or updating a vehicle.

Fields

string

optional

Default display label.

LinxioId | null

optional

Depot identifier when the tenant uses depots.

LinxioId[]

optional

Vehicle group identifiers.

string

optional

Vehicle model text.

string

optional

Registration number or fleet identifier.

LinxioId

optional

Vehicle type identifier.

string

optional

Vehicle identification number.

LinxioVehicleListParams

Parameters for client.vehicles.list().

Fields

VehicleField[]

optional

Vehicle fields to include in the response projection.

Possible enum values

id

Vehicle identifier.

regNo

Registration number or fleet code.

defaultLabel

Default display label.

model

Vehicle model text.

depot

Depot object.

groups

Vehicle group objects.

driver

Assigned driver object.

type

Vehicle type key.

typeId

Vehicle type identifier.

typeName

Vehicle type display name.

make

Vehicle make.

makeModel

Vehicle make/model label.

vin

Vehicle identification number.

deviceId

Installed device identifier.

status

Vehicle status.

lastLoggedAt

Last telemetry timestamp.

lastCoordinates

Last known vehicle coordinates.

todayData

Current-day telemetry summary.

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.

LinxioVehicleType

Vehicle type record returned by the dashboard-derived vehicle types endpoint.

Fields

string | null

optional

Default color for this vehicle type.

string | null

optional

Driving-state color for this vehicle type.

LinxioId

required

Vehicle type identifier.

string | null

optional

Idling-state color for this vehicle type.

string

optional

Vehicle type display name.

number

optional

Sort order when supplied.

string | null

optional

Vehicle type status.

string | null

optional

Stopped-state color for this vehicle type.

LinxioVehicleTypeParams

Parameters for client.vehicles.types().

Fields

number

optional

Maximum number of type records.

Default: 1000

string

optional

Sort expression.

Default: order

QueryValue

optional

Additional filters forwarded as query parameters.

LinxioCount

Count response returned by dashboard-derived count endpoints.

Fields

number

optional

Count value when Linxio returns count.

number

optional

Count value when Linxio returns total.

LinxioOdometer

Vehicle odometer reading returned by Linxio.

Fields

number | null

optional

Reading accuracy when supplied.

LinxioId | null

optional

Device identifier.

LinxioId | null

optional

Driver identifier.

LinxioId | null

optional

Odometer reading identifier.

boolean

optional

Whether the reading is synced with the device.

ISODateString | null

optional

Timestamp of the last tracker record.

number | null

optional

Odometer value from the last tracker record.

ISODateString | null

optional

Timestamp associated with the reading.

number

required

Odometer reading.

LinxioId

required

Vehicle identifier.

LinxioOdometerParams

Optional parameters for fetching odometer values.

Fields

ISODateString

optional

Optional occurrence timestamp.

LinxioOdometerRecalibration

Payload for recalibrating a vehicle odometer.

Fields

ISODateString

required

When the recalibrated reading applies.

number

required

New odometer value.

LinxioEngineHours

Current engine-hours reading for a vehicle.

Fields

number

required

Current engine-hours reading.

ISODateString | null

optional

Timestamp associated with the reading when supplied.

LinxioId

required

Vehicle identifier.

LinxioVehicleRoute

One route segment returned by Linxio.

Fields

string | null

optional

Resolved address for the segment.

number | null

optional

Average speed.

string | null

optional

Route comment when supplied.

LinxioRouteCoordinate[]

optional

Route coordinate points. This field can be large.

Show child fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

LinxioId

optional

Coordinate identifier.

boolean

optional

Whether the coordinate can be null in source data.

LinxioId | null

optional

Device identifier.

number | string | null

optional

Route distance.

LinxioId | null

optional

Driver identifier.

number | null

optional

Route duration.

LinxioId

required

Route segment identifier.

number | null

optional

Maximum speed.

LinxioRoutePoint | null

optional

Finish point for the segment.

Show child fields

string | null

optional

Resolved address.

LatLng & { ts?: ISODateString } | null

optional

Last known coordinates for the route point.

LinxioRoutePoint | null

optional

Start point for the segment.

Show child fields

string | null

optional

Resolved address.

LatLng & { ts?: ISODateString } | null

optional

Last known coordinates for the route point.

unknown

optional

Route scope payload when supplied by Linxio.

driving | idle | stopped | string

optional

Route segment type.

LinxioId

required

Vehicle identifier.

LinxioVehicleRoutesGroup

Route response group for a vehicle/driver pair.

Fields

LinxioId | null

optional

Driver identifier.

LinxioVehicleRoute[]

required

Route segments for the group.

Show child fields

string | null

optional

Resolved address for the segment.

number | null

optional

Average speed.

string | null

optional

Route comment when supplied.

LinxioRouteCoordinate[]

optional

Route coordinate points. This field can be large.

LinxioId | null

optional

Device identifier.

number | string | null

optional

Route distance.

LinxioId | null

optional

Driver identifier.

number | null

optional

Route duration.

LinxioId

required

Route segment identifier.

number | null

optional

Maximum speed.

LinxioRoutePoint | null

optional

Finish point for the segment.

LinxioRoutePoint | null

optional

Start point for the segment.

unknown

optional

Route scope payload when supplied by Linxio.

driving | idle | stopped | string

optional

Route segment type.

LinxioId

required

Vehicle identifier.

LinxioId

required

Vehicle identifier.

LinxioVehicleRoutesParams

Parameters for client.routes.getVehicleRoutes().

Fields

ISODateString

optional

Start date/time.

ISODateString

optional

End date/time.

RouteField[]

optional

Additional route fields. coordinates can produce large responses.

Possible enum values

coordinates

Route coordinate points. This can produce large responses.

driver

Driver summary for each route.

vehicle

Vehicle summary for each route.

address

Resolved start/finish addresses.

number

optional

Page size when supported.

number

optional

Page number when supported.

LinxioRoutePoint

Start or finish point for a route segment.

Fields

string | null

optional

Resolved address.

LatLng & { ts?: ISODateString } | null

optional

Last known coordinates for the route point.

Show child fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

LinxioRouteCoordinate

One route coordinate point.

Fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

LinxioId

optional

Coordinate identifier.

boolean

optional

Whether the coordinate can be null in source data.

Devices, sensors, and realtime

LinxioDevice

Device record returned by Linxio device endpoints.

Fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

Show child fields

LinxioId

optional

Vendor identifier.

string

optional

Vendor display name.

LinxioRecord[]

optional

Device models returned under this vendor.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

Show child fields

LinxioRecord | null

optional

Device object when supplied.

LinxioId

optional

Device identifier.

LinxioRecord[]

optional

Installation files when supplied.

LinxioId

optional

Installation record identifier.

ISODateString | null

optional

Install timestamp.

number | null

optional

Odometer captured at installation.

ISODateString | null

optional

Uninstall timestamp when supplied.

LinxioRecord | null

optional

Vehicle object when supplied.

LinxioId

optional

Vehicle identifier.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

Show child fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

LinxioDeviceListParams

Parameters for client.devices.list().

Fields

DeviceField[]

optional

Device fields to include in the response projection.

Possible enum values

id

Device identifier.

imei

Device IMEI.

serial

Device serial number.

status

Device status.

vehicle

Assigned vehicle summary.

usage

Usage label when supplied.

vendor

Device vendor label.

model

Device model object.

trackerData

Last tracker data object.

deviceInstallation

Current installation details when assigned.

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.

LinxioDevicePayload

Payload for creating or updating a device.

Fields

string

optional

Device IMEI.

string

optional

Device serial number.

LinxioId

optional

Device type identifier.

string

optional

Usage label.

LinxioId

optional

Vendor identifier.

LinxioDeviceInstallationPayload

Payload for installing a device into a vehicle.

Fields

ISODateString

optional

Install timestamp.

number

optional

Vehicle odometer at install time.

LinxioId

required

Vehicle identifier.

LinxioDeviceUninstallPayload

Payload for uninstalling a device from a vehicle.

Fields

number

optional

Vehicle odometer at uninstall time.

ISODateString

optional

Uninstall timestamp.

LinxioDeviceCoordinate

Coordinate reported by a device.

Fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

LinxioId

optional

Device identifier.

LinxioId

optional

Coordinate record identifier.

LinxioDeviceCoordinateParams

Optional filters for recent device coordinates.

Fields

ISODateString

optional

Start date/time for coordinate history.

ISODateString

optional

End date/time for coordinate history.

boolean

optional

Whether to compare the same time across each day when supported.

string

optional

Dashboard filter value when supported.

LinxioDeviceVendor

Device vendor record from the dashboard-derived vendor endpoint.

Fields

LinxioId

optional

Vendor identifier.

string

optional

Vendor display name.

LinxioRecord[]

optional

Device models returned under this vendor.

LinxioDeviceInstallation

Device installation lookup returned by `/devices/installation/`.

Fields

LinxioRecord | null

optional

Device object when supplied.

LinxioId

optional

Device identifier.

LinxioRecord[]

optional

Installation files when supplied.

LinxioId

optional

Installation record identifier.

ISODateString | null

optional

Install timestamp.

number | null

optional

Odometer captured at installation.

ISODateString | null

optional

Uninstall timestamp when supplied.

LinxioRecord | null

optional

Vehicle object when supplied.

LinxioId

optional

Vehicle identifier.

LinxioDeviceInstallationLookupParams

Lookup parameters for the live `/devices/installation/` endpoint.

Fields

string

optional

Device IMEI to look up.

string

optional

Vehicle registration number to look up.

LinxioDeviceCamera

Camera record associated with a device.

Fields

LinxioId

optional

Device identifier.

LinxioId

optional

Camera identifier.

string

optional

Camera display name.

string

optional

Camera status.

LinxioSensor

Sensor record returned by Linxio sensor endpoints.

Fields

ISODateString | null

optional

Sensor creation timestamp.

LinxioId | null

optional

Device identifier.

LinxioId

required

Sensor identifier.

string | null

optional

Sensor display label.

string | null

optional

Hardware sensor identifier.

string | null

optional

Sensor system status.

LinxioRecord | null

optional

Owning team summary.

string | null

optional

Sensor type.

ISODateString | null

optional

Last update timestamp.

LinxioId | null

optional

Vehicle identifier.

LinxioSensorListParams

Parameters for client.sensors.list().

Fields

SensorField[]

optional

Sensor fields to include in the response projection.

Possible enum values

id

Sensor identifier.

label

Sensor display label.

sensorId

Hardware sensor identifier.

systemStatus

Sensor system status.

team

Owning team summary.

type

Sensor type.

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.

LinxioSensorReportParams

Parameters for temperature/humidity sensor reports.

Fields

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

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.

LinxioId

optional

Sensor identifier filter.

LinxioId

optional

Vehicle identifier filter.

ISODateString

optional

Date range for the sensor report.

LinxioTemperatureHumidityReading

Temperature/humidity reading returned by sensor reports.

Fields

number | null

optional

Humidity reading.

ISODateString

optional

Reading timestamp.

LinxioId

optional

Sensor identifier.

number | null

optional

Temperature reading.

LinxioId

optional

Vehicle identifier.

LinxioTrackingPosition

Live vehicle position payload received from the coordinates socket.

Fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

string | null

optional

Resolved address.

LinxioId

optional

Device identifier.

LinxioId | null

optional

Driver identifier.

number | null

optional

Heading in degrees.

number | null

optional

Speed value from Linxio telemetry.

LinxioId

required

Vehicle identifier.

Accounts, users, and drivers

LinxioUser

User record returned by Linxio user endpoints.

Fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioUserPayload

Payload for creating or updating a user.

Fields

string

optional

User email address.

string

optional

Given name.

string

optional

Full display name.

string

optional

Family name.

string

optional

Phone number.

LinxioId

optional

Role identifier.

LinxioUserListParams

Parameters for client.users.list().

Fields

UserField[]

optional

User fields to include in the response projection.

Possible enum values

id

User identifier.

email

User email address.

fullName

User display name when supplied.

name

User given name.

surname

User surname.

role

User role label.

status

User status.

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.

string

optional

Optional role filter.

LinxioClientAccount

Client account record.

Fields

LinxioId

required

Client account identifier.

string | null

optional

Client account display name.

LinxioId | null

optional

Timezone identifier when supplied.

LinxioClientUserListParams

Parameters for client user list endpoints.

Fields

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

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.

string

optional

Optional role filter.

LinxioDriverListParams

Parameters for client.drivers.list().

Fields

DriverField[]

optional

Driver fields to include in the response projection.

Possible enum values

id

Driver user identifier.

fullName

Driver display name.

email

Driver email address.

phone

Driver phone number.

role

Driver role label.

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.

LinxioId

optional

Client account identifier. When supplied, the SDK lists client users with role=driver.

LinxioReseller

Reseller account record.

Fields

LinxioId

required

Reseller identifier.

string | null

optional

Reseller display name.

Geofences

LinxioGeofence

Geofence object. Linxio's API calls these areas.

Fields

string | null

optional

Display color.

LatLng[]

optional

Polygon/polyline/rectangle coordinates.

Show child fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

LinxioId

required

Geofence identifier.

string

required

Geofence display name.

number | null

optional

Circle radius when the geofence is circular.

GeofenceType

optional

Geofence shape type.

Possible enum values

circle

Circular geofence.

polygon

Polygon geofence.

polyline

Polyline geofence.

rectangle

Rectangular geofence.

LinxioGeofenceListParams

Parameters for client.geofences.list().

Fields

string[]

optional

Optional geofence field projection accepted by Linxio.

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.

LinxioGeofencePayload

Payload for creating or updating a geofence.

Fields

string

optional

Display color.

LatLng[]

optional

Polygon/polyline/rectangle coordinates.

Show child fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

string

required

Geofence display name.

number

optional

Circle radius.

GeofenceType

required

Geofence shape type.

Possible enum values

circle

Circular geofence.

polygon

Polygon geofence.

polyline

Polyline geofence.

rectangle

Rectangular geofence.

LinxioAreaGroup

Dashboard area-group record.

Fields

LinxioId

required

Area-group identifier.

string

required

Area-group display name.

LinxioAreaGroupPayload

Payload accepted by dashboard-derived area-group endpoints.

Fields

string

required

Area-group display name.

Fuel and reports

LinxioFuelRecord

Fuel transaction record.

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.

LinxioFuelSummaryRecord

Fuel summary row.

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.

LinxioFuelListParams

Parameters for fuel list and summary endpoints.

Fields

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.

LinxioFuelCard

Fuel card record.

Fields

string

optional

Fuel card number.

LinxioId

required

Fuel card identifier.

LinxioId | null

optional

Assigned vehicle identifier.

LinxioReportParams

Common parameters for report endpoints.

Fields

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

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.

LinxioFileFormat

optional

Export/report file format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

ISODateString

optional

Date range for endpoints that use dateFrom/dateTo.

ISODateString

optional

Date range for endpoints that use startDate/endDate.

LinxioScheduledReport

Scheduled report record.

Fields

LinxioFileFormat

optional

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

LinxioId

required

Scheduled report identifier.

string

optional

Scheduled report display name.

active | disabled | string

optional

Scheduled report status.

string

optional

Scheduled report type.

LinxioScheduledReportPayload

Payload for creating a scheduled report.

Fields

LinxioFileFormat

required

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

string

required

Scheduled report display name.

Record<string, unknown>

optional

Report-specific parameter object.

string

required

Scheduled report type.

LinxioDigitalForm

Digital form record.

Fields

LinxioId

required

Digital form identifier.

string

optional

Digital form display name.

string

optional

Digital form status.

Metadata and shared shapes

LinxioMetadataRecord

Shared shape for dashboard reference-data records.

Fields

LinxioId

optional

Stable identifier when the endpoint returns one.

string

optional

Machine-readable code, slug, or setting key.

string

optional

Human-readable label.

string

optional

Human-readable name.

number

optional

Sort order used by dashboard dropdowns.

string

optional

Machine-readable value used by dashboard dropdowns.

LinxioCountryMap

Country map returned by Linxio, keyed by country code with display names as values.

Fields

string

optional

Country display name keyed by an ISO-style country code such as AU.

LinxioCurrentPlan

Current-plan permission keys returned by Linxio as a string array.

Fields

string

optional

Permission or feature key enabled for the current plan.

LinxioSettingRecord

Tenant, role, or user scoped setting record returned by dashboard settings endpoints.

Fields

LinxioId | string

optional

Setting identifier.

string

optional

Setting key.

LinxioRecord | null

optional

Role scope when supplied.

LinxioRecord | null

optional

Team scope when supplied.

LinxioRecord | null

optional

User scope when supplied.

unknown

optional

Setting value. Type varies by setting and tenant configuration.

DateRangeParams

Date-range parameters used by report, route, and sensor endpoints.

Fields

ISODateString

optional

Start date/time accepted by Linxio endpoints that use dateFrom.

ISODateString

optional

End date/time accepted by Linxio endpoints that use dateTo.

ISODateString

optional

Start date/time accepted by endpoints that use startDate.

ISODateString

optional

End date/time accepted by endpoints that use endDate.

LatLng

Latitude/longitude coordinate pair.

Fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

LinxioHttpRequestOptions

Per-request options accepted by the low-level HTTP client.

Fields

unknown

optional

Request body for mutation methods. Plain objects are JSON encoded.

HeadersInit

optional

Additional request headers.

string

optional

Optional idempotency key for caller-managed retry safety.

QueryParams

optional

Query parameters appended to the URL.

json | text | blob | arrayBuffer | raw

optional

Response parser override.

Default: json

AbortSignal

optional

Abort signal for caller-managed cancellation.

boolean

optional

Skip the bearer token for this request.

boolean

optional

Skip automatic refresh handling for this request.

number

optional

Override the client timeout for this request.