GET Invoice/GetInvoiceListByLocationIDByDate?LocationID={LocationID}&StartDate={StartDate}&EndDate={EndDate}&VoidOnly={VoidOnly}&CustomerID={CustomerID}
Returns invoice data.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
LocationID |
Location ID to return invoices for. |
string |
Required |
StartDate |
Start date of invoices to return. Format MM-dd-yyyy. |
string |
Required |
EndDate |
End date of invoices to return. Format MM-dd-yyyy. |
string |
Required |
VoidOnly |
True or False to only return voided invoices. Default is False. (optional) |
boolean |
Default value is False |
CustomerID |
Customer ID to return invoices for. (optional) |
string |
Default value is string.Empty |
Body Parameters
Response Information
Resource Description
Returns invoice data.
AgvInvoiceName | Description | Type | Additional Information |
---|---|---|---|
Status |
Status of the API call. |
string | |
Message |
Message of the API call. |
string | |
Count |
Count of how many Invoices. |
string | |
InvoiceRecords |
JSON dictionary of InvoiceRecords. |
Collection of clsAPIInvoice |
Response Formats
application/json, text/json
Sample:
{ "Status": "sample string 1", "Message": "sample string 2", "Count": "2", "InvoiceRecords": [ { "InvoiceDate": "sample string 1", "InvoiceLocation": "sample string 2", "InvoiceNumber": "sample string 3", "InvoiceRecordHeaderDetails": null, "InvoiceRecordSplitDetails": [], "InvoiceRecordLineItemDetails": [], "InvoiceTaxCodeDetails": [], "InvoiceBooksDetails": [], "InvoiceBlendsDetails": [], "InvoiceDelivsDetails": [], "InvoiceEnergyDetails": [], "InvoiceApplicatorDetails": [] }, { "InvoiceDate": "sample string 1", "InvoiceLocation": "sample string 2", "InvoiceNumber": "sample string 3", "InvoiceRecordHeaderDetails": null, "InvoiceRecordSplitDetails": [], "InvoiceRecordLineItemDetails": [], "InvoiceTaxCodeDetails": [], "InvoiceBooksDetails": [], "InvoiceBlendsDetails": [], "InvoiceDelivsDetails": [], "InvoiceEnergyDetails": [], "InvoiceApplicatorDetails": [] } ] }
application/xml
Sample:
text/xml
Sample: