PriceListRoles

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.

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: PriceListRoles

Entity Path:

/atservicesrest/v1.0/PriceListRoles
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 fields for this entity. Refer to the following articles for more information about working with these fields:

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
currencyID integer Currencies  
hourlyRate decimal  
Only when usesInternalCurrencyPrice=
false 		   
id long    
roleID integer Roles  
usesInternalCurrencyPrice boolean      

Additional resources