Service

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

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: Service
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • On create(), AllocationCodeID, 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 AllocationCodeID for an existing Service to an inactive Recurring Service Contract code.
  • create() or 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 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
AllocationCodeID AllocationCode ID integer   AllocationCode  
CatalogNumberPartNumber Catalong Number/Part Number string (50)      

 
CreateDate Create Date datetime      
CreatorResourceID Creator Resource ID integer   Resource  
Description Description string (400)        
ExternalID External ID string (50)      

 
id Service ID long    
InternalID

Internal ID

string (50)

 

 

 

 
InvoiceDescription Invoice Description string (1000)        
IsActive Is Active boolean        
LastModifiedDate Update Date datetime      
ManufacturerServiceProvider

Manufacturer/Service Provider

string (100)

 

 

 

 
ManufacturerServiceProviderProductNumber

Manufacturer/Service Provider Product Number

string (50)

 

 

 

 
MarkupRate Markup Rate double      
Name Name string (150)      
PeriodType Period Type string (1)  
ServiceLevelAgreementID Service Level Agreement Id long      

SKU

SKU

string (50)

 

 

 

 
UnitCost Unit Cost double        
UnitPrice Unit Price double      
UpdateResourceID Update By ID integer   Resource  

URL

URL

string (500)

 

 

 

 
VendorAccountID Vendor Account ID integer     Account