GET ApBill/GetApBill?VendorID={VendorID}&InvoiceNumber={InvoiceNumber}&DueDate={DueDate}&Status={Status}&apBillGuid={apBillGuid}

Returns AP Bill

Request Information

URI Parameters

Name	Description	Type	Additional Information
VendorID	The Vendor ID the AP Bill is for. The combination of Vendor, Invoice, and Bill Date are what uniquely identify an AP Bill. (optional)	string	Default value is string.Empty
InvoiceNumber	The number of the Invoice the AP Bill paid. One of the values returned by the GetApBill method of the API. (optional)	string	Default value is string.Empty
DueDate	The date the bill is due to be paid. Format MM-dd-yyyy (optional)	string	Default value is string.Empty
Status	The current status of the AP Bills returned. Statuses are both, open, or closed. (optional)	string	Default value is Both
apBillGuid	The Globally Unique Identifier of the AP Bill (optional)	globally unique identifier

Body Parameters

Response Information

Resource Description

Returns AP Bill

AgvApBill

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many AP Bills.	string
ApBillRecords	JSON dictionary of APBillRecords.	Collection of clsApBill

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "ApBillRecords": [
    {
      "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": "05ab8159-a71e-4acf-b0e2-28103dc67fd7",
      "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": "05ab8159-a71e-4acf-b0e2-28103dc67fd7",
      "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:

<AgvApBill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vendor">
  <ApBillRecords 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>05ab8159-a71e-4acf-b0e2-28103dc67fd7</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>05ab8159-a71e-4acf-b0e2-28103dc67fd7</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>
  </ApBillRecords>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvApBill>