Transaction API
List transactions.
Retrieves the collection of TransactionResource resources.
Endpoint
GET - https://api.travisroadservices.com/v1/transactions
Copy
Query params
| Parameter | Type | Description |
|---|---|---|
bookingId
|
string | Filters transactions by booking ID. |
dateFrom
|
string | Filters transactions created on or after this date. Format: ATOM or Y-m-d. When Y-m-d is used, time defaults to 00:00. |
dateTo
|
string | Filters transactions created on or before this date. Format: ATOM or Y-m-d. When Y-m-d is used, time defaults to 23:59. |
travisCode
|
string | Filters transactions by TRAVIS booking code. |
service
|
string | Filters by service type. Possible values: truckwash, parking, tankcleaning, repair. |
locationId
|
string | Filters transactions by location ID. |
licensePlate1
|
string | Filters transactions by truck license plate. |
licensePlate2
|
string | Filters transactions by trailer license plate. |
licensePlate3
|
string | Filters transactions by second trailer license plate. |
driver
|
string | Filters transactions by driver name. Not available when authenticated as an App Driver. |
page
|
string | The collection page number |
itemsPerPage
|
string | The number of items per page |
Request body
No request bodyResponse body
Response 200
TransactionResource collection
Fields
| Field | Type | Description |
|---|---|---|
id
|
integer | Unique identifier of the transaction. |
tripReference
|
string | Reference to the trip associated with this transaction. |
travisCode
|
string | TRAVIS booking code for this transaction. |
createdAt
|
string (date-time) | Date and time when the transaction was created. |
service
|
string | Service type of this transaction. Possible values: truckwash, parking, tankcleaning, repair, truckcharging. |
transactionExtraCost
|
array | List of extra cost transactions associated with this transaction. |
serviceInformation
|
object | Service-specific information for this transaction. |
washProgramId
|
integer | Only set when service is Truckwash |
cleaningType
|
string | Only set when service is Truckwash |
isNao
|
boolean | Only set when service is Truckwash |
isDisinfection
|
boolean | Only set when service is Truckwash |
isSelfService
|
boolean | Only set when service is Truckwash |
arrival
|
object | Arrival date and time. |
date
|
string (date-time) | Expected date in Y-m-d format. |
time
|
string (date-time) | Expected time in H:i format. Only returned when the service is Parking or Truck Charging. |
departure
|
object | Only set when service is Parking |
date
|
string (date-time) | Expected date in Y-m-d format. |
time
|
string (date-time) | Expected time in H:i format. Only returned when the service is Parking or Truck Charging. |
finalArrival
|
object | Actual arrival date and time from Overstay entity |
date
|
string (date-time) | Expected date in Y-m-d format. |
time
|
string (date-time) | Expected time in H:i format. Only returned when the service is Parking or Truck Charging. |
finalDeparture
|
object | Actual departure date and time from Overstay entity |
date
|
string (date-time) | Expected date in Y-m-d format. |
time
|
string (date-time) | Expected time in H:i format. Only returned when the service is Parking or Truck Charging. |
overstayPrice
|
object | Overstay transaction price |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
amountEUR
|
number | Price amount converted to EUR. |
parkingType
|
string | Only set when service is Parking |
isEcdRequested
|
boolean | Only set when service is Tank cleaning |
previousProducts
|
object | Only set when service is Tank cleaning |
trip1
|
array | Tank cleaning products from the most recent trip prior to this booking. |
trip2
|
array | Tank cleaning products from the second most recent trip prior to this booking. |
trip3
|
array | Tank cleaning products from the oldest of the three previous trips prior to this booking. |
cleaningCodes
|
array | Only set when service is Tank cleaning |
cargoType
|
string | Cargo type for tank cleaning. Only set when service is Tank cleaning. |
repairType
|
string | Type of repair performed. Only set when service is Repair. |
bayType
|
object | Bay type used for truck charging. Only set when service is Truck Charging. |
id
|
string (uuid) | Unique identifier of the bay type. |
capacity
|
integer | Maximum charging capacity of the bay in kW. |
supply
|
string | Power supply type of the bay. |
connectorSide
|
string | Side of the vehicle the connector is on. |
size
|
string | Size category of the bay. |
access
|
string | Access type of the bay. |
location
|
object | Location where the service was performed. |
id
|
integer | Unique identifier of the location. |
name
|
string | Name of the location. |
city
|
string | City where the location is situated. |
country
|
string | ISO 3166-1 alpha-2 country code of the location (e.g. NL, DE, FR). |
truck
|
object | Truck vehicle used in this transaction. |
vehicleId
|
integer | Vehicle ID known at TRAVIS. When provided, other vehicle parameters are ignored. |
licensePlate
|
string | License plate of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vehicleType
|
integer | Vehicle type identifier. Required when no vehicle ID is provided; otherwise ignored. |
fleetNumber
|
string | Fleet number the vehicle belongs to. |
trailer
|
object | Trailer vehicle used in this transaction. |
vehicleId
|
integer | Vehicle ID known at TRAVIS. When provided, other vehicle parameters are ignored. |
licensePlate
|
string | License plate of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vehicleType
|
integer | Vehicle type identifier. Required when no vehicle ID is provided; otherwise ignored. |
fleetNumber
|
string | Fleet number the vehicle belongs to. |
trailer2
|
object | Second trailer vehicle used in this transaction. |
vehicleId
|
integer | Vehicle ID known at TRAVIS. When provided, other vehicle parameters are ignored. |
licensePlate
|
string | License plate of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vehicleType
|
integer | Vehicle type identifier. Required when no vehicle ID is provided; otherwise ignored. |
fleetNumber
|
string | Fleet number the vehicle belongs to. |
driver
|
object | Driver who performed the transaction. |
name
|
string | Full name of the driver. |
appDriverId
|
string (uuid) | Unique identifier of the App Driver account. |
priceExclVat
|
object | Transaction price excluding VAT. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
amountEUR
|
number | Price amount converted to EUR. |
invoice
|
object | Invoice associated with this transaction. |
id
|
integer | Unique identifier of the invoice. |
number
|
integer | Invoice number. |
date
|
string (date-time) | Date the invoice was issued. |
entity
|
object | TRAVIS entity the invoice belongs to. |
name
|
string | Name of the TRAVIS entity. |
invoiceCustomer
|
object | Customer the invoice was billed to. |
id
|
integer | Unique identifier of the customer. |
city
|
string | City where the customer is located. |
country
|
string | ISO 3166-1 alpha-2 country code of the customer (e.g. NL, DE, FR). |
companyName
|
string | Company name of the customer. |
fuelCard
|
object | Fuel card used to pay for this transaction. |
provider
|
string | Fuel card provider identifier. |
cardNumber
|
integer | Card number of the fuel card. |
expiryDate
|
string (date-time) | Expiry date of the fuel card. Format: YYYY-MM. |
booking
|
object | Booking associated with this transaction. |
id
|
integer | Unique identifier of the booking. |
createdAt
|
string (date-time) | Date and time when the booking was created. |
createdBy
|
string | Name of the user who created the booking. |
attachments
|
array | List of attachments associated with this transaction. |
status
|
string | Status of the transaction. Possible values: completed. |
extraWorkDescriptions
|
array | List of descriptions for extra work carried out as part of this transaction. |
vatRate
|
number | VAT rate applied to this transaction. |
Example