create_discount_rule_m

Last updated
Save as PDF

Creates a 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

client_no

long

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

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

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

Specifies the amount of discount.

currency

string

Specifies the currency code of the rule

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

inline_offset_ind

string

Specifies how the discount will be displayed in the invoice.Valid values are [I, O]

discount_behavior_type_ind

string

Specifies the discount scope for a discount rule.Valid values are [G, N]

service_code_to_use

int

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

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

Specifies the duration of the discount in months. Allowable values are from 1 to 999.

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.

remainder_discount_rule_indicator

int

When set to 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 is null. This parameter is only applicable when someone enters max_applicable_months. It will be null if no input is given, otherwise it will be stored as 1 or 0 depending upon what the 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.

max_applications_per_acct

int

Specifies the number of times the discount can be applied.

alt_service_no_2_apply

int

Specifies the specific service code to use.

alt_service_id_2_apply

string

100

Specifies the specific service code to use.

applicable_trans_scope

string

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.

plans

array

plan_no

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: plans[0][plan_no]=1002&plans[1][plan_no]=1003 etc

client_plan_id

string

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: plans[0][client_plan_id]=1002&plans[0][client_plan_id]=1003 etc

service

array

service_no

int

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

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 service[0][client_service_id]=1002&service[1][client_service_id]=1003 For scope 13 service[0][client_service_id][0]=10002

item

array

item_no

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[0][item_no]=1002&item[0][item_no]=103

client_sku

string array

100

Client SKU of the NSO/Inventory item

use_all_or_nth_subs_rule

string

Specifies whether to apply discount when 'all' of 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
TRUE	Apply discount when 'all' of the plans are under the account
FALSE	Apply discount when 'some' of the plans are under the account

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.
rule_no	string	Rule No

Input Arguments

Allowable values for flat_percent_ind:

Allowable values for duration_type_ind:

Allowable values for scope_no:

Allowable values for applicable_trans_scope:

Allowable values for use_all_or_nth_subs_rule:

Output Arguments