API Documentation
Back to top  

InvoiceArchiveReadService

Implements \InvoiceArchiveReadServiceInterface

Class InvoiceListArchiveReadService

category

System
package

Invoice

Methods

InvoiceListArchiveReadService constructor.

__construct(\InvoiceListGeneratorInterface $invoiceListGenerator, \InvoiceServiceSettingsInterface $invoiceServiceSettings)

Arguments

$invoiceListGenerator

\InvoiceListGeneratorInterface

$invoiceServiceSettings

\InvoiceServiceSettingsInterface

Filter the invoice records with specific conditions.

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

Provide the filtering values in the conditions array in order to fetch a filtered result set.

Arguments

$filterParameters

array

Contains an array of the GET parameters to be used for filtering the order records.

$startIndex

\IntType

Start index of order list item collections which should be returned.

$maxCount

\IntType

Maximum amount of collections.

$orderBy

\StringType

Argument to specify the order.

Response

\InvoiceListItemCollection

Get the filtered invoices count.

filterInvoiceListCount(array $filterParameters) : integer

Arguments

$filterParameters

array

Response

integer

Returns the invoice file download information.

getInvoiceFileDownloadInfoByInvoiceId(\IdType $invoiceId) : \FileDownloadInformation

Arguments

$invoiceId

\IdType

invoice_id of expected entry.

Response

\FileDownloadInformation

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

Returns the invoice to the given id

getInvoiceListItemById(\IdType $invoiceId) : \InvoiceListItem
Throws
\UnexpectedValueException

if invoice does not exist

Arguments

$invoiceId

\IdType

Response

\InvoiceListItem

Properties

invoiceListGenerator

invoiceListGenerator : \InvoiceListGeneratorInterface
var

Type(s)

\InvoiceListGeneratorInterface

invoiceServiceSettings

invoiceServiceSettings : \InvoiceServiceSettingsInterface
var

Type(s)

\InvoiceServiceSettingsInterface