ContractServiceAdjustments

This entity describes an adjustment to the quantity of units of a ContractService entity that are added to a Recurring Service type Contract. It can only be created; it CANNOT be queried or updated.

In Autotask, users specify the number of Service Units associated with a Contract through the Contracts module when creating or managing a Recurring Service type Contract: Contracts module > Contracts > New Recurring Service Contract, or Contracts module > Contracts > Search Contracts > Open Contract > Services.

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.

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

Entity Path:

/atservicesrest/v1.0/ContractServiceAdjustments
Parent Entity: Contracts
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.
  • The ContractServiceAdjustment can be created without the specified ContractService entity in place. If the API creates a ContractServiceAdjustment entity and the API cannot find the correct ContractService entity, it will create it.

Special field attributes

Field Conditions and Requirements
adjustedUnitPrice

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).
allowRepeatService allowRepeatService must equal True in order to create two or more instances of the same Service on a contract.
contractServiceID If contractServiceID is provided, contractID and serviceID are not required (in other words, either contractID and serviceID OR ContractService ID is required
unitPrice unitPrice allows a negative value (allows users to apply discount).

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
adjustedUnitCost decimal        
adjustedUnitPrice decimal        
allowRepeatService boolean        
contractID integer  
If no contractServiceID is provided		 Contracts  
contractServiceID       ContractServices  
effectiveDate datetime      
id long    
quoteItemID integer     QuoteItems  
serviceID integer  
If no contractServiceID is provided		 Services
unitChange integer      

Additional resources