supplement

Representation of one supplement.

A supplement is an element serves to complete, increase or strengthen a reservation in some point.

A supplement will be applied depending of the departure date, age of some of the pax, third person in triple room ...

The amounts of these discounts will be expressed directly (fixed quantity).

Campaign discount behavior

Some supplements may be excluded from special campaign discounts.

When a reservation has an active campaign, excluded supplements are still returned in the price lines and are added to the final total, but they do not increase the discount amount.

Examples of supplements that may be excluded from campaign discount:

• Additional nights.
• Transfers.
• Night/holiday transfer supplements.
• Cancellation insurance.
• Half board.
• Other supplements excluded by VPT.

For more information about how the final total, commission and discount fields are calculated, see price.

attributes

group

[int]

It indicates the group of the supplement.

code

[int]

It indicates the supplement code.

name

[string]

It indicates the supplement name.

startdate

[date:yyyy-mm-dd]

It indicates the start date to apply the supplement.

enddate

[date:yyyy-mm-dd]

It indicates the end date to apply the supplement.

agefrom

[int:years]

It indicates the age (in years) from which the supplement is applied.

ageto

[int:years]

It indicates the age (in years) to which the supplement is applied.

currency

[currency]

It indicates the currency in which the supplement is specified.

category

[category]

It indicates the category of the supplement.

percent

[currency]

It indicates the percent of the supplement.

amount

[int]

It indicates the amount of the supplement.