ContractFactor

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 ContractFactor entity describes an Autotask Block Hour Factor, an option used with Block Hours Contracts. With a Block Hours Contract, the customer pre-pays for a block of hours at a fixed hourly rate. A Block Hour Factor can compensate for the fixed rate by applying a multiplier to specific role rates. For example, if the contract hourly rate is $60, but an Engineer's hourly billing rate is $120, applying a block hour factor of 2 will debit 2 hours of contract time for each hour worked by an Engineer. In Autotask, you create and manage Block Hour Factors from a Block Hours Contract's Summary page in the Contract module.

Entity details

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

Entity Name: ContractFactor
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.
  • Each RoleID/ContractID combination can have only one ContractFactor; for example, you cannot have TWO factors for the "Support Person" role on one contract.
  • ContractFactor.ContractID must reference a Contract where Contract.ContractType is Block Hour type.

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
BlockHourFactor Hourly Offset double      
ContractHourlyRate Contract Hourly Rate double        
ContractID Contract ID integer Contract  
id id long    
InternalCurrencyContractHourlyRate Internal Currency Contract Hourly Rate double      
RoleID Role ID integer   Role