rt_get_rate_total_range
Description
Returns the daily total of the specified rate for each day in the given date range according to the given rate groups.
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 | Start date | Required | Start of the date range. |
| 4 | End date | Required | End of the date range. |
| 5 | Rate Groups | Required | There are three possible rate group structures.
1) 2) 3) |
| 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 | 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. |
| 8 | 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 structure (1):
| Array key | Description |
|---|---|
| 0 | “Id” of the rate group |
| 1 | Quantity for the rate group |
5. Rate group array keys structure (2):
| Array key | Structure key | Description |
|---|---|---|
| 0 | rate_group_id | The string “all”. |
| 1 | rate_groups | Array of rate groups as seen above in type 1. |
5. Rate group array keys structure (3):
| Array key | Structure key | Description |
|---|---|---|
| 0 | rate_group_id | The string “all”. |
Example
Request
{
"method": "rt_get_rate_total_range",
"params": [
{
"bridge_username":"username",
"bridge_password":"password",
"link_id":"4"
},
"WB7",
"",
"",
[
0,
0,
0
],
"",
"",
""
],
"id": 1
}
Response
{
"id": 1,
"error": null,
"result": [
{
"rateGroups": [
{
"0": "RS1",
"1": "Unit",
"2": "UNIT",
"3": "1",
"4": "0",
"5": "1",
"rt_rate_group_ix": "RS1",
"rt_rate_group_desc": "Unit",
"rt_rate_group_abbrv": "UNIT",
"rt_rate_group_sys_code": "1",
"rt_rate_group_class": "0",
"rt_rate_comp_grp_seq": "1",
"qty": 1
},
{
"0": "RS2",
"1": "Adult",
"2": "AD",
"3": "2",
"4": "1",
"5": "2",
"rt_rate_group_ix": "RS2",
"rt_rate_group_desc": "Adult",
"rt_rate_group_abbrv": "AD",
"rt_rate_group_sys_code": "2",
"rt_rate_group_class": "1",
"rt_rate_comp_grp_seq": "2",
"qty": 0
},
{
"0": "RS3",
"1": "Child",
"2": "CH",
"3": "3",
"4": "2",
"5": "3",
"rt_rate_group_ix": "RS3",
"rt_rate_group_desc": "Child",
"rt_rate_group_abbrv": "CH",
"rt_rate_group_sys_code": "3",
"rt_rate_group_class": "2",
"rt_rate_comp_grp_seq": "3",
"qty": 0
}
],
"periods": [
{
"start": "2018-03-23",
"end": "2018-03-23",
"total": "0.00"
}
]
},
{
"rateGroups": [
{
"0": "RS1",
"1": "Unit",
"2": "UNIT",
"3": "1",
"4": "0",
"5": "1",
"rt_rate_group_ix": "RS1",
"rt_rate_group_desc": "Unit",
"rt_rate_group_abbrv": "UNIT",
"rt_rate_group_sys_code": "1",
"rt_rate_group_class": "0",
"rt_rate_comp_grp_seq": "1",
"qty": 1
},
{
"0": "RS2",
"1": "Adult",
"2": "AD",
"3": "2",
"4": "1",
"5": "2",
"rt_rate_group_ix": "RS2",
"rt_rate_group_desc": "Adult",
"rt_rate_group_abbrv": "AD",
"rt_rate_group_sys_code": "2",
"rt_rate_group_class": "1",
"rt_rate_comp_grp_seq": "2",
"qty": 0
},
{
"0": "RS3",
"1": "Child",
"2": "CH",
"3": "3",
"4": "2",
"5": "3",
"rt_rate_group_ix": "RS3",
"rt_rate_group_desc": "Child",
"rt_rate_group_abbrv": "CH",
"rt_rate_group_sys_code": "3",
"rt_rate_group_class": "2",
"rt_rate_comp_grp_seq": "3",
"qty": 1
}
],
"periods": [
{
"start": "2018-03-23",
"end": "2018-03-23",
"total": "100.00"
}
]
},
{
"rateGroups": [
{
"0": "RS1",
"1": "Unit",
"2": "UNIT",
"3": "1",
"4": "0",
"5": "1",
"rt_rate_group_ix": "RS1",
"rt_rate_group_desc": "Unit",
"rt_rate_group_abbrv": "UNIT",
"rt_rate_group_sys_code": "1",
"rt_rate_group_class": "0",
"rt_rate_comp_grp_seq": "1",
"qty": 1
},
{
"0": "RS2",
"1": "Adult",
"2": "AD",
"3": "2",
"4": "1",
"5": "2",
"rt_rate_group_ix": "RS2",
"rt_rate_group_desc": "Adult",
"rt_rate_group_abbrv": "AD",
"rt_rate_group_sys_code": "2",
"rt_rate_group_class": "1",
"rt_rate_comp_grp_seq": "2",
"qty": 1
},
{
"0": "RS3",
"1": "Child",
"2": "CH",
"3": "3",
"4": "2",
"5": "3",
"rt_rate_group_ix": "RS3",
"rt_rate_group_desc": "Child",
"rt_rate_group_abbrv": "CH",
"rt_rate_group_sys_code": "3",
"rt_rate_group_class": "2",
"rt_rate_comp_grp_seq": "3",
"qty": 0
}
],
"periods": [
{
"start": "2018-03-23",
"end": "2018-03-23",
"total": "100.00"
}
]
},
{
"rateGroups": [
{
"0": "RS1",
"1": "Unit",
"2": "UNIT",
"3": "1",
"4": "0",
"5": "1",
"rt_rate_group_ix": "RS1",
"rt_rate_group_desc": "Unit",
"rt_rate_group_abbrv": "UNIT",
"rt_rate_group_sys_code": "1",
"rt_rate_group_class": "0",
"rt_rate_comp_grp_seq": "1",
"qty": 1
},
{
"0": "RS2",
"1": "Adult",
"2": "AD",
"3": "2",
"4": "1",
"5": "2",
"rt_rate_group_ix": "RS2",
"rt_rate_group_desc": "Adult",
"rt_rate_group_abbrv": "AD",
"rt_rate_group_sys_code": "2",
"rt_rate_group_class": "1",
"rt_rate_comp_grp_seq": "2",
"qty": 1
},
{
"0": "RS3",
"1": "Child",
"2": "CH",
"3": "3",
"4": "2",
"5": "3",
"rt_rate_group_ix": "RS3",
"rt_rate_group_desc": "Child",
"rt_rate_group_abbrv": "CH",
"rt_rate_group_sys_code": "3",
"rt_rate_group_class": "2",
"rt_rate_comp_grp_seq": "3",
"qty": 1
}
],
"periods": [
{
"start": "2018-03-23",
"end": "2018-03-23",
"total": "200.00"
}
]
}
]
}
Keep up to date with us
Menu
Visit our website
ResRequest Modules
- Business Intelligence
- Central Reservations
- Channel Management
- Customer Relationship Management
- Developer
- Email Series 2022
- Email Series 2023
- Financial Management
- Marketing tools
- Payment Gateways
- Point of sale
- Product
- Professional Services
- Property Management
- ResConnect
- ResInsite
- ResNova
- System Setup
- Technical Alerts
- Technical Tips
- Telephone Management
- Webinars Index