GET Invoice/GetInvoiceListByLocationIDByFiscalMonth?LocationID={LocationID}&StartFiscalMonth={StartFiscalMonth}&EndFiscalMonth={EndFiscalMonth}&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
StartFiscalMonth	Start fiscal month of invoices to return.	integer	Required
EndFiscalMonth	End fiscal month of invoices to return.	integer	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.

AgvInvoice

Name	Description	Type
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:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.