| 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/statement 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 for duration_type_ind:
| Values |
Description |
| U |
Number of uses |
| M |
Duration in months |
| W |
Duration in weeks |
| D |
Duration in days |
| I |
Never expires |
|
| 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. |
| remainder_discount_rule_indicator |
int |
When set as TRUE (1), it will prorate the discount applied on the initial invoice and apply the remaining proportion of the discount on the appropriate invoice. By default it’s null. This parameter is only applicable when someone enters max_applicable_months. It will be null if no input is given else will be stored as 1 or 0 on what user enters. In addition, be aware that this attribute only applies when a discount rule is assigned at the plan instance level for advanced recurring services. |
| 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 |
|
| 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 |
|
| 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 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 |
|
| 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 |
|
| 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_sku |
string array |
Client SKU of the NSO/Inventory item |
| 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/statement and is visible to account holder. |
