Currencies
This entity describes a currency available for use with the Autotask multi-currency installed module. The currency entity is used in Autotask only when the multi-currency installed module is enabled. It allows selected currency related fields to be queried and updated through the API. Currencies cannot be created or deleted.
In Autotask, when the multi-currency installed module is enabled, currencies are managed from the Currencies page, available to Administrators in the Autotask menu
under Admin > Finance, Companying & Invoicing. They allow you to use different currencies for customer invoicing while setting your own internal currency.
NOTE The Currencies entity should not be confused with the currency local term list of available currencies. The local term option is not available when the multi-currency module is enabled.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
| Entity Name: | Currencies |
|
Entity Path: |
/atservicesrest/v1.0/Currencies |
| Can Create: | |
| Can Update: |
|
| Can Query: |
|
| Can Delete: | |
| Can Have UDFs: |
Conditions and requirements
General
-
To support SaaS and BCDR billing integrations, the Currencies entity supports Query via the REST API even if Multi-Currency is not enabled.
- Only one currency can be selected as the internal currency. When a second currency is saved as active on the user's system, the current internal currency will be permanently locked as the internal currency.
Special field attributes
| Field | Conditions and Requirements |
|---|---|
| exchangeRate |
currencies.exchangeRate allows only positive non-zero numbers up to five decimal places and six places to the left of the decimal. Trailing zeroes will not be shown in the UI. If a negative number or 0 is entered, an error message displays in that curency's row in the UI. When working with the API, all fields are read-only except for currencies.exchangeRate and currencies.lastModifiedDateTime. currencies.exchangeRate for the currency set as Internal is set to 1 and cannot be updated. |
| lastModifiedDateTime | When working with the API, all fields are read-only except for currencies.exchangeRate and currencies.lastModifiedDateTime. |
Field definitions
About this table
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
| Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|
| currencyNegativeFormat | string (10) |
|
|
||
| currencyPositiveFormat | string (10) |
|
|
||
| description | string (100) |
|
|
||
| displaySymbol | integer |
|
|
|
|
| exchangeRate | decimal |
|
|||
| id | long |
|
|
||
| isActive | boolean |
|
|
||
| isInternalCurrency | boolean |
|
|
||
| lastModifiedDateTime | datetime | ||||
| name | string (3) |
|
|
||
| updateResourceId | integer |
|
Resources |
