Aggregate voucher counts and cash totals for one voucher type, broken down by status. Built while summarising a redeemer organisation's vouchers, holding one VoucherStateSummary per status code that has at least one matching voucher.


Properties

PropertyReturnsDescription
cashValueBigDecimalThe total cash value of vouchers of this voucher type, summed across all statuses.
codeStringCode name of the voucher type this summary is for.
statesMap<String,VoucherStateSummary>Per-status summaries for this voucher type, keyed by status code.
titleStringDisplay title of the voucher type this summary is for.
totalLongThe total number of vouchers of this voucher type, summed across all statuses.

Methods

getCode()

Returns: String

Code name of the voucher type this summary is for.

getTitle()

Returns: String

Display title of the voucher type this summary is for.

getTotal()

Returns: Long

The total number of vouchers of this voucher type, summed across all statuses.

getCashValue()

Returns: BigDecimal

The total cash value of vouchers of this voucher type, summed across all statuses.

getStates()

Returns: Map<String,VoucherStateSummary>

Per-status summaries for this voucher type, keyed by status code.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.