ContractServiceUnits

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.

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

Entity Path:

/atservicesrest/v1.0/ContractServiceUnits

Parent Entity:

Contracts

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 ContractServiceUnits entity for every period. The response will enumerate the individual units for that period. When the number of units for a ContractServiceUnits period is 0, the query response will not return this entity. This behavior is intentional.

Special field attributes

Field Conditions and Requirements

cost

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.
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

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
approveAndPostDate datetime      
contractID integer Contracts  
contractServiceID integer     ContractServices  
cost float      
endDate datetime    
id long    
internalCurrencyPrice (Multi-currency module only) decimal      

organizationalLevelAssociationID

integer

 

OrganizationalLevelAssociations

 
price decimal      
serviceID integer Services
startDate datetime    
units integer    
vendorCompanyID integer   Companies  

Additional resources