Transaction API

Get transaction.

Retrieves a TransactionResource resource.

Open Swagger Specification

Endpoint

    GET - https://api.travisroadservices.com/v1/transactions/{id}
    Copy

Path params

Parameter Type Description
id string TransactionResource identifier

Request body

No request body

Response body

Response 200

TransactionResource resource

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.
address string Street address of the location.
zipCode string Postal code 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).
latitude number Latitude coordinate of the location.
longitude number Longitude coordinate of the location.
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

Response 401

No response body - No bearer token set verify if your token is added as bearer token

Response 403

No response body - You don't have access to this API resource

Response 404

Not found

Fields

Field Type Description
title string A short, human-readable summary of the problem.
detail string A human-readable explanation specific to this occurrence of the problem.
status number The HTTP status code applicable to this problem.
instance string A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type string A URI reference that identifies the problem type

Example