API reference / Quittio \ Core \ Documents

OpenItem

final readonly class in quittio/core

Quittio\Core\Documents\OpenItem · Source

An invoice in a payment reminder or account statement.

Properties#

Property	Type	Description
`$amount` readonly	`Brick\Money\Money`
`$description` readonly	`?string`
`$dueDate` readonly	`?Date`
`$invoiceDate` readonly	`Date`
`$invoiceNumber` readonly	`string`
`$paid` readonly	`?Brick\Money\Money`

Methods#

Method	Description
`->__construct()`
`->isSettled()`
`->open()`	Amount still open (amount minus paid); negative for overpaid items and credits.

`__construct()`#

public function __construct(
    string $invoiceNumber,
    Date $invoiceDate,
    Money $amount,
    ?Date $dueDate = null,
    ?Money $paid = null,
    ?string $description = null,
)

Parameter	Type	Description
`$invoiceNumber`	`string`
`$invoiceDate`	`Date`
`$amount`	`Brick\Money\Money`
`$dueDate`	`?Date` = `null`
`$paid`	`?Brick\Money\Money` = `null`
`$description`	`?string` = `null`

`isSettled()`#

public function isSettled(): bool

Returns: bool

`open()`#

public function open(): Money

Amount still open (amount minus paid); negative for overpaid items and credits.

Returns: Brick\Money\Money