ContractExclusionRoles

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).

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

Entity Path:

/atservicesrest/v1.0/ContractExclusionRoles

Parent Entity:

Contracts

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 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
contractID long Contracts  
id long    
roleID long Roles  

Additional resources