ContractServiceUnit
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
This entity describes the number of units of a specific service 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 Period Type) or by an adjustment to the number of units of the service. That is, each billing period generates a ContractServiceUnit unless the number of Service units is adjusted within the billing period. When the number of Service units for one service on a contract is adjusted, a new ContractServiceUnit is created with a start date equal to the effective date of the adjustment. The end date for the ContractServiceUnit will be the end date of the current billing period 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: | ContractServiceUnit |
| Can Create: | |
| Can Update: | |
| Can Query: |
|
| Can Delete: | |
| Can Have UDFs: |
Conditions and requirements
General
- Resources with security levels that specify limited or no contract visibility cannot create, update, or query this entity.
-
Queries will return a ContractServiceUnit entity for every period. The response will enumerate the individual Units for that period. When the number of Units for a ContractServiceUnit period is 0, the query response will not return this entity. This behavior is intentional.
Special field attributes
| Field | Conditions and Requirements |
|---|---|
| InternalCurrencyPrice | If the Multi-currency Installed Module is enabled, this field will return the saved Internal Currency value. |
| Price |
If the Multi-currency Installed Module is enabled, this field will return the relevant Customer Currency value instead of the Internal Currency value. AdjustedUnitPrice allows a negative value (allows users to apply discount). |
|
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. |
| Units |
When the number of units for a period is 0, the query response will not return this entity. |
Field definitions
About this table
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 |
|
|
|
|
| ContractID | Contract ID | integer |
|
|
Contract | |
| ContractServiceID | Contract Service ID | integer | ContractService | |||
| Cost | Period Cost | float |
|
|||
| EndDate | End Date | datetime |
|
|
||
| id | Contract Service Unique id | long |
|
|
||
| InternalCurrencyPrice (Multi-currency module only) | Internal Currency Price | float |
|
|||
| Price | Price | float |
|
|||
| ServiceID | Service ID | integer |
|
|
Service |
|
| StartDate | Start Date | datetime |
|
|
||
| Units | Units | integer |
|
|
||
| VendorAccountID | Vendor Account ID | integer |
|
Account |
