ContractServiceBundle

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 Bundle added to a Recurring Service type contract. Autotask Service Bundles group multiple Services for purchase. In Autotask, Administrators create and manage Autotask Service Bundles from the Admin module: Products and Services > Services > Service Bundles. Service Bundles are added to a Contract when the contract is create or through the Contract Summary view.

The entity specifies an AdjustedPrice where applicable. It does not specify the number of units of the service bundle that have been added to the contract. To add ContractServiceBundle units to the contract, or remove units, use the ContractServiceBundleAdjustment 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: ContractServiceBundle
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.
  • On update(), all fields are Read Only except for AdjustedPrice and InvoiceDescription.
  • On Create(), ContractID must reference a Recurring Service type Contract (Contract.ContractType = 7).

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).
InternalCurrencyAdjustedPrice, InternalCurrencyUnitPrice. If the Multi-currency Installed Module is enabled, these fields will return the saved Internal Currency value.
ServiceBundleID The same ServiceBundleID can be added to the same contract more than once.
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 Contract Service Bundle 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  
ServiceBundleID Service Bundle ID integer ServiceBundle
UnitPrice Unit Price double