Documentation
price
Representation of the breakdown price.
A breakdown price always will be composed of one or more price lines
The breakdown price includes the fare, supplements, discounts and customer commission.
Usually the currency will be the own currency of each client unless the customer had specified a different currency.
Notes about discounts and special campaigns
When a reservation has an active campaign, the discount field represents the total amount discounted from the applicable base of the reservation.
The campaign discount is not always applied to the full gross amount of the reservation. In special campaigns, the discount is applied only to:
- Base fare / brochure price.
- Supplements allowed for campaign discount.
Some supplements may be excluded from campaign discount, such as:
- Additional nights.
- Transfers.
- Night/holiday transfer supplements.
- Cancellation insurance.
- Half board.
- Other supplements excluded by VPT.
These excluded supplements are added in full to the final total and do not increase the discount field.
Therefore, the discount field may not match the campaign percentage applied to the full gross amount of the reservation.
Example:
If the applicable campaign base is 6085 and the campaign discount is 10%, the discount field will be 608.5.
Calculation:
6085 * 10% = 608.5
If the reservation also includes supplements excluded from campaign discount, those supplements will be added to the final total without changing the discount.
attributes
lines
[array:priceline]
Array which contains the price lines.
total
[int]
It indicates the final total amount of the reservation after applying discounts or campaigns when applicable.
commission
[int]
It indicates the total commission of the reservation.
discount
[int]
It indicates the total discount amount applied to the reservation.
This amount may come from a regular discount or from a special campaign.
In special campaigns, this amount is calculated only over the applicable campaign base, not necessarily over the full gross amount of the reservation.
currency
[currency]
It indicates the currency in which the price is specified.