ENVIRONMENT : Test

BookingInModel

Model with required information for booking re-calculation or modification.

Name Description Type Additional information
BookAsCommissioner

If true, booking will be treated as booking by commissioner (pay on arrival), otherwise it will be treated as booking by agency (prepaid).

boolean

None.

Booking_Drivers

List of drivers.

Collection of BookingDriverModel

None.

CarCategoryId

Identifier of car category in provider system.

integer

Range: inclusive between 1 and 2147483647

Client

Extended information about client. Entry is optional.

BookingClientModel

None.

ClientEmail

Email address of the client.

string

None.

ClientName

Name of the client.

string

None.

ClientPhone

Telephone of the client.

string

None.

CollectionLocation

Location for car collection.

string

None.

Currency

ISO 4217 currency code for this booking.

string

None.

DateIn

Drop-off date and time in ISO 8601 format. Local representation in ISO 8601 format without time zone designator. It represents time in pickup location local time. Example: '2018-03-22T07:20:00'.

date

None.

DateOut

Pick-up date and time in ISO 8601 format. Local representation in ISO 8601 format without time zone designator. It represents time in pickup location local time. Example: '2018-03-21T07:15:00'.

date

None.

DeliveryLocation

Location for car delivery.

string

None.

DropOffLocationId

DropOff location Id (ie. Id of location in foreign country)

integer

None.

ExternalUserId

Optional. External system (e.g. company web) user ID.

string

Max length: 10

FlightNumber

Customer arrival flight number.

string

None.

HasCollection

Flag that user requested collection of the vehicle from location other that office estimated in

boolean

None.

HasDelivery

Flag that user requested delivery of the vehicle to location other that office out.

boolean

None.

IntegrationRemark

string

None.

IsOnRequest

Indicator wheather the reservation avilability is On Request

boolean

None.

MeetAndGreetLocationInId

Meet and greet location IN Id.

integer

None.

MeetAndGreetLocationOutId

Meet and greet location OUT Id.

integer

None.

Number

Booking number. Ommit this parameter if booking is not saved.

string

None.

OfficeInId

Identifier of return office in provider system.

integer

None.

OfficeOutId

Identifier of pick-up office in provider system.

integer

Range: inclusive between 1 and 2147483647

OrderReference

Order reference. Used for partners that have a general agreement with the provider for multiple cars.

string

None.

PriceDate

Price UTC date and time in ISO 8601 format. It represents time of availability search and can be sent to booking "save" method to prevent price changes. When the availability search is made for the booking, the response will contain the information about the search date in the field "PriceDate". This information should be provided in the remaining booking process("create/calculate/save" methods) to guarantee the price returned by the availability. However, the value of the "PriceDate" guarantees the initially returned price within one hour from the availability search. If the „PriceDate“ value is not provided in Create/Calculate/Save methods, we will calculate the price by the actual price during any of the steps in the booking process.

date

None.

PricelistId

Identifier of pricelist in provider system.

integer

Range: inclusive between 1 and 2147483647

PromoCode

Indicator of the Promo code that should be applied to the booking

string

None.

Remark

Arbitrary remarks for this booking.

string

None.

RowVersion

Identifier of document version, recevied in response of "booking save" method. Prevents overwriting changes to same document. Set null if booking is not saved.

Collection of byte

None.

Services

List of services. Contains both obligatory and optional services. Pick optional services by setting "IsSelected" property to "true".

Collection of BookingServiceInModel

None.

TrackingId

Tracking Id. Used for website to track sales.

string

None.

VoucherNumber

Number of voucher given by agency to the client.

string

None.