ServiceBundleServices

This entity describes a Service added to a ServiceBundle. A ServiceBundle describes Service items that are priced and billed as one component of Recurring Service type contract. Refer to ServiceBundles.

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

Entity Path:

/atservicesrest/v1.0/ServiceBundleServices

Parent Entity:

ServiceBundles

Can Create:
Can Update:  
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

  • A ServiceBundle cannot have duplicate ServiceBundleServices assigned; that is, you can assign an individual ServiceBundleService to a ServiceBundle only once. If you attempt to add a ServiceBundleService to the same ServiceBundle more than once, an error message opens.
  • You cannot delete the last ServiceBundleService assigned to a ServiceBundle.
  • Access to the Admin module is required to add a ServiceBundleService to a Service Bundle.
  • The API respects the setting "Use sum of selected service unit prices." When this ServiceBundle setting is selected in the Autotask UI , the ServiceBundle extended price is automatically readjusted when a ServiceBundleService is assigned to or removed from the ServiceBundle.

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
id long    
serviceBundleID long    
serviceID long    

Additional resources