GET api/purchaseorder/orderid?id={id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

PurchaseOrder

Name	Type	Additional information
DocumentID	integer	None.
OrderNumber	string	None.
OrderDate	date	None.
DateRequired	date	None.
Creditor	Creditor	None.
Branch	Branch	Required
Department	Department	Required
Job	JobLite	None.
Lines	Collection of PurchaseOrderLine	None.
OrderStatus	string	None.
DeliveryAddress1	string	None.
DeliveryAddress2	string	None.
DeliveryAddress3	string	None.
DeliveryAddress4	string	None.
DeliveryAddress5	string	None.
DeliveryPostCode	string	None.
InternalReference	string	None.
OrderedAmout	decimal number	None.
OrderedGST	decimal number	None.
OutstandingAmountInvoice	decimal number	None.
OutstandingAmountReceipt	decimal number	None.
AuthorisationCode	string	None.
Comment	string	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentID": 1,
  "OrderNumber": "sample string 2",
  "OrderDate": "2025-11-01T22:07:38.8382636+13:00",
  "DateRequired": "2025-11-01T22:07:38.8382636+13:00",
  "Creditor": {
    "CreditorCode": "sample string 1",
    "CreditorName": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Address3": "sample string 5",
    "Address4": "sample string 6",
    "Address5": "sample string 7",
    "PostCode": "sample string 8",
    "Email": "sample string 9",
    "Phone": "sample string 10",
    "Phone2": "sample string 11",
    "GSTNumber": "sample string 12",
    "Comment": "sample string 13",
    "PaymentMethod": "sample string 14",
    "PaymentUnit": "sample string 15",
    "PaymentDayOfMonth": 16,
    "PaymentCount": 17,
    "Discount": 18.0,
    "DiscountUnit": "sample string 19",
    "DiscountDayOfMonth": 20,
    "DiscountCount": 21,
    "Inactive": true,
    "PhysicalAddress1": "sample string 23",
    "PhysicalAddress2": "sample string 24",
    "PhysicalAddress3": "sample string 25",
    "PhysicalAddress4": "sample string 26",
    "PhysicalAddress5": "sample string 27",
    "PhysicalPostCode": "sample string 28",
    "BankName": "sample string 29",
    "BankAccount": "sample string 30",
    "PayeeName": "sample string 31",
    "BankReference": "sample string 32",
    "BankParticulars": "sample string 33",
    "OrderEmail": "sample string 34",
    "Category1": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Inactive": true
    },
    "Category2": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Inactive": true
    },
    "Group": {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Inactive": true
    },
    "Expense": {
      "AnalysisCode": "sample string 1",
      "AnalysisName": "sample string 2",
      "AccountClass": "sample string 3",
      "AccountCode": {
        "AccountCode": "sample string 1",
        "AccountName": "sample string 2",
        "AccountClass": "sample string 3",
        "AccountType": "sample string 4",
        "Inactive": true
      },
      "FriendlyCode": "sample string 4",
      "Inactive": true
    },
    "Contacts": [
      {
        "ContactId": 1,
        "FullName": "sample string 2",
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "MiddleName": "sample string 5",
        "LastName": "sample string 6",
        "PhoneNo": "sample string 7",
        "MobileNo": "sample string 8",
        "FaxNo": "sample string 9",
        "Email": "sample string 10",
        "Comment": "sample string 11",
        "Role": "sample string 12",
        "Inactive": true
      },
      {
        "ContactId": 1,
        "FullName": "sample string 2",
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "MiddleName": "sample string 5",
        "LastName": "sample string 6",
        "PhoneNo": "sample string 7",
        "MobileNo": "sample string 8",
        "FaxNo": "sample string 9",
        "Email": "sample string 10",
        "Comment": "sample string 11",
        "Role": "sample string 12",
        "Inactive": true
      }
    ]
  },
  "Branch": {
    "BranchCode": "sample string 1",
    "BranchName": "sample string 2",
    "Inactive": true
  },
  "Department": {
    "DepartmentCode": "sample string 1",
    "DepartmentName": "sample string 2",
    "Inactive": true
  },
  "Job": {
    "JobCode": "sample string 1",
    "JobName": "sample string 2",
    "CustomerCode": "sample string 3",
    "CustomerName": "sample string 4",
    "BranchCode": "sample string 5",
    "DepartmentCode": "sample string 6",
    "DefaultLocationCode": "sample string 7",
    "RelatedJobCode": "sample string 8",
    "JobGroupCode": "sample string 9",
    "JobStatus": "sample string 10",
    "JobType": "sample string 11",
    "DateRequired": "2025-11-01T22:07:38.8382636+13:00",
    "DateEntered": "2025-11-01T22:07:38.8382636+13:00",
    "DateCreated": "2025-11-01T22:07:38.8382636+13:00",
    "NonWIP": true,
    "InActive": true,
    "OrderNumber": "sample string 15",
    "ScheduleStatus": 0
  },
  "Lines": [
    {
      "LineID": 1,
      "LineNo": 2,
      "LineStatus": "sample string 3",
      "LineType": "sample string 4",
      "Product": {
        "ProductCode": "sample string 1",
        "Description": "sample string 2",
        "AlternateCode": "sample string 3",
        "Barcode": "sample string 4",
        "Barcodes": [
          {
            "Barcode": "sample string 1"
          },
          {
            "Barcode": "sample string 1"
          }
        ],
        "StockGroupCode": "sample string 5",
        "SalesGroupCode": "sample string 6",
        "CreditorCode": "sample string 7",
        "QuantityOnHand": 8.0,
        "NonDiminishing": true,
        "Category2Code": "sample string 10",
        "Unit": "sample string 11"
      },
      "Description": "sample string 5",
      "VendorCode": "sample string 6",
      "Unit": "sample string 7",
      "Branch": {
        "BranchCode": "sample string 1",
        "BranchName": "sample string 2",
        "Inactive": true
      },
      "Department": {
        "DepartmentCode": "sample string 1",
        "DepartmentName": "sample string 2",
        "Inactive": true
      },
      "OrderQuantity": 8.0,
      "UnitCost": 9.0,
      "OrderCost": 10.0,
      "UnitSell": 11.0,
      "Custom1": "sample string 12",
      "Custom2": "sample string 13",
      "QuantityInvoiced": 14.0,
      "QuantityReceipted": 15.0
    },
    {
      "LineID": 1,
      "LineNo": 2,
      "LineStatus": "sample string 3",
      "LineType": "sample string 4",
      "Product": {
        "ProductCode": "sample string 1",
        "Description": "sample string 2",
        "AlternateCode": "sample string 3",
        "Barcode": "sample string 4",
        "Barcodes": [
          {
            "Barcode": "sample string 1"
          },
          {
            "Barcode": "sample string 1"
          }
        ],
        "StockGroupCode": "sample string 5",
        "SalesGroupCode": "sample string 6",
        "CreditorCode": "sample string 7",
        "QuantityOnHand": 8.0,
        "NonDiminishing": true,
        "Category2Code": "sample string 10",
        "Unit": "sample string 11"
      },
      "Description": "sample string 5",
      "VendorCode": "sample string 6",
      "Unit": "sample string 7",
      "Branch": {
        "BranchCode": "sample string 1",
        "BranchName": "sample string 2",
        "Inactive": true
      },
      "Department": {
        "DepartmentCode": "sample string 1",
        "DepartmentName": "sample string 2",
        "Inactive": true
      },
      "OrderQuantity": 8.0,
      "UnitCost": 9.0,
      "OrderCost": 10.0,
      "UnitSell": 11.0,
      "Custom1": "sample string 12",
      "Custom2": "sample string 13",
      "QuantityInvoiced": 14.0,
      "QuantityReceipted": 15.0
    }
  ],
  "OrderStatus": "sample string 4",
  "DeliveryAddress1": "sample string 5",
  "DeliveryAddress2": "sample string 6",
  "DeliveryAddress3": "sample string 7",
  "DeliveryAddress4": "sample string 8",
  "DeliveryAddress5": "sample string 9",
  "DeliveryPostCode": "sample string 10",
  "InternalReference": "sample string 11",
  "OrderedAmout": 12.0,
  "OrderedGST": 13.0,
  "OutstandingAmountInvoice": 14.0,
  "OutstandingAmountReceipt": 15.0,
  "AuthorisationCode": "sample string 16",
  "Comment": "sample string 17"
}

application/xml, text/xml

Sample:

<PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.PO">
  <AuthorisationCode>sample string 16</AuthorisationCode>
  <Branch xmlns:d2p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.CO">
    <d2p1:BranchCode>sample string 1</d2p1:BranchCode>
    <d2p1:BranchName>sample string 2</d2p1:BranchName>
    <d2p1:Inactive>true</d2p1:Inactive>
  </Branch>
  <Comment>sample string 17</Comment>
  <Creditor xmlns:d2p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.AP">
    <d2p1:Address1>sample string 3</d2p1:Address1>
    <d2p1:Address2>sample string 4</d2p1:Address2>
    <d2p1:Address3>sample string 5</d2p1:Address3>
    <d2p1:Address4>sample string 6</d2p1:Address4>
    <d2p1:Address5>sample string 7</d2p1:Address5>
    <d2p1:BankAccount>sample string 30</d2p1:BankAccount>
    <d2p1:BankName>sample string 29</d2p1:BankName>
    <d2p1:BankParticulars>sample string 33</d2p1:BankParticulars>
    <d2p1:BankReference>sample string 32</d2p1:BankReference>
    <d2p1:Category1>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Inactive>true</d2p1:Inactive>
    </d2p1:Category1>
    <d2p1:Category2>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Inactive>true</d2p1:Inactive>
    </d2p1:Category2>
    <d2p1:Comment>sample string 13</d2p1:Comment>
    <d2p1:Contacts>
      <d2p1:CreditorContact>
        <d2p1:Comment>sample string 11</d2p1:Comment>
        <d2p1:ContactId>1</d2p1:ContactId>
        <d2p1:Email>sample string 10</d2p1:Email>
        <d2p1:FaxNo>sample string 9</d2p1:FaxNo>
        <d2p1:FirstName>sample string 4</d2p1:FirstName>
        <d2p1:FullName>sample string 2</d2p1:FullName>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:LastName>sample string 6</d2p1:LastName>
        <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
        <d2p1:MobileNo>sample string 8</d2p1:MobileNo>
        <d2p1:PhoneNo>sample string 7</d2p1:PhoneNo>
        <d2p1:Role>sample string 12</d2p1:Role>
        <d2p1:Title>sample string 3</d2p1:Title>
      </d2p1:CreditorContact>
      <d2p1:CreditorContact>
        <d2p1:Comment>sample string 11</d2p1:Comment>
        <d2p1:ContactId>1</d2p1:ContactId>
        <d2p1:Email>sample string 10</d2p1:Email>
        <d2p1:FaxNo>sample string 9</d2p1:FaxNo>
        <d2p1:FirstName>sample string 4</d2p1:FirstName>
        <d2p1:FullName>sample string 2</d2p1:FullName>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:LastName>sample string 6</d2p1:LastName>
        <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
        <d2p1:MobileNo>sample string 8</d2p1:MobileNo>
        <d2p1:PhoneNo>sample string 7</d2p1:PhoneNo>
        <d2p1:Role>sample string 12</d2p1:Role>
        <d2p1:Title>sample string 3</d2p1:Title>
      </d2p1:CreditorContact>
    </d2p1:Contacts>
    <d2p1:CreditorCode>sample string 1</d2p1:CreditorCode>
    <d2p1:CreditorName>sample string 2</d2p1:CreditorName>
    <d2p1:Discount>18</d2p1:Discount>
    <d2p1:DiscountCount>21</d2p1:DiscountCount>
    <d2p1:DiscountDayOfMonth>20</d2p1:DiscountDayOfMonth>
    <d2p1:DiscountUnit>sample string 19</d2p1:DiscountUnit>
    <d2p1:Email>sample string 9</d2p1:Email>
    <d2p1:Expense>
      <d2p1:AccountClass>sample string 3</d2p1:AccountClass>
      <d2p1:AccountCode xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.GL">
        <d4p1:AccountClass>sample string 3</d4p1:AccountClass>
        <d4p1:AccountCode>sample string 1</d4p1:AccountCode>
        <d4p1:AccountName>sample string 2</d4p1:AccountName>
        <d4p1:AccountType>sample string 4</d4p1:AccountType>
        <d4p1:Inactive>true</d4p1:Inactive>
      </d2p1:AccountCode>
      <d2p1:AnalysisCode>sample string 1</d2p1:AnalysisCode>
      <d2p1:AnalysisName>sample string 2</d2p1:AnalysisName>
      <d2p1:FriendlyCode>sample string 4</d2p1:FriendlyCode>
      <d2p1:Inactive>true</d2p1:Inactive>
    </d2p1:Expense>
    <d2p1:GSTNumber>sample string 12</d2p1:GSTNumber>
    <d2p1:Group>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:Group>
    <d2p1:Inactive>true</d2p1:Inactive>
    <d2p1:OrderEmail>sample string 34</d2p1:OrderEmail>
    <d2p1:PayeeName>sample string 31</d2p1:PayeeName>
    <d2p1:PaymentCount>17</d2p1:PaymentCount>
    <d2p1:PaymentDayOfMonth>16</d2p1:PaymentDayOfMonth>
    <d2p1:PaymentMethod>sample string 14</d2p1:PaymentMethod>
    <d2p1:PaymentUnit>sample string 15</d2p1:PaymentUnit>
    <d2p1:Phone>sample string 10</d2p1:Phone>
    <d2p1:Phone2>sample string 11</d2p1:Phone2>
    <d2p1:PhysicalAddress1>sample string 23</d2p1:PhysicalAddress1>
    <d2p1:PhysicalAddress2>sample string 24</d2p1:PhysicalAddress2>
    <d2p1:PhysicalAddress3>sample string 25</d2p1:PhysicalAddress3>
    <d2p1:PhysicalAddress4>sample string 26</d2p1:PhysicalAddress4>
    <d2p1:PhysicalAddress5>sample string 27</d2p1:PhysicalAddress5>
    <d2p1:PhysicalPostCode>sample string 28</d2p1:PhysicalPostCode>
    <d2p1:PostCode>sample string 8</d2p1:PostCode>
  </Creditor>
  <DateRequired>2025-11-01T22:07:38.8382636+13:00</DateRequired>
  <DeliveryAddress1>sample string 5</DeliveryAddress1>
  <DeliveryAddress2>sample string 6</DeliveryAddress2>
  <DeliveryAddress3>sample string 7</DeliveryAddress3>
  <DeliveryAddress4>sample string 8</DeliveryAddress4>
  <DeliveryAddress5>sample string 9</DeliveryAddress5>
  <DeliveryPostCode>sample string 10</DeliveryPostCode>
  <Department xmlns:d2p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.CO">
    <d2p1:DepartmentCode>sample string 1</d2p1:DepartmentCode>
    <d2p1:DepartmentName>sample string 2</d2p1:DepartmentName>
    <d2p1:Inactive>true</d2p1:Inactive>
  </Department>
  <DocumentID>1</DocumentID>
  <InternalReference>sample string 11</InternalReference>
  <Job xmlns:d2p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.JC">
    <d2p1:BranchCode>sample string 5</d2p1:BranchCode>
    <d2p1:CustomerCode>sample string 3</d2p1:CustomerCode>
    <d2p1:CustomerName>sample string 4</d2p1:CustomerName>
    <d2p1:DateCreated>2025-11-01T22:07:38.8382636+13:00</d2p1:DateCreated>
    <d2p1:DateEntered>2025-11-01T22:07:38.8382636+13:00</d2p1:DateEntered>
    <d2p1:DateRequired>2025-11-01T22:07:38.8382636+13:00</d2p1:DateRequired>
    <d2p1:DefaultLocationCode>sample string 7</d2p1:DefaultLocationCode>
    <d2p1:DepartmentCode>sample string 6</d2p1:DepartmentCode>
    <d2p1:InActive>true</d2p1:InActive>
    <d2p1:JobCode>sample string 1</d2p1:JobCode>
    <d2p1:JobGroupCode>sample string 9</d2p1:JobGroupCode>
    <d2p1:JobName>sample string 2</d2p1:JobName>
    <d2p1:JobStatus>sample string 10</d2p1:JobStatus>
    <d2p1:JobType>sample string 11</d2p1:JobType>
    <d2p1:NonWIP>true</d2p1:NonWIP>
    <d2p1:OrderNumber>sample string 15</d2p1:OrderNumber>
    <d2p1:RelatedJobCode>sample string 8</d2p1:RelatedJobCode>
    <d2p1:ScheduleStatus>None</d2p1:ScheduleStatus>
  </Job>
  <Lines>
    <PurchaseOrderLine>
      <Branch xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.CO">
        <d4p1:BranchCode>sample string 1</d4p1:BranchCode>
        <d4p1:BranchName>sample string 2</d4p1:BranchName>
        <d4p1:Inactive>true</d4p1:Inactive>
      </Branch>
      <Custom1>sample string 12</Custom1>
      <Custom2>sample string 13</Custom2>
      <Department xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.CO">
        <d4p1:DepartmentCode>sample string 1</d4p1:DepartmentCode>
        <d4p1:DepartmentName>sample string 2</d4p1:DepartmentName>
        <d4p1:Inactive>true</d4p1:Inactive>
      </Department>
      <Description>sample string 5</Description>
      <LineID>1</LineID>
      <LineNo>2</LineNo>
      <LineStatus>sample string 3</LineStatus>
      <LineType>sample string 4</LineType>
      <OrderCost>10</OrderCost>
      <OrderQuantity>8</OrderQuantity>
      <Product xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.IC">
        <d4p1:AlternateCode>sample string 3</d4p1:AlternateCode>
        <d4p1:Barcode>sample string 4</d4p1:Barcode>
        <d4p1:Barcodes>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
        </d4p1:Barcodes>
        <d4p1:Category2Code>sample string 10</d4p1:Category2Code>
        <d4p1:CreditorCode>sample string 7</d4p1:CreditorCode>
        <d4p1:Description>sample string 2</d4p1:Description>
        <d4p1:NonDiminishing>true</d4p1:NonDiminishing>
        <d4p1:ProductCode>sample string 1</d4p1:ProductCode>
        <d4p1:QuantityOnHand>8</d4p1:QuantityOnHand>
        <d4p1:SalesGroupCode>sample string 6</d4p1:SalesGroupCode>
        <d4p1:StockGroupCode>sample string 5</d4p1:StockGroupCode>
        <d4p1:Unit>sample string 11</d4p1:Unit>
      </Product>
      <QuantityInvoiced>14</QuantityInvoiced>
      <QuantityReceipted>15</QuantityReceipted>
      <Unit>sample string 7</Unit>
      <UnitCost>9</UnitCost>
      <UnitSell>11</UnitSell>
      <VendorCode>sample string 6</VendorCode>
    </PurchaseOrderLine>
    <PurchaseOrderLine>
      <Branch xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.CO">
        <d4p1:BranchCode>sample string 1</d4p1:BranchCode>
        <d4p1:BranchName>sample string 2</d4p1:BranchName>
        <d4p1:Inactive>true</d4p1:Inactive>
      </Branch>
      <Custom1>sample string 12</Custom1>
      <Custom2>sample string 13</Custom2>
      <Department xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.CO">
        <d4p1:DepartmentCode>sample string 1</d4p1:DepartmentCode>
        <d4p1:DepartmentName>sample string 2</d4p1:DepartmentName>
        <d4p1:Inactive>true</d4p1:Inactive>
      </Department>
      <Description>sample string 5</Description>
      <LineID>1</LineID>
      <LineNo>2</LineNo>
      <LineStatus>sample string 3</LineStatus>
      <LineType>sample string 4</LineType>
      <OrderCost>10</OrderCost>
      <OrderQuantity>8</OrderQuantity>
      <Product xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.IC">
        <d4p1:AlternateCode>sample string 3</d4p1:AlternateCode>
        <d4p1:Barcode>sample string 4</d4p1:Barcode>
        <d4p1:Barcodes>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
        </d4p1:Barcodes>
        <d4p1:Category2Code>sample string 10</d4p1:Category2Code>
        <d4p1:CreditorCode>sample string 7</d4p1:CreditorCode>
        <d4p1:Description>sample string 2</d4p1:Description>
        <d4p1:NonDiminishing>true</d4p1:NonDiminishing>
        <d4p1:ProductCode>sample string 1</d4p1:ProductCode>
        <d4p1:QuantityOnHand>8</d4p1:QuantityOnHand>
        <d4p1:SalesGroupCode>sample string 6</d4p1:SalesGroupCode>
        <d4p1:StockGroupCode>sample string 5</d4p1:StockGroupCode>
        <d4p1:Unit>sample string 11</d4p1:Unit>
      </Product>
      <QuantityInvoiced>14</QuantityInvoiced>
      <QuantityReceipted>15</QuantityReceipted>
      <Unit>sample string 7</Unit>
      <UnitCost>9</UnitCost>
      <UnitSell>11</UnitSell>
      <VendorCode>sample string 6</VendorCode>
    </PurchaseOrderLine>
  </Lines>
  <OrderDate>2025-11-01T22:07:38.8382636+13:00</OrderDate>
  <OrderNumber>sample string 2</OrderNumber>
  <OrderStatus>sample string 4</OrderStatus>
  <OrderedAmout>12</OrderedAmout>
  <OrderedGST>13</OrderedGST>
  <OutstandingAmountInvoice>14</OutstandingAmountInvoice>
  <OutstandingAmountReceipt>15</OutstandingAmountReceipt>
</PurchaseOrder>