ContractBlockHourFactors

The ContractBlockHourFactors 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.

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

Entity Path:

/atservicesrest/v1.0/ContractBlockHourFactors

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

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
blockHourMultiplier decimal      
contractHourlyRate decimal        
contractID integer Contracts  
id long      
internalCurrencyContractHourlyRate decimal    
roleID integer   Roles  

Additional resources