ContractExclusionSet

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

The ContractExclusionSet entity describes a reusable set of roles and work types that are excluded from the contract the set is applied to. Time entries associated with the contract cannot use the excluded roles and work types. If you attempt to save a time entry with a role or work type that is excluded by the associated contract, a warning message opens. If you continue 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: ContractExclusionSet
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Fields that cannot be queried

The following fields from this entity will return an error when queried.

Conditions and requirements

The contract exclusion set name must be unique.

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 (500)        
id Contract Exclusion Set ID long    
Name Name string (100)