rt_get_rate_total

rt_get_rate_total

Description

Returns the total of the specified rate according to the given rate groups. If a rate exists for the given parameters. then a total is returned otherwise the string “tba” is returned.

Version

Available from version 5.25.0.

Access

Read-only, master access not required, available to all users.

Parameters

Number	Name	O/R	Usage
1	Auth	Required	Authentication structure.*
2	Accommodation	Required	“Id” of the accommodation type to return stock for. Case sensitive.
3	Arrival date	Optional	Date from which the accommodation would be required. If left blank the current date is used.
4	Departure date	Optional	Date to which the accommodation would be required. If left blank then one day after the arrival date is used.
5	Rate Groups	Optional	Array consisting of the rate groups and quantities thereof. This includes the unit (ie. rooms) quantity – see the table below.
6	Rate type	Optional	“Id” of the rate type to use. If left blank the user’s default rate type is used. Case sensitive.
7	Amount type	Optional	The type of amount to return. Options are “payable”, “gross”, “nett”, “comm” and “tax”. If left blank defaults to “payable”. Only internal users may select a value other than “payable”.
8	Agent id	Optional	Set an agent to use to look up the commission percentage and commission deduct flag. Only internal users may override the agent. If left blank then direct (no agent) is assumed for internal users and external users will be linked to the agent their user is associated with. This parameter may also be set to “linked” to specify that the linked agent should be used.
9	Commission %	Optional	Override the commission percentage. This will override the commission percentage even if an agent id is supplied. Only internal users have access to this override.

*See call structure explanation.

5. Rate group array keys

Array key	Description
O	“Id” of the rate group
1	Quantity for the rate group

Example

Request

{

    "method": "rt_get_rate_total",

    "params": [

        {

            "bridge_username":"username",

            "bridge_password":"password",

            "link_id":"4"

        },

        "WB7",

        "",

        "",

        [

            [

                "RS1",

                "1"

            ],

            [

                "RS2",

                "1"

            ]

        ],

        "",

        "",

        "",

        ""

    ],

    "id": 1

}

Response

{
    "id": 1,
    "error": null,
    "result": 150
}

rt_get_rate_total

Description

Version

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules