POST api/v1/PurchaseOrders

Return a list of all outstanding purchase orders and lines

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

<PurchaseOrderParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
</PurchaseOrderParams>

Response Information

Resource Description

Returns:
200 OK Returns error list if failed
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

PurchaseOrders

Name	Description	Type	Additional information
PurchaseOrderList		Collection of PurchaseOrder	None.

Response Formats

application/json, text/json

Sample:

{
  "PurchaseOrderList": [
    {
      "OrderID": 1,
      "OrderNo": "sample string 2",
      "AccountNo": "sample string 3",
      "OrderDesc": "sample string 4",
      "Currency": "sample string 5",
      "DateCreated": "sample string 6",
      "FixedExchangeRate": true,
      "FixedExchangeRateValue": 8.0,
      "POLines": {
        "POLineList": [
          {
            "ProductID": 1,
            "ProductCode": "sample string 2",
            "ProductDescription": "sample string 3",
            "QtyRequired": 4,
            "QtyReceived": 5,
            "QtyInvoiced": 6,
            "DateRequired": "sample string 7",
            "DateExpected": "sample string 8",
            "DespatchStatus": "sample string 9",
            "UnitPrice": 10.0,
            "LinePrice": 11.0
          },
          {
            "ProductID": 1,
            "ProductCode": "sample string 2",
            "ProductDescription": "sample string 3",
            "QtyRequired": 4,
            "QtyReceived": 5,
            "QtyInvoiced": 6,
            "DateRequired": "sample string 7",
            "DateExpected": "sample string 8",
            "DespatchStatus": "sample string 9",
            "UnitPrice": 10.0,
            "LinePrice": 11.0
          }
        ]
      }
    },
    {
      "OrderID": 1,
      "OrderNo": "sample string 2",
      "AccountNo": "sample string 3",
      "OrderDesc": "sample string 4",
      "Currency": "sample string 5",
      "DateCreated": "sample string 6",
      "FixedExchangeRate": true,
      "FixedExchangeRateValue": 8.0,
      "POLines": {
        "POLineList": [
          {
            "ProductID": 1,
            "ProductCode": "sample string 2",
            "ProductDescription": "sample string 3",
            "QtyRequired": 4,
            "QtyReceived": 5,
            "QtyInvoiced": 6,
            "DateRequired": "sample string 7",
            "DateExpected": "sample string 8",
            "DespatchStatus": "sample string 9",
            "UnitPrice": 10.0,
            "LinePrice": 11.0
          },
          {
            "ProductID": 1,
            "ProductCode": "sample string 2",
            "ProductDescription": "sample string 3",
            "QtyRequired": 4,
            "QtyReceived": 5,
            "QtyInvoiced": 6,
            "DateRequired": "sample string 7",
            "DateExpected": "sample string 8",
            "DespatchStatus": "sample string 9",
            "UnitPrice": 10.0,
            "LinePrice": 11.0
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<PurchaseOrders xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PurchaseOrder>
    <OrderID>1</OrderID>
    <OrderNo>sample string 2</OrderNo>
    <AccountNo>sample string 3</AccountNo>
    <OrderDesc>sample string 4</OrderDesc>
    <Currency>sample string 5</Currency>
    <DateCreated>sample string 6</DateCreated>
    <FixedExchangeRate>true</FixedExchangeRate>
    <FixedExchangeRateValue>8</FixedExchangeRateValue>
    <POLines>
      <POLine>
        <ProductID>1</ProductID>
        <ProductCode>sample string 2</ProductCode>
        <ProductDescription>sample string 3</ProductDescription>
        <QtyRequired>4</QtyRequired>
        <QtyReceived>5</QtyReceived>
        <QtyInvoiced>6</QtyInvoiced>
        <DateRequired>sample string 7</DateRequired>
        <DateExpected>sample string 8</DateExpected>
        <DespatchStatus>sample string 9</DespatchStatus>
        <UnitPrice>10</UnitPrice>
        <LinePrice>11</LinePrice>
      </POLine>
      <POLine>
        <ProductID>1</ProductID>
        <ProductCode>sample string 2</ProductCode>
        <ProductDescription>sample string 3</ProductDescription>
        <QtyRequired>4</QtyRequired>
        <QtyReceived>5</QtyReceived>
        <QtyInvoiced>6</QtyInvoiced>
        <DateRequired>sample string 7</DateRequired>
        <DateExpected>sample string 8</DateExpected>
        <DespatchStatus>sample string 9</DespatchStatus>
        <UnitPrice>10</UnitPrice>
        <LinePrice>11</LinePrice>
      </POLine>
    </POLines>
  </PurchaseOrder>
  <PurchaseOrder>
    <OrderID>1</OrderID>
    <OrderNo>sample string 2</OrderNo>
    <AccountNo>sample string 3</AccountNo>
    <OrderDesc>sample string 4</OrderDesc>
    <Currency>sample string 5</Currency>
    <DateCreated>sample string 6</DateCreated>
    <FixedExchangeRate>true</FixedExchangeRate>
    <FixedExchangeRateValue>8</FixedExchangeRateValue>
    <POLines>
      <POLine>
        <ProductID>1</ProductID>
        <ProductCode>sample string 2</ProductCode>
        <ProductDescription>sample string 3</ProductDescription>
        <QtyRequired>4</QtyRequired>
        <QtyReceived>5</QtyReceived>
        <QtyInvoiced>6</QtyInvoiced>
        <DateRequired>sample string 7</DateRequired>
        <DateExpected>sample string 8</DateExpected>
        <DespatchStatus>sample string 9</DespatchStatus>
        <UnitPrice>10</UnitPrice>
        <LinePrice>11</LinePrice>
      </POLine>
      <POLine>
        <ProductID>1</ProductID>
        <ProductCode>sample string 2</ProductCode>
        <ProductDescription>sample string 3</ProductDescription>
        <QtyRequired>4</QtyRequired>
        <QtyReceived>5</QtyReceived>
        <QtyInvoiced>6</QtyInvoiced>
        <DateRequired>sample string 7</DateRequired>
        <DateExpected>sample string 8</DateExpected>
        <DespatchStatus>sample string 9</DespatchStatus>
        <UnitPrice>10</UnitPrice>
        <LinePrice>11</LinePrice>
      </POLine>
    </POLines>
  </PurchaseOrder>
</PurchaseOrders>