get_surcharges_m
Summary
| API Name | get_surcharges_m |
|---|---|
| Class | administration_services_m |
| Update Version | 6.22 |
Description
Returns all surcharges for a 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 surcharges object | ||||||||||||
| surcharges | object | No |
The surcharges associated with this method. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶surcharge_no | long | 100 | Yes |
Surcharge Number |
||||||||
| ▶client_surcharge_id | string | 100 | Yes |
Client defined identifier for Surcharge. |
||||||||
| ▶surcharge_name | string | 100 | Yes |
Surcharge Name |
||||||||
| ▶surcharge_type_cd | string | 1 | Yes |
Specifies whether the discount is going to be fixed or percentage based.. Allowed values:
|
||||||||
| ▶currency_cd | string | 3 | Yes |
Currency for the surcharge. |
||||||||
| ▶scope_label | string | 100 | Yes |
Scope for the surcharge |
||||||||
| ▶deleteable | string | 1 | Yes |
Specifies if surcharge is deleteable or not. Y - Yes, N - No |
||||||||
| ▶surcharge_scope | int | 1 | No |
Specifies the surcharge application. The value will be available only for EOM Clients. Allowed values:
|
||||||||
| ▶installment_surcharge_ind | int | 1 | No |
Indicates if the surcharge should be spread over installment period. Applicable only when an item is purchased with installment. Allowable values are: 0 - Surcharge will not be spread over installment period 1 - Surcharge will be spread over installment period. |
||||||||
| Start of surcharge_translations object | ||||||||||||
| ▶surcharge_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 |
||||||||
| ▶▶surcharge_no | long | 100 | No |
Surcharge Number |
||||||||
| ▶▶surcharge_name | string | 100 | No |
Surcharge Name |
||||||||
| End of surcharge_translations object | ||||||||||||
| End of surcharges object | ||||||||||||