ContractExclusionSetExcludedRole

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.

This entity describes a billing role that is excluded from the contract the set is applied to.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: ContractExclusionSetExcludedRole
Can Create:
Can Update:  
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

General

There is a limit of 500 roles per Exclusion Set.

Special field attributes

Field Conditions and Requirements
Excluded Role ID Must be an active Role.
Contract Exclusion Set Excluded Role ID Must be unique for the exclusion set.
Contract Exclusion Set ID Must be unique in your database.

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
ContractExclusionSetID Contract Exclusion Set ID integer   ContractExclusionSet  
ExcludedRoleID Excluded Role ID integer   Role  
id Contract Exclusion Set Excluded Role ID long