![]() |
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. |
![]() |
label |
string |
100 |
Specifies Discount Rule Name. Translatable. |
![]() |
rule_id |
string |
100 |
Specifies client rule id for Discount Rule |
![]() |
description |
string |
1000 |
Specifies description for the Discount Rule. Translatable. |
![]() |
ext_description |
string |
1000 |
Specifies description that can be added to invoice/statment and is visible to account holder. Translatable. |
![]() |
flat_percent_ind |
string |
1 |
Specifies whether the discount is going to be flat or percentage based.
Allowable values for flat_percent_ind
Values |
Description |
P |
Percentage discount type |
F |
Fixed discount type |
|
![]() |
amount |
float |
12 |
Specifies the amount of discount. |
![]() |
currency |
string |
3 |
Specifies the currency code of the rule |
![]() |
duration_type_ind |
string |
1 |
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 |
|
![]() |
inline_offset_ind |
string |
1 |
Specifies how the discount will be displayed in the invoice.Valid values are [I, O] |
![]() |
discount_behavior_type_ind |
string |
1 |
Specifies the discount scope for a discount rule.Valid values are [G, N] |
![]() |
service_code_to_use |
int |
1 |
Specifies which service code to use. Valid values are [0,1] where 0 uses the same service as the 'charge' line item and 1 uses a specific service |
![]() |
scope_no |
int |
2 |
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 |
|
|
max_applicable_months |
int |
3 |
Specifies the duration of the discount in months. Allowable values are from 1 to 999. |
|
max_applications_per_acct |
int |
8 |
Specifies the number of times the discount can be applied. |
|
alt_service_no_2_apply |
int |
12 |
Specifies the specific service code to use. |
|
OR |
|
|
|
|
alt_service_id_2_apply |
string |
100 |
Specifies the specific service code to use. |
|
applicable_trans_scope |
string |
1 |
Specifies whether the discount is applied to each or all transactions.
Allowable values for applicable_trans_scope
Values |
Description |
E |
Applies discount to each transaction on the invoice (current behavior) |
M |
Applies discount to all the transaction on the invoice. Any remaining credit will be carried over to next month. |
|
|
plan_no |
int array |
12 |
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 |
string array |
100 |
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: client_plan_id[0]=1002&client_plan_id[1]=1003 etc |
|
service_no |
int array |
12 |
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_no[0][1]=1001&service_no[1][0]=100&service_no[1][1]=103 |
|
client_service_id |
string array |
100 |
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 client_service_id[0]=1002&client_service_id[1]=1003 For scope 13 client_service_id[0][0]=10002 |
|
item_no |
int array |
12 |
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 |
100 |
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: client_sku[0]=1002&client_sku[1]=103 |
|
use_all_or_nth_subs_rule |
string |
5 |
Specifies whether to apply discount when 'all' the plans are under the account or 'some' of the plans are are under the account.
Allowable values for use_all_or_nth_subs_rule
Values |
Description |
1 |
Apply discount when 'all' the plans are under the account |
|
Apply discount when 'some' the plans are under the account |
|