GET ApPurchaseOrder/GetApPo?vendorId={vendorId}&poNumber={poNumber}&poDate={poDate}&status={status}&apPoGuid={apPoGuid}

Returns AP Purchase Orders

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
vendorId

The Vendor ID the AP PO is for. (optional)

string

Default value is string.Empty

poNumber

The po number of the transaction. (optional)

string

Default value is string.Empty

poDate

The date of the AP PO. Format MM-dd-yyyy (optional)

date
status

The current status of the AP PO returned. Statuses are both, open, or closed. (optional)

string

Default value is Both

apPoGuid

The Globally Unique Identifier of the AP PO (optional)

globally unique identifier

Body Parameters

Response Information

Resource Description

Returns AP Purchase Orders

AgvApPo
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
ErrorList

List of error messages of the API call.

Collection of string
WarningList

List of warning messages of the API call.

Collection of string
Count

Number of results returned.

string
Data

List of Properties and Values returned for each AP Purchase Order that matches request

Collection of clsApBill

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "Data": [
    {
      "Vendor": "sample string 1",
      "InvoiceNumber": "sample string 2",
      "Description": "sample string 3",
      "EntryDate": "sample string 4",
      "BillDate": "sample string 5",
      "DueDate": "sample string 6",
      "Source": "sample string 7",
      "UserName": "sample string 8",
      "PONumber": "sample string 9",
      "OnHoldYN": true,
      "PaidByDate1": "sample string 11",
      "PaidByDate2": "sample string 12",
      "PaidByDate3": "sample string 13",
      "PaidByDate4": "sample string 14",
      "PaidByDate5": "sample string 15",
      "DeductionPercent1": 16.1,
      "DeductionPercent2": 17.1,
      "DeductionPercent3": 18.1,
      "DeductionPercent4": 19.1,
      "DeductionPercent5": 20.1,
      "DiscountAmount1": 21.1,
      "DiscountAmount2": 22.1,
      "DiscountAmount3": 23.1,
      "DiscountAmount4": 24.1,
      "DiscountAmount5": 25.1,
      "DiscountGL": "sample string 26",
      "Gross": 27.1,
      "Discount": 28.1,
      "Net": 29.1,
      "DatePaid": "sample string 30",
      "AmountPaid": 31.1,
      "PaidYN": true,
      "VoidedYN": true,
      "ReversedYN": true,
      "Amount1099": 35.1,
      "CheckNumber": "sample string 36",
      "FiscalMonth": 37,
      "UsePrepayYN": true,
      "Transferred": true,
      "LocationID": "sample string 40",
      "SpecialHandling": "sample string 41",
      "PayByEFTYN": true,
      "Notes": "sample string 43",
      "POInvoice": "sample string 44",
      "APPurchaseOrder": true,
      "UserID": "sample string 46",
      "ApBillGuid": "ef7315d6-1ba8-4046-8954-5116b4b558c3",
      "BillDetail": [
        {
          "Vendor": "sample string 1",
          "Invoice": "sample string 2",
          "LineItem": 3,
          "GLAccount": "sample string 4",
          "Amount": 5.1,
          "Comment": "sample string 6",
          "Quantity": 8.1,
          "UnitPrice": 9.1,
          "VehicleID": "sample string 10",
          "GLAccountDescription": "sample string 11"
        },
        {
          "Vendor": "sample string 1",
          "Invoice": "sample string 2",
          "LineItem": 3,
          "GLAccount": "sample string 4",
          "Amount": 5.1,
          "Comment": "sample string 6",
          "Quantity": 8.1,
          "UnitPrice": 9.1,
          "VehicleID": "sample string 10",
          "GLAccountDescription": "sample string 11"
        }
      ]
    },
    {
      "Vendor": "sample string 1",
      "InvoiceNumber": "sample string 2",
      "Description": "sample string 3",
      "EntryDate": "sample string 4",
      "BillDate": "sample string 5",
      "DueDate": "sample string 6",
      "Source": "sample string 7",
      "UserName": "sample string 8",
      "PONumber": "sample string 9",
      "OnHoldYN": true,
      "PaidByDate1": "sample string 11",
      "PaidByDate2": "sample string 12",
      "PaidByDate3": "sample string 13",
      "PaidByDate4": "sample string 14",
      "PaidByDate5": "sample string 15",
      "DeductionPercent1": 16.1,
      "DeductionPercent2": 17.1,
      "DeductionPercent3": 18.1,
      "DeductionPercent4": 19.1,
      "DeductionPercent5": 20.1,
      "DiscountAmount1": 21.1,
      "DiscountAmount2": 22.1,
      "DiscountAmount3": 23.1,
      "DiscountAmount4": 24.1,
      "DiscountAmount5": 25.1,
      "DiscountGL": "sample string 26",
      "Gross": 27.1,
      "Discount": 28.1,
      "Net": 29.1,
      "DatePaid": "sample string 30",
      "AmountPaid": 31.1,
      "PaidYN": true,
      "VoidedYN": true,
      "ReversedYN": true,
      "Amount1099": 35.1,
      "CheckNumber": "sample string 36",
      "FiscalMonth": 37,
      "UsePrepayYN": true,
      "Transferred": true,
      "LocationID": "sample string 40",
      "SpecialHandling": "sample string 41",
      "PayByEFTYN": true,
      "Notes": "sample string 43",
      "POInvoice": "sample string 44",
      "APPurchaseOrder": true,
      "UserID": "sample string 46",
      "ApBillGuid": "ef7315d6-1ba8-4046-8954-5116b4b558c3",
      "BillDetail": [
        {
          "Vendor": "sample string 1",
          "Invoice": "sample string 2",
          "LineItem": 3,
          "GLAccount": "sample string 4",
          "Amount": 5.1,
          "Comment": "sample string 6",
          "Quantity": 8.1,
          "UnitPrice": 9.1,
          "VehicleID": "sample string 10",
          "GLAccountDescription": "sample string 11"
        },
        {
          "Vendor": "sample string 1",
          "Invoice": "sample string 2",
          "LineItem": 3,
          "GLAccount": "sample string 4",
          "Amount": 5.1,
          "Comment": "sample string 6",
          "Quantity": 8.1,
          "UnitPrice": 9.1,
          "VehicleID": "sample string 10",
          "GLAccountDescription": "sample string 11"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<AgvApPo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vendor">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AP">
    <d2p1:APBill>
      <d2p1:APPurchaseOrder>true</d2p1:APPurchaseOrder>
      <d2p1:Amount1099>35.1</d2p1:Amount1099>
      <d2p1:AmountPaid>31.1</d2p1:AmountPaid>
      <d2p1:ApBillGuid>ef7315d6-1ba8-4046-8954-5116b4b558c3</d2p1:ApBillGuid>
      <d2p1:BillDate>sample string 5</d2p1:BillDate>
      <d2p1:BillDetail>
        <d2p1:BillDetail>
          <d2p1:Amount>5.1</d2p1:Amount>
          <d2p1:Comment>sample string 6</d2p1:Comment>
          <d2p1:GLAccount>sample string 4</d2p1:GLAccount>
          <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription>
          <d2p1:Invoice>sample string 2</d2p1:Invoice>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:Quantity>8.1</d2p1:Quantity>
          <d2p1:UnitPrice>9.1</d2p1:UnitPrice>
          <d2p1:VehicleID>sample string 10</d2p1:VehicleID>
          <d2p1:Vendor>sample string 1</d2p1:Vendor>
        </d2p1:BillDetail>
        <d2p1:BillDetail>
          <d2p1:Amount>5.1</d2p1:Amount>
          <d2p1:Comment>sample string 6</d2p1:Comment>
          <d2p1:GLAccount>sample string 4</d2p1:GLAccount>
          <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription>
          <d2p1:Invoice>sample string 2</d2p1:Invoice>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:Quantity>8.1</d2p1:Quantity>
          <d2p1:UnitPrice>9.1</d2p1:UnitPrice>
          <d2p1:VehicleID>sample string 10</d2p1:VehicleID>
          <d2p1:Vendor>sample string 1</d2p1:Vendor>
        </d2p1:BillDetail>
      </d2p1:BillDetail>
      <d2p1:CheckNumber>sample string 36</d2p1:CheckNumber>
      <d2p1:DatePaid>sample string 30</d2p1:DatePaid>
      <d2p1:DeductionPercent1>16.1</d2p1:DeductionPercent1>
      <d2p1:DeductionPercent2>17.1</d2p1:DeductionPercent2>
      <d2p1:DeductionPercent3>18.1</d2p1:DeductionPercent3>
      <d2p1:DeductionPercent4>19.1</d2p1:DeductionPercent4>
      <d2p1:DeductionPercent5>20.1</d2p1:DeductionPercent5>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Discount>28.1</d2p1:Discount>
      <d2p1:DiscountAmount1>21.1</d2p1:DiscountAmount1>
      <d2p1:DiscountAmount2>22.1</d2p1:DiscountAmount2>
      <d2p1:DiscountAmount3>23.1</d2p1:DiscountAmount3>
      <d2p1:DiscountAmount4>24.1</d2p1:DiscountAmount4>
      <d2p1:DiscountAmount5>25.1</d2p1:DiscountAmount5>
      <d2p1:DiscountGL>sample string 26</d2p1:DiscountGL>
      <d2p1:DueDate>sample string 6</d2p1:DueDate>
      <d2p1:EntryDate>sample string 4</d2p1:EntryDate>
      <d2p1:FiscalMonth>37</d2p1:FiscalMonth>
      <d2p1:Gross>27.1</d2p1:Gross>
      <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
      <d2p1:LocationID>sample string 40</d2p1:LocationID>
      <d2p1:Net>29.1</d2p1:Net>
      <d2p1:Notes>sample string 43</d2p1:Notes>
      <d2p1:OnHoldYN>true</d2p1:OnHoldYN>
      <d2p1:POInvoice>sample string 44</d2p1:POInvoice>
      <d2p1:PONumber>sample string 9</d2p1:PONumber>
      <d2p1:PaidByDate1>sample string 11</d2p1:PaidByDate1>
      <d2p1:PaidByDate2>sample string 12</d2p1:PaidByDate2>
      <d2p1:PaidByDate3>sample string 13</d2p1:PaidByDate3>
      <d2p1:PaidByDate4>sample string 14</d2p1:PaidByDate4>
      <d2p1:PaidByDate5>sample string 15</d2p1:PaidByDate5>
      <d2p1:PaidYN>true</d2p1:PaidYN>
      <d2p1:PayByEFTYN>true</d2p1:PayByEFTYN>
      <d2p1:ReversedYN>true</d2p1:ReversedYN>
      <d2p1:Source>sample string 7</d2p1:Source>
      <d2p1:SpecialHandling>sample string 41</d2p1:SpecialHandling>
      <d2p1:Transferred>true</d2p1:Transferred>
      <d2p1:UsePrepayYN>true</d2p1:UsePrepayYN>
      <d2p1:UserID>sample string 46</d2p1:UserID>
      <d2p1:UserName>sample string 8</d2p1:UserName>
      <d2p1:Vendor>sample string 1</d2p1:Vendor>
      <d2p1:VoidedYN>true</d2p1:VoidedYN>
    </d2p1:APBill>
    <d2p1:APBill>
      <d2p1:APPurchaseOrder>true</d2p1:APPurchaseOrder>
      <d2p1:Amount1099>35.1</d2p1:Amount1099>
      <d2p1:AmountPaid>31.1</d2p1:AmountPaid>
      <d2p1:ApBillGuid>ef7315d6-1ba8-4046-8954-5116b4b558c3</d2p1:ApBillGuid>
      <d2p1:BillDate>sample string 5</d2p1:BillDate>
      <d2p1:BillDetail>
        <d2p1:BillDetail>
          <d2p1:Amount>5.1</d2p1:Amount>
          <d2p1:Comment>sample string 6</d2p1:Comment>
          <d2p1:GLAccount>sample string 4</d2p1:GLAccount>
          <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription>
          <d2p1:Invoice>sample string 2</d2p1:Invoice>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:Quantity>8.1</d2p1:Quantity>
          <d2p1:UnitPrice>9.1</d2p1:UnitPrice>
          <d2p1:VehicleID>sample string 10</d2p1:VehicleID>
          <d2p1:Vendor>sample string 1</d2p1:Vendor>
        </d2p1:BillDetail>
        <d2p1:BillDetail>
          <d2p1:Amount>5.1</d2p1:Amount>
          <d2p1:Comment>sample string 6</d2p1:Comment>
          <d2p1:GLAccount>sample string 4</d2p1:GLAccount>
          <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription>
          <d2p1:Invoice>sample string 2</d2p1:Invoice>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:Quantity>8.1</d2p1:Quantity>
          <d2p1:UnitPrice>9.1</d2p1:UnitPrice>
          <d2p1:VehicleID>sample string 10</d2p1:VehicleID>
          <d2p1:Vendor>sample string 1</d2p1:Vendor>
        </d2p1:BillDetail>
      </d2p1:BillDetail>
      <d2p1:CheckNumber>sample string 36</d2p1:CheckNumber>
      <d2p1:DatePaid>sample string 30</d2p1:DatePaid>
      <d2p1:DeductionPercent1>16.1</d2p1:DeductionPercent1>
      <d2p1:DeductionPercent2>17.1</d2p1:DeductionPercent2>
      <d2p1:DeductionPercent3>18.1</d2p1:DeductionPercent3>
      <d2p1:DeductionPercent4>19.1</d2p1:DeductionPercent4>
      <d2p1:DeductionPercent5>20.1</d2p1:DeductionPercent5>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Discount>28.1</d2p1:Discount>
      <d2p1:DiscountAmount1>21.1</d2p1:DiscountAmount1>
      <d2p1:DiscountAmount2>22.1</d2p1:DiscountAmount2>
      <d2p1:DiscountAmount3>23.1</d2p1:DiscountAmount3>
      <d2p1:DiscountAmount4>24.1</d2p1:DiscountAmount4>
      <d2p1:DiscountAmount5>25.1</d2p1:DiscountAmount5>
      <d2p1:DiscountGL>sample string 26</d2p1:DiscountGL>
      <d2p1:DueDate>sample string 6</d2p1:DueDate>
      <d2p1:EntryDate>sample string 4</d2p1:EntryDate>
      <d2p1:FiscalMonth>37</d2p1:FiscalMonth>
      <d2p1:Gross>27.1</d2p1:Gross>
      <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
      <d2p1:LocationID>sample string 40</d2p1:LocationID>
      <d2p1:Net>29.1</d2p1:Net>
      <d2p1:Notes>sample string 43</d2p1:Notes>
      <d2p1:OnHoldYN>true</d2p1:OnHoldYN>
      <d2p1:POInvoice>sample string 44</d2p1:POInvoice>
      <d2p1:PONumber>sample string 9</d2p1:PONumber>
      <d2p1:PaidByDate1>sample string 11</d2p1:PaidByDate1>
      <d2p1:PaidByDate2>sample string 12</d2p1:PaidByDate2>
      <d2p1:PaidByDate3>sample string 13</d2p1:PaidByDate3>
      <d2p1:PaidByDate4>sample string 14</d2p1:PaidByDate4>
      <d2p1:PaidByDate5>sample string 15</d2p1:PaidByDate5>
      <d2p1:PaidYN>true</d2p1:PaidYN>
      <d2p1:PayByEFTYN>true</d2p1:PayByEFTYN>
      <d2p1:ReversedYN>true</d2p1:ReversedYN>
      <d2p1:Source>sample string 7</d2p1:Source>
      <d2p1:SpecialHandling>sample string 41</d2p1:SpecialHandling>
      <d2p1:Transferred>true</d2p1:Transferred>
      <d2p1:UsePrepayYN>true</d2p1:UsePrepayYN>
      <d2p1:UserID>sample string 46</d2p1:UserID>
      <d2p1:UserName>sample string 8</d2p1:UserName>
      <d2p1:Vendor>sample string 1</d2p1:Vendor>
      <d2p1:VoidedYN>true</d2p1:VoidedYN>
    </d2p1:APBill>
  </Data>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvApPo>