GET PurchaseInvoiceList/GetPurchaseInvoiceList?vendorId={vendorId}&invoiceNumber={invoiceNumber}&entryStartDate={entryStartDate}&entryEndDate={entryEndDate}&invoiceStartDate={invoiceStartDate}&invoiceEndDate={invoiceEndDate}&voidOnly={voidOnly}
Returns a list of purchase invoices.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| vendorId |
Vendor ID of the purchase invoices to return (optional) |
string |
Default value is string.Empty |
| invoiceNumber |
Invoice number of the purchase invoices to return (optional) |
string |
Default value is string.Empty |
| entryStartDate |
Start date of the purchase invoices to return (optional) - Format = MM-dd-yyyy (If entryStartDate is sent in then entryEndDate must be sent in) |
string |
Default value is string.Empty |
| entryEndDate |
End date of the purchase invoices to return (optional) - Format = MM-dd-yyyy (If entryEndDate is sent in then entryStartDate must be sent in) |
string |
Default value is string.Empty |
| invoiceStartDate |
Invoice start date of the purchase invoices to return (optional) - Format = MM-dd-yyyy (If invoiceStartDate is sent in then invoiceEndDate must be sent in) |
string |
Default value is string.Empty |
| invoiceEndDate |
Invoice end date of the purchase invoices to return (optional) - Format MM-dd-yyyy (If invoiceEndDate is sent in then invoiceStartDate must be sent in) |
string |
Default value is string.Empty |
| voidOnly |
Return voided purchase invoices only (optional) - True or False (default) |
boolean |
Default value is False |
Body Parameters
Response Information
Resource Description
Returns a list of purchase invoices.
AgvPurchaseInvoiceList| Name | Description | Type | Additional 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 |
Count of how many PurchaseInvoice JSON dictionaries |
string | |
| PurchaseInvoiceList |
JSON dictionary of PurchaseInvoiceList |
Collection of ClsAPIPurchaseInvoiceList |
Response Formats
application/json, text/json
{
"Status": "sample string 1",
"Message": "sample string 2",
"Count": "2",
"PurchaseInvoiceList": [
{
"VendorId": "sample string 1",
"InvoiceNumber": "sample string 2",
"PurchaseInvoiceRecordHeaderDetails": null,
"PurchaseInvoiceRecordLineItemDetails": [],
"PurchaseInvoiceRecordChargeDetails": []
},
{
"VendorId": "sample string 1",
"InvoiceNumber": "sample string 2",
"PurchaseInvoiceRecordHeaderDetails": null,
"PurchaseInvoiceRecordLineItemDetails": [],
"PurchaseInvoiceRecordChargeDetails": []
}
]
}