POST api/apbill/search

Get a list of AP Bills by search criteria

Request Information

URI Parameters

None.

Body Parameters

APBillSearch
NameDescriptionTypeAdditional information
IncludeVendorIDList

Collection of integer

None.

VendorTypeID

integer

None.

InvoiceNumber

string

None.

Status

string

None.

InvoiceDateStart

date

None.

InvoiceDateEnd

date

None.

DueDateStart

date

None.

DueDateEnd

date

None.

VendorUserdefTableID

integer

None.

ExcludeVendorIDList

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "IncludeVendorIDList": [
    1,
    2
  ],
  "VendorTypeID": 1,
  "InvoiceNumber": "sample string 2",
  "Status": "sample string 3",
  "InvoiceDateStart": "2018-09-24T08:03:23.5048734-04:00",
  "InvoiceDateEnd": "2018-09-24T08:03:23.5048734-04:00",
  "DueDateStart": "2018-09-24T08:03:23.5048734-04:00",
  "DueDateEnd": "2018-09-24T08:03:23.5048734-04:00",
  "VendorUserdefTableID": 4,
  "ExcludeVendorIDList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<APBillSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <DueDateEnd>2018-09-24T08:03:23.5048734-04:00</DueDateEnd>
  <DueDateStart>2018-09-24T08:03:23.5048734-04:00</DueDateStart>
  <ExcludeVendorIDList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ExcludeVendorIDList>
  <IncludeVendorIDList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </IncludeVendorIDList>
  <InvoiceDateEnd>2018-09-24T08:03:23.5048734-04:00</InvoiceDateEnd>
  <InvoiceDateStart>2018-09-24T08:03:23.5048734-04:00</InvoiceDateStart>
  <InvoiceNumber>sample string 2</InvoiceNumber>
  <Status>sample string 3</Status>
  <VendorTypeID>1</VendorTypeID>
  <VendorUserdefTableID>4</VendorUserdefTableID>
</APBillSearch>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'APBillSearch'.

Response Information

Resource Description

Collection of APBillResults
NameDescriptionTypeAdditional information
VendorID

integer

None.

VendorCode

string

None.

VendorTypeID

integer

None.

VendorUserdefTable1ID

integer

None.

InvoiceID

integer

None.

InvoiceNumber

string

None.

Status

string

None.

InvoiceDate

date

None.

PostingDate

date

None.

DueDate

date

None.

TermCode

string

None.

CategoryCode

string

None.

Amount

decimal number

None.

NetDue

decimal number

None.

Memo

string

None.

BranchCode

string

None.

WarehouseCode

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "VendorID": 1,
    "VendorCode": "sample string 2",
    "VendorTypeID": 1,
    "VendorUserdefTable1ID": 3,
    "InvoiceID": 4,
    "InvoiceNumber": "sample string 5",
    "Status": "sample string 6",
    "InvoiceDate": "2018-09-24T08:03:23.5204991-04:00",
    "PostingDate": "2018-09-24T08:03:23.5204991-04:00",
    "DueDate": "2018-09-24T08:03:23.5204991-04:00",
    "TermCode": "sample string 10",
    "CategoryCode": "sample string 11",
    "Amount": 12.0,
    "NetDue": 13.0,
    "Memo": "sample string 14",
    "BranchCode": "sample string 15",
    "WarehouseCode": "sample string 16"
  },
  {
    "VendorID": 1,
    "VendorCode": "sample string 2",
    "VendorTypeID": 1,
    "VendorUserdefTable1ID": 3,
    "InvoiceID": 4,
    "InvoiceNumber": "sample string 5",
    "Status": "sample string 6",
    "InvoiceDate": "2018-09-24T08:03:23.5204991-04:00",
    "PostingDate": "2018-09-24T08:03:23.5204991-04:00",
    "DueDate": "2018-09-24T08:03:23.5204991-04:00",
    "TermCode": "sample string 10",
    "CategoryCode": "sample string 11",
    "Amount": 12.0,
    "NetDue": 13.0,
    "Memo": "sample string 14",
    "BranchCode": "sample string 15",
    "WarehouseCode": "sample string 16"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPBillResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <APBillResults>
    <Amount>12</Amount>
    <BranchCode>sample string 15</BranchCode>
    <CategoryCode>sample string 11</CategoryCode>
    <DueDate>2018-09-24T08:03:23.5204991-04:00</DueDate>
    <InvoiceDate>2018-09-24T08:03:23.5204991-04:00</InvoiceDate>
    <InvoiceID>4</InvoiceID>
    <InvoiceNumber>sample string 5</InvoiceNumber>
    <Memo>sample string 14</Memo>
    <NetDue>13</NetDue>
    <PostingDate>2018-09-24T08:03:23.5204991-04:00</PostingDate>
    <Status>sample string 6</Status>
    <TermCode>sample string 10</TermCode>
    <VendorCode>sample string 2</VendorCode>
    <VendorID>1</VendorID>
    <VendorTypeID>1</VendorTypeID>
    <VendorUserdefTable1ID>3</VendorUserdefTable1ID>
    <WarehouseCode>sample string 16</WarehouseCode>
  </APBillResults>
  <APBillResults>
    <Amount>12</Amount>
    <BranchCode>sample string 15</BranchCode>
    <CategoryCode>sample string 11</CategoryCode>
    <DueDate>2018-09-24T08:03:23.5204991-04:00</DueDate>
    <InvoiceDate>2018-09-24T08:03:23.5204991-04:00</InvoiceDate>
    <InvoiceID>4</InvoiceID>
    <InvoiceNumber>sample string 5</InvoiceNumber>
    <Memo>sample string 14</Memo>
    <NetDue>13</NetDue>
    <PostingDate>2018-09-24T08:03:23.5204991-04:00</PostingDate>
    <Status>sample string 6</Status>
    <TermCode>sample string 10</TermCode>
    <VendorCode>sample string 2</VendorCode>
    <VendorID>1</VendorID>
    <VendorTypeID>1</VendorTypeID>
    <VendorUserdefTable1ID>3</VendorUserdefTable1ID>
    <WarehouseCode>sample string 16</WarehouseCode>
  </APBillResults>
</ArrayOfAPBillResults>