ContractServiceBundleUnit

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 the number of units of a specific service bundle that are associated with a Recurring Service contract for a specific date range. They provide information used in billing for the service bundle.

The start and end dates of the date range are determined by either the beginning or end date of a billing period (as specified by the Contract Billing Period type) or by an adjustment to the number of units of the service bundle. That is, each billing period generates one ContractServiceBundleUnit unless the number of service bundle units is adjusted within the billing period. When the number of ServiceBundle units for one ServiceBundle on a contract is adjusted, a new ContractServiceBundleUnit is created with a start date equal to the effective date of the adjustment. The end date for the ContractServiceBundleUnit will be the end date of the billing period in which the adjustment becomes effective or, if another adjustment is made in the same billing period, the effective date of that adjustment. Refer to About recurring service contract entity relationships.

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: ContractServiceBundleUnit
Can Create:  
Can Update:  
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • Resources with security levels that specify limited or no contract visibility cannot create, update, or query this entity.
  • If the Multi-currency Installed Module is enabled, the following field will return the relevant Customer Currency values instead of the Internal Currency values: Price.
  • The following field will return the saved Internal Currency values: InternalCurrencyPrice.

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
ApproveAndPostDate Approve and Post Date datetime      

BusinessDivisionSubdivisionID

Business Division Subdivision ID

integer

 

BusinessDivisionSubdivision

 
ContractID Contract ID integer Contract  
ContractServiceBundleID Contract Service Bundle ID integer     ContractServiceBundle  
Cost Contract Period Cost double      
EndDate Contract Period End Date datetime    
id Contract Service Period ID integer    
InternalCurrencyPrice (Multi-currency module only) Internal Currency Contract Period Price double      
Price Contract Period Price double      
ServiceBundleID Service ID integer ServiceBundle
StartDate Contract Period Date datetime    
Units Units integer