ServiceBundle

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 a group of Service items that are priced and billed as one component of Recurring Service type contract. The group usually consists of Services that are performed together or at the same interval. The customer is billed for each service bundle associated with the contract instead of billing separately for each service in the bundle. The price for the bundle may offer a discount.

Service Bundles are created in the Autotask Admin module > Products and Services > Service Bundles page.

Entity details

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

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

Conditions and requirements

  • No two ServiceBundle entities can have the same name.
  • A ServiceBundle associated to a Contract or QuoteItem entity cannot be deleted.
  • AllocationCode must be Active and Type 5 (Recurring Contract Service Code)
  • Empty ServiceBundle entities cannot be referenced for updates or creates in the following entities: Contract, ContractServiceBundle, ContractServiceBundleAdjustment, ContractServiceBundleUnit, InstalledProduct, QuoteItem, Ticket, TimeEntry
  • UnitPrice allows a negative value (allows users to apply discount).

Special field attributes

Field Conditions and Requirements

UnitCost

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.

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
AllocationCodeID AllocationCode ID integer   AllocationCode  
CatalogNumberPartNumber Catalong Number/Part Number string (50)      

 
CreateDate Create Date datetime      
CreatorResourceID Creator Resource ID integer   Resource  
Description Description string (200)        
ExternalID External ID string (50)      

 
id Service Bundle ID long      
InternalID

Internal ID

string (50)

 

 

 

 
InvoiceDescription Invoice Description (1000) string (1000)        
IsActive Is Active boolean        
LastModifiedDate Update Date datetime      
ManufacturerServiceProvider

Manufacturer/Service Provider

string (100)

 

 

 

 
ManufacturerServiceProviderProductNumber

Manufacturer/Service Provider Product Number

string (50)

 

 

 

 
Name Name string(150)      
PercentageDiscount Discount Percent double        
PeriodType Period Type string (1)  
ServiceLevelAgreementID Service Level Agreement Id long      

SKU

SKU

string (50)

 

 

 

 
UnitCost Unit Cost double      
UnitDiscount Discount Dollars double        
UnitPrice Unit Price double        
UpdateResourceID Update By ID integer   Resource  

URL

URL

string (500)