Cost Methods

GET list	Return a list of all costs
GET get/[id]	Detailed information for a specific cost
POST add	Add a cost
PUT update	Update a cost
POST delete	Delete a cost
POST delete all	Delete all costs

GET list

Parameters:

page

Required

A maximum of 1000 cost items will be returned per request. The number of items returned will be indicated by the "Records" element. To fetch all the costs you will need to make multiple calls to the API with the page number incremented each time. When the "Records" element is set to 0 then all the costs have been returned.

Example URL:

http://api.workflowmax.com/cost.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]&page=1

Example Response:

<Response>
  <Status>OK</Status> 
  <Records>2</Records> 
  <Costs>
    <Cost>
      <ID>123</ID> 
      <Description>Widget</Description> 
      <Code /> 
      <Note /> 
      <UnitCost>100.00</UnitCost> 
      <UnitPrice>130.00</UnitPrice> 
      <Supplier>
        <ID>193</ID> 
        <Name>Widget Incorporated</Name> 
      </Supplier>
    </Cost>
    <Cost>
      <ID>124</ID> 
      <Description>Widget 2</Description> 
      <Code /> 
      <Note /> 
      <UnitCost>200.00</UnitCost> 
      <UnitPrice>260.00</UnitPrice> 
      <Supplier>
        <ID>193</ID> 
        <Name>Widget Incorporated</Name> 
      </Supplier>
    </Cost>
  </Costs>
</Response>

GET get/[id]

Example URL:

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

Example Response:

<Response>
  <Status>OK</Status> 
  <Cost>
    <ID>123</ID> 
    <Description>Widget</Description> 
    <Code /> 
    <Note /> 
    <UnitCost>100.00</UnitCost> 
    <UnitPrice>130.00</UnitPrice> 
    <Supplier>
      <ID>193</ID> 
      <Name>Widget Incorporated</Name> 
    </Supplier>
  </Cost>
</Response>

POST add

Example URL:

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

Example Message:

 
<Cost>
  <Description>Widget</Description> 
  <Code /> 
  <Note /> 
  <UnitCost>100.00</UnitCost> 
  <UnitPrice>130.00</UnitPrice> 
  <SupplierID />  <!-- Optional -->
</Cost>

The response will include the detailed information of the cost as per the GET get/[id] method

PUT update

Example URL:

PUT http://api.workflowmax.com/cost.api/update?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Message:

 
<Cost>
  <ID>123</ID> 
  <Description>Widget</Description> 
  <Code /> 
  <Note /> 
  <UnitCost>100.00</UnitCost> 
  <UnitPrice>130.00</UnitPrice> 
  <SupplierID />  <!-- Optional -->
</Cost>

The response will include the detailed information of the cost as per the GET get/[id] method

POST delete

Example URL:

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

Example Message:

 
<Cost>
  <ID>1234</ID>
</Cost>

POST delete all

Example URL:

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

Example Message:

 
<DeleteAll />

Developer API