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. |
![]() | rule_no | int | Specifies the rule number | |
OR | ||||
client_rule_id | string | 100 | Client defined unique identifier | |
locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |
OR | ||||
locale_name | string | 32 | Name of the locale to which the translations belong. | |
include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowable Values |
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. |
discount_rules | hash | |
![]() | int | Specifies the no for the discount rule. |
![]() | string | Specifies rule name for Discount Rule |
![]() | string | Specifies client rule id for Discount Rule |
![]() | string | Specifies description for the Discount Rule |
![]() | string | Specifies description that can be added to invoice/statment and is visible to account holder. |
![]() | string | Specifies whether the discount is going to be flat or percentage based. |
![]() | float | Specifies the amount of discount. |
![]() | string | Specifies the currency code of the rule |
![]() | string | Specifies the Applicable transaction scope |
![]() | string | Specifies the duration type. Valid values are [ U, M] for uses and months Allowable Values |
![]() | int | Specifies the duration of the discount in months. |
![]() | int | Specifies the number of times the discount can be applied. |
![]() | string | Specifies how the discount will be displayed in the invoice. Allowable Values |
![]() | int | Specifies which service code to use. Allowable Values |
![]() | int | Specifies the specific service code to use. |
![]() | string | Specifies the client defined id for specific service code to use. |
![]() | int | Specifies the charges eligible for the discount. Allowable Values |
![]() | string | Specifies the discount scope for a discount rule. Allowable Values |
![]() | hash | Aria-assigned unique plan identifier |
![]() | int | 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 |
![]() | hash | |
![]() | hash | |
![]() | string | 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 |
![]() | hash | |
![]() | hash | |
![]() | int | 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 |
![]() | hash | |
![]() | string | Specifies the Use 'All Or Nothing' Subscription Rule |
![]() | hash | Array that contains all the translated values for a given locale. |
![]() | string | Name of the locale |
![]() | int | Aria-assigned unique identifier of the locale used for translations. |
![]() | int | Specifies the no for the discount rule. |
![]() | string | Specifies rule name for Discount Rule |
![]() | string | Specifies description for the Discount Rule |
![]() | string | Specifies description that can be added to invoice/statment and is visible to account holder. |