ContractExclusionRole
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
This entity describes a billing Role that has been excluded from a Contract; that is, time entries associated with the contract cannot use the excluded role. If a resource attempts to save a time entry with a role that is excluded by the associated contract, a warning message opens. If the resource continues the save, the time entry is saved without an associated contract, unless a default exclusion contract has been set up (Contract.ExclusionContractID).
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
Entity Name: | ContractExclusionRole |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
- Resources with security levels that specify limited or no contract visibility cannot create, update, or query this entity.
- Provided Role must have a RoleType value equal to 0 and cannot be a system role.
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 |
---|---|---|---|---|---|---|
ContractID | Contract ID | long | Contract | |||
id | ID | long | ||||
RoleID | Role ID | long | Role |