Get Bookings

POST 
/v1/api/Pull/GetBookings

Retrive information about bookings by ID or period.

Request

application/json

Body

PrimaryLangID LanguageCodeEnum

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

Default value: 8

LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE

EchoToken stringnullable

An arbitrary string returned in the response for tracking/debugging.

TimeStamp stringrequired

The date and time (ISO format) just before the request is sent.

Target TargetEnumrequired

Possible values: [0, 1]

The target environment for this request. TargetEnum: 0=Test | 1=Production

Version number

Default value: 1

The version number of this request format.

ReadRequestsType objectnullable
HotelReadRequests object[]
A list of hotel read requests, each specifying the criteria for a hotel search.
Array [
HotelRef objectnullable
Information about the hotel or chain to search for.
ChainCode object nullable
The code of the hotel chain (if applicable).
oneOf
MOD1
integer
MOD2
string
ChainName stringnullable
The name of the hotel chain (if applicable).
HotelName stringnullable
The name of the hotel.
HotelCode object required
The unique code of the hotel.
oneOf
MOD1
integer
MOD2
string
SelectionCriteria objectnullable
Criteria for selecting hotels within the specified date range (e.g., start and end dates).
Start stringrequired
The start date (ISO 8601 format) of the date range for the hotel search.
End stringrequired
The end date (ISO 8601 format) of the date range for the hotel search.
Duration integernullable
The duration of the stay in nights.
]
UniqueID objectnullable

ID stringrequired

Unique identifier.

Type UniqueIDCodeEnumrequired

Possible values: [14, 25]

Type of the identifier. UniqueIDCodeEnum: 14=Reservation | 25=AssociatedReservation

Reason stringnullable

Reason or context for the identifier, if any.

Responses

200

application/json

Schema

Schema

PrimaryLangID LanguageCodeEnum

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

Default value: 8

LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE

EchoToken stringnullable

The same token received in the request.

TimeStamp stringrequired

The date in ISO format right before the response is sent.

Target TargetEnumrequired

Possible values: [0, 1]

The environment target. The same value received in the request. TargetEnum: 0=Test | 1=Production

Version numberrequired

Version of the API being used. The same value received in the request.

Success objectnullable
property name* string
WarningsType objectnullable
Warnings object[]
Array [
Code integerrequired
Error code associated with the warning.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
ShortText stringrequired
Short description or summary of the warning.
]
ErrorsType objectnullable
Errors object[]
Array [
Code integerrequired
Error code associated with the warning.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
ShortText stringrequired
Short description or summary of the warning.
]
MaxResponses integernullable

Maximum number of responses that can be returned, if specified.

PageNumber integerrequired

Page number of the current response set.

TotalRecords integerrequired

Total number of records available.

MoreIndicator boolean

Default value: false

Indicates whether there are more records available.

POS stringnullable

Point of Sale (POS) identifier, if applicable.

HotelReservationsType object
HotelReservations object[]
A list of hotel reservations.
Array [
CreateDateTime stringnullable
The date and time the reservation was created (ISO 8601 format).
LastModifyDateTime stringnullable
The date and time the reservation was last modified (ISO 8601 format).
ResStatus objectnullable
Indicates the status of the reservation represented by the message.
TransactionActionType TransactionActionTypeEnumnullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]
To specify the type of action requested when more than one function could be handled by the message. TransactionActionTypeEnum: 0=Book | 1=Commit | 2=Hold | 3=Ignore | 4=Initiate | 5=Modify | 6=VerifyPrice | 7=CancelRoom | 8=CancelRoomVerifyPrice
PMS_ResStatusType PMS_ResStatusTypeEnumnullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
Code the status of the reservation in the Property Management System (PMS). PMS_ResStatusTypeEnum: 0=Requested | 1=Reserved | 2=RequestDenied | 3=RequestAccepted | 4=Cancelled | 5=Waitlisted | 6=Modified | 7=CancelledOnRequest | 8=CancelPending | 9=OnRequestChannelCancel
POS objectnullable
Information about the point of sale where the reservation was made.
Sources object[]
A list of sources for the point of sale.
Array [
ISOCountry stringnullable
The ISO 3166-1 alpha-2 country code of the source.
]
UniqueID objectrequired
A unique identifier for the reservation.
ID stringrequired
Unique identifier.
Type UniqueIDCodeEnumrequired
Possible values: [14, 25]
Type of the identifier. UniqueIDCodeEnum: 14=Reservation | 25=AssociatedReservation
Reason stringnullable
Reason or context for the identifier, if any.
RoomStaysType objectrequired
Information about the room stays within the reservation.
MoreIndicator boolean
Default value: false
Indicates if there are more room stays available (true) or not (false).
RoomStays object[]
A list of room stay objects.
Array [
RoomStayLanguage LanguageCodeEnumnullable
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
RPH integernullable
Identifies the room stay for use in the hotel stay.
WarningRPH stringnullable
A warning RPH associated with the room stay (if applicable).
AvailabilityStatus stringnullable
The availability status of the room stay (e.g., 'Available', 'NotAvailable').
RoomStayCandidateRPH stringnullable
An alternative RPH for a potential room stay.
BasicPropertyInfo objectnullable
Basic information about the property where the room stay will occur.
CurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') used for prices at this property. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
ImageURL stringnullable
The URL of an image representing the property.
Award objectnullable
A dictionary of awards or ratings for the property, where the key is the award name and the value is the rating.
oneOf
Address objectnullable
The address of the property.
AddressLine stringnullable
The street address or line 1 of the address.
CityCode object nullable
A numerical code for the city.
oneOf
MOD1
integer
MOD2
string
CityName stringnullable
The name of the city.
CountryCode CountryCodeEnumnullable
Possible values: [161, 177, 209, 95, 168, 94, 60, 189, 186, 24, 104, 56, 63, 198, 49, 171, 102, 113, 109, 148, 158, 29, 200, 97, 195, 73, 71, 68, 181, 82, 44, 72, 112, 27, 118, 79, 132, 32, 75, 199, 120, 90, 42, 18, 156, 159, 108, 211, 210, 54, 122, 114, 39, 129, 183, 178, 137, 121, 17, 149, 30, 196, 188, 180, 36, 92, 124, 141, 138, 204, 103, 110, 150, 208, 190, 93, 111, 187, 155, 123, 52, 41, 45, 106, 101, 107, 173, 66, 160, 134, 25, 127, 131, 152, 176, 197, 140, 205, 143, 74, 116, 46, 169, 55, 157, 115, 99, 81, 70, 146, 43, 191, 86, 128, 35, 77, 172, 167, 78, 85, 50, 145, 125, 194, 179, 136, 126, 19, 62, 91, 201, 185, 184, 142, 26, 33, 80, 119, 96, 133, 76, 20, 117, 174, 61, 147, 206, 166, 98, 175, 135, 58, 38, 21, 139, 31, 48, 87, 219, 182, 153, 203, 40, 100, 65, 59, 28, 193, 162, 64, 22, 163, 214, 218, 164, 216, 83, 34, 69, 84, 89, 144, 57, 207, 67, 53, 151, 88, 23, 51, 37, 154, 130, 105, 192, 165, 217, 47, 202, 170, 213, 215, 212]
The three-letter country code (ISO 3166-1 alpha-3). CountryCodeEnum: 161=RW | 177=SO | 209=YE | 95=IQ | 168=SA | 94=IR | 60=CY | 189=TZ | 186=SY | 24=AM | 104=KE | 56=CD | 63=DJ | 198=UG | 49=CF | 171=SC | 102=JO | 113=LB | 109=KW | 148=OM | 158=QA | 29=BH | 200=AE | 97=IL | 195=TR | 73=ET | 71=ER | 68=EG | 181=SD | 82=GR | 44=BI | 72=EE | 112=LV | 27=AZ | 118=LT | 79=GE | 132=MD | 32=BY | 75=FI | 199=UA | 120=MK | 90=HU | 42=BG | 18=AL | 156=PL | 159=RO | 108=XK | 211=ZW | 210=ZM | 54=KM | 122=MW | 114=LS | 39=BW | 129=MU | 183=SZ | 178=ZA | 137=MZ | 121=MG | 17=AF | 149=PK | 30=BD | 196=TM | 188=TJ | 180=LK | 36=BT | 92=IN | 124=MV | 141=NP | 138=MM | 204=UZ | 103=KZ | 110=KG | 150=PW | 208=VD | 190=TH | 93=ID | 111=LA | 187=TW | 155=PH | 123=MY | 52=CN | 41=BN | 45=KH | 106=KP | 101=JP | 107=KR | 173=SG | 66=TP | 160=RU | 134=MN | 25=AU | 127=MH | 131=FM | 152=PG | 176=SB | 197=TV | 140=NR | 205=VU | 143=NZ | 74=FJ | 116=LY | 46=CM | 169=SN | 55=CG | 157=PT | 115=LR | 99=CI | 81=GH | 70=GQ | 146=NG | 43=BF | 191=TG | 86=GW | 128=MR | 35=BJ | 77=GA | 172=SL | 167=ST | 78=GM | 85=GN | 50=TD | 145=NE | 125=ML | 194=TN | 179=ES | 136=MA | 126=MT | 19=DZ | 62=DK | 91=IS | 201=GB | 185=CH | 184=SE | 142=NL | 26=AT | 33=BE | 80=DE | 119=LU | 96=IE | 133=MC | 76=FR | 20=AD | 117=LI | 174=SK | 61=CZ | 147=NO | 206=VA | 166=SM | 98=IT | 175=SI | 135=ME | 58=HR | 38=BA | 21=AO | 139=NA | 31=BB | 48=CV | 87=GY | 219=GF | 182=SR | 153=PY | 203=UY | 40=BR | 100=JM | 65=DO | 59=CU | 28=BS | 193=TT | 162=KN | 64=DM | 22=AG | 163=LC | 214=AW | 218=VG | 164=VC | 216=MF | 83=GD | 34=BZ | 69=SV | 84=GT | 89=HN | 144=NI | 57=CR | 207=VE | 67=EC | 53=CO | 151=PA | 88=HT | 23=AR | 51=CL | 37=BO | 154=PE | 130=MX | 105=KI | 192=TO | 165=WS | 217=PR | 47=CA | 202=US | 170=RS | 213=CW | 215=BQ | 212=HK
CountryName stringnullable
The full name of the country.
PostalCode stringnullable
The postal or zip code.
StateProvCode integernullable
A numerical code for the state or province.
StateProv stringnullable
Name of the state or province.
ZoneCode integernullable
A numerical code for the zone or area within the city.
HotelRef objectnullable
Reference information for the hotel, including chain code, chain name, hotel code, and hotel name.
ChainCode object nullable
The code of the hotel chain (if applicable).
oneOf
MOD1
integer
MOD2
string
ChainName stringnullable
The name of the hotel chain (if applicable).
HotelName stringnullable
The name of the hotel.
HotelCode object required
The unique code of the hotel.
oneOf
MOD1
integer
MOD2
string
Position objectnullable
The geographic coordinates (latitude and longitude) of the property.
Latitude stringnullable
The latitude coordinate of the location.
Longitude stringnullable
The longitude coordinate of the location.
VendorMessagesType objectnullable
A collection of VendorMessages.
VendorMessages object[]required
List of specific message associated with this vendor.
Array [
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the message. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Description stringrequired
Description in plain text format.
]
TPA_Extensions objectnullable
Additional information or extensions specific to the Travel Partner Agreement (TPA).
SupplierCode stringnullable
The code of the supplier providing the service or product.
RoomTypes object[]
A list of room types available for the stay.
Array [
MaxOccupancy integernullable
Max guest occupancy.
NumberOfUnits integernullable
Quantity of rooms available in the property for this room type.
RoomID integerrequired
Unique identifier for the room.
RoomName stringnullable
Name of the room type.
MinOccupancy integernullable
Minimum guest occupancy allowed in this room type, if applicable.
Occupancies object[]
List of occupancy configurations for this room type.
Array [
AgeQualifyingCode AgeQualifyCodeEnumrequired
Possible values: [10, 8]
AgeQualifyCodeEnum: 10=Adult | 8=Child
MaxOccupancy integernullable
MinOccupancy integernullable
]
RoomDescription objectnullable
Description of the room type, if available.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Description stringnullable
]
RatePlans object[]
A list of rate plans available for the stay.
Array [
EffectiveDate stringnullable
The start date (ISO 8601 format) from which the rate plan is valid.
ExpireDate stringnullable
The end date (ISO 8601 format) until which the rate plan is valid.
RatePlanName stringnullable
The name or title of the rate plan.
Guarantees object[]nullable
A list of guarantees associated with the rate plan.
Array [
Start stringnullable
The start date (ISO 8601 format) of the guarantee period.
End stringnullable
The end date (ISO 8601 format) of the guarantee period.
GuaranteeCode stringnullable
A unique code identifying the type of guarantee.
AmountPercent objectnullable
Details about the amount or percentage associated with the guarantee.
Amount numbernullable
The fixed amount, if applicable.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
NmbrOfNights integernullable
The number of nights to which the amount or percentage applies.
Percent numbernullable
The percentage value, if applicable.
Deadline objectnullable
Information about the guarantee deadline.
OffsetDropTime nullable
Possible values: [BeforeArrival, null]
Default value: BeforeArrival
Specifies whether the deadline offset is applied 'BeforeArrival'.
OffsetUnitMultiplier integernullable
A multiplier for the time unit (e.g., 2 for 2 days).
TimeUnitType TimeUnitEnumnullable
Possible values: [0]
The unit of time for the offset. TimeUnitEnum: 0=Day
GuaranteeDescription objectnullable
Language-specific descriptions of the guarantee.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the guarantee description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Name stringrequired
The name or title of the guarantee.
Description stringnullable
A detailed description of the guarantee in the specified language.
GuaranteesAcceptedType objectnullable
Information about the types of guarantees accepted.
GuaranteesAccepted object[]
Array [
GuaranteeTypeCode GuaranteeTypeCodeEnumrequired
Possible values: [2, 5, 8, 3, 4, 38]
The type of guarantee accepted (numerical code). GuaranteeTypeCodeEnum: 2=DirectBill | 5=CreditCard | 8=Deposit | 3=Voucher | 4=PrePay | 38=None
RPH integernullable
Provides a reference to a specific form of payment.
GuaranteeID stringnullable
A unique identifier for the guarantee.
PaymentCard objectnullable
Details of the payment card used for the guarantee (if applicable).
CardCode CardCodeTypeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]
The code or type of the payment card. CardCodeTypeEnum: 1=Visa | 2=MasterCard | 3=AmericanExpress | 4=Discover | 5=HiperCard | 6=DinnersClub | 7=JCB | 8=Electron | 9=EuroCard | 10=EnRouteCard | 11=Laser | 12=Maestro | 13=Solo | 14=PayPal | 15=Aura | 16=Liberate | 17=Elo | 18=Hotelcard
CardHolderName stringrequired
The name of the cardholder.
CardNumber stringrequired
The payment card number.
ExpireDate stringrequired
The expiration date of the payment card (YYYY-MM-DD format).
SeriesCode stringrequired
The card verification code (CVV) or security code.
Extras object[]nullable
A list of extras that can be included.
Array [
ID stringrequired
The identifier of the extra inclusion.
Description stringnullable
Description of the extra inclusion.
]
CurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the price. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
Amount numbernullable
Amount that will be billed for the given guarantee.
ExchangeRate numbernullable
Exchange rate applied in the transaction.
ExchangeCurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The exchange currency code (e.g., 'USD', 'EUR') for the price. This represents the booked item currency. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
ExchangeAmount numbernullable
Amount in the item currency.
]
]
CancelPenalties object[]
A list of cancellation penalties associated with the rate plan.
Array [
NonRefundable booleanrequired
Indicates whether the booking is non-refundable (true) or refundable (false).
AmountPercent objectnullable
Details about the amount or percentage of the penalty.
Amount numbernullable
The fixed amount, if applicable.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
NmbrOfNights integernullable
The number of nights to which the amount or percentage applies.
Percent numbernullable
The percentage value, if applicable.
AmountRule objectnullable
Details about a fixed amount penalty rule.
Amount numberrequired
The fixed amount for the penalty rule.
End stringrequired
The end date (ISO 8601 format) for which the rule applies.
Start stringrequired
The start date (ISO 8601 format) for which the rule applies.
CurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount, if applicable. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
DeadLine objectnullable
Information about the penalty deadline.
OffsetDropTime integerrequired
The offset time for the penalty deadline.
OffsetUnitMultiplier integerrequired
A multiplier for the offset time unit.
TimeUnitType TimeUnitEnumrequired
Possible values: [0]
The type of time unit for the offset. TimeUnitEnum: 0=Day
AbsoluteDeadline stringnullable
The absolute deadline date (ISO 8601 format), if applicable.
Duration stringnullable
The duration of the cancellation penalty period.
End stringnullable
The end date (ISO 8601 format) of the penalty period.
PenaltyDescription objectrequired
Language-specific descriptions of the penalty.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the penalty description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Name stringrequired
The name or title of the penalty.
Description stringnullable
A detailed description of the penalty in the specified language.
Start stringnullable
The start date (ISO 8601 format) of the penalty period.
]
RatePlanInclusions object[]
A list of inclusions offered as part of the rate plan.
Array [
RatePlanInclusionDesciption objectnullable
A description of the rate plan inclusion, including the name.
Language LanguageCodeEnumnullable
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Description stringnullable
A descriptive text.
Name stringnullable
The name associated with the description.
Start stringnullable
The start date (ISO 8601 format) of the rate plan inclusion.
Duration stringnullable
The duration of the rate plan inclusion.
End stringnullable
The end date (ISO 8601 format) of the rate plan inclusion.
ID integernullable
The unique identifier for the rate plan inclusion.
]
MealsIncluded objectnullable
Details about meals included in the rate plan.
Breakfast booleannullable
Indicates whether breakfast is included (true) or not (false).
Lunch booleannullable
Indicates whether lunch is included (true) or not (false).
Dinner booleannullable
Indicates whether dinner is included (true) or not (false).
MealPlanIndicator booleannullable
Indicates if a meal plan is associated with the booking (true) or not (false).
MealPlanCode MealPlanCodeEnumnullable
Possible values: [1, 3, 10, 12]
The code identifying the meal plan (MPT code). MealPlanCodeEnum: 1=AllInclusive | 3=BedBreakfast | 10=FullBoard | 12=HalfBoard
ID integernullable
The unique identifier for the meal plan.
Name stringnullable
The name of the meal plan.
Description stringnullable
A description of the meal plan.
Price objectnullable
The price details for the meal plan.
Start stringnullable
The start date (ISO 8601 format) for which this price is valid.
Duration stringnullable
The duration for which this price is valid.
End stringnullable
The end date (ISO 8601 format) for which this price is valid.
AmountBeforeTax numbernullable
The amount before taxes are applied.
AmountAfterTax integernullable
The amount after taxes are applied.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the prices. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
AmountIncludingMarkup booleannullable
Indicates whether the amount includes markup (true) or not (false).
ServicePricingType ServicePricingTypeEnumnullable
Possible values: [7, 12, 18, 19, 20, 21, 25]
The service pricing type (CHG code). ServicePricingTypeEnum: 7=PerPerson | 12=PerStay | 18=PerRoomPerStay | 19=PerRoomPerNight | 20=PerPersonPerStay | 21=PerPersonPerNight | 25=PerRoom | 19=PerNight
RatePlanID integernullable
The unique identifier for the rate plan.
TaxPolicies object[]
A list of tax policies applicable to the rate plan.
Array [
Name stringnullable
The name of the tax.
Description stringnullable
A description of the tax.
IsPerNight booleannullable
Indicates if the tax is applied per night (True) or not (False).
IsPerStay booleannullable
Indicates if the tax is applied per stay (True) or not (False).
IsPerPerson booleannullable
Indicates if the tax is applied per person (True) or not (False).
IsPerRoom booleannullable
Indicates if the tax is applied per room (True) or not (False).
Value numbernullable
The amount of the tax, either a percentage or a fixed value.
IsValuePercentage booleannullable
Indicates if the tax value is a percentage (True) or a fixed amount (False).
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the tax. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
ID integernullable
The unique identifier for the tax policy.
]
RatePlanDescription objectnullable
A description of the rate plan, possibly in multiple languages.
Language LanguageCodeEnumnullable
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Description stringnullable
A descriptive text.
AdditionalDetailsType objectnullable
Additional details related to the rate plan.
AdditionalDetails object[]
A list of additional details.
Array [
DetailDescription objectrequired
Language-specific description and name for an additional detail.
Description stringnullable
A description of the additional detail.
Name stringrequired
The name or title of the additional detail.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
]
Offers object[]
A list of special offers associated with the rate plan.
Array [
OfferCode stringrequired
The unique code identifying the offer.
RPH stringrequired
The RPH associated with the offer.
OfferRules object[]nullable
A list of rules that apply to the offer.
Array [
MaxAdvancedBookingOffset integernullable
The maximum number of days in advance a booking can be made for the offer.
MinAdvancedBookingOffset integernullable
The minimum number of days in advance a booking must be made for the offer.
DateRestriction objectnullable
Date restrictions for when the offer is valid.
Start stringrequired
The start date (ISO 8601 format) of the date restriction.
End stringrequired
The end date (ISO 8601 format) of the date restriction.
LengthsOfStay objectnullable
Restrictions on the minimum or maximum length of stay for the offer.
ArrivalDateBased boolean
Default value: true
Indicates if the length of stay restriction is based on the arrival date (true) or not (false).
LengthsOfStay object[]required
A list of length of stay restrictions.
Array [
Time integerrequired
The length of time for the stay restriction. Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements.
TimeUnit TimeUnitEnum
Possible values: [0]
The unit of time for the LengthOfStay. TimeUnitEnum: 0=Day
MinMaxMessageType LOSTypeEnum
Possible values: [0, 1]
Indicates whether it's a minimum (0) or maximum (1) length of stay restriction. LOSTypeEnum: 0=SetMinLOS | 1=SetMaxLOS
]
]
Discount objectnullable
Information about any discounts associated with the offer.
ChargeUnitCode ChargeUnitCodeEnum
Possible values: [18]
Default value: 18
The unit to which the discount applies (e.g., PerRoomPerStay, PerPersonPerNight). ChargeUnitCodeEnum: 18=PerRoomPerStay
DiscountPattern stringnullable
The pattern or structure of the discount (if applicable).
NightsDiscounted integernullable
The number of nights that are discounted.
NightsRequired integernullable
The minimum number of nights required to qualify for the discount.
Percent numbernullable
The percentage of the discount.
CompatibleOffer object[]
A list of offers that are compatible with this offer.
Array [
IncompatibleOfferInidcator boolean
Default value: false
Indicates if the offer is incompatible with others (true) or compatible (false).
OfferRPH stringrequired
The Rate Plan Header (RPH) of the compatible offer.
]
Description objectnullable
A description of the offer in multiple languages.
Description stringrequired
The description of the offer.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
]
PaymentPolicies objectnullable
Payment policies applicable to the rate plan.
AcceptedPayments object[]
A list of accepted payment methods and their associated details, such as guarantee type and card information.
Array [
RPH integernullable
The Rate Plan Header (RPH) number associated with the accepted payment, if applicable.
GuaranteeTypeCode GuaranteeTypeCodeEnumrequired
Possible values: [2, 5, 8, 3, 4, 38]
The numerical code indicating the type of guarantee accepted for the payment. GuaranteeTypeCodeEnum: 2=DirectBill | 5=CreditCard | 8=Deposit | 3=Voucher | 4=PrePay | 38=None
PaymentCard stringnullable
Information about the payment card accepted (e.g., card type, last digits).
GuaranteeID stringnullable
A unique identifier for the guarantee associated with the payment.
]
Commission stringnullable
Information about commissions for the rate plan.
CurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for prices in the rate plan. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
RatePlanTypeCode integernullable
A numerical code representing the type of rate plan.
SortOrder stringnullable
The order in which the rate plan should be displayed.
PriceViewableInd booleannullable
Indicates if the price for this rate plan is viewable by the customer (True) or not (False).
TPA_Extensions objectnullable
Additional information or extensions specific to the Travel Partner Agreement (TPA).
SupplierCode stringnullable
The code of the supplier providing the service or product.
ExternalTpiId stringnullable
An external third-party identifier (TPI ID) for the booking or reservation.
ExternalName stringnullable
An external reference name or identifier.
CostCenter stringnullable
The cost center associated with the booking or reservation.
GenerateVCN stringnullable
Indicates whether to generate a Virtual Card Number (VCN) for the payment.
POS stringnullable
Point of Sale (POS) information.
WLCode integernullable
The waitlist code for the booking or reservation.
ApprovalInvoiced stringnullable
Information about approval or invoicing for the booking.
Services stringnullable
Information about additional services included or requested.
GuestsTotalRate stringnullable
The total rate for all guests.
Rates stringnullable
Information about individual rates for guests or items.
TotalDiscountValue stringnullable
The total value of discounts applied.
IsPreferredHotel stringnullable
Indicates whether the hotel is a preferred property (True/False).
]
RoomRates object[]
A list of room rates associated with the stay.
Array [
RoomStayCandidateRPH integer
A reference to a requested room stay candidate from the SearchCriteria.
EffectiveDate stringrequired
Check-in date (ISO 8601 format).
ExpireDate stringrequired
Check-out date (ISO 8601 format).
RatePlanID integerrequired
The unique identifier for the rate plan associated with this room rate.
RoomID integerrequired
The unique identifier for the room type associated with this room rate.
RatesType objectrequired
Details about the different rate types available for this room.
Rates object[]
A list of rate details for the hotel or room type.
Array [
EffectiveDate stringrequired
The effective date for the rate (ISO 8601 format).
MaxLOS integernullable
The maximum length of stay allowed for the rate.
MinLOS integernullable
The minimum length of stay required for the rate.
NumberOfUnits integernullable
The number of available units for the rate.
StayThrough integernullable
Unknown, need further details from Omnibees/Niara documentation.
MinAdvancedBookingOffset integernullable
The minimum number of days in advance a booking must be made.
FPLOS stringnullable
Unknown, need further details from Omnibees/Niara documentation.
Total objectrequired
The total cost information for the rate.
AmountBeforeTax numberrequired
The total cost before taxes.
AmountAfterTax numberrequired
The total cost after taxes.
AmountIncludingMarkup boolean
Default value: false
Indicates if the amount includes markup (true) or not (false).
AmountIsPackage booleannullable
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
ChargeType integernullable
A numerical code representing the type of charge.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
Status stringnullable
The status of the rate (e.g., 'Available', 'Closed').
AgeQualifyingCode AgeQualifyCodeEnumnullable
Possible values: [10, 8]
The age qualifying code for the rate. AgeQualifyCodeEnum: 10=Adult | 8=Child
MinAge integernullable
The minimum age required for the rate.
MaxAge integernullable
The maximum age allowed for the rate.
MinGuestApplicable integernullable
The minimum number of guests for which the rate is applicable.
MaxGuestApplicable integernullable
The maximum number of guests for which the rate is applicable.
Duration integernullable
The duration for which this rate is valid.
]
Total objectrequired
The total cost for this room rate, including taxes and fees.
AmountBeforeTax numberrequired
The total cost before taxes.
AmountAfterTax numberrequired
The total cost after taxes.
AmountIncludingMarkup boolean
Default value: false
Indicates if the amount includes markup (true) or not (false).
AmountIsPackage booleannullable
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
ChargeType integernullable
A numerical code representing the type of charge.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
TPA_Extensions objectnullable
TPA extensions for the room rate total, including the total discount value.
TotalDiscountValue numberrequired
The total discount value applied to the room rate.
ServiceRPHs object[]nullable
Services RPHs (Not yet implemented).
Array [
RPH integerrequired
The Rate Plan Header (RPH) identifier for the service.
IsPerRoom booleannullable
Indicates whether the service is priced per room (True) or not (False).
]
Discount objectnullable
Information about any discounts applied to this room rate.
ChargeUnitCode ChargeUnitCodeEnum
Possible values: [18]
Default value: 18
The unit to which the discount applies (e.g., PerRoomPerStay, PerPersonPerNight). ChargeUnitCodeEnum: 18=PerRoomPerStay
DiscountPattern stringnullable
The pattern or structure of the discount (if applicable).
NightsDiscounted integernullable
The number of nights that are discounted.
NightsRequired integernullable
The minimum number of nights required to qualify for the discount.
Percent numbernullable
The percentage of the discount.
PromotionCode stringnullable
A promotional code applied to this room rate (if any).
GroupCode stringnullable
A group code associated with this room rate (if any).
TPA_Extensions objectnullable
Additional information or extensions specific to the Travel Partner Agreement (TPA).
ApprovalInvoiced integernullable
Approval number or invoice ID.
IsPreferredHotel booleannullable
Indicates if it's a preferred hotel (True) or not (False).
IsExclusiveMobile booleannullable
Indicates if it's exclusive for mobile (True) or not (False).
OccupationFor objectnullable
Occupancy details for the rate.
Adults integernullable
The number of adults included in the occupation.
Childs integernullable
The number of children included in the occupation.
SupplierCode stringnullable
Niara code for the room rate. Needed in order to booking service work.
Rates object[]
A list of rate details with TPA extensions.
Array [
AgeQualifyingCode AgeQualifyCodeEnumrequired
Possible values: [10, 8]
The age qualifying code for the rate. AgeQualifyCodeEnum: 10=Adult | 8=Child
EffectiveDate stringrequired
The effective date for the rate (ISO 8601 format).
MaxGuestApplicable integerrequired
The maximum number of guests applicable for the rate.
MinGuestApplicable integerrequired
The minimum number of guests applicable for the rate.
Total objectrequired
The total cost information for the rate.
AmountBeforeTax numberrequired
The total cost before taxes.
AmountAfterTax numberrequired
The total cost after taxes.
AmountIncludingMarkup boolean
Default value: false
Indicates if the amount includes markup (true) or not (false).
AmountIsPackage booleannullable
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
ChargeType integernullable
A numerical code representing the type of charge.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
]
Availability object[]
A list of availability information for the room rate.
Array [
AvailabilityStatus stringrequired
The availability status of the room rate (e.g., 'Available', 'NotAvailable').
WarningRPH integernullable
An RPH number for a warning message related to the room rate availability (if any).
]
Guarantee objectnullable
Information about the guarantee associated with the room rate.
Start stringnullable
The start date (ISO 8601 format) of the guarantee period.
End stringnullable
The end date (ISO 8601 format) of the guarantee period.
GuaranteeCode stringnullable
A unique code identifying the type of guarantee.
AmountPercent objectnullable
Details about the amount or percentage associated with the guarantee.
Amount numbernullable
The fixed amount, if applicable.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
NmbrOfNights integernullable
The number of nights to which the amount or percentage applies.
Percent numbernullable
The percentage value, if applicable.
Deadline objectnullable
Information about the guarantee deadline.
OffsetDropTime nullable
Possible values: [BeforeArrival, null]
Default value: BeforeArrival
Specifies whether the deadline offset is applied 'BeforeArrival'.
OffsetUnitMultiplier integernullable
A multiplier for the time unit (e.g., 2 for 2 days).
TimeUnitType TimeUnitEnumnullable
Possible values: [0]
The unit of time for the offset. TimeUnitEnum: 0=Day
GuaranteeDescription objectnullable
Language-specific descriptions of the guarantee.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the guarantee description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Name stringrequired
The name or title of the guarantee.
Description stringnullable
A detailed description of the guarantee in the specified language.
GuaranteesAcceptedType objectnullable
Information about the types of guarantees accepted.
GuaranteesAccepted object[]
Array [
GuaranteeTypeCode GuaranteeTypeCodeEnumrequired
Possible values: [2, 5, 8, 3, 4, 38]
The type of guarantee accepted (numerical code). GuaranteeTypeCodeEnum: 2=DirectBill | 5=CreditCard | 8=Deposit | 3=Voucher | 4=PrePay | 38=None
RPH integernullable
Provides a reference to a specific form of payment.
GuaranteeID stringnullable
A unique identifier for the guarantee.
PaymentCard objectnullable
Details of the payment card used for the guarantee (if applicable).
CardCode CardCodeTypeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]
The code or type of the payment card. CardCodeTypeEnum: 1=Visa | 2=MasterCard | 3=AmericanExpress | 4=Discover | 5=HiperCard | 6=DinnersClub | 7=JCB | 8=Electron | 9=EuroCard | 10=EnRouteCard | 11=Laser | 12=Maestro | 13=Solo | 14=PayPal | 15=Aura | 16=Liberate | 17=Elo | 18=Hotelcard
CardHolderName stringrequired
The name of the cardholder.
CardNumber stringrequired
The payment card number.
ExpireDate stringrequired
The expiration date of the payment card (YYYY-MM-DD format).
SeriesCode stringrequired
The card verification code (CVV) or security code.
Extras object[]nullable
A list of extras that can be included.
Array [
ID stringrequired
The identifier of the extra inclusion.
Description stringnullable
Description of the extra inclusion.
]
CurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the price. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
Amount numbernullable
Amount that will be billed for the given guarantee.
ExchangeRate numbernullable
Exchange rate applied in the transaction.
ExchangeCurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The exchange currency code (e.g., 'USD', 'EUR') for the price. This represents the booked item currency. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
ExchangeAmount numbernullable
Amount in the item currency.
]
CancelPenalty objectnullable
Cancellation penalty.
NonRefundable booleanrequired
Indicates whether the booking is non-refundable (true) or refundable (false).
AmountPercent objectnullable
Details about the amount or percentage of the penalty.
Amount numbernullable
The fixed amount, if applicable.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
NmbrOfNights integernullable
The number of nights to which the amount or percentage applies.
Percent numbernullable
The percentage value, if applicable.
AmountRule objectnullable
Details about a fixed amount penalty rule.
Amount numberrequired
The fixed amount for the penalty rule.
End stringrequired
The end date (ISO 8601 format) for which the rule applies.
Start stringrequired
The start date (ISO 8601 format) for which the rule applies.
CurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount, if applicable. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
DeadLine objectnullable
Information about the penalty deadline.
OffsetDropTime integerrequired
The offset time for the penalty deadline.
OffsetUnitMultiplier integerrequired
A multiplier for the offset time unit.
TimeUnitType TimeUnitEnumrequired
Possible values: [0]
The type of time unit for the offset. TimeUnitEnum: 0=Day
AbsoluteDeadline stringnullable
The absolute deadline date (ISO 8601 format), if applicable.
Duration stringnullable
The duration of the cancellation penalty period.
End stringnullable
The end date (ISO 8601 format) of the penalty period.
PenaltyDescription objectrequired
Language-specific descriptions of the penalty.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the penalty description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Name stringrequired
The name or title of the penalty.
Description stringnullable
A detailed description of the penalty in the specified language.
Start stringnullable
The start date (ISO 8601 format) of the penalty period.
]
Total objectnullable
The total cost for the room stay.
AmountBeforeTax numberrequired
The total cost before taxes.
AmountAfterTax numberrequired
The total cost after taxes.
AmountIncludingMarkup boolean
Default value: false
Indicates if the amount includes markup (true) or not (false).
AmountIsPackage booleannullable
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
ChargeType integernullable
A numerical code representing the type of charge.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
GuestCountsType objectnullable
Information about the number of guests staying in the room.
GuestCounts object[]
A list of guest counts by age category.
Array [
Age integernullable
The age of the guest (required if AgeQualifyCode=8).
AgeQualifyCode integerrequired
A numerical code representing the age qualifying code for the guest (e.g., adult, child).
Count integerrequired
The number of guests of the specified age or age category.
ResGuestRPH integer[]
A list of reference numbers for guests associated with this count.
]
Reference stringnullable
A reference number or identifier for the room stay.
CommentsType stringnullable
Comments or notes related to the room stay.
SpecialRequestsType stringnullable
Special requests made by the guest for the room stay.
IndexNumber stringnullable
An index number associated with the room stay.
RoomStayStatus objectnullable
The status of the room stay.
TransactionActionType TransactionActionTypeEnumnullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]
To specify the type of action requested when more than one function could be handled by the message. TransactionActionTypeEnum: 0=Book | 1=Commit | 2=Hold | 3=Ignore | 4=Initiate | 5=Modify | 6=VerifyPrice | 7=CancelRoom | 8=CancelRoomVerifyPrice
PMS_ResStatusType PMS_ResStatusTypeEnumnullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
Code the status of the reservation in the Property Management System (PMS). PMS_ResStatusTypeEnum: 0=Requested | 1=Reserved | 2=RequestDenied | 3=RequestAccepted | 4=Cancelled | 5=Waitlisted | 6=Modified | 7=CancelledOnRequest | 8=CancelPending | 9=OnRequestChannelCancel
Guarantees stringnullable
Information about guarantees associated with the room stay.
]
ResGuestsType objectrequired
Information about the guests associated with the reservation.
ResGuests object[]
A list of guests associated with the reservation.
Array [
ResGuestRPH integerrequired
A reference number for the guest within the reservation.
AgeQualifyingCode AgeQualifyCodeEnumrequired
Possible values: [10, 8]
AgeQualifyCodeEnum: 10=Adult | 8=Child
Age integerrequired
The age of the guest.
Profiles objectrequired
Profile information for the guest, including personal details and contact information.
ProfileInfos object[]
A list of profile information for the reservation guests.
Array [
UniqueID stringnullable
A unique identifier for the profile.
Profile objectrequired
The profile details.
Customer objectrequired
The customer's profile information.
Gender integernullable
A numerical code representing the customer's gender.
BirthDate stringnullable
The customer's birthdate (ISO 8601 format: YYYY-MM-DD).
Email stringnullable
The customer's email address.
Telephones object[]
A list of the customer's phone numbers.
Array [
ShareSyncInd integernullable
An indicator for sharing or synchronization.
ShareMarketInd integernullable
An indicator for sharing in a market.
PhoneNumber stringnullable
The phone number.
PhoneTechType PhoneTechTypeEnumnullable
Possible values: [0, 1, 3, 5]
The type of phone technology. PhoneTechTypeEnum: 0=None | 1=Voice | 3=Fax | 5=Mobile
Extension stringnullable
The phone extension (if applicable).
PhoneLocationType PhoneLocationTypeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9]
The type of phone location. PhoneLocationTypeEnum: 1=BrandReservationsOffice | 2=CentralReservationsOffice | 3=PropertyReservationOffice | 4=PropertyDirect | 5=SalesOffice | 6=Home | 7=Office | 8=Other | 9=ManagingCompany
]
PersonName objectrequired
The customer's name details.
NamePrefix integernullable
A numerical code representing the person's name prefix (e.g., Mr., Ms., Dr.).
GivenName stringrequired
The person's first or given name.
MiddleName stringnullable
The person's middle name (if applicable).
Surname stringnullable
The person's last name or surname.
Address objectnullable
The customer's address details.
AddressLine stringnullable
The street address or line 1 of the address.
CityCode object nullable
A numerical code for the city.
oneOf
MOD1
integer
MOD2
string
CityName stringnullable
The name of the city.
CountryCode CountryCodeEnumnullable
Possible values: [161, 177, 209, 95, 168, 94, 60, 189, 186, 24, 104, 56, 63, 198, 49, 171, 102, 113, 109, 148, 158, 29, 200, 97, 195, 73, 71, 68, 181, 82, 44, 72, 112, 27, 118, 79, 132, 32, 75, 199, 120, 90, 42, 18, 156, 159, 108, 211, 210, 54, 122, 114, 39, 129, 183, 178, 137, 121, 17, 149, 30, 196, 188, 180, 36, 92, 124, 141, 138, 204, 103, 110, 150, 208, 190, 93, 111, 187, 155, 123, 52, 41, 45, 106, 101, 107, 173, 66, 160, 134, 25, 127, 131, 152, 176, 197, 140, 205, 143, 74, 116, 46, 169, 55, 157, 115, 99, 81, 70, 146, 43, 191, 86, 128, 35, 77, 172, 167, 78, 85, 50, 145, 125, 194, 179, 136, 126, 19, 62, 91, 201, 185, 184, 142, 26, 33, 80, 119, 96, 133, 76, 20, 117, 174, 61, 147, 206, 166, 98, 175, 135, 58, 38, 21, 139, 31, 48, 87, 219, 182, 153, 203, 40, 100, 65, 59, 28, 193, 162, 64, 22, 163, 214, 218, 164, 216, 83, 34, 69, 84, 89, 144, 57, 207, 67, 53, 151, 88, 23, 51, 37, 154, 130, 105, 192, 165, 217, 47, 202, 170, 213, 215, 212]
The three-letter country code (ISO 3166-1 alpha-3). CountryCodeEnum: 161=RW | 177=SO | 209=YE | 95=IQ | 168=SA | 94=IR | 60=CY | 189=TZ | 186=SY | 24=AM | 104=KE | 56=CD | 63=DJ | 198=UG | 49=CF | 171=SC | 102=JO | 113=LB | 109=KW | 148=OM | 158=QA | 29=BH | 200=AE | 97=IL | 195=TR | 73=ET | 71=ER | 68=EG | 181=SD | 82=GR | 44=BI | 72=EE | 112=LV | 27=AZ | 118=LT | 79=GE | 132=MD | 32=BY | 75=FI | 199=UA | 120=MK | 90=HU | 42=BG | 18=AL | 156=PL | 159=RO | 108=XK | 211=ZW | 210=ZM | 54=KM | 122=MW | 114=LS | 39=BW | 129=MU | 183=SZ | 178=ZA | 137=MZ | 121=MG | 17=AF | 149=PK | 30=BD | 196=TM | 188=TJ | 180=LK | 36=BT | 92=IN | 124=MV | 141=NP | 138=MM | 204=UZ | 103=KZ | 110=KG | 150=PW | 208=VD | 190=TH | 93=ID | 111=LA | 187=TW | 155=PH | 123=MY | 52=CN | 41=BN | 45=KH | 106=KP | 101=JP | 107=KR | 173=SG | 66=TP | 160=RU | 134=MN | 25=AU | 127=MH | 131=FM | 152=PG | 176=SB | 197=TV | 140=NR | 205=VU | 143=NZ | 74=FJ | 116=LY | 46=CM | 169=SN | 55=CG | 157=PT | 115=LR | 99=CI | 81=GH | 70=GQ | 146=NG | 43=BF | 191=TG | 86=GW | 128=MR | 35=BJ | 77=GA | 172=SL | 167=ST | 78=GM | 85=GN | 50=TD | 145=NE | 125=ML | 194=TN | 179=ES | 136=MA | 126=MT | 19=DZ | 62=DK | 91=IS | 201=GB | 185=CH | 184=SE | 142=NL | 26=AT | 33=BE | 80=DE | 119=LU | 96=IE | 133=MC | 76=FR | 20=AD | 117=LI | 174=SK | 61=CZ | 147=NO | 206=VA | 166=SM | 98=IT | 175=SI | 135=ME | 58=HR | 38=BA | 21=AO | 139=NA | 31=BB | 48=CV | 87=GY | 219=GF | 182=SR | 153=PY | 203=UY | 40=BR | 100=JM | 65=DO | 59=CU | 28=BS | 193=TT | 162=KN | 64=DM | 22=AG | 163=LC | 214=AW | 218=VG | 164=VC | 216=MF | 83=GD | 34=BZ | 69=SV | 84=GT | 89=HN | 144=NI | 57=CR | 207=VE | 67=EC | 53=CO | 151=PA | 88=HT | 23=AR | 51=CL | 37=BO | 154=PE | 130=MX | 105=KI | 192=TO | 165=WS | 217=PR | 47=CA | 202=US | 170=RS | 213=CW | 215=BQ | 212=HK
CountryName stringnullable
The full name of the country.
PostalCode stringnullable
The postal or zip code.
StateProvCode integernullable
A numerical code for the state or province.
StateProv stringnullable
Name of the state or province.
ZoneCode integernullable
A numerical code for the zone or area within the city.
Document stringnullable
The customer's identification document number.
]
PrimaryIndicator boolean
Default value: false
Indicates if this is the primary guest in the reservation (true) or not (false).
SpecialRequests stringnullable
Any special requests made by the guest for the reservation.
]
ResGlobalInfo objectrequired
Global information about the reservation.
TimeSpan stringnullable
The time span of the reservation (e.g., check-in and check-out dates).
Total objectrequired
The total cost information for the reservation.
AmountBeforeTax numberrequired
The total cost before taxes.
AmountAfterTax numberrequired
The total cost after taxes.
AmountIncludingMarkup boolean
Default value: false
Indicates if the amount includes markup (true) or not (false).
AmountIsPackage booleannullable
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
ChargeType integernullable
A numerical code representing the type of charge.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
HotelReservationsIDsType objectnullable
Identifiers for multiple hotel reservations (if applicable).
HotelReservationIDs object[]
A list of hotel reservation identifiers.
Array [
ResID_Type UniqueIDCodeEnumnullable
Possible values: [14, 25]
The type of unique identifier for the hotel reservation. UniqueIDCodeEnum: 14=Reservation | 25=AssociatedReservation
ResID_Value stringnullable
The value of the unique identifier for the hotel reservation.
]
Guarantee objectnullable
Information about the guarantee for the reservation.
Start stringnullable
The start date (ISO 8601 format) of the guarantee period.
End stringnullable
The end date (ISO 8601 format) of the guarantee period.
GuaranteeCode stringnullable
A unique code identifying the type of guarantee.
AmountPercent objectnullable
Details about the amount or percentage associated with the guarantee.
Amount numbernullable
The fixed amount, if applicable.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
NmbrOfNights integernullable
The number of nights to which the amount or percentage applies.
Percent numbernullable
The percentage value, if applicable.
Deadline objectnullable
Information about the guarantee deadline.
OffsetDropTime nullable
Possible values: [BeforeArrival, null]
Default value: BeforeArrival
Specifies whether the deadline offset is applied 'BeforeArrival'.
OffsetUnitMultiplier integernullable
A multiplier for the time unit (e.g., 2 for 2 days).
TimeUnitType TimeUnitEnumnullable
Possible values: [0]
The unit of time for the offset. TimeUnitEnum: 0=Day
GuaranteeDescription objectnullable
Language-specific descriptions of the guarantee.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the guarantee description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Name stringrequired
The name or title of the guarantee.
Description stringnullable
A detailed description of the guarantee in the specified language.
GuaranteesAcceptedType objectnullable
Information about the types of guarantees accepted.
GuaranteesAccepted object[]
Array [
GuaranteeTypeCode GuaranteeTypeCodeEnumrequired
Possible values: [2, 5, 8, 3, 4, 38]
The type of guarantee accepted (numerical code). GuaranteeTypeCodeEnum: 2=DirectBill | 5=CreditCard | 8=Deposit | 3=Voucher | 4=PrePay | 38=None
RPH integernullable
Provides a reference to a specific form of payment.
GuaranteeID stringnullable
A unique identifier for the guarantee.
PaymentCard objectnullable
Details of the payment card used for the guarantee (if applicable).
CardCode CardCodeTypeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]
The code or type of the payment card. CardCodeTypeEnum: 1=Visa | 2=MasterCard | 3=AmericanExpress | 4=Discover | 5=HiperCard | 6=DinnersClub | 7=JCB | 8=Electron | 9=EuroCard | 10=EnRouteCard | 11=Laser | 12=Maestro | 13=Solo | 14=PayPal | 15=Aura | 16=Liberate | 17=Elo | 18=Hotelcard
CardHolderName stringrequired
The name of the cardholder.
CardNumber stringrequired
The payment card number.
ExpireDate stringrequired
The expiration date of the payment card (YYYY-MM-DD format).
SeriesCode stringrequired
The card verification code (CVV) or security code.
Extras object[]nullable
A list of extras that can be included.
Array [
ID stringrequired
The identifier of the extra inclusion.
Description stringnullable
Description of the extra inclusion.
]
CurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the price. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
Amount numbernullable
Amount that will be billed for the given guarantee.
ExchangeRate numbernullable
Exchange rate applied in the transaction.
ExchangeCurrencyCode CurrencyCodeEnumnullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The exchange currency code (e.g., 'USD', 'EUR') for the price. This represents the booked item currency. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
ExchangeAmount numbernullable
Amount in the item currency.
]
CommentsType objectnullable
Comments associated with the reservation.
Comments object[]
A list of comments, each with a name and description.
Array [
Language LanguageCodeEnumnullable
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Description stringnullable
A descriptive text.
Name stringnullable
The name associated with the description.
]
Services object[]nullable
Information about services included in the reservation.
Array [
ID stringrequired
The unique identifier for the service.
ServiceCategoryCode stringnullable
A code representing the category of the service.
ServicePricingType ServicePricingTypeEnumrequired
Possible values: [7, 12, 18, 19, 20, 21, 25]
The pricing type for the service (CHG code). ServicePricingTypeEnum: 7=PerPerson | 12=PerStay | 18=PerRoomPerStay | 19=PerRoomPerNight | 20=PerPersonPerStay | 21=PerPersonPerNight | 25=PerRoom | 19=PerNight
ServiceDescription objectrequired
A description of the service, including name and language.
Name stringrequired
The name of the service.
Description stringnullable
A description of the service.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description. LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
ImageURL stringnullable
The URL of an image representing the service (if available).
]
]
ResResponseType stringnullable

Response type for the reservation, if any.

RetransmissionIndicator stringnullable

Indicator for retransmission, if applicable.

TransactionIdentifier stringnullable

Identifier for the transaction, if any.

Example (from schema)

{
  "PrimaryLangID": 8,
  "EchoToken": "string",
  "TimeStamp": "string",
  "Target": 0,
  "Version": 0,
  "Success": {},
  "WarningsType": {
    "Warnings": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "ErrorsType": {
    "Errors": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "MaxResponses": 0,
  "PageNumber": 0,
  "TotalRecords": 0,
  "MoreIndicator": false,
  "POS": "string",
  "HotelReservationsType": {
    "HotelReservations": [
      {
        "CreateDateTime": "string",
        "LastModifyDateTime": "string",
        "ResStatus": {
          "TransactionActionType": 0,
          "PMS_ResStatusType": 0
        },
        "POS": {
          "Sources": [
            {
              "ISOCountry": "string"
            }
          ]
        },
        "UniqueID": {
          "ID": "string",
          "Type": 14,
          "Reason": "string"
        },
        "RoomStaysType": {
          "MoreIndicator": false,
          "RoomStays": [
            {
              "RoomStayLanguage": 8,
              "RPH": 0,
              "WarningRPH": "string",
              "AvailabilityStatus": "string",
              "RoomStayCandidateRPH": "string",
              "BasicPropertyInfo": {
                "CurrencyCode": 1,
                "ImageURL": "string",
                "Award": {},
                "Address": {
                  "AddressLine": "string",
                  "CityCode": 0,
                  "CityName": "string",
                  "CountryCode": 161,
                  "CountryName": "string",
                  "PostalCode": "string",
                  "StateProvCode": 0,
                  "StateProv": "string",
                  "ZoneCode": 0
                },
                "HotelRef": {
                  "ChainCode": 0,
                  "ChainName": "string",
                  "HotelName": "string",
                  "HotelCode": 0
                },
                "Position": {
                  "Latitude": "string",
                  "Longitude": "string"
                },
                "VendorMessagesType": {
                  "VendorMessages": [
                    {
                      "Language": 8,
                      "Description": "string"
                    }
                  ]
                }
              },
              "TPA_Extensions": {
                "SupplierCode": "string"
              },
              "RoomTypes": [
                {
                  "MaxOccupancy": 0,
                  "NumberOfUnits": 0,
                  "RoomID": 0,
                  "RoomName": "string",
                  "MinOccupancy": 0,
                  "Occupancies": [
                    {
                      "AgeQualifyingCode": 10,
                      "MaxOccupancy": 0,
                      "MinOccupancy": 0
                    }
                  ],
                  "RoomDescription": {
                    "Language": 8,
                    "Description": "string"
                  }
                }
              ],
              "RatePlans": [
                {
                  "EffectiveDate": "string",
                  "ExpireDate": "string",
                  "RatePlanName": "string",
                  "Guarantees": [
                    {
                      "Start": "string",
                      "End": "string",
                      "GuaranteeCode": "string",
                      "AmountPercent": {
                        "Amount": 0,
                        "CurrencyCode": 1,
                        "NmbrOfNights": 0,
                        "Percent": 0
                      },
                      "Deadline": {
                        "OffsetUnitMultiplier": 0,
                        "TimeUnitType": 0
                      },
                      "GuaranteeDescription": {
                        "Language": 8,
                        "Name": "string",
                        "Description": "string"
                      },
                      "GuaranteesAcceptedType": {
                        "GuaranteesAccepted": [
                          {
                            "GuaranteeTypeCode": 2,
                            "RPH": 0,
                            "GuaranteeID": "string",
                            "PaymentCard": {
                              "CardCode": 1,
                              "CardHolderName": "string",
                              "CardNumber": "string",
                              "ExpireDate": "string",
                              "SeriesCode": "string"
                            },
                            "Extras": [
                              {
                                "ID": "string",
                                "Description": "string"
                              }
                            ],
                            "CurrencyCode": 1,
                            "Amount": 0,
                            "ExchangeRate": 0,
                            "ExchangeCurrencyCode": 1,
                            "ExchangeAmount": 0
                          }
                        ]
                      }
                    }
                  ],
                  "CancelPenalties": [
                    {
                      "NonRefundable": true,
                      "AmountPercent": {
                        "Amount": 0,
                        "CurrencyCode": 1,
                        "NmbrOfNights": 0,
                        "Percent": 0
                      },
                      "AmountRule": {
                        "Amount": 0,
                        "End": "string",
                        "Start": "string",
                        "CurrencyCode": 1
                      },
                      "DeadLine": {
                        "OffsetDropTime": 0,
                        "OffsetUnitMultiplier": 0,
                        "TimeUnitType": 0,
                        "AbsoluteDeadline": "string"
                      },
                      "Duration": "string",
                      "End": "string",
                      "PenaltyDescription": {
                        "Language": 8,
                        "Name": "string",
                        "Description": "string"
                      },
                      "Start": "string"
                    }
                  ],
                  "RatePlanInclusions": [
                    {
                      "RatePlanInclusionDesciption": {
                        "Language": 8,
                        "Description": "string",
                        "Name": "string"
                      },
                      "Start": "string",
                      "Duration": "string",
                      "End": "string",
                      "ID": 0
                    }
                  ],
                  "MealsIncluded": {
                    "Breakfast": true,
                    "Lunch": true,
                    "Dinner": true,
                    "MealPlanIndicator": true,
                    "MealPlanCode": 1,
                    "ID": 0,
                    "Name": "string",
                    "Description": "string",
                    "Price": {
                      "Start": "string",
                      "Duration": "string",
                      "End": "string",
                      "AmountBeforeTax": 0,
                      "AmountAfterTax": 0,
                      "CurrencyCode": 1,
                      "AmountIncludingMarkup": true
                    },
                    "ServicePricingType": 7
                  },
                  "RatePlanID": 0,
                  "TaxPolicies": [
                    {
                      "Name": "string",
                      "Description": "string",
                      "IsPerNight": true,
                      "IsPerStay": true,
                      "IsPerPerson": true,
                      "IsPerRoom": true,
                      "Value": 0,
                      "IsValuePercentage": true,
                      "CurrencyCode": 1,
                      "ID": 0
                    }
                  ],
                  "RatePlanDescription": {
                    "Language": 8,
                    "Description": "string"
                  },
                  "AdditionalDetailsType": {
                    "AdditionalDetails": [
                      {
                        "DetailDescription": {
                          "Description": "string",
                          "Name": "string",
                          "Language": 8
                        }
                      }
                    ]
                  },
                  "Offers": [
                    {
                      "OfferCode": "string",
                      "RPH": "string",
                      "OfferRules": [
                        {
                          "MaxAdvancedBookingOffset": 0,
                          "MinAdvancedBookingOffset": 0,
                          "DateRestriction": {
                            "Start": "string",
                            "End": "string"
                          },
                          "LengthsOfStay": {
                            "ArrivalDateBased": true,
                            "LengthsOfStay": [
                              {
                                "Time": 0,
                                "TimeUnit": 0,
                                "MinMaxMessageType": 0
                              }
                            ]
                          }
                        }
                      ],
                      "Discount": {
                        "ChargeUnitCode": 18,
                        "DiscountPattern": "string",
                        "NightsDiscounted": 0,
                        "NightsRequired": 0,
                        "Percent": 0
                      },
                      "CompatibleOffer": [
                        {
                          "IncompatibleOfferInidcator": false,
                          "OfferRPH": "string"
                        }
                      ],
                      "Description": {
                        "Description": "string",
                        "Language": 8
                      }
                    }
                  ],
                  "PaymentPolicies": {
                    "AcceptedPayments": [
                      {
                        "RPH": 0,
                        "GuaranteeTypeCode": 2,
                        "PaymentCard": "string",
                        "GuaranteeID": "string"
                      }
                    ]
                  },
                  "Commission": "string",
                  "CurrencyCode": 1,
                  "RatePlanTypeCode": 0,
                  "SortOrder": "string",
                  "PriceViewableInd": true,
                  "TPA_Extensions": {
                    "SupplierCode": "string",
                    "ExternalTpiId": "string",
                    "ExternalName": "string",
                    "CostCenter": "string",
                    "GenerateVCN": "string",
                    "POS": "string",
                    "WLCode": 0,
                    "ApprovalInvoiced": "string",
                    "Services": "string",
                    "GuestsTotalRate": "string",
                    "Rates": "string",
                    "TotalDiscountValue": "string",
                    "IsPreferredHotel": "string"
                  }
                }
              ],
              "RoomRates": [
                {
                  "RoomStayCandidateRPH": 0,
                  "EffectiveDate": "string",
                  "ExpireDate": "string",
                  "RatePlanID": 0,
                  "RoomID": 0,
                  "RatesType": {
                    "Rates": [
                      {
                        "EffectiveDate": "string",
                        "MaxLOS": 0,
                        "MinLOS": 0,
                        "NumberOfUnits": 0,
                        "StayThrough": 0,
                        "MinAdvancedBookingOffset": 0,
                        "FPLOS": "string",
                        "Total": {
                          "AmountBeforeTax": 0,
                          "AmountAfterTax": 0,
                          "AmountIncludingMarkup": false,
                          "AmountIsPackage": false,
                          "ChargeType": 0,
                          "CurrencyCode": 1
                        },
                        "Status": "string",
                        "AgeQualifyingCode": 10,
                        "MinAge": 0,
                        "MaxAge": 0,
                        "MinGuestApplicable": 0,
                        "MaxGuestApplicable": 0,
                        "Duration": 0
                      }
                    ]
                  },
                  "Total": {
                    "AmountBeforeTax": 0,
                    "AmountAfterTax": 0,
                    "AmountIncludingMarkup": false,
                    "AmountIsPackage": false,
                    "ChargeType": 0,
                    "CurrencyCode": 1,
                    "TPA_Extensions": {
                      "TotalDiscountValue": 0
                    }
                  },
                  "ServiceRPHs": [
                    {
                      "RPH": 0,
                      "IsPerRoom": true
                    }
                  ],
                  "Discount": {
                    "ChargeUnitCode": 18,
                    "DiscountPattern": "string",
                    "NightsDiscounted": 0,
                    "NightsRequired": 0,
                    "Percent": 0
                  },
                  "PromotionCode": "string",
                  "GroupCode": "string",
                  "TPA_Extensions": {
                    "ApprovalInvoiced": 0,
                    "IsPreferredHotel": true,
                    "IsExclusiveMobile": true,
                    "OccupationFor": {
                      "Adults": 0,
                      "Childs": 0
                    },
                    "SupplierCode": "string",
                    "Rates": [
                      {
                        "AgeQualifyingCode": 10,
                        "EffectiveDate": "string",
                        "MaxGuestApplicable": 0,
                        "MinGuestApplicable": 0,
                        "Total": {
                          "AmountBeforeTax": 0,
                          "AmountAfterTax": 0,
                          "AmountIncludingMarkup": false,
                          "AmountIsPackage": false,
                          "ChargeType": 0,
                          "CurrencyCode": 1
                        }
                      }
                    ]
                  },
                  "Availability": [
                    {
                      "AvailabilityStatus": "string",
                      "WarningRPH": 0
                    }
                  ],
                  "Guarantee": {
                    "Start": "string",
                    "End": "string",
                    "GuaranteeCode": "string",
                    "AmountPercent": {
                      "Amount": 0,
                      "CurrencyCode": 1,
                      "NmbrOfNights": 0,
                      "Percent": 0
                    },
                    "Deadline": {
                      "OffsetUnitMultiplier": 0,
                      "TimeUnitType": 0
                    },
                    "GuaranteeDescription": {
                      "Language": 8,
                      "Name": "string",
                      "Description": "string"
                    },
                    "GuaranteesAcceptedType": {
                      "GuaranteesAccepted": [
                        {
                          "GuaranteeTypeCode": 2,
                          "RPH": 0,
                          "GuaranteeID": "string",
                          "PaymentCard": {
                            "CardCode": 1,
                            "CardHolderName": "string",
                            "CardNumber": "string",
                            "ExpireDate": "string",
                            "SeriesCode": "string"
                          },
                          "Extras": [
                            {
                              "ID": "string",
                              "Description": "string"
                            }
                          ],
                          "CurrencyCode": 1,
                          "Amount": 0,
                          "ExchangeRate": 0,
                          "ExchangeCurrencyCode": 1,
                          "ExchangeAmount": 0
                        }
                      ]
                    }
                  },
                  "CancelPenalty": {
                    "NonRefundable": true,
                    "AmountPercent": {
                      "Amount": 0,
                      "CurrencyCode": 1,
                      "NmbrOfNights": 0,
                      "Percent": 0
                    },
                    "AmountRule": {
                      "Amount": 0,
                      "End": "string",
                      "Start": "string",
                      "CurrencyCode": 1
                    },
                    "DeadLine": {
                      "OffsetDropTime": 0,
                      "OffsetUnitMultiplier": 0,
                      "TimeUnitType": 0,
                      "AbsoluteDeadline": "string"
                    },
                    "Duration": "string",
                    "End": "string",
                    "PenaltyDescription": {
                      "Language": 8,
                      "Name": "string",
                      "Description": "string"
                    },
                    "Start": "string"
                  }
                }
              ],
              "Total": {
                "AmountBeforeTax": 0,
                "AmountAfterTax": 0,
                "AmountIncludingMarkup": false,
                "AmountIsPackage": false,
                "ChargeType": 0,
                "CurrencyCode": 1
              },
              "GuestCountsType": {
                "GuestCounts": [
                  {
                    "Age": 0,
                    "AgeQualifyCode": 0,
                    "Count": 0,
                    "ResGuestRPH": [
                      0
                    ]
                  }
                ]
              },
              "Reference": "string",
              "CommentsType": "string",
              "SpecialRequestsType": "string",
              "IndexNumber": "string",
              "RoomStayStatus": {
                "TransactionActionType": 0,
                "PMS_ResStatusType": 0
              },
              "Guarantees": "string"
            }
          ]
        },
        "ResGuestsType": {
          "ResGuests": [
            {
              "ResGuestRPH": 0,
              "AgeQualifyingCode": 10,
              "Age": 0,
              "Profiles": {
                "ProfileInfos": [
                  {
                    "UniqueID": "string",
                    "Profile": {
                      "Customer": {
                        "Gender": 0,
                        "BirthDate": "string",
                        "Email": "string",
                        "Telephones": [
                          {
                            "ShareSyncInd": 0,
                            "ShareMarketInd": 0,
                            "PhoneNumber": "string",
                            "PhoneTechType": 0,
                            "Extension": "string",
                            "PhoneLocationType": 1
                          }
                        ],
                        "PersonName": {
                          "NamePrefix": 0,
                          "GivenName": "string",
                          "MiddleName": "string",
                          "Surname": "string"
                        },
                        "Address": {
                          "AddressLine": "string",
                          "CityCode": 0,
                          "CityName": "string",
                          "CountryCode": 161,
                          "CountryName": "string",
                          "PostalCode": "string",
                          "StateProvCode": 0,
                          "StateProv": "string",
                          "ZoneCode": 0
                        },
                        "Document": "string"
                      }
                    }
                  }
                ]
              },
              "PrimaryIndicator": false,
              "SpecialRequests": "string"
            }
          ]
        },
        "ResGlobalInfo": {
          "TimeSpan": "string",
          "Total": {
            "AmountBeforeTax": 0,
            "AmountAfterTax": 0,
            "AmountIncludingMarkup": false,
            "AmountIsPackage": false,
            "ChargeType": 0,
            "CurrencyCode": 1
          },
          "HotelReservationsIDsType": {
            "HotelReservationIDs": [
              {
                "ResID_Type": 14,
                "ResID_Value": "string"
              }
            ]
          },
          "Guarantee": {
            "Start": "string",
            "End": "string",
            "GuaranteeCode": "string",
            "AmountPercent": {
              "Amount": 0,
              "CurrencyCode": 1,
              "NmbrOfNights": 0,
              "Percent": 0
            },
            "Deadline": {
              "OffsetUnitMultiplier": 0,
              "TimeUnitType": 0
            },
            "GuaranteeDescription": {
              "Language": 8,
              "Name": "string",
              "Description": "string"
            },
            "GuaranteesAcceptedType": {
              "GuaranteesAccepted": [
                {
                  "GuaranteeTypeCode": 2,
                  "RPH": 0,
                  "GuaranteeID": "string",
                  "PaymentCard": {
                    "CardCode": 1,
                    "CardHolderName": "string",
                    "CardNumber": "string",
                    "ExpireDate": "string",
                    "SeriesCode": "string"
                  },
                  "Extras": [
                    {
                      "ID": "string",
                      "Description": "string"
                    }
                  ],
                  "CurrencyCode": 1,
                  "Amount": 0,
                  "ExchangeRate": 0,
                  "ExchangeCurrencyCode": 1,
                  "ExchangeAmount": 0
                }
              ]
            }
          },
          "CommentsType": {
            "Comments": [
              {
                "Language": 8,
                "Description": "string",
                "Name": "string"
              }
            ]
          }
        },
        "Services": [
          {
            "ID": "string",
            "ServiceCategoryCode": "string",
            "ServicePricingType": 7,
            "ServiceDescription": {
              "Name": "string",
              "Description": "string",
              "Language": 8,
              "ImageURL": "string"
            }
          }
        ]
      }
    ]
  },
  "ResResponseType": "string",
  "RetransmissionIndicator": "string",
  "TransactionIdentifier": "string"
}

Loading...