feat: initialize project backend structure and document system specifications across all modules
This commit is contained in:
52
docs/specs/customer_management/statement.md
Normal file
52
docs/specs/customer_management/statement.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: "Statement"
|
||||
type: OpenSpec
|
||||
status: Draft
|
||||
domain: Customer Management
|
||||
---
|
||||
|
||||
# Statement
|
||||
|
||||
## Requirement Definition
|
||||
Provides a list of all transactions for an account/customer over a set period (usually monthly). Includes earned, redeemed, adjusted points, beginning/ending balances, and expired points.
|
||||
|
||||
## Process Flow
|
||||
|
||||
### Pre-Conditions
|
||||
- Users must have access rights in the "Statement Enquiry" module.
|
||||
|
||||
## Business Rules
|
||||
|
||||
### Data Schema
|
||||
|
||||
#### Statement Summary
|
||||
| Field Name | Description | Logic Type | Constraints / Rules |
|
||||
|---|---|---|---|
|
||||
| Loyalty Account Number | Identifier. | String | Read-only. |
|
||||
| Product Account Number | Identifier. | String | Read-only. |
|
||||
| Pool ID | Statement Pool. | String | Read-only. |
|
||||
| Cycle Start Date | Previous statement cycle start. | Date | Read-only. |
|
||||
| Statement Opening Balance | Previous points balance. | Decimal | Read-only. |
|
||||
| Total Award | Earned points in cycle. | Decimal | Read-only. |
|
||||
| Total Redeem | Redeemed points in cycle. | Decimal | Read-only. |
|
||||
| Total Adjust | Adjusted points in cycle. | Decimal | Read-only. |
|
||||
| Statement Closing Balance | Accumulated points at cycle end. | Decimal | Read-only. |
|
||||
| Expired Points | Balance in expired but not forfeited buckets. | Decimal | Read-only. |
|
||||
| Cycle Statement Date | Generation date. | Date | Read-only. |
|
||||
|
||||
#### Transaction Detail
|
||||
Lists transactions within the cycle.
|
||||
| Field Name | Description | Logic Type | Constraints / Rules |
|
||||
|---|---|---|---|
|
||||
| Reference Number | OLS Reference Number. | String | Read-only. |
|
||||
| Transaction Type | Award, Redeem, Adjust. | Enum | Read-only. |
|
||||
| Unit | Earned/Redeemed/Adjusted points. | Decimal | Read-only. |
|
||||
| Post Date | Post Date. | Date | Read-only. |
|
||||
| Transaction Date | Transaction Date Time. | Date | Read-only. |
|
||||
|
||||
### Execution
|
||||
- **View-only screen.** Records are updated by OLS batch jobs.
|
||||
- Output supports Customer and Account level, but stored under Account level.
|
||||
|
||||
## Exception Flow
|
||||
- N/A
|
||||
Reference in New Issue
Block a user