ContractRate

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 rate for an Autotask Contract. A Contract Rate is associated with a Role and is specific to a contract, allowing you to override your company's standard role rates for labor tracked against the contract. Rates are used with Time and Materials, Fixed Price, and Retainer type contracts. In Autotask, you add and manage Contract Rates from the Contract Summary page.

Entity details

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

Entity Name: ContractRate
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 ContractRate; for example, you cannot have TWO rates for the "Support Person" role on one contract.
  • ContractRate.ContractID cannot reference a Contract where Contract.ContractType is Recurring Service or Block Hour. It can reference any other Contract type, that is, Time and Materials, Fixed Price, or Retainer.
  • If the Multi-currency Installed Module is enabled, the following fields will return the relevant Customer Currency values instead of the Internal Currency values: ContractHourlyRate.
  • The following fields will return the saved Internal Currency values: InternalCurrencyContractHourlyRate.

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
ContractHourlyRate Rate Offset double      
ContractID Contract ID integer Contract  
id id long    
InternalCurrencyContractHourlyRate (Multi-currency module only) Internal Currency Contract Hourly Rate double      
RoleID Role ID integer   Role