Currency

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.

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, Accounting & Invoicing. They allow you to use different currencies for customer invoicing while setting your own internal currency.

NOTE  The Currency 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.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: Currency
Can Create:  
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

General

  • Multi-Currency must be enabled to query this entity or any of the ProductList entities.
  • 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

Currency.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 Currency.ExchangeRate and Currency.LastModifiedDateTime.

Currency.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 Currency.ExchangeRate and Currency.LastModifiedDateTime.

Field definitions

Field Name Label Datatype Read Only Is Required Reference Name Picklist
Active Active boolean    
CurrencyNegativeFormat Currency Negative Format string (10)    
CurrencyPositiveFormat Currency Positive Format string (10)    
Description Currency Description string (100)    
DisplaySymbol Display Symbol integer  
ExchangeRate Exchange Rate decimal      
id Currency ID Int64    
IsInternalCurrency Is Internal Currency boolean    
LastModifiedDateTime Last Modified Time datetime        
Name Currency Name string (3)    
UpdateResourceId Update Resource Id integer   Resource