ContractRates

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.

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

Entity Path:

/atservicesrest/v1.0/ContractRates

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 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 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
contractHourlyRate decimal      
contractID integer Contracts  
id long    
internalCurrencyContractHourlyRate (Multi-currency module only) decimal      
roleID integer   Roles  

Additional resources