API Documentation

Purchase Order Methods

Method	Description
GET current	Return a list of current purchase orders
GET get/[order number]	Detailed information for a specific purchase order
GET draft	Return a list of draft purchase orders
GET list	Return a list of current and archived purchase orders
GET job/[job number]	Returns a list of purchase orders for a specific job
POST add	Add a purchase orders
POST adddraft	Add a draft purchase orders

GET current

Return a list of current purchase orders

Parameters

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

EXAMPLE URL

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

Example Response

<Response>
  <Status>OK</Status> 
  <PurchaseOrders>
    <PurchaseOrder>
      <ID>PO000123</ID> 
      <State>Issued</State> 
      <Date>2007-09-15T00:00:00</Date> 
      <Description />
      <DeliveryAddress />
      <Amount>200.00</Amount> 
      <AmountTax>25.00</AmountTax> 
      <AmountIncludingTax>225.00</AmountIncludingTax> 
      <Supplier>
        <UUID>a98b5db3-c3b7-4f90-acee-f1e741a4fc7c</UUID>
        <Name>A B C Limited</Name>
      </Supplier>
      <Job>
        <ID>J000123</ID> 
        <Name>Design Job</Name> 
      </Job>
    </PurchaseOrder>
  </PurchaseOrders>
</Response>

GET get/[order number]

Detailed information for a specific purchase order

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/purchaseorder.api/get/PO000123

Example Response

<Response>
  <Status>OK</Status> 
  <PurchaseOrder>
    <ID>PO000123</ID> 
    <State>Issued</State> 
    <Date>2007-09-15T00:00:00</Date> 
    <Description />
    <DeliveryAddress />
    <Amount>200.00</Amount> 
    <AmountTax>25.00</AmountTax> 
    <AmountIncludingTax>225.00</AmountIncludingTax> 
    <Supplier>
      <UUID>a98b5db3-c3b7-4f90-acee-f1e741a4fc7c</UUID>
      <Name>A B C Limited</Name> 
    </Supplier>
    <Job>
      <ID>J000123</ID> 
      <Name>Design Job</Name> 
    </Job>
    <Costs>
      <Cost>
        <Description>Widget</Description> 
        <Code>WDGT</Code> 
        <Quantity>4</Quantity> 
        <UnitCost>50.00</UnitCost> 
        <Amount>200.00</Amount> 
        <AmountTax>25</AmountTax> 
        <AmountIncludingTax>250.00</AmountIncludingTax> 
        <Note /> 
      </Cost>
    </Costs>
  </PurchaseOrder>
</Response>

GET draft

Return a list of draft purchase orders

Parameters

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

EXAMPLE URL

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

GET list

Return a list of current and archived purchase orders

Parameters

Parameter	Required?	Description
from=YYYYMMDD	Required	Return purchase orders created on or after this date.
to=YYYYMMDD	Required	Return purchase orders created on or before this date.
detailed=true	Optional	Return detailed information on purchase order. See GET get/[order number] method for example of detailed purchase order response.

EXAMPLE URL

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

GET job/[job number]

Returns a list of purchase orders for a specific job

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/purchaseorder.api/job/J000001

POST add

Add a purchase orders

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/purchaseorder.api/add

Example Message

<PurchaseOrder>
  <JobNumber>J000123</JobNumber>
  <SupplierUUID>e178dca8-7d99-4ab9-b811-9fdc0da09c65</SupplierUUID>
  <Description />
  <DeliveryAddress />
  <Date>20110123</Date>
  <Items>
    <Item>
      <Description>Widget</Description> 
      <Quantity>4</Quantity> 
      <UnitCost>50.00</UnitCost> 
      <Code /> 
      <Note />    
    </Item>  
  </Items>  
</PurchaseOrder>

The response will include the ID of the newly created purchase order

POST adddraft

Add a draft purchase orders

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/purchaseorder.api/adddraft

The message for adding a draft purchase order is the same as that for the POST add method

Quote Methods

Method	Description
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

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

Detailed information for a specific quote

EXAMPLE URL

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

Example Quote Response

<Response>
  <Status>OK</Status> 
  <Quote>
    <ID>Q000123</ID> 
    <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