GET PurchaseReceiptList/GetPurchaseReceipt?PONumber={PONumber}&TicketNumber={TicketNumber}&IncludeProcessed={IncludeProcessed}&IncludeUnprocessed={IncludeUnprocessed}&UsePO={UsePO}&UseTicket={UseTicket}&UseDateRange={UseDateRange}&IncludeICT={IncludeICT}&StartDate={StartDate}&EndDate={EndDate}&VendorID={VendorID}&ReceiptType={ReceiptType}&filterOnOrAfterUtc={filterOnOrAfterUtc}&filterOnOrBeforeUtc={filterOnOrBeforeUtc}

Returns a list of purchase receipts

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
PONumber

PONumber of purchase orders to return. (optional)

string

Default value is string.Empty

TicketNumber

TicketNumber of purchase orders to return. (optional)

string

Default value is string.Empty

IncludeProcessed

Include processed purchase receipts in the return list. The default is False. (optional)

boolean

Default value is False

IncludeUnprocessed

Include unprocessed purchase receipts in the return list. The default is True. If both IncludeProcessed and IncludeUnprocessed are False, no data will be returned. (optional)

boolean

Default value is True

UsePO

If true, include only purchase receipts for this PO number. (optional)

boolean

Default value is False

UseTicket

include purchase receipt if it matches ticket number of purchase receipt to return. (optional)

boolean

Default value is False

UseDateRange

UseDateRange to indicate whether or not to filter by the Start and End Dates used on the purchase receipts. (optional)

boolean

Default value is False

IncludeICT

Include ICT of purchase orders to return. (optional)

boolean

Default value is False

StartDate

If UseDateRange is true, the Start Shipped Date of the purchase receipts. Format MM-dd-yyyy (optional)

string

Default value is string.Empty

EndDate

If UseDateRange is true, the End Shipped Date of the purchase receipts. Format MM-dd-yyyy (optional)

string

Default value is string.Empty

VendorID

Vendor ID to return purchase receipts for. (optional)

string

Default value is string.Empty

ReceiptType

Receipt Type to return: TI for Transfer In, TO for Transfer Out, RV for Return, PR for Regular. (optional)

string

Default value is string.Empty

filterOnOrAfterUtc

Filter the list of tickets to those changed on or after the supplied UTC date and time (optional) - format = yyyy-MM-ddTHH:mm:ss

date
filterOnOrBeforeUtc

Filter the list of tickets to those changed on or before the supplied UTC date and time (optional) format = yyyy-MM-ddTHH:mm:ss

date

Body Parameters

Response Information

Resource Description

Returns a list of purchase receipts

AgvPurchaseReceiptList
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many PurchaseReceipt JSON dictionaries.

string
PurchaseReceiptList

JSON dictionary of PurchaseReceiptList.

Collection of PurchaseReceiptListItem

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "PurchaseReceiptList": [
    {
      "VendorID": "sample string 1",
      "TicketNumber": "sample string 2",
      "ShipDate": "sample string 3",
      "TicketType": "sample string 4",
      "VendorName": "sample string 5",
      "Voided": true,
      "LastModifiedUtc": "2022-12-08T03:20:49.3936423+00:00"
    },
    {
      "VendorID": "sample string 1",
      "TicketNumber": "sample string 2",
      "ShipDate": "sample string 3",
      "TicketType": "sample string 4",
      "VendorName": "sample string 5",
      "Voided": true,
      "LastModifiedUtc": "2022-12-08T03:20:49.3936423+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvPurchaseReceiptList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vendor">
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <PurchaseReceiptList>
    <AgvPurchaseReceiptList.PurchaseReceiptListItem>
      <LastModifiedUtc>2022-12-08T03:20:49.3936423+00:00</LastModifiedUtc>
      <ShipDate>sample string 3</ShipDate>
      <TicketNumber>sample string 2</TicketNumber>
      <TicketType>sample string 4</TicketType>
      <VendorID>sample string 1</VendorID>
      <VendorName>sample string 5</VendorName>
      <Voided>true</Voided>
    </AgvPurchaseReceiptList.PurchaseReceiptListItem>
    <AgvPurchaseReceiptList.PurchaseReceiptListItem>
      <LastModifiedUtc>2022-12-08T03:20:49.3936423+00:00</LastModifiedUtc>
      <ShipDate>sample string 3</ShipDate>
      <TicketNumber>sample string 2</TicketNumber>
      <TicketType>sample string 4</TicketType>
      <VendorID>sample string 1</VendorID>
      <VendorName>sample string 5</VendorName>
      <Voided>true</Voided>
    </AgvPurchaseReceiptList.PurchaseReceiptListItem>
  </PurchaseReceiptList>
  <Status>sample string 1</Status>
</AgvPurchaseReceiptList>