GET api/PurchaseOrder/DocId/{docId}

Get Purchase Order by Document ID

Request Information

URI Parameters

Name	Description	Type	Additional information
docId	PO Document ID	integer	Required

Body Parameters

None.

Response Information

Resource Description

Purchase Order

PurchaseOrder

Name	Description	Type	Additional information
CompanyCode	Company Code	string	None.
CompanyName	Company Name	string	None.
LocationCode	Location Code	string	None.
LocationName	Location Name	string	None.
DocumentID	Document ID	integer	None.
DocumentGUID	Document Guid	globally unique identifier	None.
PONumber	Purchase Order Number	string	None.
CreateDate	Create Date	date	None.
ApproveDate	Approve Date	date	None.
AccountNumber	Account Number	string	None.
BillToAddress1	Bill to Address Line 1	string	None.
BillToAddress2	Bill to Address Line 2	string	None.
BillToCity	Bill to Address City	string	None.
BillToState	Bill to Address State	string	None.
BillToZip	Bill to Address Zip/Postal Code	string	None.
BuyerID	Buyer ID	string	None.
BuyerNamee	Buyer Name	string	None.
POClass	PO Class	string	None.
POType	PO Type	string	None.
POSubType	PO Subtype	string	None.
CloseDate	Close Date	date	None.
ConfirmationNumber	Order Confirmation Number	string	None.
CostCenter	Cost Center	string	None.
CreatedByName	Created by Name	string	None.
CurrencyCode	Currency Code	string	None.
Department	Department	string	None.
Description	Description	string	None.
Discount	Discount	decimal number	None.
ExpectedDeliveryDate	Expected Delivery Date	date	None.
ExportDate	Export Date	date	None.
Freight	Freight/Shipping	decimal number	None.
GLCode	GL Code	string	None.
PODate	Purchase Order Date	date	None.
POEndDate	Purchase Order End Date	date	None.
Purpose	Purchase Order Purpose category	string	None.
Subtotal	Purchase Order Subtotal	decimal number	None.
Title	Purchase Order Title	string	None.
POTotal	Purchase Order Total	decimal number	None.
PaymentMethod	Payment Method	string	None.
RequestDate	Purchase Order Request Date	date	None.
Requestor	Purchase Order Requestor	string	None.
Reviewer	Purchase Order Reviewer	string	None.
ShipMethod	Shipping Method	string	None.
ShipToAddress1	Ship to Address Line 1	string	None.
ShipToaddress2	Ship to Address Line 2	string	None.
ShipToCity	Ship to Address City	string	None.
ShipToState	Ship to Address State	string	None.
ShipToZip	Ship to Address Zip/Postal Code	string	None.
ShipToAttention	Ship to Attention	string	None.
ShipToDepartment	Ship to Department	string	None.
ShipToLocation	Ship to Location	string	None.
ShippingReceiverName	Shipping Receiver Name	string	None.
Status	Purchase Order Status	string	None.
Tax	Tax Total	decimal number	None.
Terms	Purchase Order Terms	string	None.
VendorCode	Vendor Code	string	None.
VendorName	Vendor Name	string	None.
VendorAddress1	Vendor Remit to Address Line 1	string	None.
VendorAddress2	Vendor Remit to Address Line 2	string	None.
VendorCity	Vendor Remit to Address City	string	None.
VendorState	Vendor Remit to Address State	string	None.
VendorZip	Vendor Remit to Address Zip/Postal Code	string	None.
VendorContact	Vendor Contact	string	None.
VendorEmail	Vendor Email	string	None.
VendorPhone	Vendor Phone	string	None.
VendorType	Vendor Type	string	None.
Lines	Purchase Order Lines	Collection of POLine	None.
AssociatedInvoices	Purchase Order Matches- 0 to Many (Basic information only. For full details look at the invoice)	Collection of POLinkedInvoice	None.
DetailAmounts	Detail Amounts - 0 to Many	Collection of DetailAmount	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyCode": "sample string 1",
  "CompanyName": "sample string 2",
  "LocationCode": "sample string 3",
  "LocationName": "sample string 4",
  "DocumentID": 5,
  "DocumentGUID": "38707faf-104d-4ea6-9714-8da5bc1f336e",
  "PONumber": "sample string 7",
  "CreateDate": "2026-09-21T02:45:19.3892172-05:00",
  "ApproveDate": "2026-09-21T02:45:19.3892172-05:00",
  "AccountNumber": "sample string 9",
  "BillToAddress1": "sample string 10",
  "BillToAddress2": "sample string 11",
  "BillToCity": "sample string 12",
  "BillToState": "sample string 13",
  "BillToZip": "sample string 14",
  "BuyerID": "sample string 15",
  "BuyerNamee": "sample string 16",
  "POClass": "sample string 17",
  "POType": "sample string 18",
  "POSubType": "sample string 19",
  "CloseDate": "2026-09-21T02:45:19.3892172-05:00",
  "ConfirmationNumber": "sample string 20",
  "CostCenter": "sample string 21",
  "CreatedByName": "sample string 22",
  "CurrencyCode": "sample string 23",
  "Department": "sample string 24",
  "Description": "sample string 25",
  "Discount": 1.0,
  "ExpectedDeliveryDate": "2026-09-21T02:45:19.3892172-05:00",
  "ExportDate": "2026-09-21T02:45:19.3892172-05:00",
  "Freight": 1.0,
  "GLCode": "sample string 26",
  "PODate": "2026-09-21T02:45:19.3892172-05:00",
  "POEndDate": "2026-09-21T02:45:19.3892172-05:00",
  "Purpose": "sample string 27",
  "Subtotal": 1.0,
  "Title": "sample string 28",
  "POTotal": 1.0,
  "PaymentMethod": "sample string 29",
  "RequestDate": "2026-09-21T02:45:19.3892172-05:00",
  "Requestor": "sample string 30",
  "Reviewer": "sample string 31",
  "ShipMethod": "sample string 32",
  "ShipToAddress1": "sample string 33",
  "ShipToaddress2": "sample string 34",
  "ShipToCity": "sample string 35",
  "ShipToState": "sample string 36",
  "ShipToZip": "sample string 37",
  "ShipToAttention": "sample string 38",
  "ShipToDepartment": "sample string 39",
  "ShipToLocation": "sample string 40",
  "ShippingReceiverName": "sample string 41",
  "Status": "sample string 42",
  "Tax": 1.0,
  "Terms": "sample string 43",
  "VendorCode": "sample string 44",
  "VendorName": "sample string 45",
  "VendorAddress1": "sample string 46",
  "VendorAddress2": "sample string 47",
  "VendorCity": "sample string 48",
  "VendorState": "sample string 49",
  "VendorZip": "sample string 50",
  "VendorContact": "sample string 51",
  "VendorEmail": "sample string 52",
  "VendorPhone": "sample string 53",
  "VendorType": "sample string 54",
  "Lines": [
    {
      "LineNumber": "sample string 1",
      "ApproveDate": "2026-09-21T02:45:19.3892172-05:00",
      "CancelDate": "2026-09-21T02:45:19.3892172-05:00",
      "Status": "sample string 2",
      "CreateDate": "2026-09-21T02:45:19.3892172-05:00",
      "CreatedBy": "sample string 3",
      "Discount": 1.0,
      "Freight": 1.0,
      "GLCode": "sample string 4",
      "ItemCategory": "sample string 5",
      "ItemNumberCustomer": "sample string 6",
      "ItemDescriptionCustomer": "sample string 7",
      "ItemNumberVendor": "sample string 8",
      "ItemDescriptionVendor": "sample string 9",
      "LineTotal": 10.0,
      "LineCategory": "sample string 11",
      "LineSubCategory": "sample string 12",
      "QuantityOrdered": 13.0,
      "Tax": 1.0,
      "UnitOfMeasure": "sample string 14",
      "UnitPrice": 15.0
    },
    {
      "LineNumber": "sample string 1",
      "ApproveDate": "2026-09-21T02:45:19.3892172-05:00",
      "CancelDate": "2026-09-21T02:45:19.3892172-05:00",
      "Status": "sample string 2",
      "CreateDate": "2026-09-21T02:45:19.3892172-05:00",
      "CreatedBy": "sample string 3",
      "Discount": 1.0,
      "Freight": 1.0,
      "GLCode": "sample string 4",
      "ItemCategory": "sample string 5",
      "ItemNumberCustomer": "sample string 6",
      "ItemDescriptionCustomer": "sample string 7",
      "ItemNumberVendor": "sample string 8",
      "ItemDescriptionVendor": "sample string 9",
      "LineTotal": 10.0,
      "LineCategory": "sample string 11",
      "LineSubCategory": "sample string 12",
      "QuantityOrdered": 13.0,
      "Tax": 1.0,
      "UnitOfMeasure": "sample string 14",
      "UnitPrice": 15.0
    }
  ],
  "AssociatedInvoices": [
    {
      "DocumentID": 1,
      "InvoiceNumber": "sample string 2",
      "InvoiceTotal": 1.0,
      "Status": "sample string 3",
      "InvoiceDate": "2026-09-21T02:45:19.3892172-05:00",
      "VendorCode": "sample string 4",
      "VendorName": "sample string 5"
    },
    {
      "DocumentID": 1,
      "InvoiceNumber": "sample string 2",
      "InvoiceTotal": 1.0,
      "Status": "sample string 3",
      "InvoiceDate": "2026-09-21T02:45:19.3892172-05:00",
      "VendorCode": "sample string 4",
      "VendorName": "sample string 5"
    }
  ],
  "DetailAmounts": [
    {
      "Amount": 1.0,
      "DetailType": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "Amount": 1.0,
      "DetailType": "sample string 1",
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<PurchaseOrderController.PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <AccountNumber>sample string 9</AccountNumber>
  <ApproveDate>2026-09-21T02:45:19.3892172-05:00</ApproveDate>
  <AssociatedInvoices>
    <PurchaseOrderController.POLinkedInvoice>
      <DocumentID>1</DocumentID>
      <InvoiceDate>2026-09-21T02:45:19.3892172-05:00</InvoiceDate>
      <InvoiceNumber>sample string 2</InvoiceNumber>
      <InvoiceTotal>1</InvoiceTotal>
      <Status>sample string 3</Status>
      <VendorCode>sample string 4</VendorCode>
      <VendorName>sample string 5</VendorName>
    </PurchaseOrderController.POLinkedInvoice>
    <PurchaseOrderController.POLinkedInvoice>
      <DocumentID>1</DocumentID>
      <InvoiceDate>2026-09-21T02:45:19.3892172-05:00</InvoiceDate>
      <InvoiceNumber>sample string 2</InvoiceNumber>
      <InvoiceTotal>1</InvoiceTotal>
      <Status>sample string 3</Status>
      <VendorCode>sample string 4</VendorCode>
      <VendorName>sample string 5</VendorName>
    </PurchaseOrderController.POLinkedInvoice>
  </AssociatedInvoices>
  <BillToAddress1>sample string 10</BillToAddress1>
  <BillToAddress2>sample string 11</BillToAddress2>
  <BillToCity>sample string 12</BillToCity>
  <BillToState>sample string 13</BillToState>
  <BillToZip>sample string 14</BillToZip>
  <BuyerID>sample string 15</BuyerID>
  <BuyerNamee>sample string 16</BuyerNamee>
  <CloseDate>2026-09-21T02:45:19.3892172-05:00</CloseDate>
  <CompanyCode>sample string 1</CompanyCode>
  <CompanyName>sample string 2</CompanyName>
  <ConfirmationNumber>sample string 20</ConfirmationNumber>
  <CostCenter>sample string 21</CostCenter>
  <CreateDate>2026-09-21T02:45:19.3892172-05:00</CreateDate>
  <CreatedByName>sample string 22</CreatedByName>
  <CurrencyCode>sample string 23</CurrencyCode>
  <Department>sample string 24</Department>
  <Description>sample string 25</Description>
  <DetailAmounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
    <d2p1:DetailAmount>
      <d2p1:Amount>1</d2p1:Amount>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:DetailType>sample string 1</d2p1:DetailType>
    </d2p1:DetailAmount>
    <d2p1:DetailAmount>
      <d2p1:Amount>1</d2p1:Amount>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:DetailType>sample string 1</d2p1:DetailType>
    </d2p1:DetailAmount>
  </DetailAmounts>
  <Discount>1</Discount>
  <DocumentGUID>38707faf-104d-4ea6-9714-8da5bc1f336e</DocumentGUID>
  <DocumentID>5</DocumentID>
  <ExpectedDeliveryDate>2026-09-21T02:45:19.3892172-05:00</ExpectedDeliveryDate>
  <ExportDate>2026-09-21T02:45:19.3892172-05:00</ExportDate>
  <Freight>1</Freight>
  <GLCode>sample string 26</GLCode>
  <Lines>
    <PurchaseOrderController.POLine>
      <ApproveDate>2026-09-21T02:45:19.3892172-05:00</ApproveDate>
      <CancelDate>2026-09-21T02:45:19.3892172-05:00</CancelDate>
      <CreateDate>2026-09-21T02:45:19.3892172-05:00</CreateDate>
      <CreatedBy>sample string 3</CreatedBy>
      <Discount>1</Discount>
      <Freight>1</Freight>
      <GLCode>sample string 4</GLCode>
      <ItemCategory>sample string 5</ItemCategory>
      <ItemDescriptionCustomer>sample string 7</ItemDescriptionCustomer>
      <ItemDescriptionVendor>sample string 9</ItemDescriptionVendor>
      <ItemNumberCustomer>sample string 6</ItemNumberCustomer>
      <ItemNumberVendor>sample string 8</ItemNumberVendor>
      <LineCategory>sample string 11</LineCategory>
      <LineNumber>sample string 1</LineNumber>
      <LineSubCategory>sample string 12</LineSubCategory>
      <LineTotal>10</LineTotal>
      <QuantityOrdered>13</QuantityOrdered>
      <Status>sample string 2</Status>
      <Tax>1</Tax>
      <UnitOfMeasure>sample string 14</UnitOfMeasure>
      <UnitPrice>15</UnitPrice>
    </PurchaseOrderController.POLine>
    <PurchaseOrderController.POLine>
      <ApproveDate>2026-09-21T02:45:19.3892172-05:00</ApproveDate>
      <CancelDate>2026-09-21T02:45:19.3892172-05:00</CancelDate>
      <CreateDate>2026-09-21T02:45:19.3892172-05:00</CreateDate>
      <CreatedBy>sample string 3</CreatedBy>
      <Discount>1</Discount>
      <Freight>1</Freight>
      <GLCode>sample string 4</GLCode>
      <ItemCategory>sample string 5</ItemCategory>
      <ItemDescriptionCustomer>sample string 7</ItemDescriptionCustomer>
      <ItemDescriptionVendor>sample string 9</ItemDescriptionVendor>
      <ItemNumberCustomer>sample string 6</ItemNumberCustomer>
      <ItemNumberVendor>sample string 8</ItemNumberVendor>
      <LineCategory>sample string 11</LineCategory>
      <LineNumber>sample string 1</LineNumber>
      <LineSubCategory>sample string 12</LineSubCategory>
      <LineTotal>10</LineTotal>
      <QuantityOrdered>13</QuantityOrdered>
      <Status>sample string 2</Status>
      <Tax>1</Tax>
      <UnitOfMeasure>sample string 14</UnitOfMeasure>
      <UnitPrice>15</UnitPrice>
    </PurchaseOrderController.POLine>
  </Lines>
  <LocationCode>sample string 3</LocationCode>
  <LocationName>sample string 4</LocationName>
  <POClass>sample string 17</POClass>
  <PODate>2026-09-21T02:45:19.3892172-05:00</PODate>
  <POEndDate>2026-09-21T02:45:19.3892172-05:00</POEndDate>
  <PONumber>sample string 7</PONumber>
  <POSubType>sample string 19</POSubType>
  <POTotal>1</POTotal>
  <POType>sample string 18</POType>
  <PaymentMethod>sample string 29</PaymentMethod>
  <Purpose>sample string 27</Purpose>
  <RequestDate>2026-09-21T02:45:19.3892172-05:00</RequestDate>
  <Requestor>sample string 30</Requestor>
  <Reviewer>sample string 31</Reviewer>
  <ShipMethod>sample string 32</ShipMethod>
  <ShipToAddress1>sample string 33</ShipToAddress1>
  <ShipToAttention>sample string 38</ShipToAttention>
  <ShipToCity>sample string 35</ShipToCity>
  <ShipToDepartment>sample string 39</ShipToDepartment>
  <ShipToLocation>sample string 40</ShipToLocation>
  <ShipToState>sample string 36</ShipToState>
  <ShipToZip>sample string 37</ShipToZip>
  <ShipToaddress2>sample string 34</ShipToaddress2>
  <ShippingReceiverName>sample string 41</ShippingReceiverName>
  <Status>sample string 42</Status>
  <Subtotal>1</Subtotal>
  <Tax>1</Tax>
  <Terms>sample string 43</Terms>
  <Title>sample string 28</Title>
  <VendorAddress1>sample string 46</VendorAddress1>
  <VendorAddress2>sample string 47</VendorAddress2>
  <VendorCity>sample string 48</VendorCity>
  <VendorCode>sample string 44</VendorCode>
  <VendorContact>sample string 51</VendorContact>
  <VendorEmail>sample string 52</VendorEmail>
  <VendorName>sample string 45</VendorName>
  <VendorPhone>sample string 53</VendorPhone>
  <VendorState>sample string 49</VendorState>
  <VendorType>sample string 54</VendorType>
  <VendorZip>sample string 50</VendorZip>
</PurchaseOrderController.PurchaseOrder>