| 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 |
Specifies Coupon Code |
| coupon_desc |
string |
Specifies Coupon description |
| coupon_msg |
string |
Specifies Coupon Message |
| status_ind |
int |
Specifies Coupon status. Valid values are [0, 1]1 indicates coupon is Active. 0 indicates coupon Inactive |
| no_of_uses |
int |
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 |
| credit_template_id |
int |
credit template id |
| credit_template_name |
string |
credit template name |
| eligible_plan_no |
int |
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. |
| eligible_client_plan_id |
string |
Eligible service plan id number. If eligible_client_plan_id 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. |
| eligible_service_no |
int |
Eligible service number |
| eligible_client_service_id |
string |
Eligible client service id |
| no_of_credits |
int |
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. |
| time_between_credits |
int |
Time interval between credits |
| discount_type |
int |
Specifies discount type. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage |
| discount_amt |
float |
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 its set to "2" then its range is > 0 to 100 |
| percentage_plan_no |
int |
Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| percentage_client_plan_id |
string |
Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| percentage_service_no |
int |
Specifies Percentage service number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| percentage_client_service_id |
string |
Specifies Percentage client service id. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| alt_service_no |
int |
Specifies Alternative service number. If this value is null, then for coupon can be Service code to use is standard |
| alt_client_service_id |
string |
Specifies Alternative client service id. If this value is null, then for coupon can be Service code to use is standard |
| eligible_service_types |
hash |
Service type code for which the credit is applicable |
 eligible_service_type |
string |
|
| credit_template |
hash |
|
| credit_template_no |
int |
Refers to recurring credit template id |
| credit_template_id |
string |
credit template id |
| credit_template_name |
string |
credit template name |
| client_credit_template_id |
string |
Client defined unique id |
| eligible_plan_no |
int |
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. |
| eligible_client_plan_id |
string |
Eligible service plan id number. If eligible_client_plan_id 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. |
| eligible_service_no |
int |
Eligible service number |
| eligible_client_service_id |
string |
Eligible client service id |
| no_of_credits |
int |
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. |
| time_between_credits |
int |
Time interval between credits |
| discount_type |
int |
Specifies discount type. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage |
| discount_amt |
float |
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 its set to "2" then its range is > 0 to 100 |
| percentage_plan_no |
int |
Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| percentage_client_plan_id |
string |
Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| percentage_service_no |
int |
Specifies Percentage service number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| percentage_client_service_id |
string |
Specifies Percentage client service id. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| alt_service_no |
int |
Specifies Alternative service number. If this value is null, then for coupon can be Service code to use is standard |
| alt_client_service_id |
string |
Specifies Alternative client service id. If this value is null, then for coupon can be Service code to use is standard |
| eligible_service_types |
hash |
Service type code for which the credit is applicable |
| eligible_service_type |
string |
|
| discount_rule |
hash |
|
| rule_no |
int |
Specifies the no for the discount rule. |
| rule_name |
string |
Specifies rule name for Discount Rule |
| rule_id |
string |
Specifies client rule id for Discount Rule |
| description |
string |
Specifies description for the Discount Rule |
| ext_description |
string |
Specifies description that can be added to invoice/statment and is visible to account holder. |
| discount_type |
string |
Specifies discount type for Discount Rule |
| flat_percent_ind |
int |
Specifies whether the discount is going to be flat or percentage based. |
| amount |
float |
Specifies the amount of discount. |
| currency |
string |
Specifies the currency code of the rule |
| 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. |
|
| duration_type_ind |
string |
Specifies the duration type.
Allowable values for duration_type_ind
| Values |
Description |
| U |
Number of uses |
| M |
Duration in months |
| I |
Never expires |
|
| max_applicable_months |
int |
Specifies the duration of the discount in months. |
| max_applications_per_acct |
int |
Specifies the number of times the discount can be applied. |
| inline_offset_ind |
string |
Specifies how the discount will be displayed in the invoice.
Allowable values for inline_offset_ind
| Values |
Description |
| I |
Inline |
| O |
Offset |
|
| service_code_to_use |
int |
Specifies which service code to use.
Allowable values for service_code_to_use
| Values |
Description |
| 0 |
Uses the same service as the 'charge' line item |
| 1 |
Uses a specific service |
|
| alt_service_no_2_apply |
int |
Specifies the specific service code to use. |
| alt_service_id_2_apply |
string |
Specifies the specific service id to use. |
| 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 |
|
| plan_no |
hash |
Aria-assigned unique plan identifier |
| plan_nos |
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: plan_no[0]=1002&plan_no[1]=1003 etc |
| client_plan_id |
hash |
|
| client_plan_ids |
string |
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 |
hash |
|
| service_nos |
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[0][1]=1001&service[1][0]=100&service[1][1]=103 |
| client_service_id |
hash |
|
| client_service_ids |
string |
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 |
hash |
|
| item_nos |
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_no[0]=1002&item_no[1]=103 |
| client_item_id |
hash |
|
| client_item_ids |
string |
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_item_id[0]=1002&client_item_id[1]=103 |
| rule_application |
hash |
|
| plan_no |
hash |
Aria-assigned unique plan identifier |
| plan_nos |
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: plan_no[0]=1002&plan_no[1]=1003 etc |
| client_plan_id |
hash |
|
| client_plan_ids |
string |
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 |
| plan_ids |
string |
This attribute is not in use. It is just a placeholder. |
| service_no |
hash |
|
| service_nos |
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[0][1]=1001&service[1][0]=100&service[1][1]=103 |
| client_service_id |
hash |
|
| client_service_ids |
string |
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 |
| service_ids |
string |
This attribute is not in use. It is just a placeholder. |
| item_no |
hash |
|
| item_nos |
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_no[0]=1002&item_no[1]=103 |
| client_item_id |
hash |
|
| client_item_ids |
string |
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_item_id[0]=1002&client_item_id[1]=103 |
| item_ids |
string |
This attribute is not in use. It is just a placeholder. |
| plan_service |
hash |
|
| plan_no |
string |
Plan numbers that are eligible for discount. |
| client_plan_id |
string |
Client plan ids that are associated with plan number. |
| service_no |
string |
Services that are eligible for discount. |
| client_service_id |
string |
Client service ids that are associated with service number. |
| discount_bundle |
hash |
|
| bundle_no |
int |
Specifies the no for the discount bundle. |
| bundle_name |
string |
Specifies the name for the discount bundle. |
| bundle_id |
string |
Specifies bundle id for discount Bundle |
| description |
string |
Specifies description for the discount Bundle |
| rules |
hash |
|
| rule |
int |
Specifies the rules to be grouped in this bundle. REST input arrays should be passed in the following format: rules[1]=1002&rules[2]=103 |
| rule_ids |
hash |
|
| rule |
string |
Specifies the client defined IDs for the rules to be grouped in this bundle. REST input arrays should be passed in the following format: rule_ids[1]=1002&rule_ids[2]=103 |
| allow_overlap_ind |
string |
Specifies if the rules in the bundle can overlap or not.
Allowable values for allow_overlap_ind
| Values |
Description |
| Y |
Yes |
| N |
No |
|
| group_no |
int |
Aria-assigned unique identifier for coupon group. |
| client_group_id |
string |
Client defined identifier for coupon group. |
| group_name |
string |
Specified coupon group name. |
| group_description |
string |
Specifies group description. Pass ~ to delete the previously saved description. |
| precedence |
int |
Specifies the precedence of the coupon group. |
| coupon_scope |
int |
Specifies the coupon application. The parameter is available only for EOM Clients.
Allowable values for coupon_scope
| Values |
Description |
| 1 |
Coupon can be applied to Account only |
| 2 |
Coupon can be applied to Master plan instance only |
| 3 |
Coupon can be applied to Account & Master plan instance |
|
| coupon_translation_details |
hash |
Array that contains all the translated values for a given locale. |
| locale_name |
string |
Name of the locale |
| locale_no |
int |
Aria-assigned unique identifier of the locale used for translations. |
| coupon_desc |
string |
Specifies Coupon description |
| coupon_msg |
string |
Specifies Coupon Message |
| discount_rule_t |
hash |
|
| rule_no |
int |
Specifies the no for the discount rule. |
| rule_name |
string |
Specifies rule name for Discount Rule |
| description |
string |
Specifies description for the Discount Rule |
| ext_description |
string |
Specifies description that can be added to invoice/statment and is visible to account holder. |
