ContractServiceBundleAdjustment

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 adjustment to the quantity of units of a ServiceBundle that are added to a Recurring Service type Contract. It can only be created; it cannot be queried or updated. Changes made to the Contract using the ContractServiceBundleAdjustment entity affect only the quantity of Service Bundle units and not the price/adjusted price of the bundle or services.

In Autotask, users specify the number of Service Bundle units that are 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.

Entity details

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

Entity Name: ContractServiceBundleAdjustment
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.
  • ContractServiceBundleAdjustment can be created without the specified ContractServiceBundle entity in place. If the API creates a ContractServiceBundleAdjustment entity and the API cannot find the correct ContractServiceBundle, it will create the ContractServiceBundle entity.

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).
ContractServiceBundleID If ContractServiceBundleID is provided, ContractID and ServiceBundleID are not required (in other words, either ContractID and ServiceBundleID OR ContractServiceBundleID is required
AllowRepeatService AllowRepeatService must equal True in order to create two or more instances of the same Service on a contract.

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
AdjustedUnitPrice Adjusted Unit Price double        
AllowRepeatServiceBundle Allow Repeat Service Bundle boolean        
ContractID Contract ID integer   Contract  
ContractServiceBundleID Contract Service Bundle ID integer     ContractServiceBundle  
EffectiveDate Start Date datetime      
id id long    
QuoteItemID Quote Item ID integer     QuoteItem  
ServiceBundleID Service Bundle ID integer   ServiceBundle
UnitChange Unit Change integer