ServiceBundles

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.

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

Entity Path:

/atservicesrest/v1.0/ServiceBundles
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:
(maximum 100)

Conditions and requirements

  • No two ServiceBundle entities can have the same name.
  • A ServiceBundle associated to a Contract or QuoteItem entity cannot be deleted.
  • BillingCode must be isActive 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, ConfigurationItem, 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 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
billingCodeID integer   ProjectCharges  
catalogNumberPartNumber string (50)        
createDate datetime      
creatorResourceID integer   Resources  
description string (200)        
externalID string (50)        
id long      
internalID string (50)        
invoiceDescription string (1000)        
isActive boolean        
lastModifiedDate datetime      
manufacturerServiceProvider string (100)        
manufacturerServiceProviderProductNumber string (50)        
name string (150)      
percentageDiscount decimal        
periodType integer  
serviceLevelAgreementID long      
sku string (50)        
unitCost decimal      
unitDiscount decimal        
unitPrice decimal        
updateResourceID integer   Resources  
url string (500)        

Additional resources