POST Invoice/GetInvoicesListRestricted

Returns a list of invoices.

Request Information

URI Parameters

Body Parameters

A JSON string that includes the list of customerId, locationId, transactionStartDate, transactionEndDate, invoiceStartDate, invoiceEndDate, fiscalStartMonth, fiscalEndMonth, paidStatus, voidOnly, voidStartDate, voidEndDate combinations.

clsInvoiceListRequest

Name	Description	Type	Additional Information
InvoiceListRequestItems		Collection of clsInvoiceListRequestItem

Request Formats

application/json, text/json

Sample:

{
  "InvoiceListRequestItems": [
    {
      "customerId": "sample string 1",
      "locationId": "sample string 2",
      "transactionStartDate": "sample string 3",
      "transactionEndDate": "sample string 4",
      "invoiceStartDate": "sample string 5",
      "invoiceEndDate": "sample string 6",
      "fiscalStartMonth": 7,
      "fiscalEndMonth": 8,
      "paidStatus": "sample string 9",
      "voidOnly": true,
      "voidStartDate": "sample string 11",
      "voidEndDate": "sample string 12",
      "startInvoiceNumber": 13,
      "endInvoiceNumber": 14
    },
    {
      "customerId": "sample string 1",
      "locationId": "sample string 2",
      "transactionStartDate": "sample string 3",
      "transactionEndDate": "sample string 4",
      "invoiceStartDate": "sample string 5",
      "invoiceEndDate": "sample string 6",
      "fiscalStartMonth": 7,
      "fiscalEndMonth": 8,
      "paidStatus": "sample string 9",
      "voidOnly": true,
      "voidStartDate": "sample string 11",
      "voidEndDate": "sample string 12",
      "startInvoiceNumber": 13,
      "endInvoiceNumber": 14
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.API">
  <InvoiceListRequestItems>
    <clsInvoiceListRequestItem>
      <customerId>sample string 1</customerId>
      <endInvoiceNumber>14</endInvoiceNumber>
      <fiscalEndMonth>8</fiscalEndMonth>
      <fiscalStartMonth>7</fiscalStartMonth>
      <invoiceEndDate>sample string 6</invoiceEndDate>
      <invoiceStartDate>sample string 5</invoiceStartDate>
      <locationId>sample string 2</locationId>
      <paidStatus>sample string 9</paidStatus>
      <startInvoiceNumber>13</startInvoiceNumber>
      <transactionEndDate>sample string 4</transactionEndDate>
      <transactionStartDate>sample string 3</transactionStartDate>
      <voidEndDate>sample string 12</voidEndDate>
      <voidOnly>true</voidOnly>
      <voidStartDate>sample string 11</voidStartDate>
    </clsInvoiceListRequestItem>
    <clsInvoiceListRequestItem>
      <customerId>sample string 1</customerId>
      <endInvoiceNumber>14</endInvoiceNumber>
      <fiscalEndMonth>8</fiscalEndMonth>
      <fiscalStartMonth>7</fiscalStartMonth>
      <invoiceEndDate>sample string 6</invoiceEndDate>
      <invoiceStartDate>sample string 5</invoiceStartDate>
      <locationId>sample string 2</locationId>
      <paidStatus>sample string 9</paidStatus>
      <startInvoiceNumber>13</startInvoiceNumber>
      <transactionEndDate>sample string 4</transactionEndDate>
      <transactionStartDate>sample string 3</transactionStartDate>
      <voidEndDate>sample string 12</voidEndDate>
      <voidOnly>true</voidOnly>
      <voidStartDate>sample string 11</voidStartDate>
    </clsInvoiceListRequestItem>
  </InvoiceListRequestItems>
</InvoiceListRequest>

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 'clsInvoiceListRequest'.

Response Information

Resource Description

Returns a list of invoices.

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.