update_credit_template_m
Summary
| API Name | update_credit_template_m |
|---|---|
| Class | administration_services_m |
| Update Version |
Description
Inputs
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||||
| credit_template_no | long | Yes |
Alternative required field: client_credit_template_id |
|||||||||
| credit_template_name | string | Yes | ||||||||||
| eligible_plan_no | long | 8 | No |
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. Alternative field: eligible_client_plan_id |
||||||||
| eligible_client_plan_id | string | 100 | No |
Specifies Client defined unique id Alternative field: eligible_plan_no |
||||||||
| eligible_service_no | long | 12 | No |
Eligible service number Alternative field: eligible_client_service_id |
||||||||
| eligible_client_service_id | string | 100 | No |
Specifies Client defined unique id Alternative field: eligible_service_no |
||||||||
| eligible_service_types | string | 2 | No |
Service type code for which the credit is applicable. |
||||||||
| discount_type | int | No | ||||||||||
| discount_amt | float | Yes | ||||||||||
| no_of_credits | int | No | ||||||||||
| credit_interval_type_ind | string | 1 | Yes |
Specifies the credit inteval type. Allowed values:
|
||||||||
| credit_interval_months | int | No | ||||||||||
| credit_interval_weeks | int | No | ||||||||||
| credit_interval_days | int | No | ||||||||||
| percentage_plan_no | long | No |
Alternative field: percentage_client_plan_id |
|||||||||
| percentage_client_plan_id | string | 100 | No |
Specifies Client defined unique id Alternative field: percentage_plan_no |
||||||||
| percentage_service_no | long | No |
Alternative field: percentage_client_service_id |
|||||||||
| percentage_client_service_id | string | 100 | No |
Specifies Client defined unique id Alternative field: percentage_service_no |
||||||||
| alt_service_no | long | No |
Alternative field: alt_client_service_id |
|||||||||
| alt_client_service_id | string | 100 | No |
Specifies Client defined unique id Alternative field: alt_service_no |
||||||||
| client_credit_template_id | string | 100 | Yes |
Client Defined unique id |
||||||||
| currency_cd | string | 3 | No |
Specifies the currency code of template |
||||||||
| coupon | object | No |
The coupon associated with this method. |
|||||||||
| existing_coupon | int | No |
coupon fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| coupon_cd | string | 30 | No |
Specifies Coupon Code |
||||||||
| coupon_desc | string | 200 | No |
Specifies Coupon description |
||||||||
| coupon_msg | string | 300 | No |
Specifies Coupon Message |
||||||||
| status_ind | int | 1 | No |
Specifies Coupon status. Valid values are [0, 1]. 1 indicates coupon is Active. 0 indicates coupon Inactive. |
||||||||
| no_of_uses | int | 8 | No |
Specifies number of uses after which coupon get expires. Related to coupon expiry detail. |
||||||||
| start_date | string | No |
Specifies start date. The date is in the format "yyyy-mm-dd" Related to coupon expiry detail |
|||||||||
| end_date | string | No |
Specifies start date. The date is in the format "yyyy-mm-dd" Related to coupon expiry detail |
|||||||||
| coupon_scope | int | 1 | No |
Specifies the coupon application. The parameter is required for EOM Clients Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| credit_template_no | long | No |