Roles

This entity describes an Autotask Role. Roles are associated with a department and have a standard billing rate. Resources are associated with one or more department/role combinations. Resources must specify a Role when entering time. When billing for that time, the default rate for the role determines the billable rate unless it is overridden, for example, by a Contract or workType.

Roles are managed through the Admin module. They are created through Site Setup > Company Setup > Roles tab and assigned to a resource when adding or editing the resource (Admin > Site Setup > Resource Setup > Resources > New or Edit ) or adding the resource to a department (Admin > Site Setup > Company Setup > Departments tab).

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

Entity Path:

/atservicesrest/v1.0/Roles
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

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
description string (200)        
hourlyFactor decimal      
hourlyRate decimal      
id long    
isActive boolean      
isExcludedFromNewContracts boolean        
isSystemRole boolean      
name string (200)      
quoteItemDefaultTaxCategoryId integer     TaxCategories  
roleType integer      

Additional resources