Purchase Order Methods

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
POST add	Add a purchase orders
POST adddraft	Add a draft purchase orders

GET current

Parameters:

detailed=true

Optional

Return detailed information on purchase order. See GET get/[order number] method for example of detailed purchase order response.

Example URL:

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

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>
        <ID>5</ID> 
        <Name>A B C Limited</Name> 
      </Supplier>
      <Job>
        <ID>J000123</ID> 
        <Name>Design Job</Name> 
      </Job>
    </PurchaseOrder>
  </PurchaseOrders>
</Response>

GET get/[order number]

Example URL:

http://api.workflowmax.com/purchaseorder.api/get/PO000123?apiKey=[your API key]&accountKey=[WorkflowMax account key]

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>
      <ID>5</ID> 
      <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

Parameters:

detailed=true

Optional

Return detailed information on purchase order. See GET get/[order number] method for example of detailed purchase order response.

Example URL:

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

GET list

Parameters:

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:

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

POST add

Example URL:

POST http://api.workflowmax.com/purchaseorder.api/add?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Message:

<PurchaseOrder>
  <JobNumber>J000123</JobNumber>
  <SupplierID>123</SupplierID>
  <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

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

Example URL:

POST http://api.workflowmax.com/purchaseorder.api/adddraft?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Developer API