Services

This entity describes a deliverable item that represents a pre-defined unit of work performed for a set price, for example, a "Disk Backup" or "Virus Check" performed for one computer. Services are billed at regular intervals. In Autotask, a Service can be added as a component of a recurring service type contract. The customer is billed for each unit of service associated with the contract instead of billing separately for labor and parts each time the service is provided.

Services are created in the Autotask Admin module > Products and Services > Services 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: Services

Entity Path:

/atservicesrest/v1.0/Services
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:

Conditions and requirements

  • On create, billingCodeID, name, periodType, and unitPrice are required.
  • A newly created service is active by default.
  • On create, an active Recurring Service contract Allocation Code is required.
  • If a request is made to update a Service that is associated with an inactive Recurring Service Contract code, you can pass in the inactive code. You cannot, however, set billingCodeID for an existing Service to an inactive Recurring Service Contract code.
  • Create and update require System Administrator level security. There are no restrictions on query.
  • unitPrice allows a negative value (allows users to apply discount).

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 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
billingCodeID integer   ProjectCharges  
catalogNumberPartNumber string (50)        
createDate datetime      
creatorResourceID integer   Resources  
description string (400)        
externalID string (50)        
id long    
internalID string (50)        
invoiceDescription string (1000)        
isActive boolean        
lastModifiedDate datetime      
manufacturerServiceProvider string (100)        
manufacturerServiceProviderProductNumber string (50)        
markupRate decimal      
name string (150)      
periodType integer  
serviceLevelAgreementID long      
sku string (50)        
unitCost decimal        
unitPrice decimal      
updateResourceID integer   Resources  
url string (500)        
vendorCompanyID integer     Companies  

Additional resources