get_surcharges_m
Returns all surcharges for a client
Input Arguments
| 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. | ||||||
| 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 for include_translations:
|
Output Arguments
| 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. | ||||||||
| surcharges | hash | |||||||||
 surcharge_no |
int | Surcharge Number | ||||||||
| client_surcharge_id |
string | Client defined identifier for Surcharge. | ||||||||
| surcharge_name |
string | Surcharge Name | ||||||||
| surcharge_type_cd |
string | Specifies whether the discount is going to be fixed or percentage based.
Allowable values for surcharge_type_cd:
|
||||||||
| currency_cd |
string | Currency for the surcharge. | ||||||||
| scope_label |
string | Scope for the surcharge | ||||||||
| deleteable |
string | Specifies if surcharge is deleteable or not. Y - Yes, N - No | ||||||||
| surcharge_scope |
int | Specifies the surcharge application. The value will be available only for EOM Clients.
Allowable values for surcharge_scope:
|
||||||||
| surcharge_translations |
hash | Array that contains all the translated values for a given locale. | ||||||||
| locale_name |
string | Name of the locale | ||||||||
| locale_no |
int | Aria-assigned unique identifier of the locale used for translations. | ||||||||
| surcharge_no |
int | Surcharge Number | ||||||||
| surcharge_name |
string | Surcharge Name |