PriceListRole

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity is only used in Multi-currency databases. It describes whether a Role Hourly Rate on the Price List uses the internal currency or an external currency, and if it is external, lets you set the price in that currency.

Entity details

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

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

Conditions and requirements

General

  • If you don't have Multi-currency enabled and you try to write to the entity, you will receive an error.

Special field attributes

Field Conditions and Requirements
HourlyRate If this field's value equals true, then PriceListRole.HourlyRate will return UnitPrice divided by the current Currency exchange rate; that is, the Unit Price of the Role entity with id equal to PriceListRole.RoleID, divided by the current exchange rate of the Currency with id equal to PriceListRole.CurrencyID.

UsesInternalCurrencyPrice

 
  • If the UsesInternalCurrencyPrice field is set to true, any supplied value for the UnitPrice field will be ignored by the system.
  • If the UsesInternalCurrencyPrice field is set to true, any existing value for the UnitPrice field will be cleared.
  • If the UsesInternalCurrencyPrice field is set to false, the UnitPrice field will be required, even though it is not required otherwise.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
CurrencyID Currency Id integer Currency  
HourlyRate Hourly Rate decimal  
Only when UsesInternal
CurrencyPrice=
false 		   
id ID long    
RoleID Role Id integer Role  
UsesInternalCurrencyPrice Uses Internal Currency Price boolean