ServiceBundleService
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
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 ServiceBundle.
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: | ServiceBundleService |
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 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 |
---|---|---|---|---|---|---|
id | Service Bundle Service ID | long | ||||
ServiceBundleID | Service Bundle ID | long | ||||
ServiceID | Service ID | long |