rt_get_rate_detail

rt_get_rate_detail

Description

Returns a structure with the requested rate detail with the following structure:

payable (if in amount types)
gross (if in amount types)
nett (if in amounts types)
comm (if in amount types)
tax (if in amount types)
periods (contents governed by detail split -> period)
- period_from (date of first billable night)
- period_to (date of last billable night, does not include the departure date)
- payable (if in amount types)
- gross (if in amount types)
- nett (if in amount types)
- comm (if in amount types)
- tax (if in amount types)
- rate_groups (only if enabled using detail split -> rate_group).
  - rate group id (as the key). Use rt_get_rate_group to look up
    - qty (quantity of rate group)
    - payable (if in amount types)
    - gross (if in amount types)
    - nett (if in amount types)
    - comm (if in amount types)
    - tax (if in amount types)

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	Optional	“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 types	Optional	An array specifying the amount types to be included in the rate detail – see table below. If this field is left out it will default to including the payable amount.
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.
10	Detail split	Optional	An array specifying the detail splits to be included – see table below. All splits will include the same amount types as set in the “Amount types” parameter.

*See call structure explanation.

5. Rate group array keys

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

7. Amount type array keys:

Array key	Structure key	Description
0	payable	If not empty include payable amount.
1	gross	If not empty include gross amount.
2	nett	If not empty include nett amount.
3	comm	If not empty include comm amount.
4	tax	If not empty include tax amount.

10. Detail split array keys:

Array key	Structure key	Description
0	period	If not empty split by period otherwise only a single consolidated period will be included. This does not override the setting in the default table and if rates have been set not to split on the default table then this option will have no effect.
1	rate_group	If not empty split by rate group.

Example

Request

{
    "method": "rt_get_rate_detail",
    "params": [
        {
            "bridge_username":"username",
            "bridge_password":"password",
            "link_id":"4"
        },
        "WB7",
        "",
        "",
        [
            [
                "RS1",
                "1"
            ],
            [
                "RS2",
                "1"
            ]
        ],
        "",
        {
            "payable":"0",
            "gross":"0",
            "nett":"0",
            "comm":"0",
            "tax":"0"
        },
        "",
        "",
        {
            "period":"0",
            "rate_group":"1"
        }
    ],
    "id": 1
}

Response

{

    "id": 1,

    "error": null,

    "result": {

        "payable": 150,

        "periods": [

            {

                "period_from": "2018-03-23",

                "period_to": "2018-03-23",

                "payable": 150,

                "rate_groups": {

                    "RS1": {

                        "qty": "1",

                        "payable": 0

                    },

                    "RS2": {

                        "qty": "1",

                        "payable": 150

                    }

                }

            }

        ]

    }

}

rt_get_rate_detail

Description

Version

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules