Quotes

This entity describes a Quote in Autotask. The quote allows users to specify and track multiple products, services, labor items, etc., to further define an Opportunity. A Quote must be associated with an Autotask Opportunity entity. The quote total can update the Opportunity's forecasted amount. Quotes can be used internally or presented to the customer as an eQuote.

Quotes are created and managed in Autotask through the CRM module.

What are quick quotes?

The term Quick Quotes refers to basic Autotask quotes (they contain only products, one-time discounts, shipping, and/or charges) that are closed in Autotask via the Won Quote or Lost Quote wizards. Quick quotes are specific to the Autotask UI. They cannot be created via the API.

The Won Quote wizard streamlines the process of creating and closing simple quotes in Autotask. It closes the associated opportunity, creates billing items from quoted items, and can automatically approve and post those items and generate an invoice (subject to security level requirements). The Won Quote wizard cannot perform all tasks completed by the Won Opportunity wizard, for example, setting up a recurring service contract or changing opportunity settings. For more information on Quick Quotes, refer to Win or Lose Quotes (Quick Quotes), in the Online 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: Quotes

Entity Path:

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

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Parent None
Children QuoteItems
URLs Quotes​/query (GET, POST)
Quotes​/{id} (GET)
Quotes​/query​/count (GET, POST)
Quotes (PUT, POST, PATCH) Quotes​/entityInformation (GET)
Quotes​/entityInformation​/fields (GET) Quotes​/entityInformation​/userDefinedFields (GET)

Fields that cannot be queried

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

  • calculateTaxSeparately
  • groupByProductCategory
  • showEachTaxInGroup
  • showTaxCategory

Conditions and requirements

General

  • This entity's support for the VARStreet integration sunset with the release of Autotask 2022.2.

Special field attributes

Field Conditions and Requirements

companyID

On update, companyID is Read-Only.

calculateTaxSeparately, showTaxCategory, showEachTaxInGroup

Quote.calculateTaxSeparately, Quote.showTaxCategory, and Quote.showEachTaxInGroup are determined by QuoteTemplate. These three fields are Read-Only in the Quote entity

contactID
  • contactID must be an isActive Autotask Contact from the Company referenced by the Quote companyID or from the parentCompany of the Company referenced by the Quote companyID.
    		•

    expirationDate

    expirationDate must be >= effectiveDate

    externalQuoteNumber

    externalQuoteNumber for all quotes associated with the same opportunity must be unique.

    groupByProductCategory

    groupByProductCategory is retired. The groupByID field will determine how quote items are grouped on the Quote. groupByID maps to groupByProductCategory: if groupByID is set to the ID for either "Do Not Group" or "Group by Period Type Only," groupByProductCategory will be set to false. Otherwise it will be set to true.

    opportunityID

    On update, opportunityID is Read-Only.

    opportunityID must be an isActive Autotask Opportunity.

    opportunityID is required via the API. In the UI you can create a quote with no associated opportunity and Autotask will create the Opportunity. The API will not automatically create an Opportunity.

    primaryQuote

    An Opportunity with multiple quotes associated must have one quote with primaryQuote = True.

    The Opportunity entity field useQuoteTotals will evaluate against Opportunity.primaryQuote.

    proposalProjectID

    proposalProjectID can accept only Proposals of Type = 2 (Project).

    showTaxCategory

    showTaxCategory defaults to false.

    taxRegionID

    In Autotask, Tax Regions have replaced Tax Groups. To preserve existing API code, Quote.taxRegionID passes the taxRegionID.

    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
    approvalStatus integer      
    approvalStatusChangedByResourceID integer   Resources  
    approvalStatusChangedDate datetime      
    billToLocationID integer   QuoteLocations  
    calculateTaxSeparately boolean        
    comment string (1000)        
    companyID integer     Companies
    contactID integer     Contacts  

    createDate

    datetime

     

     

     
    creatorResourceID integer   Resources  
    description string (2000)        
    effectiveDate datetime      
    expirationDate datetime      
    extApprovalContactResponse integer    
    extApprovalResponseDate datetime      
    extApprovalResponseSignature string (250)      
    externalQuoteNumber string (50)        
    groupByID integer      
    id long    
    impersonatorCreatorResourceID integer   Resources

     

    isActive

    boolean

     

     

     

     
    lastActivityDate datetime      
    lastModifiedBy integer   Resources  

    lastPublishedByResourceID

    integer

     

    Resources

     
    lastPublishedDateTime datetime

    		 

     

     
    name string (100)      
    opportunityID integer Opportunities  
    paymentTerm integer      
    paymentType integer      
    primaryQuote boolean        
    proposalProjectID integer     Projects  
    purchaseOrderNumber string (50)        
    quoteNumber integer      
    quoteTemplateID integer     QuoteTemplates  
    shippingType integer     ShippingTypes
    shipToLocationID integer   QuoteLocations  
    showEachTaxInGroup boolean      
    showTaxCategory boolean      
    soldToLocationID integer   QuoteLocations  
    taxRegionID integer      

    Additional resources