get_discount_rules_m
Summary
| API Name | get_discount_rules_m |
|---|---|
| Class | administration_services_m |
| Update Version | 6.12 |
Description
Lists all the discount rules for the client
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. |
||||||
| 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. |
|
| Start of discount_rules object | ||||
| discount_rules | object | No |
The discount_rules associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶rule_no | long | 300 | Yes |
Specifies the no for the 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 whether the discount is going to be flat or percentage based. |
| ▶amount | float | 12 | Yes |
Specifies the amount of discount. |
| Start of discount_rule_translations object | ||||
| ▶discount_rule_translations | object | No |
Array that contains all the translated values for a given locale. |
|
| 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 |
| ▶▶rule_no | long | 300 | Yes |
Specifies the no for the discount rule. |
| ▶▶rule_name | string | 300 | 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. |
| End of discount_rule_translations object | ||||
| End of discount_rules object | ||||
| currency | string | No | ||