Home > Aria6 User Documentation > Aria6 admintools api > get_discount_rule_details

get_discount_rule_details

Lists all the details of a given discount rule

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

Input Arguments

Req Field Name Field Type Max Length Description
Asterisk_0807a.jpg client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
Asterisk_0807a.jpg auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
Asterisk_0807a.jpg 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 for include_translations

Values Description
true Translated fields will be fetched in all the locales defined.
false Translation information will not be fetched.
 

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  
brd_arrow.gif rule_no int Specifies the no for the discount rule.
brd_arrow.gif rule_name string Specifies rule name for Discount Rule
brd_arrow.gif rule_id string Specifies client rule id for Discount Rule
brd_arrow.gif description string Specifies description for the Discount Rule
brd_arrow.gif ext_description string Specifies description that can be added to invoice/statment and is visible to account holder.
brd_arrow.gif discount_type string Specifies whether the discount is going to be flat or percentage based.
brd_arrow.gif amount float Specifies the amount of discount.
brd_arrow.gif currency string Specifies the currency code of the rule
brd_arrow.gif applicable_trans_scope string Specifies the Applicable transaction scope
brd_arrow.gif duration_type_ind string Specifies the duration type. Valid values are [ U, M] for uses and months 

Allowable values for duration_type_ind

Values Description
U Number of uses
M Duration in months
I Never expires
brd_arrow.gif max_applicable_months int Specifies the duration of the discount in months.
brd_arrow.gif max_applications_per_acct int Specifies the number of times the discount can be applied.
brd_arrow.gif inline_offset_ind string Specifies how the discount will be displayed in the invoice. 

Allowable values for inline_offset_ind

Values Description
I Inline
O Offset
brd_arrow.gif service_code_to_use int Specifies which service code to use. 

Allowable values for service_code_to_use

Values Description
0 Uses the same service as the 'charge' line item
1 Uses a specific service
brd_arrow.gif alt_service_no_2_apply int Specifies the specific service code to use.
brd_arrow.gif alt_service_id_2_apply string Specifies the client defined id for specific service code to use.
brd_arrow.gif scope_no int Specifies the charges eligible for the discount. 

Allowable values for scope_no

Values Description
0 All Charges
10 All Plan Charges, All Plans
11 All Plan Charges, Specified Plans
12 All Plans, Specified Service Charges
13 Specified Plan/Service Charges
21 All Recurring Service Charges
22 All Usage Service Charges
23 All Activation Service Charges
30 All Item Charges
31 Specified Item Charges
brd_arrow.gif discount_behavior_type_ind string Specifies the discount scope for a discount rule. 

Allowable values for discount_behavior_type_ind

Values Description
G Apply to gross amount of the charge
N Apply to net amount after previously applied discounts
brd_arrow.gif plan_no hash Aria-assigned unique plan identifier
brd_arrow.gif 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
brd_arrow.gif client_plan_id hash  
brd_arrow.gif service_no hash  
brd_arrow.gif 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
brd_arrow.gif client_service_id hash  
brd_arrow.gif item_no hash  
brd_arrow.gif 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
brd_arrow.gif client_sku hash  
brd_arrow.gif use_all_or_nth_subs_rule string Specifies the Use 'All Or Nothing' Subscription Rule
brd_arrow.gif discount_rule_translations hash Array that contains all the translated values for a given locale.
brd_arrow.gif locale_name string Name of the locale
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif rule_no int Specifies the no for the discount rule.
brd_arrow.gif rule_name string Specifies rule name for Discount Rule
brd_arrow.gif description string Specifies description for the Discount Rule
brd_arrow.gif ext_description string Specifies description that can be added to invoice/statment and is visible to account holder.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®