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 | 32 | Coupon Code |
locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |
OR | ||||
locale_name | string | 32 | Name of the locale to which the translations belong. | |
include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowable Values |
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 | 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 |
![]() |
string | |
credit_template | hash | |
![]() |
int | Refers to recurring credit template id |
![]() |
string | credit template id |
![]() |
string | credit template name |
![]() |
string | Client defined unique id |
![]() |
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. |
![]() |
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. |
![]() |
int | Eligible service number |
![]() |
string | Eligible client service id |
![]() |
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. |
![]() |
int | Time interval between credits |
![]() |
int | Specifies discount type. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage |
![]() |
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 |
![]() |
int | Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
![]() |
string | Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
![]() |
int | Specifies Percentage service number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
![]() |
string | Specifies Percentage client service id. This value is only set if discount_type is 2 i.e. discount type is Percentage |
![]() |
int | Specifies Alternative service number. If this value is null, then for coupon can be Service code to use is standard |
![]() |
string | Specifies Alternative client service id. If this value is null, then for coupon can be Service code to use is standard |
![]() |
hash | Service type code for which the credit is applicable |
![]() |
string | |
discount_rule | hash | |
![]() |
int | Specifies the no for the discount rule. |
![]() |
string | Specifies rule name for Discount Rule |
![]() |
string | Specifies client rule id for Discount Rule |
![]() |
string | Specifies description for the Discount Rule |
![]() |
string | Specifies description that can be added to invoice/statment and is visible to account holder. |
![]() |
string | Specifies discount type for Discount Rule |
![]() |
int | Specifies whether the discount is going to be flat or percentage based. |
![]() |
float | Specifies the amount of discount. |
![]() |
string | Specifies the currency code of the rule |
![]() |
string | Specifies whether the discount is applied to each or all transactions. Allowable Values |
![]() |
string | Specifies the duration type. Allowable Values |
![]() |
int | Specifies the duration of the discount in months. |
![]() |
int | Specifies the number of times the discount can be applied. |
![]() |
string | Specifies how the discount will be displayed in the invoice. Allowable Values |
![]() |
int | Specifies which service code to use. Allowable Values |
![]() |
int | Specifies the specific service code to use. |
![]() |
string | Specifies the specific service id to use. |
![]() |
int | Specifies the charges eligible for the discount. Allowable Values |
![]() |
hash | Aria-assigned unique plan identifier |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
hash | Aria-assigned unique plan identifier |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
string | This attribute is not in use. It is just a placeholder. |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
string | This attribute is not in use. It is just a placeholder. |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
string | This attribute is not in use. It is just a placeholder. |
![]() |
hash | |
![]() |
string | Plan numbers that are eligible for discount. |
![]() |
string | Client plan ids that are associated with plan number. |
![]() |
string | Services that are eligible for discount. |
![]() |
string | Client service ids that are associated with service number. |
discount_bundle | hash | |
![]() |
int | Specifies the no for the discount bundle. |
![]() |
string | Specifies the name for the discount bundle. |
![]() |
string | Specifies bundle id for discount Bundle |
![]() |
string | Specifies description for the discount Bundle |
![]() |
hash | |
![]() |
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 |
![]() |
hash | |
![]() |
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 |
![]() |
string | Specifies if the rules in the bundle can overlap or not. Allowable Values |
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 |
coupon_translation_details | hash | Array that contains all the translated values for a given locale. |
![]() |
string | Name of the locale |
![]() |
int | Aria-assigned unique identifier of the locale used for translations. |
![]() |
string | Specifies Coupon description |
![]() |
string | Specifies Coupon Message |
![]() |
hash | |
![]() |
int | Specifies the no for the discount rule. |
![]() |
string | Specifies rule name for Discount Rule |
![]() |
string | Specifies description for the Discount Rule |
![]() |
string | Specifies description that can be added to invoice/statment and is visible to account holder. |