The supplier sends this message to get cancellation deadlines for an hotel or a specific agreement. The query type (type) is set to getdeadlines.

Below you can see the fields you can find in the message body and their meanings.

Request

@hotel (Mandatory) Hotel id to ask for

@agreement (Optional) Get only base rates for this agreement id

@show_supplier_deadlines (Optional) Will show the supplier deadline configuration in response as well. Value should be true

• startdate Date from which you want to receive deadlines

• days (Mandatory if startdate is present) number of days. (You can add this number to the effective date to get the end of the period. If these two dates correspond the value is set to 0).

Let’s see an example of message the client could send.

<envelope>
    <header>
        <actor>...</actor>
        <user>...</user>
        <password>...</password>
        <version>1.0.0</version>
        <timestamp>20250516162719</timestamp>
        <transaction>00000001</transaction>
    </header>
    <query type="getdeadlines" product="hotel" hotel="12345" agreement="4321">
        <startdate>2025-05-17</startdate>
        <days>365</days>
    </query>

</envelope>

Response

The reply message contains within each tag agreement a list of deadline element with each item configuration as below

• startdate Day from which the deadline rule applies

• days Days after startdate for which the deadline rule is applicable

• hours Number of hours before checkin date on which the specified penalty is applied

• penalty Penalty value. This must be interpreted based on the value of type element (see below)

• type Can have 3 distinct values:

  • P : percentage
  • N : nights
  • C : based on configuration
• configuration (only if type is C)
  • target: can be "pax", "room" Multiplier based on occupancy
  • period: can be "total" or "night". Multiplier based on length of stay

Let’s see an example of message the client could receive.

<envelope>
    <header>
        <actor>...</actor>
        <user>...</user>
        <version>1.0</version>
        <timestamp>20250721134931</timestamp>
        <transaction>00000001</transaction>
    </header>
    <response type="getdeadlines" />
    <agreement id="5935">
        <deadline>
            <startdate>2024-04-01</startdate>
            <days>29</days>
            <currency>EUR</currency>
            <hours>72</hours>
            <type>C</type>
            <penalty>50.0</penalty>
            <configuration>
                <target>pax</target>
                <period>total</period>
            </configuration>
        </deadline>
        <deadline>
            <startdate>2024-05-01</startdate>
            <days>30</days>
            <currency />
            <hours>24</hours>
            <type>N</type>
            <penalty>1.0</penalty>
        </deadline>
        <deadline>
            <startdate>2024-06-01</startdate>
            <days>29</days>
            <currency />
            <hours>999999</hours>
            <type>P</type>
            <penalty>100.0</penalty>
        </deadline>
    </agreement>
</envelope>

In the example we see all different kinds of policies:

<deadline>
    <startdate>2024-04-01</startdate>
    <days>29</days>
    <currency>EUR</currency>
    <hours>72</hours>
    <type>C</type>
    <penalty>50.0</penalty>
    <configuration>
        <target>pax</target>
        <period>total</period>
    </configuration>
</deadline>

This means that: starting from 72 hours before checkin, the penalty to pay would be 50EUR per each passenger for the whole period

<deadline>
    <startdate>2024-05-01</startdate>
    <days>30</days>
    <currency />
    <hours>24</hours>
    <type>N</type>
    <penalty>1.0</penalty>
</deadline>

This means that: starting from 24 hours before checkin, the penalty to pay would be the cost of 1 night

<deadline>
    <startdate>2024-06-01</startdate>
    <days>29</days>
    <currency />
    <hours>999999</hours>
    <type>P</type>
    <penalty>100.0</penalty>
</deadline>

This means that: starting from 999999 hours before checkin, the penalty to pay would be 100% of the total cost

In case of error the reply message contains, within tag response, the string "error code XX (description)", where XX represents an error code