Quote Methods

GET current Return a list of current quotes
GET get/[quote number] Detailed information for a specific quote
GET draft Return a list of draft quotes
GET list Return a list of current and archived quotes

 

GET current

 

Parameters:

detailed=true Optional Return detailed information on quote.  See GET get/[quote number] method for example of detailed quote response.

 

Example URL:

https://api.workflowmax.com/quote.api/current?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

Example Response:

<Response>
  <Status>OK</Status> 
  <Quotes>
    <Quote>
      <ID>Q000123</ID> 
      <Type>Estimate</Type> 
      <State>Issued</State> 
      <Date>2007-09-15T00:00:00</Date> 
      <ValidDate>2007-09-22T00:00:00</ValidDate> 
      <Budget />
      <OptionExplanation />
      <EstimatedCost>100.00</EstimatedCost> 
      <EstimatedCostTax>12.50</EstimatedCostTax> 
      <EstimatedCostIncludingTax>112.50</EstimatedCostIncludingTax> 
      <Amount>200.00</Amount> 
      <AmountTax>25.00</AmountTax> 
      <AmountIncludingTax>225.00</AmountIncludingTax> 
      <Client>
        <ID>5</ID> 
        <Name>A C Smith Limited</Name> 
      </Client>
      <Contact>
        <ID>234</ID> 
        <Name>Andrew Smith</Name> 
      </Contact>
    </Quote>
  </Quotes>
</Response>

 

GET get/[quote number]

 

Example URL:

https://api.workflowmax.com/quote.api/get/Q000123?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

Example Quote Response:

<Response>
  <Status>OK</Status> 
  <Quote>
    <ID>Q000123</ID> 
    <Type>Estimate</Type> 
    <State>Issued</State> 
    <Date>2007-09-15T00:00:00</Date> 
    <ValidDate>2007-09-22T00:00:00</ValidDate> 
    <Budget />
    <OptionExplanation />
    <LeadID />   <!-- ID of lead associated with quote -->
    <EstimatedCost>100.00</EstimatedCost> 
    <EstimatedCostTax>12.50</EstimatedCostTax> 
    <EstimatedCostIncludingTax>112.50</EstimatedCostIncludingTax> 
    <Amount>200.00</Amount> 
    <AmountTax>25.00</AmountTax> 
    <AmountIncludingTax>225.00</AmountIncludingTax> 
    <Client>
      <ID>5</ID> 
      <Name>A C Smith Limited</Name> 
    </Client>
    <Contact>
      <ID>234</ID> 
      <Name>Andrew Smith</Name> 
    </Contact>
    <Tasks>
      <Task>
        <Name>Design</Name> 
        <Description></Description> 
        <EstimatedMinutes>60</EstimatedMinutes> 
        <BillableRate>150</BillableRate> 
        <Billable>Yes</Billable> 
        <Amount>150.00</Amount> 
        <AmountTax>18.75</AmountTax> 
        <AmountIncludingTax>168.75</AmountIncludingTax> 
      </Task>
    </Tasks>
    <Costs>
      <Cost>
        <Description>Courier</Description> 
        <Code>COURIER</Code> 
        <Billable>Yes</Billable> 
        <Quantity>1</Quantity> 
        <UnitCost>50.00</UnitCost> 
        <UnitPrice>50.00</UnitPrice> 
        <Amount>50.00</Amount> 
        <AmountTax>6.25</AmountTax> 
        <AmountIncludingTax>56.25</AmountIncludingTax> 
      </Cost>
    </Costs>
    <Options>
      <Option>
        <Description>Printing</Description> 
        <Code>PRINT</Code> 
        <Quantity>1</Quantity> 
        <UnitCost>50.00</UnitCost> 
        <UnitPrice>100.00</UnitPrice> 
        <Amount>100.00</Amount> 
        <AmountTax>12.50</AmountTax> 
        <AmountIncludingTax>112.50</AmountIncludingTax> 
      </Option>
    </Options>
  </Quote>
</Response>

 

GET draft

 

Parameters:

detailed=true Optional Return detailed information on quote See GET get/[quote number] method for example of detailed quote response.

 

Example URL:

https://api.workflowmax.com/quote.api/draft?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

GET list

 

Parameters:

from=YYYYMMDD Required Return quotes created on or after this date.
to=YYYYMMDD Required Return quote created on or before this date.
detailed=true Optional Return detailed information on quote.  See GET get/[get number] method for example of detailed quote response.

 

Example URL:

GET https://api.workflowmax.com/quote.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]&from=20090801&to=20090901

  Developer API
Job Management Software developed by Xero - Copyright 2013