get_coupon_details_m
Summary
| API Name | get_coupon_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Returns details of specified coupon
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. |
||||||
| coupon_cd | string | 32 | Yes |
Coupon Code |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. 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. |
|||||||||||
| coupon_cd | string | 30 | No |
Specifies Coupon Code |
||||||||||
| coupon_desc | string | 100 | 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 | 10 | No |
Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail |
||||||||||
| end_date | string | 10 | No |
Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail |
||||||||||
| credit_template_id | long | 200 | No |
credit template id |
||||||||||
| credit_template_name | string | 200 | No |
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 |
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 | long | 12 | No |
Eligible service number |
||||||||||
| eligible_client_service_id | string | 100 | No |
Eligible client service 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. |
||||||||||
| time_between_credits | int | 3 | No |
Time interval between credits |
||||||||||
| discount_type | int | 1 | No |
Specifies discount type. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage |
||||||||||
| discount_amt | float | 12 | No |
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 | 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 Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
||||||||||
| 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 Percentage client service id. This value is only set if discount_type is 2 i.e. discount type is Percentage |
||||||||||
| 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 Alternative client service id. If this value is null, then for coupon can be Service code to use is standard |
||||||||||
| eligible_service_types | object | No |
Service type code for which the credit is applicable. |
|||||||||||
| credit_template | object | No |
The credit_template associated with this method. |
|||||||||||
| discount_rule | object | No |
The discount_rule associated with this method. |
|||||||||||
| discount_bundle | object | No |
The discount_bundle associated with this method. |
|||||||||||
| group_no | long | 38 | No |
Aria-assigned unique identifier for coupon group. |
||||||||||
| client_group_id | string | 100 | No |
Client defined identifier for coupon group. |
||||||||||
| group_name | string | 100 | No |
Specified coupon group name. |
||||||||||
| group_description | string | 300 | No |
Specifies group description. Pass ~ to delete the previously saved description. |
||||||||||
| precedence | int | 5 | No |
Specifies the precedence of the coupon group. |
||||||||||
| coupon_scope | int | 1 | No |
Specifies the coupon application. The parameter is available only for EOM Clients Allowed values:
|
||||||||||
| coupon_translation_details | object | No |
Array that contains all the translated values for a given locale. |
eligible_service_types fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| eligible_service_type | string | 2 | No |
credit_template.eligible_service_types fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| eligible_service_type | string | 2 | No |
credit_template fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| credit_template_no | long | 12 | Yes |
Refers to recurring credit template id |
| credit_template_id | string | 200 | Yes |
credit template id |
| credit_template_name | string | 200 | Yes |
credit template name |
| client_credit_template_id | string | 100 | No |
Client defined unique id |
| 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 |
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 | long | 12 | No |
Eligible service number |
| eligible_client_service_id | string | 100 | No |
Eligible client service 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. |
| time_between_credits | int | 3 | No |
Time interval between credits |
| discount_type | int | 1 | No |
Specifies discount type. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage |
| discount_amt | float | 12 | No |
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 | 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 Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| 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 Percentage client service id. This value is only set if discount_type is 2 i.e. discount type is Percentage |
| 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 Alternative client service id. If this value is null, then for coupon can be Service code to use is standard |
| eligible_service_types | object | No |
Service type code for which the credit is applicable. |
discount_rule.rule_application.plan_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_nos | long | 12 | No |
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 |
discount_rule.rule_application.client_plan_id fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_plan_ids | string | 100 | No |
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 |
discount_rule.rule_application.service_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| service_nos | long | 12 | No |
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 |
discount_rule.rule_application.client_service_id fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_service_ids | string | 100 | No |
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 |
discount_rule.rule_application.item_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| item_nos | long | 12 | No |
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 |
discount_rule.rule_application.client_item_id fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_item_ids | string | 100 | No |
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 |
discount_rule.rule_application.client_sku fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_skus | string | 100 | No |
Specifies the inventory items that are eligible for the discount. This is mandatory for scope 31. |
discount_rule.rule_application.plan_service fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | No |
Plan numbers that are eligible for discount. |
|
| client_plan_id | string | No |
Client plan ids that are associated with plan number. |
|
| service_no | long | No |
Services that are eligible for discount. |
|
| client_service_id | string | No |
Client service ids that are associated with service number. |
discount_rule.rule_application fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | object | No |
The plan_no associated with this method. |
|
| client_plan_id | object | No |
The client_plan_id associated with this method. |
|
| service_no | object | No |
The service_no associated with this method. |
|
| client_service_id | object | No |
The client_service_id associated with this method. |
|
| item_no | object | No |
The item_no associated with this method. |
|
| client_item_id | object | No |
The client_item_id associated with this method. Note: This field was deprecated in version 43. |
|
| client_sku | object | No |
The client_sku associated with this method. |
|
| plan_service | object | No |
The plan_service associated with this method. |
discount_rule fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| rule_no | long | 300 | Yes |
Specifies the no for the discount rule. |
||||||||||||||||||||||
| rule_name | string | 30 | Yes |
Specifies rule name for Discount Rule |
||||||||||||||||||||||
| rule_id | string | 30 | Yes |
Specifies client rule id for Discount Rule |
||||||||||||||||||||||
| description | string | 300 | Yes |
Specifies description for the Discount Rule |
||||||||||||||||||||||
| ext_description | string | 300 | Yes |
Specifies description that can be added to invoice/statement and is visible to account holder. |
||||||||||||||||||||||
| discount_type | string | 8 | Yes |
Specifies discount type for Discount Rule |
||||||||||||||||||||||
| flat_percent_ind | int | 8 | Yes |
Specifies whether the discount is going to be flat or percentage based. |
||||||||||||||||||||||
| amount | float | 12 | Yes |
Specifies the amount of discount. |
||||||||||||||||||||||
| currency | string | 3 | Yes |
Specifies the currency code of the rule |
||||||||||||||||||||||
| applicable_trans_scope | string | 1 | Yes |
Specifies whether the discount is applied to each or all transactions. Allowed values:
|
||||||||||||||||||||||
| duration_type_ind | string | 1 | Yes |
Specifies the duration type. Allowed values:
|
||||||||||||||||||||||
| max_applicable_months | int | 8 | No |
Specifies the duration of the discount in months. |
||||||||||||||||||||||
| max_applicable_weeks | int | 8 | No |
Specifies the duration of the discount in weeks. |
||||||||||||||||||||||
| max_applicable_days | int | 8 | No |
Specifies the duration of the discount in days. |
||||||||||||||||||||||
| max_applications_per_acct | int | 8 | No |
Specifies the number of times the discount can be applied. |
||||||||||||||||||||||
| remainder_discount_rule_indicator | int | 3 | No |
When set as 1, it will prorate the discount applied on the initial invoice if the respective charge is prorated and then force the remaining proportion of the discount on its final application. In any of its application, if respective charge is prorated, then the discount also gets prorated. By default it's null. This parameter is applicable only for (a) duration_type_ind = M (months type duration) and (b) duration_type_ind = U (usage count type duration) with flat_percent_ind = F (fixed discount type). |
||||||||||||||||||||||
| inline_offset_ind | string | 1 | Yes |
Specifies how the discount will be displayed in the invoice. Allowed values:
|
||||||||||||||||||||||
| service_code_to_use | int | 1 | No |
'Specifies which service code to use. Valid values are [0,1] where 0 uses the same service as the 'charge' line item and 1 uses a specific service' Allowed values:
|
||||||||||||||||||||||
| alt_service_no_2_apply | int | 12 | No |
Specifies the specific service code to use. |
||||||||||||||||||||||
| alt_service_id_2_apply | string | 100 | No |
Specifies the specific service id to use. |
||||||||||||||||||||||
| scope_no | int | 2 | Yes |
Specifies the charges eligible for the discount. Allowed values:
|
||||||||||||||||||||||
| rule_application | object | No |
The rule_application associated with this method. |
discount_bundle.rules fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rule | long | 12 | No |
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 |
discount_bundle.rule_ids fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rule | string | 100 | No |
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 |
discount_bundle fields
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| bundle_no | long | 300 | Yes |
Specifies the no for the discount bundle. |
||||||
| bundle_name | string | 300 | Yes |
Specifies the name for the discount bundle. |
||||||
| bundle_id | string | 30 | Yes |
Specifies bundle id for discount Bundle |
||||||
| description | string | 300 | Yes |
Specifies description for the discount Bundle |
||||||
| rules | object | No |
The rules associated with this method. |
|||||||
| rule_ids | object | No |
The rule_ids associated with this method. |
|||||||
| allow_overlap_ind | string | 1 | Yes |
Specifies if the rules in the bundle can overlap or not. Allowed values:
|
coupon_translation_details.discount_rule_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rule_no | long | 300 | No |
Specifies the no for the discount rule. |
| rule_name | string | 30 | No |
Specifies rule name for Discount Rule |
| description | string | 300 | No |
Specifies description for the Discount Rule |
| ext_description | string | 300 | No |
Specifies description that can be added to invoice/statement and is visible to account holder. |
coupon_translation_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| coupon_desc | string | 100 | No |
Specifies Coupon description |
| coupon_msg | string | 300 | No |
Specifies Coupon Message |
| discount_rule_t | object | No |
The discount_rule_t associated with this method. |