Home > Aria Crescendo Documentation > Aria Crescendo admintools api > get_discount_rule_details_m
get_discount_rule_details_m
get_discount_rule_details_m
Lists all the details of a given discount rule
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
|
rule_no | int | Specifies the rule number | |
| OR | ||||
| client_rule_id | string | 100 | Client defined unique identifier | |
| locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |
| OR | ||||
| locale_name | string | 32 | Name of the locale to which the translations belong. | |
| include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowable Values |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error |
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
| discount_rules | hash | |
 rule_no |
int | Specifies the no for the discount rule. |
| rule_name |
string | Specifies rule name for Discount Rule |
| rule_id |
string | Specifies client rule id for Discount Rule |
| description |
string | Specifies description for the Discount Rule |
| ext_description |
string | Specifies description that can be added to invoice/statment and is visible to account holder. |
| discount_type |
string | Specifies whether the discount is going to be flat or percentage based. |
| amount |
float | Specifies the amount of discount. |
| currency |
string | Specifies the currency code of the rule |
| applicable_trans_scope |
string | Specifies the Applicable transaction scope |
| duration_type_ind |
string | Specifies the duration type. Allowable Values |
| max_applicable_months |
int | Specifies the duration of the discount in months. |
| max_applicable_weeks |
int |
Specifies the duration of the discount in weeks. Allowable values are 1-999. |
| max_applicable_days |
int |
Specifies the duration of the discount in days. Allowable values are 1-999. |
| max_applications_per_acct |
int | Specifies the number of times the discount can be applied. |
| inline_offset_ind |
string | Specifies how the discount will be displayed in the invoice. Allowable Values |
| service_code_to_use |
int | Specifies which service code to use. Allowable Values |
| alt_service_no_2_apply |
int | Specifies the specific service code to use. |
| alt_service_id_2_apply |
string | Specifies the client defined id for specific service code to use. |
| scope_no |
int | Specifies the charges eligible for the discount. Allowable Values |
| discount_behavior_type_ind |
string | Specifies the discount scope for a discount rule. Allowable Values |
| rule_application |
hash | |
| plan_no |
hash | Aria-assigned unique plan identifier |
| plan_nos |
int | Specifies the plan that are eligible for the discount. This is mandatory for scope 11 and 13.REST input arrays should be passed in the following format: plan_no[0]=1002&plan_no[1]=1003 etc |
| client_plan_id |
hash | |
| client_plan_ids |
string | This attribute is not in use. It is just a placeholder. |
| service_no |
hash | |
| service_nos |
string | Specifies the services that are eligible for the discount. This is mandatory for scope 12 and 13. REST input arrays should be passed in the following format: For scope 12 service_no[0]=1002&service_no[1]=1003 For scope 13 service_no[0][0]=10002&service[0][1]=1001&service[1][0]=100&service[1][1]=103 |
| client_service_id |
hash | |
| client_service_ids |
string | This attribute is not in use. It is just a placeholder. |
| item_no |
hash | |
| item_nos |
int | Specifies the inventory items that are eligible for the discount. This is mandatory for scope 31. REST input arrays should be passed in the following format: item_no[0]=1002&item_no[1]=103 |
| client_item_id |
hash | |
| client_item_ids |
string | This attribute is not in use. It is just a placeholder. |
| plan_service |
hash | |
| plan_no |
string | Plan numbers that are eligible for discount. |
| client_plan_id |
string | Client plan ids that are associated with plan number. |
| service_no |
string | Services that are eligible for discount. |
| client_service_id |
string | Client service ids that are associated with service number. |
| use_all_or_nth_subs_rule |
string | Specifies the Use 'All Or Nothing' Subscription Rule |
| discount_rule_translations |
hash | Array that contains all the translated values for a given locale. |
| locale_name |
string | Name of the locale |
| locale_no |
int | Aria-assigned unique identifier of the locale used for translations. |
| rule_no |
int | Specifies the no for the discount rule. |
| rule_name |
string | Specifies rule name for Discount Rule |
| description |
string | Specifies description for the Discount Rule |
| ext_description |
string | Specifies description that can be added to invoice/statment and is visible to account holder. |
- © Copyright 2020 Aria Developer Central