GET PurchaseReceipt/GetPurchaseReceiptByVendorIDByTicketNumber?VendID={VendID}&TicketNum={TicketNum}

Returns purchase receipt

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
VendID

Vendor ID of purchase orders to return

string

Required

TicketNum

Ticket number of purchase orders to return

string

Required

Body Parameters

Response Information

Resource Description

Returns purchase receipt

AgvPurchaseReceiptFull
NameDescriptionTypeAdditional Information
Status

0 - Success; 1 - An error occurred; 2 - An error occurred; 3 - Descriptive message, process was successful

string
Message

Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know

string
Count

Number of results returned

string
PurchaseReceipt

JSON Object of PurchaseReceipt

ClsPurJnl

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "PurchaseReceipt": {
    "VendorID": "sample string 1",
    "TicketNumber": "sample string 2",
    "Shipdate": "sample string 3",
    "ControlNumber": "sample string 4",
    "LocationID": "sample string 5",
    "FreightType": "sample string 6",
    "FreightVendorID": "sample string 7",
    "LoadNumber": "sample string 11",
    "Notes": "sample string 12",
    "FreightTotalDollars": 17.1,
    "UseAgvanceAddons": true,
    "CalculateFreightFromPurchaseOrders": true,
    "CalculateAddOnsFromPurchaseOrders": true,
    "PurchaseReceiptGuid": "0bcc6831-5314-4727-b263-ebfa9e1afd48",
    "LastModifiedUTC": "2024-11-21T09:49:28.329023+00:00",
    "ReceiptDetail": [
      {
        "DepartmentID": "sample string 4",
        "ProductID": "sample string 5",
        "ProductDescription": "sample string 6",
        "Quantity": 7.1,
        "Cost": 8.1,
        "Lotnum": "sample string 12",
        "LotExpireDate": "sample string 13",
        "PONumber": "sample string 14",
        "POLineItem": 15
      },
      {
        "DepartmentID": "sample string 4",
        "ProductID": "sample string 5",
        "ProductDescription": "sample string 6",
        "Quantity": 7.1,
        "Cost": 8.1,
        "Lotnum": "sample string 12",
        "LotExpireDate": "sample string 13",
        "PONumber": "sample string 14",
        "POLineItem": 15
      }
    ],
    "ReceiptAddOn": [
      {
        "LineItem": 4,
        "Rate": 7.1,
        "CalculateAs": "sample string 8",
        "ApplyTo": "sample string 10",
        "GlAccount": "sample string 11",
        "Vendor": "sample string 12",
        "ChargeId": "sample string 14"
      },
      {
        "LineItem": 4,
        "Rate": 7.1,
        "CalculateAs": "sample string 8",
        "ApplyTo": "sample string 10",
        "GlAccount": "sample string 11",
        "Vendor": "sample string 12",
        "ChargeId": "sample string 14"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<AgvPurchaseReceiptFull 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>
  <PurchaseReceipt xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
    <d2p1:CalculateAddOnsFromPurchaseOrders>true</d2p1:CalculateAddOnsFromPurchaseOrders>
    <d2p1:CalculateFreightFromPurchaseOrders>true</d2p1:CalculateFreightFromPurchaseOrders>
    <d2p1:ControlNumber>sample string 4</d2p1:ControlNumber>
    <d2p1:FreightTotalDollars>17.1</d2p1:FreightTotalDollars>
    <d2p1:FreightType>sample string 6</d2p1:FreightType>
    <d2p1:FreightVendorID>sample string 7</d2p1:FreightVendorID>
    <d2p1:LastModifiedUTC>2024-11-21T09:49:28.329023+00:00</d2p1:LastModifiedUTC>
    <d2p1:LoadNumber>sample string 11</d2p1:LoadNumber>
    <d2p1:LocationID>sample string 5</d2p1:LocationID>
    <d2p1:Notes>sample string 12</d2p1:Notes>
    <d2p1:PurchaseReceiptGuid>0bcc6831-5314-4727-b263-ebfa9e1afd48</d2p1:PurchaseReceiptGuid>
    <d2p1:ReceiptAddOn>
      <d2p1:ReceiptAddOn>
        <d2p1:ApplyTo>sample string 10</d2p1:ApplyTo>
        <d2p1:CalculateAs>sample string 8</d2p1:CalculateAs>
        <d2p1:ChargeId>sample string 14</d2p1:ChargeId>
        <d2p1:GlAccount>sample string 11</d2p1:GlAccount>
        <d2p1:LineItem>4</d2p1:LineItem>
        <d2p1:Rate>7.1</d2p1:Rate>
        <d2p1:Vendor>sample string 12</d2p1:Vendor>
      </d2p1:ReceiptAddOn>
      <d2p1:ReceiptAddOn>
        <d2p1:ApplyTo>sample string 10</d2p1:ApplyTo>
        <d2p1:CalculateAs>sample string 8</d2p1:CalculateAs>
        <d2p1:ChargeId>sample string 14</d2p1:ChargeId>
        <d2p1:GlAccount>sample string 11</d2p1:GlAccount>
        <d2p1:LineItem>4</d2p1:LineItem>
        <d2p1:Rate>7.1</d2p1:Rate>
        <d2p1:Vendor>sample string 12</d2p1:Vendor>
      </d2p1:ReceiptAddOn>
    </d2p1:ReceiptAddOn>
    <d2p1:ReceiptDetail>
      <d2p1:ReceiptDetail>
        <d2p1:Cost>8.1</d2p1:Cost>
        <d2p1:DepartmentID>sample string 4</d2p1:DepartmentID>
        <d2p1:LotExpireDate>sample string 13</d2p1:LotExpireDate>
        <d2p1:Lotnum>sample string 12</d2p1:Lotnum>
        <d2p1:POLineItem>15</d2p1:POLineItem>
        <d2p1:PONumber>sample string 14</d2p1:PONumber>
        <d2p1:ProductDescription>sample string 6</d2p1:ProductDescription>
        <d2p1:ProductID>sample string 5</d2p1:ProductID>
        <d2p1:Quantity>7.1</d2p1:Quantity>
      </d2p1:ReceiptDetail>
      <d2p1:ReceiptDetail>
        <d2p1:Cost>8.1</d2p1:Cost>
        <d2p1:DepartmentID>sample string 4</d2p1:DepartmentID>
        <d2p1:LotExpireDate>sample string 13</d2p1:LotExpireDate>
        <d2p1:Lotnum>sample string 12</d2p1:Lotnum>
        <d2p1:POLineItem>15</d2p1:POLineItem>
        <d2p1:PONumber>sample string 14</d2p1:PONumber>
        <d2p1:ProductDescription>sample string 6</d2p1:ProductDescription>
        <d2p1:ProductID>sample string 5</d2p1:ProductID>
        <d2p1:Quantity>7.1</d2p1:Quantity>
      </d2p1:ReceiptDetail>
    </d2p1:ReceiptDetail>
    <d2p1:Shipdate>sample string 3</d2p1:Shipdate>
    <d2p1:TicketNumber>sample string 2</d2p1:TicketNumber>
    <d2p1:UseAgvanceAddons>true</d2p1:UseAgvanceAddons>
    <d2p1:VendorID>sample string 1</d2p1:VendorID>
  </PurchaseReceipt>
  <Status>sample string 1</Status>
</AgvPurchaseReceiptFull>