get_client_currencies_m
Summary
| API Name | get_client_currencies_m |
|---|---|
| Class | system_services_m |
| Update Version | 3.5 |
Description
Returns a list of currencies assigned to a client.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| Start of client_currency object | ||||
| client_currency | object | No | ||
| Name | Type | Length | Required | Description |
| ▶currency_cd | string | No |
The ISO-compliant 3-character currency codes in lowercase for monetary values used in the context of this API method. |
|
| ▶currency_name | string | No |
Human-readable currency name |
|
| ▶currency_short_name | string | No |
Alternative short name for the currency |
|
| ▶iso_4217n | long | No |
ISO 4217-N Currency Identrifier |
|
| ▶currency_symbol | string | No |
Currency symbol. |
|
| ▶currency_html | string | No |
HTML currency symbol code |
|
| ▶default_ind | long | No |
Boolean value indicating if the currency is the cleint default currency true = yes, false = no). |
|
| End of client_currency object | ||||
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|