 |
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. |
|
credit_template_name |
string |
|
|
|
discount_type |
int |
|
Specifies discount type. Valid values are [1 or 2]. 1 - Indicates flat rate, 2 - Indicates percentage. |
|
discount_amt |
float |
|
|
| |
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 for eligible_service_type
| Values |
Description |
| RC |
Recurring Service |
| RA |
Recurring Arrears Service |
| SC |
Surcharge Service |
| US |
Usage Service |
| AC |
Activation Service |
| MS |
Miscellaneous Service |
| CN |
Cancellation Service |
| OR |
Order Based Service |
| MN |
Minimum Service Fee |
|
| |
no_of_credits |
int |
|
|
| |
credit_interval_months |
int |
|
|
| |
percentage_plan_no |
int |
|
|
| |
OR |
|
|
|
| |
percentage_client_plan_id |
string |
100 |
Specifies Client defined unique id |
| |
percentage_service_no |
int |
|
|
| |
OR |
|
|
|
| |
percentage_client_service_id |
string |
100 |
Specifies Client defined unique id |
| |
alt_service_no |
int |
|
|
| |
OR |
|
|
|
| |
alt_client_service_id |
string |
100 |
Specifies Client defined unique id |
| |
client_credit_template_id |
string |
100 |
Client defined unique id |
| |
currency_cd |
string |
3 |
Specifies the currency code of template |
| |
coupon |
array |
|
|
| |
coupon_cd |
string |
30 |
Specifies Coupon Code |
| |
coupon_desc |
string |
200 |
Specifies Coupon description |
| |
coupon_msg |
string |
300 |
Specifies Coupon Message |
| |
status_ind |
int |
1 |
Specifies Coupon status. Valid values are [0, 1]. 1 indicates coupon is Active. 0 indicates coupon Inactive. |
| |
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 |
| |
coupon_scope |
int |
1 |
Specifies the coupon application. The parameter is required 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 |
|
| |
existing_coupon |
int array |
|
|
