get_recurring_credit_template_details_m
Summary
| API Name | get_recurring_credit_template_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Returns details of credit template
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 |
Specifies the recurring credit template number Alternative required field: client_credit_template_id |
|
| client_credit_template_id | string | 100 | Yes |
Client defined unique id Alternative required field: credit_template_no |
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_id | long | 12 | No |
Specifies currently assigned recurring credit template associated with coupon. All of the remaining parameters are dependent on this. |
||||||||
| client_credit_template_id | string | 100 | No |
Client defined unique id |
||||||||
| credit_template_name | string | 300 | No |
Recurring credit template name |
||||||||
| 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. |
||||||||
| eligible_client_plan_id | string | 100 | No |
Specifies Client defined unique id |
||||||||
| eligible_service_no | long | 12 | No |
Eligible service number |
||||||||
| eligible_client_service_id | string | 100 | No |
Specifies Client defined unique id |
||||||||
| no_of_credits | int | 2 | No |
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. |
||||||||
| credit_interval_type_ind | string | 1 | No |
Specifies the credit inteval type. Allowed values:
|
||||||||
| credit_interval_months | int | 3 | No |
Time interval between credits in months |
||||||||
| credit_interval_weeks | int | 3 | No |
Time interval between credits in weeks |
||||||||
| credit_interval_days | int | 3 | No |
Time interval between credits in weeks |
||||||||
| discount_type | string | 100 | No |
Specifies discount type as 'Flat' or 'Percentage'. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage |
||||||||
| discount_amt | float | 12 | No |
Specifies discount amount |
||||||||
| percentage_plan_no | long | 8 | No |
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 | 100 | No |
Specifies Client defined unique id |
||||||||
| percentage_service_no | long | 12 | No |
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 | 100 | No |
Specifies Client defined unique id |
||||||||
| alt_service_no | long | 12 | No |
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 | 100 | No |
Specifies Client defined unique id |
||||||||
| eligible_service_types | object | No |
Service type code for which the credit is applicable. |
|||||||||
| coupons | object | No |
The coupons associated with this method. |
eligible_service_types fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| eligible_service_type | string | 2 | No |
coupons fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| coupon_cd | string | 100 | Yes |
Coupon Code |
||||||||
| coupon_msg | string | 300 | No |
Specifies Coupon Message |
||||||||
| coupon_desc | string | 100 | No |
Coupon description |
||||||||
| status_ind | int | 1 | Yes |
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 | 10 | Yes |
Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail |
||||||||
| end_date | string | 10 | Yes |
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 value will be available only for EOM Clients Allowed values:
|