GET api/Order/DocId/{docId}

Get Order Form by Order Form Id

Request Information

URI Parameters

Name	Description	Type	Additional information
docId	System generated unique id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Order

Name	Description	Type	Additional information
DocumentId	Order Id - primary id number generated by the sytem	integer	None.
DocumentGuid	Order Guid - unique Guid for order generated by the system	globally unique identifier	None.
ClientId	Client Id - assigned based on credentials	integer	None.
CreateDate	Create Date - Generated by the system when order is created	date	None.
OrderDate	Order Date - provided by user, required	date	None.
OrderNumber	Order Number - created by the system based on client defined rules	string	None.
Comments	Comments - provided by user, not required	string	None.
ClientName	Client Name - read only	string	None.
CompanyCode	Company Code - required	string	None.
CompanyName	Company Name - read only	string	None.
LocationCode	Location Code - required	string	None.
LocationName	Location Name - read only	string	None.
CreatedByName	Created By Name - read only	string	None.
StatusDesc	Status Description - read only	string	None.
Lines	Order Lines	Collection of OrderLine	None.
DesignatedReceivers	Designated Receivers	Collection of DesignatedReceiver	None.
CurrentRouteToName	Current Route Name - read only	string	None.
Total	Order Total - required	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentId": 1,
  "DocumentGuid": "ecab7e82-5663-4be2-958d-7ca1816da2ad",
  "ClientId": 1,
  "CreateDate": "2026-09-21T02:44:59.8974718-05:00",
  "OrderDate": "2026-09-21T02:44:59.8974718-05:00",
  "OrderNumber": "sample string 4",
  "Comments": "sample string 5",
  "ClientName": "sample string 6",
  "CompanyCode": "sample string 7",
  "CompanyName": "sample string 8",
  "LocationCode": "sample string 9",
  "LocationName": "sample string 10",
  "CreatedByName": "sample string 11",
  "StatusDesc": "sample string 12",
  "Lines": [
    {
      "DocumentId": 1,
      "LineNumber": "sample string 1",
      "VendorCode": "sample string 2",
      "VendorName": "sample string 3",
      "ItemNumber": "sample string 4",
      "ItemDescription": "sample string 5",
      "VendorItemNumber": "sample string 6",
      "Tax": 1.0,
      "Freight": 1.0,
      "Quantity": 1.0,
      "UnitOfMeasure": "sample string 7",
      "UnitPrice": 8.0,
      "LineTotal": 9.0,
      "NoteToSupplier": "sample string 10",
      "Segment1": "sample string 11",
      "Segment2": "sample string 12",
      "Segment3": "sample string 13",
      "Segment4": "sample string 14",
      "Segment5": "sample string 15",
      "Segment6": "sample string 16",
      "Segment7": "sample string 17",
      "Segment8": "sample string 18",
      "Segment9": "sample string 19",
      "Segment10": "sample string 20",
      "ApproveDate": "2026-09-21T02:44:59.8974718-05:00",
      "RejectDate": "2026-09-21T02:44:59.8974718-05:00",
      "CreateDate": "2026-09-21T02:44:59.8974718-05:00",
      "IsReceiverRequired": true,
      "ShipToLocation": "sample string 22",
      "ShipToAddress1": "sample string 23",
      "ShipToAddress2": "sample string 24",
      "ShipToCity": "sample string 25",
      "ShipToState": "sample string 26",
      "ShipToZip": "sample string 27",
      "GLCode": "sample string 28",
      "ProjectLineNumber": "sample string 29",
      "ProjectNumber": "sample string 30",
      "ProjectName": "sample string 31",
      "CompanyCode": "sample string 32",
      "CompanyName": "sample string 33",
      "CreatedByName": "sample string 34",
      "StatusDesc": "sample string 35",
      "LocationCode": "sample string 36",
      "LocationName": "sample string 37",
      "ReceiverName": "sample string 38"
    },
    {
      "DocumentId": 1,
      "LineNumber": "sample string 1",
      "VendorCode": "sample string 2",
      "VendorName": "sample string 3",
      "ItemNumber": "sample string 4",
      "ItemDescription": "sample string 5",
      "VendorItemNumber": "sample string 6",
      "Tax": 1.0,
      "Freight": 1.0,
      "Quantity": 1.0,
      "UnitOfMeasure": "sample string 7",
      "UnitPrice": 8.0,
      "LineTotal": 9.0,
      "NoteToSupplier": "sample string 10",
      "Segment1": "sample string 11",
      "Segment2": "sample string 12",
      "Segment3": "sample string 13",
      "Segment4": "sample string 14",
      "Segment5": "sample string 15",
      "Segment6": "sample string 16",
      "Segment7": "sample string 17",
      "Segment8": "sample string 18",
      "Segment9": "sample string 19",
      "Segment10": "sample string 20",
      "ApproveDate": "2026-09-21T02:44:59.8974718-05:00",
      "RejectDate": "2026-09-21T02:44:59.8974718-05:00",
      "CreateDate": "2026-09-21T02:44:59.8974718-05:00",
      "IsReceiverRequired": true,
      "ShipToLocation": "sample string 22",
      "ShipToAddress1": "sample string 23",
      "ShipToAddress2": "sample string 24",
      "ShipToCity": "sample string 25",
      "ShipToState": "sample string 26",
      "ShipToZip": "sample string 27",
      "GLCode": "sample string 28",
      "ProjectLineNumber": "sample string 29",
      "ProjectNumber": "sample string 30",
      "ProjectName": "sample string 31",
      "CompanyCode": "sample string 32",
      "CompanyName": "sample string 33",
      "CreatedByName": "sample string 34",
      "StatusDesc": "sample string 35",
      "LocationCode": "sample string 36",
      "LocationName": "sample string 37",
      "ReceiverName": "sample string 38"
    }
  ],
  "DesignatedReceivers": [
    {
      "DesignatedReceiverId": 1,
      "OrderId": 1,
      "UserId": 1,
      "UserFullName": "sample string 2",
      "UserEmail": "sample string 3",
      "Login": "sample string 4"
    },
    {
      "DesignatedReceiverId": 1,
      "OrderId": 1,
      "UserId": 1,
      "UserFullName": "sample string 2",
      "UserEmail": "sample string 3",
      "Login": "sample string 4"
    }
  ],
  "CurrentRouteToName": "sample string 13",
  "Total": 14.0
}

application/xml, text/xml

Sample:

<OrderController.Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <ClientId>1</ClientId>
  <ClientName>sample string 6</ClientName>
  <Comments>sample string 5</Comments>
  <CompanyCode>sample string 7</CompanyCode>
  <CompanyName>sample string 8</CompanyName>
  <CreateDate>2026-09-21T02:44:59.8974718-05:00</CreateDate>
  <CreatedByName>sample string 11</CreatedByName>
  <CurrentRouteToName>sample string 13</CurrentRouteToName>
  <DesignatedReceivers>
    <OrderController.DesignatedReceiver>
      <DesignatedReceiverId>1</DesignatedReceiverId>
      <Login>sample string 4</Login>
      <OrderId>1</OrderId>
      <UserEmail>sample string 3</UserEmail>
      <UserFullName>sample string 2</UserFullName>
      <UserId>1</UserId>
    </OrderController.DesignatedReceiver>
    <OrderController.DesignatedReceiver>
      <DesignatedReceiverId>1</DesignatedReceiverId>
      <Login>sample string 4</Login>
      <OrderId>1</OrderId>
      <UserEmail>sample string 3</UserEmail>
      <UserFullName>sample string 2</UserFullName>
      <UserId>1</UserId>
    </OrderController.DesignatedReceiver>
  </DesignatedReceivers>
  <DocumentGuid>ecab7e82-5663-4be2-958d-7ca1816da2ad</DocumentGuid>
  <DocumentId>1</DocumentId>
  <Lines>
    <OrderController.OrderLine>
      <ApproveDate>2026-09-21T02:44:59.8974718-05:00</ApproveDate>
      <CompanyCode>sample string 32</CompanyCode>
      <CompanyName>sample string 33</CompanyName>
      <CreateDate>2026-09-21T02:44:59.8974718-05:00</CreateDate>
      <CreatedByName>sample string 34</CreatedByName>
      <DocumentId>1</DocumentId>
      <Freight>1</Freight>
      <GLCode>sample string 28</GLCode>
      <IsReceiverRequired>true</IsReceiverRequired>
      <ItemDescription>sample string 5</ItemDescription>
      <ItemNumber>sample string 4</ItemNumber>
      <LineNumber>sample string 1</LineNumber>
      <LineTotal>9</LineTotal>
      <LocationCode>sample string 36</LocationCode>
      <LocationName>sample string 37</LocationName>
      <NoteToSupplier>sample string 10</NoteToSupplier>
      <ProjectLineNumber>sample string 29</ProjectLineNumber>
      <ProjectName>sample string 31</ProjectName>
      <ProjectNumber>sample string 30</ProjectNumber>
      <Quantity>1</Quantity>
      <ReceiverName>sample string 38</ReceiverName>
      <RejectDate>2026-09-21T02:44:59.8974718-05:00</RejectDate>
      <Segment1>sample string 11</Segment1>
      <Segment10>sample string 20</Segment10>
      <Segment2>sample string 12</Segment2>
      <Segment3>sample string 13</Segment3>
      <Segment4>sample string 14</Segment4>
      <Segment5>sample string 15</Segment5>
      <Segment6>sample string 16</Segment6>
      <Segment7>sample string 17</Segment7>
      <Segment8>sample string 18</Segment8>
      <Segment9>sample string 19</Segment9>
      <ShipToAddress1>sample string 23</ShipToAddress1>
      <ShipToAddress2>sample string 24</ShipToAddress2>
      <ShipToCity>sample string 25</ShipToCity>
      <ShipToLocation>sample string 22</ShipToLocation>
      <ShipToState>sample string 26</ShipToState>
      <ShipToZip>sample string 27</ShipToZip>
      <StatusDesc>sample string 35</StatusDesc>
      <Tax>1</Tax>
      <UnitOfMeasure>sample string 7</UnitOfMeasure>
      <UnitPrice>8</UnitPrice>
      <VendorCode>sample string 2</VendorCode>
      <VendorItemNumber>sample string 6</VendorItemNumber>
      <VendorName>sample string 3</VendorName>
    </OrderController.OrderLine>
    <OrderController.OrderLine>
      <ApproveDate>2026-09-21T02:44:59.8974718-05:00</ApproveDate>
      <CompanyCode>sample string 32</CompanyCode>
      <CompanyName>sample string 33</CompanyName>
      <CreateDate>2026-09-21T02:44:59.8974718-05:00</CreateDate>
      <CreatedByName>sample string 34</CreatedByName>
      <DocumentId>1</DocumentId>
      <Freight>1</Freight>
      <GLCode>sample string 28</GLCode>
      <IsReceiverRequired>true</IsReceiverRequired>
      <ItemDescription>sample string 5</ItemDescription>
      <ItemNumber>sample string 4</ItemNumber>
      <LineNumber>sample string 1</LineNumber>
      <LineTotal>9</LineTotal>
      <LocationCode>sample string 36</LocationCode>
      <LocationName>sample string 37</LocationName>
      <NoteToSupplier>sample string 10</NoteToSupplier>
      <ProjectLineNumber>sample string 29</ProjectLineNumber>
      <ProjectName>sample string 31</ProjectName>
      <ProjectNumber>sample string 30</ProjectNumber>
      <Quantity>1</Quantity>
      <ReceiverName>sample string 38</ReceiverName>
      <RejectDate>2026-09-21T02:44:59.8974718-05:00</RejectDate>
      <Segment1>sample string 11</Segment1>
      <Segment10>sample string 20</Segment10>
      <Segment2>sample string 12</Segment2>
      <Segment3>sample string 13</Segment3>
      <Segment4>sample string 14</Segment4>
      <Segment5>sample string 15</Segment5>
      <Segment6>sample string 16</Segment6>
      <Segment7>sample string 17</Segment7>
      <Segment8>sample string 18</Segment8>
      <Segment9>sample string 19</Segment9>
      <ShipToAddress1>sample string 23</ShipToAddress1>
      <ShipToAddress2>sample string 24</ShipToAddress2>
      <ShipToCity>sample string 25</ShipToCity>
      <ShipToLocation>sample string 22</ShipToLocation>
      <ShipToState>sample string 26</ShipToState>
      <ShipToZip>sample string 27</ShipToZip>
      <StatusDesc>sample string 35</StatusDesc>
      <Tax>1</Tax>
      <UnitOfMeasure>sample string 7</UnitOfMeasure>
      <UnitPrice>8</UnitPrice>
      <VendorCode>sample string 2</VendorCode>
      <VendorItemNumber>sample string 6</VendorItemNumber>
      <VendorName>sample string 3</VendorName>
    </OrderController.OrderLine>
  </Lines>
  <LocationCode>sample string 9</LocationCode>
  <LocationName>sample string 10</LocationName>
  <OrderDate>2026-09-21T02:44:59.8974718-05:00</OrderDate>
  <OrderNumber>sample string 4</OrderNumber>
  <StatusDesc>sample string 12</StatusDesc>
  <Total>14</Total>
</OrderController.Order>