API Documentation
Back to top  

InvoiceListGeneratorInterface

Extends

Interface InvoiceListGeneratorInterface

category

System
package

Invoice
subpackage

Interfaces

Methods

Filter invoice list items by the provided parameters.

filterInvoiceList(array $filterParameters, \IntType|null $startIndex = null, \IntType|null $maxCount = null, \StringType|null $orderBy = null) : \InvoiceListItemCollection

The following slug names need to be used:

  • invoiceNumber => invoices.invoice_number
  • invoiceDate => invoices.invoice_date
  • sum => invoices.total_sum
  • customer => invoices.billing_firstname invoices.billing_lastname
  • group => invoices.customer_status_name
  • countryIsoCode => invoices.billing_country_iso_code_2
  • orderNumber => invoices.order_id
  • orderDate => invoices.order_date_purchased
  • paymentMethod => invoices.payment_class
  • status => orders_status.orders_status_name
Throws
\BadMethodCallException
\InvalidArgumentException

Arguments

$filterParameters

array

Contains the column slug-names and their values.

$startIndex

\IntType|null

The start index of the wanted array to be returned (default = null).

$maxCount

\IntType|null

Maximum amount of items which should be returned (default = null).

$orderBy

\StringType|null

A string which defines how the items should be ordered (default = null).

Response

\InvoiceListItemCollection

Get the filtered invoice count.

filterInvoiceListCount(array $filterParameters) : integer

This number is useful for pagination functionality where the app needs to know the number of the filtered rows.

Throws
\BadMethodCallException

Arguments

$filterParameters

array

Response

integer

Returns an invoice list item collection by the given conditions.

getInvoiceListByConditions(array $conditions = array(), \IntType|null $startIndex = null, \IntType|null $maxCount = null, \StringType|null $orderBy = null) : \InvoiceListItemCollection

The other arguments helps to control fetched data.

Arguments

$conditions

array

(Optional) Conditions for tht where clause.

$startIndex

\IntType|null

(Optional) Start index for the limit clause.

$maxCount

\IntType|null

(Optional) Max count for the limit clause.

$orderBy

\StringType|null

(Optional) Sort order of fetched data.

Response

\InvoiceListItemCollection