Home > Aria Crescendo Documentation > Aria Crescendo admintools api > create_coupon_m
create_coupon_m
create_coupon_m
Table of contents
- Input Arguments
- Allowable values for status_ind
- Allowable values for eligible_service_type
- Allowable values for flat_percent_ind
- Allowable values for duration_type_ind
- Allowable values for service_code_to_use
- Allowable values for applicable_trans_scope
- Allowable values for scope_no
- Allowable values for use_all_or_nth_subs_rule
- Allowable values for allow_overlap_ind
- Allowable values for coupon_scope
- Output Arguments
Creates a coupon
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 |
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. |
|
coupon_cd | string | 30 | Specifies Coupon Code |
| coupon_desc | string | 200 | Specifies Coupon description. Translatable. | |
| coupon_msg | string | 300 | Specifies Coupon Message. Translatable. | |
| status_ind | int | 1 | Specifies Coupon status. Allowable Values | |
| no_of_uses | int | 8 | Specifies number of uses after which coupon get expires. Related to coupon expiry detail. | |
| start_date | string | Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail | ||
| end_date | string | Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail | ||
| template | array | Either template, or discount_rule, or discount_bundle is required if not using an existing_template. | ||
|
 credit_template_name |
string | 300 | Recurring credit template name. If both an existing template name and a new template name is provided, the new template name will be used to create a new template. |
| client_credit_template_id |
string | 100 | Client defined unique id | |
| eligible_plan_no |
int | 8 | Eligible service plan number. If eligible_plan_no is present then eligible_service_no is also set and vice-versa. This means that coupon can only be applied against a specific type of charge. But If both values are null then it means that coupon can be applied against any change. | |
| OR | ||||
| eligible_client_plan_id |
string | 100 | Specifies Client defined unique id | |
| eligible_service_no |
int | 12 | Eligible service number | |
| OR | ||||
| eligible_client_service_id |
string | 100 | Specifies Client defined unique id | |
| eligible_service_types |
string array | 2 | Service type code for which the credit is applicable. Allowable Values | |
|
discount_type |
int | 1 | Specifies discount type. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage |
|
discount_amt |
float | 12 | Specifies discount amount. If discount_type is set to 1, then this range of valid values of this parameter is > 0 to 9999, but if it's set to "2" then its range is > 0 to 100. |
| no_of_credits |
int | 2 | This parameter is related to information about generation frequency. i.e. Number of credits If this value is set along with time_between_credits, then it means that generation frequency is multiple. | |
| credit_interval_months |
int | 3 | Time interval between credits in months | |
| percentage_plan_no |
int | 8 | Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage | |
| OR | ||||
| percentage_client_plan_id |
string | 100 | Specifies Client defined unique id | |
| percentage_service_no |
int | 12 | Specifies Percentage service number. This value is only set if discount_type is 2 i.e. discount type is Percentage | |
| OR | ||||
| percentage_client_service_id |
string | 100 | Specifies Client defined unique id | |
| alt_service_no |
int | 12 | Specifies Alternative service number. If this value is null, then for coupon can be Service code to use is standard | |
| OR | ||||
| alt_client_service_id |
string | 100 | Specifies Client defined unique id | |
| currency_cd |
string | 3 | Specifies the currency code of Template | |
| discount_rule | array | Either discount_rule, or template, or discount_bundle is required if not using an existing_discount_rule. | ||
|
label |
string | 30 | Specifies Discount Rule Name. Translatable. |
| rule_id |
string | 30 | Specifies client rule id for Discount Rule | |
|
description |
string | 300 | Specifies description for the Discount Rule. Translatable. |
|
ext_description |
string | 300 | 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 |
|
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. Allowable Values |
| max_applicable_months |
int | 8 | Specifies the duration of the discount in months. | |
| max_applicable_weeks |
int | 8 |
Specifies the duration of the discount in weeks. Allowable values are 1-999. |
|
| max_applicable_days |
int | 8 |
Specifies the duration of the discount in days. Allowable values are 1-999. |
|
| max_applications_per_acct |
int | 8 | Specifies the number of times the discount can be applied. | |
|
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. Allowable Values | |
| alt_service_no_2_apply |
int | 12 | Specifies the specific service code to use. | |
| OR | ||||
| alt_service_id_2_apply |
string | 100 | Client defined unique identifier | |
| applicable_trans_scope |
string | 1 | Specifies whether the discount is applied to each or all transactions. Allowable Values | |
|
scope_no |
int | 2 | Specifies the charges eligible for the discount. Allowable Values |
| plans |
array | |||
| plan_no |
int | 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: plans[0][plan_no]=1002&plans[1][plan_no]=1003 etc | |
| OR | ||||
| 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 | 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[0][service_no]=1002&service[1][service_no]=1003 For scope 13 service[0][service_no][0]=10002&service[0][service_no][1]=1001&service[1][service_no][0]=100&service[0][service_no][1]=103 | |
| OR | ||||
| 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[0][client_service_id]=1003 For scope 13 service[0][client_service_id][0]=10002 | |
| item |
array | |||
| item_no |
int | 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[0][item_no]=1002&item[1][item_no]=103 | |
| OR | ||||
| client_item_id |
string | 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: item[0][client_item_id]=1002&item[1][client_item_id]=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 | |
| discount_bundle | array | Either discount_bundle, or template, or discount_rule is required if not using an existing_discount_bundle. | ||
|
bundle_name |
string | 300 | Specifies the name for the discount bundle. |
|
bundle_id |
string | 30 | Specifies bundle id for discount Bundle |
|
bundle_description |
string | 300 | Specifies description for the discount Bundle |
|
allow_overlap_ind |
string | 1 | Specifies if the rules in the bundle can overlap or not. Allowable Values |
| rules |
array | |||
| rule_no |
int | 12 | Specifies the rules to be grouped in this bundle. REST input arrays should be passed in the following format: rules[1][rule_no]=1002&rules[2][rule_no]=103 | |
| OR | ||||
| rule_id |
string | 100 | Specifies the rules to be grouped in this bundle. REST input arrays should be passed in the following format: rules[1][rule_id]=1002&rules[2][rule_id]=103 | |
| existing_template | array | |||
| template_no |
int | 12 | Specifies existing templates to be associated with the coupon. REST input arrays should passed in the following format: existing_template[0][template_no]=1243& existing_template[1][template_no]=1002 etc. | |
| OR | ||||
| template_id |
string | 100 | Specifies client defined unique identifiers for existing templates to be associated with the coupon. REST input arrays should passed in the following format: existing_template[0][template_id]=1243& existing_template[1][template_id]=1002 etc. | |
| existing_discount_rule | array | |||
| rule_no |
int | 12 | Specifies existing rules to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_rule[0][rule_no]=1243& existing_discount_rule[1][rule_no]=1002 etc. | |
| OR | ||||
| rule_id |
string | 100 | Specifies client defined unique identifiers for existing rules to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_rule[0][rule_id]=1243& existing_discount_rule[1][rule_id]=1002 etc. | |
| existing_discount_bundle | array | |||
| bundle_no |
int | 12 | Specifies existing bundles to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_bundle[0][bundle_no]=1243& existing_discount_bundle[1][bundle_no]=1002 etc. | |
| OR | ||||
| bundle_id |
string | 100 | Specifies existing bundles to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_bundle[0][bundle_id]=1243& existing_discount_bundle[1][bundle_id]=1002 etc. | |
| coupon_scope | int | 1 | Specifies the coupon application. The parameter is required for EOM Clients Allowable Values |
Output Arguments
| 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. |
| coupon_cd | string | Coupon Code |
- © Copyright 2020 Aria Developer Central