API Documentation

Quote Methods

Method	Description
GET current	Return a list of current quotes
GET get/[quote number or uuid]	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

Return a list of current quotes

Parameters

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

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/quote.api/current

Example Response

<Response>
  <Status>OK</Status> 
  <Quotes>
    <Quote>
      <ID>Q000123</ID>
      <UUID>6af333db-e272-4983-b374-6981301227b3</UUID> 
      <Type>Estimate</Type> 
      <State>Issued</State> 
      <Name>Name</Name>
      <Description>Description</Description>
      <Budget />
      <OptionExplanation />
      <LeadUUID>754a48e5-0fce-421c-b32b-f84d6b576ef3</LeadUUID>
      <Date>2007-09-15T00:00:00</Date> 
      <ValidDate>2007-09-22T00:00:00</ValidDate>
      <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>
        <UUID>23a720b6-a58e-4c4f-a938-bddbea7b4c66</UUID>
        <Name>A C Smith Limited</Name>
      </Client>
      <Contact>
        <UUID>a81b6ebf-faf3-4c79-ad25-5d0b1ac3ed67</UUID>
        <Name>Andrew Smith</Name> 
      </Contact>
    </Quote>
  </Quotes>
</Response>

GET get/[quote number or uuid]

Detailed information for a specific quote

EXAMPLE URLS

https://api.xero.com/workflowmax/3.0/quote.api/get/Q000123

https://api.xero.com/workflowmax/3.0/quote.api/get/6af333db-e272-4983-b374-6981301227b3

Example Quote Response

<Response>
  <Status>OK</Status> 
  <Quote>
    <ID>Q000123</ID> 
    <UUID>6af333db-e272-4983-b374-6981301227b3</UUID>
    <Type>Estimate</Type> 
    <State>Issued</State> 
    <Name>Name</Name>
    <Description>Description</Description>
    <Budget />
    <OptionExplanation />
    <LeadUUID>754a48e5-0fce-421c-b32b-f84d6b576ef3</LeadUUID>
    <Date>2007-09-15T00:00:00</Date> 
    <ValidDate>2007-09-22T00:00:00</ValidDate>
    <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>
      <UUID>23a720b6-a58e-4c4f-a938-bddbea7b4c66</UUID>
      <Name>A C Smith Limited</Name> 
    </Client>
    <Contact>
      <UUID>a81b6ebf-faf3-4c79-ad25-5d0b1ac3ed67</UUID>
      <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> 
        <Note>Note</Note>
        <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>
        <Note>Note</Note> 
        <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

Return a list of draft quotes

Parameters

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

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/quote.api/draft

GET list

Return a list of current and archived quotes

Parameters

Parameter	Required?	Description
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

https://api.xero.com/workflowmax/3.0/quote.api/list?from=20090801&to=20090901