To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A snapshot of one participant's points balance under a single reward, taken on a given statement date. Statements are produced in bulk by the point statement job, one row per recipient per reward per run, and are what a statement page or export reads rather than recalculating the ledger. As well as the balance, a statement can carry the points due to expire over the next one, two and three months, and six configurable extension fields, three numeric and three text, filled in from the point statement field definitions configured on the reward. Rows are historical records and are not updated once written.
Group: Database Entities
Implements: Relational, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| balance | double | Points balance at the statement date, calculated from the full credit and debit ledger. Defaults to zero. |
| id | long | Database identifier for this statement row. |
| issuedTo | BaseEntity | The profile or organisation the statement was produced for. Never null, and lazily loaded. |
| num1 | Double | First configurable numeric extension field, filled in from the point statement field definitions configured on the reward. |
| num2 | Double | Second configurable numeric extension field, filled in from the point statement field definitions configured on the reward. |
| num3 | Double | Third configurable numeric extension field, filled in from the point statement field definitions configured on the reward. |
| pointsExpiringNextOneMonth | Double | Total points that will expire within one month of the statement date. |
| pointsExpiringNextThreeMonth | Double | Total points that will expire within three months of the statement date. This is cumulative, so it includes the points counted in the one and two month figures. |
| pointsExpiringNextTwoMonth | Double | Total points that will expire within two months of the statement date. This is cumulative, so it includes the points counted in the one month figure. |
| reward | Reward | The reward, that is the points bucket, this statement reports on. A recipient has one statement per reward per statement date. Never null, and lazily loaded. |
| simpleBalance | Double | Balance as calculated by the faster simple balance query, recorded alongside the ledger balance so the two can be compared. A difference between the two indicates the ledger and the summary totals have diverged. |
| statementDate | Date | Date the statement was taken for. All statements from one run share this date, and it is the date the balance and expiry figures were calculated as at. Never null. |
| summary | String | Free text note recorded when the statement was generated, up to 2000 characters. The built in statement job writes the timings of the two balance calculations here. |
| text1 | String | First configurable text extension field, up to 200 characters, filled in from the point statement field definitions configured on the reward. |
| text2 | String | Second configurable text extension field, up to 200 characters, filled in from the point statement field definitions configured on the reward. |
| text3 | String | Third configurable text extension field, up to 200 characters, filled in from the point statement field definitions configured on the reward. |
Methods
getId() · getIssuedTo() · getReward() · getBalance() · getStatementDate() · getSimpleBalance() · setSimpleBalance(Double simpleBalance) · setPointsExpiringNextOneMonth(Double pointsExpiring) · getPointsExpiringNextOneMonth() · setPointsExpiringNextTwoMonth(Double pointsExpiring) · getPointsExpiringNextTwoMonth() · setPointsExpiringNextThreeMonth(Double pointsExpiring) · getPointsExpiringNextThreeMonth() · getSummary() · setSummary(String summary) · getNum1() · setNum1(Double num1) · getNum2() · setNum2(Double num2) · getNum3() · setNum3(Double num3) · getText1() · setText1(String text1) · getText2() · setText2(String text2) · getText3() · setText3(String text3)
getId()
Returns: long
Database identifier for this statement row.
getIssuedTo()
Returns: BaseEntity
The profile or organisation the statement was produced for. Never null, and lazily loaded.
getReward()
Returns: Reward
The reward, that is the points bucket, this statement reports on. A recipient has one statement per reward per statement date. Never null, and lazily loaded.
getBalance()
Returns: double
Points balance at the statement date, calculated from the full credit and debit ledger. Defaults to zero.
getStatementDate()
Returns: Date
Date the statement was taken for. All statements from one run share this date, and it is the date the balance and expiry figures were calculated as at. Never null.
getSimpleBalance()
Returns: Double
Balance as calculated by the faster simple balance query, recorded alongside the ledger balance so the two can be compared. A difference between the two indicates the ledger and the summary totals have diverged.
setSimpleBalance(Double simpleBalance)
Returns: void
Sets the balance calculated by the simple balance query.
| Parameter | Description |
|---|---|
simpleBalance | the simple balance to record |
setPointsExpiringNextOneMonth(Double pointsExpiring)
Returns: void
Sets the points due to expire within one month of the statement date.
| Parameter | Description |
|---|---|
pointsExpiring | the total points expiring in the next month |
getPointsExpiringNextOneMonth()
Returns: Double
Total points that will expire within one month of the statement date.
setPointsExpiringNextTwoMonth(Double pointsExpiring)
Returns: void
Sets the points due to expire within two months of the statement date.
| Parameter | Description |
|---|---|
pointsExpiring | the total points expiring in the next two months |
getPointsExpiringNextTwoMonth()
Returns: Double
Total points that will expire within two months of the statement date. This is cumulative, so it includes the points counted in the one month figure.
setPointsExpiringNextThreeMonth(Double pointsExpiring)
Returns: void
Sets the points due to expire within three months of the statement date.
| Parameter | Description |
|---|---|
pointsExpiring | the total points expiring in the next three months |
getPointsExpiringNextThreeMonth()
Returns: Double
Total points that will expire within three months of the statement date. This is cumulative, so it includes the points counted in the one and two month figures.
getSummary()
Returns: String
Free text note recorded when the statement was generated, up to 2000 characters. The built in statement job writes the timings of the two balance calculations here.
setSummary(String summary)
Returns: void
Sets the free text note recorded against the statement. Limited to 2000 characters.
| Parameter | Description |
|---|---|
summary | the summary text |
getNum1()
Returns: Double
First configurable numeric extension field, filled in from the point statement field definitions configured on the reward.
setNum1(Double num1)
Returns: void
Sets the first configurable numeric extension field.
| Parameter | Description |
|---|---|
num1 | the value to store |
getNum2()
Returns: Double
Second configurable numeric extension field, filled in from the point statement field definitions configured on the reward.
setNum2(Double num2)
Returns: void
Sets the second configurable numeric extension field.
| Parameter | Description |
|---|---|
num2 | the value to store |
getNum3()
Returns: Double
Third configurable numeric extension field, filled in from the point statement field definitions configured on the reward.
setNum3(Double num3)
Returns: void
Sets the third configurable numeric extension field.
| Parameter | Description |
|---|---|
num3 | the value to store |
getText1()
Returns: String
First configurable text extension field, up to 200 characters, filled in from the point statement field definitions configured on the reward.
setText1(String text1)
Returns: void
Sets the first configurable text extension field. Limited to 200 characters.
| Parameter | Description |
|---|---|
text1 | the value to store |
getText2()
Returns: String
Second configurable text extension field, up to 200 characters, filled in from the point statement field definitions configured on the reward.
setText2(String text2)
Returns: void
Sets the second configurable text extension field. Limited to 200 characters.
| Parameter | Description |
|---|---|
text2 | the value to store |
getText3()
Returns: String
Third configurable text extension field, up to 200 characters, filled in from the point statement field definitions configured on the reward.
setText3(String text3)
Returns: void
Sets the third configurable text extension field. Limited to 200 characters.
| Parameter | Description |
|---|---|
text3 | the value to store |
© 2025 Kademi Ltd