ContractService

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 an Autotask Service that has been added to a Recurring Service type contract. In Autotask, users add and manage Autotask Services from the Admin module: Products and Services > Services > Services. You add Services to a Contract when your create the contract or from the Contract Summary page.

The entity specifies an AdjustedPrice if applicable. It does not specify the number of units of the service that have been added to the contract. To add Contract Service units to the contract, or remove units, use the ContractServiceAdjustment entity.

BEFORE YOU BEGIN  It's important to understand how Recurring Service Contracts interact with Autotask and influence other entities. Before you use the API to create or manage this type of contract, we recommend that you read our Adding a recurring service contract article. Then, review the Conditions and requirements and Special field attributes sections of this article to get started.

Entity details

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

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

Conditions and requirements

General

  • Resources with security levels that specify limited or no contract visibility cannot create, update, or query this entity.
  • On Create(), ContractID must reference a Recurring Service type Contract (Contract.ContractType = 7).
  • On Update(), all fields are Read Only except for AdjustedPrice and InvoiceDescription.

Special field attributes

Field Conditions and Requirements
AdjustedPrice

If the Multi-currency Installed Module is enabled, this field will return the relevant Customer Currency value instead of the Internal Currency value.

AdjustedUnitPrice allows a negative value (allows users to apply discount).

Cost

This entity field will return no information if the user account making the query does not have sufficient privileges to view cost data in the Autotask UI. Additionally, if an update request does not have the necessary permissions, the API will ignore the call's values for the field even if they are blank or would be otherwise required.
InternalCurrencyAdjustedPrice, InternalCurrencyUnitPrice. If the Multi-currency Installed Module is enabled, these fields will return the saved Internal Currency value.
ServiceID The same Service ID can be added to a contract more than once.
UnitCost

UnitCost does not allow a negative value.

On create, if no UnitCost is supplied, it will default to the UnitCost of the associated service.
UnitPrice

UnitPrice allows a negative value (allows users to apply discount).

If the Multi-currency Installed Module is enabled, this field will return the relevant Customer Currency value instead of the Internal Currency value.

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
AdjustedPrice Adjusted Price double        
ContractID Contract ID integer Contract  
id id long    
InternalCurrencyAdjustedPrice
(Multi-currency module only)		 Internal Currency Adjusted Price double      
InternalCurrencyUnitPrice
(Multi-currency module only)		 Internal Currency Unit Price double      
InternalDescription Internal Description string (100)        
InvoiceDescription Invoice Description string (1000)        
QuoteItemID Quote Item ID long   QuoteItem  
ServiceID Service ID integer Service
UnitCost Unit Cost double        
UnitPrice Unit Price double