PurchaseApproval

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

Entity details

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

Entity Name: PurchaseApproval
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 PurchaseApproval 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 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
CostType Cost Type string (8)    
id Purchase Approval ID long    
IsApproved Is Approved boolean      
RejectNote Reject Note string (5000)