Summary

API Name	create_discount_rule_m
Class	administration_services_m
Update Version	6.12

Description

Creates a discount rule

Inputs

Name

Type

Length

Required

Description

client_no

long

12

Yes

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

auth_key

string

32

Yes

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

label

string

30

Yes

Specifies Discount Rule Name. Translatable.

rule_id

string

30

Yes

Specifies client rule id for Discount Rule

description

string

300

Yes

Specifies description for the Discount Rule. Translatable.

ext_description

string

300

Yes

Specifies description that can be added to invoice/statement and is visible to account holder. Translatable.

flat_percent_ind

string

1

Yes

Specifies whether the discount is going to be flat or percentage based.

Allowed values:

Value	Description
P	Percentage discount type
F	Fixed discount type

amount

float

12

Yes

Specifies the amount of discount.

currency

string

3

Yes

Specifies the currency code of the rule

duration_type_ind

string

1

Yes

Specifies the duration type. Valid values are [ U, M] for uses and months

Allowed values:

Value	Description
U	Number of uses
M	Duration in months
W	Duration in weeks
D	Duration in days
I	Never expires

max_applicable_months

int

3

No

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

max_applicable_weeks

int

3

No

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

max_applicable_days

int

3

No

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

remainder_discount_rule_indicator

int

3

No

When set as 1, it will prorate the discount applied on the initial invoice if the respective charge is prorated and then force the remaining proportion of the discount on its final application. In any of its application, if respective charge is prorated, then the discount also gets prorated. By default it's null. This parameter is applicable only for (a) duration_type_ind = M (months type duration) and (b) duration_type_ind = U (usage count type duration) with flat_percent_ind = F (fixed discount type).

max_applications_per_acct

int

8

No

Specifies the number of times the discount can be applied.

inline_offset_ind

string

1

Yes

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

discount_behavior_type_ind

string

1

Yes

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

service_code_to_use

int

1

Yes

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

alt_service_no_2_apply

int

12

No

Specifies the specific service code to use.

Alternative field: alt_service_id_2_apply

alt_service_id_2_apply

string

100

No

Specifies the specific service code to use.

Alternative field: alt_service_no_2_apply

applicable_trans_scope

string

1

No

Specifies whether the discount is applied to each or all transactions.

Allowed values:

Value	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.

scope_no

int

2

Yes

Specifies the charges eligible for the discount.

Allowed values:

Value	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

plans

object

No

The plans associated with this method.

See fields below

service

object

No

The service associated with this method.

See fields below

item

object

No

The item associated with this method.

See fields below

use_all_or_nth_subs_rule

string

5

No

Specifies whether to apply discount when 'all' the plans are under the account or 'some' of the plans are are under the account.

Allowed values:

Value	Description
True	Apply discount when 'all' the plans are under the account
False	Apply discount when 'some' the plans are under the account

plans fields

Name	Type	Length	Required	Description
plan_no	long	12	Yes	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 Alternative required field: client_plan_id
client_plan_id	string	100	Yes	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 Alternative required field: plan_no

Name

Type

Length

Required

Description

plan_no

long

12

Yes

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

Alternative required field: client_plan_id

client_plan_id

string

100

Yes

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

Alternative required field: plan_no

service fields

Name	Type	Length	Required	Description
service_no	long	12	No	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 Alternative field: client_service_id
client_service_id	string	100	No	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 Alternative field: service_no

Name

Type

Length

Required

Description

service_no

long

12

No

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

Alternative field: client_service_id

client_service_id

string

100

No

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

Alternative field: service_no

item fields

Name	Type	Length	Required	Description
item_no	long	12	No	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 Alternative field: client_sku
client_sku	string	100	No	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][client_sku]=example-sku-1&item[0][client_sku]=example-sku-2 Alternative field: item_no

Name

Type

Length

Required

Description

item_no

long

12

No

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

Alternative field: client_sku

client_sku

string

100

No

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][client_sku]=example-sku-1&item[0][client_sku]=example-sku-2

Alternative field: item_no

Outputs

Name	Type	Length	Required	Description
error_code	long		No	Aria-assigned error identifier. 0 indicates no error
error_msg	string		No	Textual description of any error that occurred. "OK" if there was no error.
rule_no	long	32	No	Rule No