Role
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
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).
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
Entity Name: | Role |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
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 |
---|---|---|---|---|---|---|
Active | Active | boolean | ||||
Description | Description | string (200) | ||||
HourlyFactor | Hourly Factor | double | ||||
HourlyRate | Hourly Rate | double | ||||
id | Role ID | long | ||||
IsExcludedFromNewContracts | Is Excluded From New Contracts | boolean | ||||
Name | Name | string (200) | ||||
QuoteItemDefaultTaxCategoryId | Quote Item Default Tax Category Id | integer | TaxCategory | |||
RoleType | Role Type | integer | ||||
SystemRole | System Role | boolean |