GET api/Receiver/ByInvoiceDocId/{invoiceDocId}

Get receivers associated with an invoice Document ID. If there are no receivers associated with the provided invoice document ID, an empty receiver list will be returned.

Request Information

URI Parameters

Name	Description	Type	Additional information
invoiceDocId	Invoice document Id	integer	Required

Body Parameters

None.

Response Information

Resource Description

List of receivers associated with an invoice

Collection of Receiver

Name	Description	Type	Additional information
POReceiverId	Receiver Id	integer	Required
ReceiverGuid	Receiver GUID	globally unique identifier	Required
CreateDate	Create Date	date	Required
LastUpdateDate	Last Update Date	date	None.
CreatedByName	Create by Name	string	None.
PONumber	PO Number	string	Required
POHeaderId	PO Header Id	integer	Required
Total	Receiver Total	decimal number	Required
Subtotal	Receiver Subtotal	decimal number	None.
Discount	Discount	decimal number	None.
Tax	Tax	decimal number	None.
Freight	Freight	decimal number	None.
UserDecimal1	User Decimal 1 - See implementation guide	decimal number	None.
UserDecimal2	User Decimal 2 - See implementation guide	decimal number	None.
UserDecimal3	User Decimal 3 - See implementation guide	decimal number	None.
ReceiverName	Receiver Name	string	None.
ReceiptNumber	Receipt Number	string	None.
ReceiveDate	Receive Date	date	Required
VendorName	Vendor Name	string	Required
VendorCode	Vendor Code	string	Required
Comments	Comments	string	None.
UserText1	User Text 1 - see implementation guide	string	None.
UserText2	User Text 2 - see implementation guide	string	None.
UserText3	User Text 3 - see implementation guide	string	None.
ExportDate	The date the this line was exported to the ERP system	date	None.
ShipDate	Ship Date	date	None.
DeliveredDate	Delivery Date	date	None.
Lines	Receiver Lines	Collection of Line	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "POReceiverId": 1,
    "ReceiverGuid": "33977d74-0571-493f-be5e-b295b122ca9b",
    "CreateDate": "2026-09-21T02:46:38.8869424-05:00",
    "LastUpdateDate": "2026-09-21T02:46:38.8869424-05:00",
    "CreatedByName": "sample string 3",
    "PONumber": "sample string 4",
    "POHeaderId": 1,
    "Total": 5.0,
    "Subtotal": 6.0,
    "Discount": 7.0,
    "Tax": 8.0,
    "Freight": 9.0,
    "UserDecimal1": 10.0,
    "UserDecimal2": 11.0,
    "UserDecimal3": 12.0,
    "ReceiverName": "sample string 13",
    "ReceiptNumber": "sample string 14",
    "ReceiveDate": "2026-09-21T02:46:38.8869424-05:00",
    "VendorName": "sample string 16",
    "VendorCode": "sample string 17",
    "Comments": "sample string 18",
    "UserText1": "sample string 19",
    "UserText2": "sample string 20",
    "UserText3": "sample string 21",
    "ExportDate": "2026-09-21T02:46:38.8869424-05:00",
    "ShipDate": "2026-09-21T02:46:38.8869424-05:00",
    "DeliveredDate": "2026-09-21T02:46:38.8869424-05:00",
    "Lines": [
      {
        "ReceiverLineId": 1,
        "ReceiverId": 2,
        "POHeaderId": 3,
        "POLineId": 4,
        "CreateDate": "2026-09-21T02:46:38.8869424-05:00",
        "CreatedByName": "sample string 6",
        "LineNumber": "sample string 7",
        "ItemCategory": "sample string 8",
        "ItemNumberCustomer": "sample string 9",
        "ItemDescriptionCustomer": "sample string 10",
        "ItemNumberVendor": "sample string 11",
        "ItemDescriptionVendor": "sample string 12",
        "UnitOfMeasure": "sample string 13",
        "UnitPrice": 14.0,
        "QuantityOrdered": 15.0,
        "QuantityReceived": 16.0,
        "Tax": 17.0,
        "Freight": 18.0,
        "Discount": 19.0,
        "LineTotal": 20.0,
        "Comments": "sample string 21",
        "UserText1": "sample string 22",
        "UserText2": "sample string 23",
        "UserText3": "sample string 24",
        "IsActive": true,
        "LastUpdateDate": "2026-09-21T02:46:38.8869424-05:00",
        "ExportDate": "2026-09-21T02:46:38.8869424-05:00",
        "DeliveredDate": "2026-09-21T02:46:38.8869424-05:00"
      },
      {
        "ReceiverLineId": 1,
        "ReceiverId": 2,
        "POHeaderId": 3,
        "POLineId": 4,
        "CreateDate": "2026-09-21T02:46:38.8869424-05:00",
        "CreatedByName": "sample string 6",
        "LineNumber": "sample string 7",
        "ItemCategory": "sample string 8",
        "ItemNumberCustomer": "sample string 9",
        "ItemDescriptionCustomer": "sample string 10",
        "ItemNumberVendor": "sample string 11",
        "ItemDescriptionVendor": "sample string 12",
        "UnitOfMeasure": "sample string 13",
        "UnitPrice": 14.0,
        "QuantityOrdered": 15.0,
        "QuantityReceived": 16.0,
        "Tax": 17.0,
        "Freight": 18.0,
        "Discount": 19.0,
        "LineTotal": 20.0,
        "Comments": "sample string 21",
        "UserText1": "sample string 22",
        "UserText2": "sample string 23",
        "UserText3": "sample string 24",
        "IsActive": true,
        "LastUpdateDate": "2026-09-21T02:46:38.8869424-05:00",
        "ExportDate": "2026-09-21T02:46:38.8869424-05:00",
        "DeliveredDate": "2026-09-21T02:46:38.8869424-05:00"
      }
    ]
  },
  {
    "POReceiverId": 1,
    "ReceiverGuid": "33977d74-0571-493f-be5e-b295b122ca9b",
    "CreateDate": "2026-09-21T02:46:38.8869424-05:00",
    "LastUpdateDate": "2026-09-21T02:46:38.8869424-05:00",
    "CreatedByName": "sample string 3",
    "PONumber": "sample string 4",
    "POHeaderId": 1,
    "Total": 5.0,
    "Subtotal": 6.0,
    "Discount": 7.0,
    "Tax": 8.0,
    "Freight": 9.0,
    "UserDecimal1": 10.0,
    "UserDecimal2": 11.0,
    "UserDecimal3": 12.0,
    "ReceiverName": "sample string 13",
    "ReceiptNumber": "sample string 14",
    "ReceiveDate": "2026-09-21T02:46:38.8869424-05:00",
    "VendorName": "sample string 16",
    "VendorCode": "sample string 17",
    "Comments": "sample string 18",
    "UserText1": "sample string 19",
    "UserText2": "sample string 20",
    "UserText3": "sample string 21",
    "ExportDate": "2026-09-21T02:46:38.8869424-05:00",
    "ShipDate": "2026-09-21T02:46:38.8869424-05:00",
    "DeliveredDate": "2026-09-21T02:46:38.8869424-05:00",
    "Lines": [
      {
        "ReceiverLineId": 1,
        "ReceiverId": 2,
        "POHeaderId": 3,
        "POLineId": 4,
        "CreateDate": "2026-09-21T02:46:38.8869424-05:00",
        "CreatedByName": "sample string 6",
        "LineNumber": "sample string 7",
        "ItemCategory": "sample string 8",
        "ItemNumberCustomer": "sample string 9",
        "ItemDescriptionCustomer": "sample string 10",
        "ItemNumberVendor": "sample string 11",
        "ItemDescriptionVendor": "sample string 12",
        "UnitOfMeasure": "sample string 13",
        "UnitPrice": 14.0,
        "QuantityOrdered": 15.0,
        "QuantityReceived": 16.0,
        "Tax": 17.0,
        "Freight": 18.0,
        "Discount": 19.0,
        "LineTotal": 20.0,
        "Comments": "sample string 21",
        "UserText1": "sample string 22",
        "UserText2": "sample string 23",
        "UserText3": "sample string 24",
        "IsActive": true,
        "LastUpdateDate": "2026-09-21T02:46:38.8869424-05:00",
        "ExportDate": "2026-09-21T02:46:38.8869424-05:00",
        "DeliveredDate": "2026-09-21T02:46:38.8869424-05:00"
      },
      {
        "ReceiverLineId": 1,
        "ReceiverId": 2,
        "POHeaderId": 3,
        "POLineId": 4,
        "CreateDate": "2026-09-21T02:46:38.8869424-05:00",
        "CreatedByName": "sample string 6",
        "LineNumber": "sample string 7",
        "ItemCategory": "sample string 8",
        "ItemNumberCustomer": "sample string 9",
        "ItemDescriptionCustomer": "sample string 10",
        "ItemNumberVendor": "sample string 11",
        "ItemDescriptionVendor": "sample string 12",
        "UnitOfMeasure": "sample string 13",
        "UnitPrice": 14.0,
        "QuantityOrdered": 15.0,
        "QuantityReceived": 16.0,
        "Tax": 17.0,
        "Freight": 18.0,
        "Discount": 19.0,
        "LineTotal": 20.0,
        "Comments": "sample string 21",
        "UserText1": "sample string 22",
        "UserText2": "sample string 23",
        "UserText3": "sample string 24",
        "IsActive": true,
        "LastUpdateDate": "2026-09-21T02:46:38.8869424-05:00",
        "ExportDate": "2026-09-21T02:46:38.8869424-05:00",
        "DeliveredDate": "2026-09-21T02:46:38.8869424-05:00"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfReceiverController.Receiver xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <ReceiverController.Receiver>
    <Comments>sample string 18</Comments>
    <CreateDate>2026-09-21T02:46:38.8869424-05:00</CreateDate>
    <CreatedByName>sample string 3</CreatedByName>
    <DeliveredDate>2026-09-21T02:46:38.8869424-05:00</DeliveredDate>
    <Discount>7</Discount>
    <ExportDate>2026-09-21T02:46:38.8869424-05:00</ExportDate>
    <Freight>9</Freight>
    <LastUpdateDate>2026-09-21T02:46:38.8869424-05:00</LastUpdateDate>
    <Lines>
      <ReceiverController.Line>
        <Comments>sample string 21</Comments>
        <CreateDate>2026-09-21T02:46:38.8869424-05:00</CreateDate>
        <CreatedByName>sample string 6</CreatedByName>
        <DeliveredDate>2026-09-21T02:46:38.8869424-05:00</DeliveredDate>
        <Discount>19</Discount>
        <ExportDate>2026-09-21T02:46:38.8869424-05:00</ExportDate>
        <Freight>18</Freight>
        <IsActive>true</IsActive>
        <ItemCategory>sample string 8</ItemCategory>
        <ItemDescriptionCustomer>sample string 10</ItemDescriptionCustomer>
        <ItemDescriptionVendor>sample string 12</ItemDescriptionVendor>
        <ItemNumberCustomer>sample string 9</ItemNumberCustomer>
        <ItemNumberVendor>sample string 11</ItemNumberVendor>
        <LastUpdateDate>2026-09-21T02:46:38.8869424-05:00</LastUpdateDate>
        <LineNumber>sample string 7</LineNumber>
        <LineTotal>20</LineTotal>
        <POHeaderId>3</POHeaderId>
        <POLineId>4</POLineId>
        <QuantityOrdered>15</QuantityOrdered>
        <QuantityReceived>16</QuantityReceived>
        <ReceiverId>2</ReceiverId>
        <ReceiverLineId>1</ReceiverLineId>
        <Tax>17</Tax>
        <UnitOfMeasure>sample string 13</UnitOfMeasure>
        <UnitPrice>14</UnitPrice>
        <UserText1>sample string 22</UserText1>
        <UserText2>sample string 23</UserText2>
        <UserText3>sample string 24</UserText3>
      </ReceiverController.Line>
      <ReceiverController.Line>
        <Comments>sample string 21</Comments>
        <CreateDate>2026-09-21T02:46:38.8869424-05:00</CreateDate>
        <CreatedByName>sample string 6</CreatedByName>
        <DeliveredDate>2026-09-21T02:46:38.8869424-05:00</DeliveredDate>
        <Discount>19</Discount>
        <ExportDate>2026-09-21T02:46:38.8869424-05:00</ExportDate>
        <Freight>18</Freight>
        <IsActive>true</IsActive>
        <ItemCategory>sample string 8</ItemCategory>
        <ItemDescriptionCustomer>sample string 10</ItemDescriptionCustomer>
        <ItemDescriptionVendor>sample string 12</ItemDescriptionVendor>
        <ItemNumberCustomer>sample string 9</ItemNumberCustomer>
        <ItemNumberVendor>sample string 11</ItemNumberVendor>
        <LastUpdateDate>2026-09-21T02:46:38.8869424-05:00</LastUpdateDate>
        <LineNumber>sample string 7</LineNumber>
        <LineTotal>20</LineTotal>
        <POHeaderId>3</POHeaderId>
        <POLineId>4</POLineId>
        <QuantityOrdered>15</QuantityOrdered>
        <QuantityReceived>16</QuantityReceived>
        <ReceiverId>2</ReceiverId>
        <ReceiverLineId>1</ReceiverLineId>
        <Tax>17</Tax>
        <UnitOfMeasure>sample string 13</UnitOfMeasure>
        <UnitPrice>14</UnitPrice>
        <UserText1>sample string 22</UserText1>
        <UserText2>sample string 23</UserText2>
        <UserText3>sample string 24</UserText3>
      </ReceiverController.Line>
    </Lines>
    <POHeaderId>1</POHeaderId>
    <PONumber>sample string 4</PONumber>
    <POReceiverId>1</POReceiverId>
    <ReceiptNumber>sample string 14</ReceiptNumber>
    <ReceiveDate>2026-09-21T02:46:38.8869424-05:00</ReceiveDate>
    <ReceiverGuid>33977d74-0571-493f-be5e-b295b122ca9b</ReceiverGuid>
    <ReceiverName>sample string 13</ReceiverName>
    <ShipDate>2026-09-21T02:46:38.8869424-05:00</ShipDate>
    <Subtotal>6</Subtotal>
    <Tax>8</Tax>
    <Total>5</Total>
    <UserDecimal1>10</UserDecimal1>
    <UserDecimal2>11</UserDecimal2>
    <UserDecimal3>12</UserDecimal3>
    <UserText1>sample string 19</UserText1>
    <UserText2>sample string 20</UserText2>
    <UserText3>sample string 21</UserText3>
    <VendorCode>sample string 17</VendorCode>
    <VendorName>sample string 16</VendorName>
  </ReceiverController.Receiver>
  <ReceiverController.Receiver>
    <Comments>sample string 18</Comments>
    <CreateDate>2026-09-21T02:46:38.8869424-05:00</CreateDate>
    <CreatedByName>sample string 3</CreatedByName>
    <DeliveredDate>2026-09-21T02:46:38.8869424-05:00</DeliveredDate>
    <Discount>7</Discount>
    <ExportDate>2026-09-21T02:46:38.8869424-05:00</ExportDate>
    <Freight>9</Freight>
    <LastUpdateDate>2026-09-21T02:46:38.8869424-05:00</LastUpdateDate>
    <Lines>
      <ReceiverController.Line>
        <Comments>sample string 21</Comments>
        <CreateDate>2026-09-21T02:46:38.8869424-05:00</CreateDate>
        <CreatedByName>sample string 6</CreatedByName>
        <DeliveredDate>2026-09-21T02:46:38.8869424-05:00</DeliveredDate>
        <Discount>19</Discount>
        <ExportDate>2026-09-21T02:46:38.8869424-05:00</ExportDate>
        <Freight>18</Freight>
        <IsActive>true</IsActive>
        <ItemCategory>sample string 8</ItemCategory>
        <ItemDescriptionCustomer>sample string 10</ItemDescriptionCustomer>
        <ItemDescriptionVendor>sample string 12</ItemDescriptionVendor>
        <ItemNumberCustomer>sample string 9</ItemNumberCustomer>
        <ItemNumberVendor>sample string 11</ItemNumberVendor>
        <LastUpdateDate>2026-09-21T02:46:38.8869424-05:00</LastUpdateDate>
        <LineNumber>sample string 7</LineNumber>
        <LineTotal>20</LineTotal>
        <POHeaderId>3</POHeaderId>
        <POLineId>4</POLineId>
        <QuantityOrdered>15</QuantityOrdered>
        <QuantityReceived>16</QuantityReceived>
        <ReceiverId>2</ReceiverId>
        <ReceiverLineId>1</ReceiverLineId>
        <Tax>17</Tax>
        <UnitOfMeasure>sample string 13</UnitOfMeasure>
        <UnitPrice>14</UnitPrice>
        <UserText1>sample string 22</UserText1>
        <UserText2>sample string 23</UserText2>
        <UserText3>sample string 24</UserText3>
      </ReceiverController.Line>
      <ReceiverController.Line>
        <Comments>sample string 21</Comments>
        <CreateDate>2026-09-21T02:46:38.8869424-05:00</CreateDate>
        <CreatedByName>sample string 6</CreatedByName>
        <DeliveredDate>2026-09-21T02:46:38.8869424-05:00</DeliveredDate>
        <Discount>19</Discount>
        <ExportDate>2026-09-21T02:46:38.8869424-05:00</ExportDate>
        <Freight>18</Freight>
        <IsActive>true</IsActive>
        <ItemCategory>sample string 8</ItemCategory>
        <ItemDescriptionCustomer>sample string 10</ItemDescriptionCustomer>
        <ItemDescriptionVendor>sample string 12</ItemDescriptionVendor>
        <ItemNumberCustomer>sample string 9</ItemNumberCustomer>
        <ItemNumberVendor>sample string 11</ItemNumberVendor>
        <LastUpdateDate>2026-09-21T02:46:38.8869424-05:00</LastUpdateDate>
        <LineNumber>sample string 7</LineNumber>
        <LineTotal>20</LineTotal>
        <POHeaderId>3</POHeaderId>
        <POLineId>4</POLineId>
        <QuantityOrdered>15</QuantityOrdered>
        <QuantityReceived>16</QuantityReceived>
        <ReceiverId>2</ReceiverId>
        <ReceiverLineId>1</ReceiverLineId>
        <Tax>17</Tax>
        <UnitOfMeasure>sample string 13</UnitOfMeasure>
        <UnitPrice>14</UnitPrice>
        <UserText1>sample string 22</UserText1>
        <UserText2>sample string 23</UserText2>
        <UserText3>sample string 24</UserText3>
      </ReceiverController.Line>
    </Lines>
    <POHeaderId>1</POHeaderId>
    <PONumber>sample string 4</PONumber>
    <POReceiverId>1</POReceiverId>
    <ReceiptNumber>sample string 14</ReceiptNumber>
    <ReceiveDate>2026-09-21T02:46:38.8869424-05:00</ReceiveDate>
    <ReceiverGuid>33977d74-0571-493f-be5e-b295b122ca9b</ReceiverGuid>
    <ReceiverName>sample string 13</ReceiverName>
    <ShipDate>2026-09-21T02:46:38.8869424-05:00</ShipDate>
    <Subtotal>6</Subtotal>
    <Tax>8</Tax>
    <Total>5</Total>
    <UserDecimal1>10</UserDecimal1>
    <UserDecimal2>11</UserDecimal2>
    <UserDecimal3>12</UserDecimal3>
    <UserText1>sample string 19</UserText1>
    <UserText2>sample string 20</UserText2>
    <UserText3>sample string 21</UserText3>
    <VendorCode>sample string 17</VendorCode>
    <VendorName>sample string 16</VendorName>
  </ReceiverController.Receiver>
</ArrayOfReceiverController.Receiver>