PurchaseApprovals

This entity describes the basic fields required to approve or reject ticket, project, and contract costs created in Autotask. It allows integrators to provide the basic approve or reject functionality that is found in Autotask on the Purchase Approvals page. Refer to Purchase Approvals in the Help.

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

Entity Path:

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

Fields that cannot be queried

The following fields from this entity will return an error when queried.

  • isApproved
  • rejectNote

Conditions and requirements

  • On query, the PurchaseApprovals entity returns only ticket, project, and contract cost that are waiting approval.
  • On update, if isApproved is set to false, then rejectNote becomes required.
  • costType is an unusual Picklist that uses string values instead of the usual numeric ID.

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
costType string (8)    
id long    
isApproved boolean      
rejectNote string (5000)        

Additional resources