Documentation

• Suppliers Integration structures
• [CCON] Contract Header
• [SIAP] Suppliers integration availability and prices
• [SIIN] Inventory
• [SIEM] Minimum and maximum stay
• [CNES] Check in and check out days
• [SICF] Supplier integration cancellation fees
• Calculation for External Providers

Depending on every chain, calculation rules may change. In order to distinguish which file belongs to which chain, it is necessary to check the codes associated. Here the list of chains available through AIF:

Suppliers Integration structures

[CCON] Contract Header

This structure informs about the contract header: range of dates this contract is valid for, ages for children... Basically, it remains as before, but there is a new field now (only for external providers): Is total price per stay.

This field indicates if it is necessary to sum several price lines from [SIAP.Amount] in order to get the final price for reaching the length of stay desired or not.

If value is Y, it is not possible to do the calculation over other lines to get the final price with the length of stay required as it is returning the lengths of stay available for this room (if a length of stay is not in the price lines in [SIAP], it is not bookable).

If value is N, it is possible to do the calculation over other lines to get the final price with the length of stay required (if a length of stay is not in the price lines in [SIAP], it is possible to do the sum to get the length of stay required).

Example:

As [CCON.Is total price per stay] is Y, it is not possible to sum prices from [SIAP] in order to get the length of stay desired, so if for example, the booking desired was for 7 nights of length of stay, this contract will not be available, as only stays for 1, 2 and 3 nights would be possible for this room.

As [CCON.Is total price per stay] is N, it is possible to sum prices from [SIAP] in order to get the length of stay desired, so if for example, the booking desired was for 7 nights of length of stay, you must sum prices from lines with length of stay 3+3+1 (twice third line and one time first line. From stay more restrictive to less restrictive).

[SIAP] Suppliers integration availability and prices

Specification

Example

These examples inform about the availability and prices for DBL-ST room with RO board:

• 1 room of 2 adults and 0 children: Price from 1st June to 2nd June, from 2nd to 3rd, from 3rd to 4th and from 4th to 5th.
• 1 room of 2 adults and 0 children: Price from 1st June to 3rd, from 2nd to 4th and from 3rd to 5th of June.
• 1 room of 2 adults and 1 child between 2 and 8 years old and 2 children between 9 and 12 years old: Price from 1st June to 5th.

This structure informs about the prices for external providers. Basically it remains as before, but now there are 2 new fields: Children and Is price per pax.

• Children: Informs the age range for the number of children admitted where the first value indicates the number of children which the rule applies to and second and third value indicates the minimum and maximum age for those children. Example:

• Occupancy: Indicates how to manage/build the occupancy per room.
  
  

When [SIAP.Occupancy] is N, structure [CNHA] will be empty when prices are per room. In those cases, it is necessary to check the structure [SIAP] in order to know for which occupancy those prices are valid (occupancy will be informed in [SIAP] structure directly). 

When [SIAP.Occupancy] is Y, structure [CNHA] must be checked and fields from [SIAP] will be empty.

Example: 

• Recurrence: Indicates the number of days this price would be the same for a period:

[SIIN] Inventory

This new structure informs about the release and allotment per room in external supplier contract. Basically it remains the same as [CNIN] structure but includes some new fields:

• Board code
• Release Min and Release Max: Minimum and maximum number of days necessary to do the booking in advance, where Release Min would be the minimum days in advance to do the booking before check-in and Release Max would be the maximum days in advance to do the booking before check-in.
• Recurrence: As for SIAP section, the recurrence will display the allotment for the range of dates (initial and final date).

Example:

Booking from 01/12/14 to 05/12/14

In example above, Release Min is 2 days (if check-in date is 01/12/14, the booking must be confirmed on 29/11/14. After this date, room will not be longer available (for bookings with check-in date on 01/12/14)).

Release Max is 30 days for bookings with check-in date on 01/12/14, so maximum you can do the booking confirmation for this booking 30 days before the 01/12/14 (in this case, the maximum date for doing the booking would be the 01/11/14).

In dark blue the period included until Release Max. In pink days that are included on Release Min. In blue the check-in date. In purple dates that exceed release.

[SIEM] Minimum and maximum stay

If data in Days is empty, there is not restriction for any day (any stay is valid)

Example

• For QUA.2B, the 26 only can stay 1 or 3 days, 27 just 1. As Is per check-in date is Y, a stay from 26 to 28 June would be valid as it complies the rule for the 26 and it is not necessary to check the 27.
• For QUA.2B, the 26 can stay from 1 to 3 days, 27 from 1 to 4, the 28 from 4 to 5. As Is per check-in date is N, a stay from 26 to 29 June would not be valid as it does not comply the rule for the 28, even the 26 and 27 is complying.

Minimum and maximum stay per day will be informed on this section for external providers.

It is possible to have for the same dates, same room type, and same board, 2 different lines in [SIEM], one per range and another per list of days. If this happens, it is necessary both lines are fulfilled in order to the requested booking is possible.

In those cases, [SIEM.Is per check-in date] will have the same value for both lines (it is not possible you will have different values for this field in these 2 lines).

Example:

In the cases above, the first line indicates the validation is per range for room DBL.AE-QU from 01/09/14 to 30/09/14 and the second line indicates the validation is per list of days for room DBL.AE-QU from 01/09/14 to 30/09/14.

It is necessary both lines are fulfilled to go on with the booking. If some of them are not fulfilled the booking will not be possible through xml.

Depending on the validation of fields [SIEM.Is per check-in date] and [SIEM.Is per range], it is necessary to apply it in one way or another:

• If [SIEM.Is per check-in date] is Y (validation per check-in date) and [SIEM.Is per range] is Y (range of minimum and maximum stays separated by comma), while the minimum stay in check-in date is complying, it is not necessary to check the rest of days. Example: 

For QUA.2Q-DX, the 1st can stay from 1 to 31 nights, 2nd from 1 to 31 nights, 3rd from 7 to 31 nights. 

As [SIEM.Is per check-in date] is Y, a stay from 1 to 4 February (3 nights) would be valid as it complies the rule for the 1st and it is not necessary to check the 2nd and 3rd.

• If [SIEM.Is per check-in date] is Y (validation per check-in date) and [SIEM.Is per range] is N (list of days separated by comma), while the minimum stay in check-in date is complying, it is not necessary to check the rest of the days. Example: 

For QUA.2Q-DX, the 1st can stay 1 and 2 nights, 2nd can stay 1, 2 and 3 nights, 3rd can stay 7 and 8 nights. 

As [SIEM.Is per check-in date] is Y, a stay from 1 to 4 February (3 nights) would not be valid as it does not comply the rule for the 1st and it is not necessary to check the 2nd and 3rd.

• If [SIEM.Is per check-in date] is N (validation per the whole stay) and [SIEM.Is per range] is Y (range of minimum and maximum stays separated by comma), it is necessary the minimum stay complies all the complete stay of the booking. Example: 

For QUA.2Q-DX, the 1st can stay from 1 to 3 nights, 2nd from 1 to 2 nights, 3rd from 7 to 15 nights. 

As [SIEM.Is per check-in date] is N, a stay from 1 to 4 February (3 nights) would not be valid as it complies the rule for the 1st but not for the 2nd neither 3rd, as for the 2nd is necessary to stay maximum 2 nights and for the 3rd is necessary to stay minimum 7 nights.

• If [SIEM.Is per check-in date] is N (validation per the whole stay) and [SIEM.Is per range] is N (list of days separated by comma), it is necessary the minimum stay complies the complete stay of the booking. Example: 

For QUA.2Q-DX, the 1st can stay 1 or 3 nights, 2nd can stay 1 or 2 nights, 3rd can stay 7 or 8 nights. 

As [SIEM.Is per check-in date] is N, a stay from 1 to 3 February (2 nights) would not be valid as it complies the rule for the 2nd but does not comply the rule for the 1st, as it is only possible to do a booking for stays of 1 or 3 nights.

[CNES] Check in and check out days

This information is displayed at CNES structure.

The [CNES.type] indicator informs about the application: if it is a restriction to check in or check out date.

In both cases seek applicable records, they shall fulfil the following conditions:

• The date of check in/out is included
• Matches the requested room or is generic
• Matches requested characteristic or is generic
• The application date is valid for the booking creation day
  
  

After that, we will validate the days when the contract requires checking in or checking out. Every record informs about the day of the week. This value must be true.

In the case of more than one applicable record, when you have just one of them to allow checking in or checking out then it will be valid for booking.

In the absence of any record, then booking is allowed.

How to do the calculation

The process to get the price for the external inventory is very simple, as final price is always calculated and published. The first step consists in checking the [CCON.External inventory] and only processes those files which [CCON.External inventory] value is true.

Then the price information is informed at SIAP structure. There you can see the final price for the requested availability:

• Check in and check out dates
• Occupancy (if price is per room)
• Length of stay

In all the cases, if [SIAP.Amount] is empty, means that there are not prices for those dates in the length of stay informed. 

[SICF] Supplier integration cancellation fees

Example

If you want to show the cancellation policies, you have to check this information at SICF structure. The cancellation fee can apply to the first night or to the entire stay depending on the [SICF.Charge type] value. If the percentage is informed and [SICF.charge type] is 1 [first night] then you have to divide the total amount of the stay by the length of stay in order to calculate ht price for the first night.


NOTE: As contracts from our third party providers are not in our direct database, it is possible there are price differences. As always the final price for external providers is confirmed through xml (ServiceAddRS/CheckRateRS).

Calculation for External Providers

If you want to book a room for 7 nights, and you have length of stay of 3, 2 and 1 nights, you should select first 2 length of stay for 3 nights (3+3) and later on select the stay of 1 night (3+3+1) as the most restrictive are the ones that include more nights in the length of stay (you should use the less restrictive ones only when there is no other option so most restrictive ones cannot be applied because the length of stay of the booking is exceeded).

NOTE: The combination of these days must be from more restrictive to less restrictive.

Example:

Booking from 10/09 to 17/09 for 2 adults

In AIF, according the above, we have the following:

Where from 10/09/2020 to 12/09/2020, the price is 437.56 (price for 3 nights), from 13/09/2020 to 15/09/2020 the price is 420.95 (price for 3 nights) and the price for 16/09/2020 is 127.030 (price for 1 night), so total price would be 985.540.


If price in [SIAP.Amount] section is for just one day, you must add the price for every day as usual. 

Example:

Booking from 05/12/2020 to 10/12/2020 for 2 adults
In AIF we have the following:

Where the only valid line is the third one, as first is for 1 adult, second for 2 adults and 1 child and fourth is for 3 adults.

Prices from 05/12 to 10/12 are the following:

Total price for this room would be 315.17