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. |
![]() | credit_template_no | string | ||
OR | ||||
client_credit_template_id | string | 100 | Client Defined unique id | |
![]() | credit_template_name | string | ||
![]() | 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 | |
![]() | string array | 2 | Service type code for which the credit is applicable | |
discount_type | int | |||
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 | |
currency_cd | string | 3 | Specifies the currency code of template | |
coupon | array | |||
![]() | string | 30 | Specifies Coupon Code | |
![]() | string | 200 | Specifies Coupon description | |
![]() | string | 300 | Specifies Coupon Message | |
![]() | int | 1 | Specifies Coupon status. Valid values are [0, 1]. 1 indicates coupon is Active. 0 indicates coupon Inactive. | |
![]() | int | 8 | Specifies number of uses after which coupon get expires. Related to coupon expiry detail. | |
![]() | string | Specifies start date. The date is in the format "yyyy-mm-dd" Related to coupon expiry detail | ||
![]() | string | Specifies start date. The date is in the format "yyyy-mm-dd" Related to coupon expiry detail | ||
![]() | int | 1 | Specifies the coupon application. The parameter is required for EOM Clients Allowable Values | |
![]() | int array |
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. |
credit_template_no | string |