Skip to main content
Aria Knowledge Central

get_discount_rule_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_discount_rule_details_m
Class administration_services_m
Update Version 6.12

Description

Lists all the details of a given 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.
rule_no long   Yes

Specifies the rule number

Alternative required field: client_rule_id
client_rule_id string 100 Yes

Client defined unique identifier

Alternative required field: rule_no
locale_no long 38 No

Aria-assigned unique identifier of the locale used for translations.

Alternative field: locale_name
locale_name string 32 No

Name of the locale to which the translations belong.

Alternative field: locale_no
include_translations string 5 No

Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowed values:

Value Description
True Translated fields will be fetched in all the locales defined.
False Translation information will not be fetched.

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.
Start of discount_rules object
discount_rules object   No

The discount_rules associated with this method.
Name Type Length Required Description
▶rule_no long 300 Yes

Specifies the no for the discount rule.
▶rule_name string 300 Yes

Specifies rule name for Discount Rule
▶rule_id string 100 Yes

Specifies client rule id for Discount Rule
▶description string 300 Yes

Specifies description for the Discount Rule
▶ext_description string 300 Yes

Specifies description that can be added to invoice/statement and is visible to account holder.
▶discount_type string 8 Yes

Specifies whether the discount is going to be flat or percentage based.
▶amount float 12 Yes

Specifies the amount of discount.
▶currency string 3 Yes

Specifies the currency code of the rule
▶applicable_trans_scope string 1 Yes

Specifies the Applicable transaction scope
▶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 8 No

Specifies the duration of the discount in months.
▶max_applicable_weeks int 8 No

Specifies the duration of the discount in weeks.
▶max_applicable_days int 8 No

Specifies the duration of the discount in days.
▶max_applications_per_acct int 8 No

Specifies the number of times the discount can be applied.
▶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).
▶inline_offset_ind string 1 Yes

Specifies how the discount will be displayed in the invoice.

Allowed values:

Value Description
I Inline
O Offset
▶service_code_to_use int 1 No

Specifies which service code to use.

Allowed values:

Value Description
0 Uses the same service as the 'charge' line item
1 Uses a specific service
▶alt_service_no_2_apply int 12 No

Specifies the specific service code to use.
▶alt_service_id_2_apply string 100 No

Specifies the client defined id for specific service code to use.
▶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
▶discount_behavior_type_ind string 1 No

Specifies the discount scope for a discount rule.

Allowed values:

Value Description
G Apply to gross amount of the charge
N Apply to net amount after previously applied discounts
Start of rule_application object
▶rule_application object   No

The rule_application associated with this method.
Name Type Length Required Description
Start of plan_no object
▶▶plan_no object   No

The plan_no associated with this method.
Name Type Length Required Description
▶▶▶plan_nos long 12 No

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
End of plan_no object
Start of client_plan_id object
▶▶client_plan_id object   No

The client_plan_id associated with this method.
Name Type Length Required Description
End of client_plan_id object
Start of service_no object
▶▶service_no object   No

The service_no associated with this method.
Name Type Length Required Description
▶▶▶service_nos long 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_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
End of service_no object
Start of client_service_id object
▶▶client_service_id object   No

The client_service_id associated with this method.
Name Type Length Required Description
End of client_service_id object
Start of item_no object
▶▶item_no object   No

The item_no associated with this method.
Name Type Length Required Description
▶▶▶item_nos 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_no[0]=1002&item_no[1]=103
End of item_no object
Start of client_item_id object
▶▶client_item_id object   No

The client_item_id associated with this method.

Note: This field was deprecated in version 43.
Name Type Length Required Description
▶▶▶client_item_ids string 100 No

Specifies the inventory items that are eligible for the discount. This is mandatory for scope 31.
End of client_item_id object
Start of client_sku object
▶▶client_sku object   No

The client_sku associated with this method.
Name Type Length Required Description
▶▶▶client_skus string 100 No

Specifies the inventory items that are eligible for the discount. This is mandatory for scope 31.
End of client_sku object
Start of plan_service object
▶▶plan_service object   No

The plan_service associated with this method.
Name Type Length Required Description
▶▶▶plan_no long   No

Plan numbers that are eligible for discount.
▶▶▶client_plan_id string   No

Client plan ids that are associated with plan number.
▶▶▶service_no long   No

Services that are eligible for discount.
▶▶▶client_service_id string   No

Client service ids that are associated with service number.
End of plan_service object
End of rule_application object
▶use_all_or_nth_subs_rule string 5 No

Specifies the Use 'All Or Nothing' Subscription Rule
Start of discount_rule_translations object
▶discount_rule_translations object   No

Array that contains all the translated values for a given locale.
Name Type Length Required Description
▶▶locale_name string 32 No

Name of the locale to which the translations belong.

Alternative field: locale_no
▶▶locale_no long 38 No

Aria-assigned unique identifier of the locale used for translations.

Alternative field: locale_name
▶▶rule_no long 300 Yes

Specifies the no for the discount rule.
▶▶rule_name string 300 No

Specifies rule name for Discount Rule
▶▶description string 300 No

Specifies description for the Discount Rule
▶▶ext_description string 300 No

Specifies description that can be added to invoice/statement and is visible to account holder.
End of discount_rule_translations object
End of discount_rules object
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.