feat: initialize project backend structure and document system specifications across all modules
This commit is contained in:
72
docs/specs/customer_management/transaction_history.md
Normal file
72
docs/specs/customer_management/transaction_history.md
Normal file
@@ -0,0 +1,72 @@
|
||||
---
|
||||
title: "Transaction History"
|
||||
type: OpenSpec
|
||||
status: Draft
|
||||
domain: Customer Management
|
||||
---
|
||||
|
||||
# Transaction History
|
||||
|
||||
## Requirement Definition
|
||||
Provides a running record of all transactions logged in OLS for a customer, including cancellations, over a configurable period (normally the last 12 months).
|
||||
|
||||
## Process Flow
|
||||
|
||||
### Pre-Conditions
|
||||
- Users must have access rights in the "Transaction History" module.
|
||||
|
||||
## Business Rules
|
||||
|
||||
### Data Schema
|
||||
|
||||
#### Transaction Detail
|
||||
| Field Name | Description | Logic Type | Constraints / Rules |
|
||||
|---|---|---|---|
|
||||
| Invoice No | Internal invoice No generated by OLS. | String | Read-only. |
|
||||
| Reference No | OLS Transaction Reference Number. | String | Read-only. |
|
||||
| Source Reference Number | Reference number from source system. | String | Read-only. |
|
||||
| OLS Transaction Code | OLS Transaction Code. | String | Read-only. |
|
||||
| Gross Amount | Gross transaction amount. | Decimal | Read-only. |
|
||||
| Nett Amount | Nett transaction amount. | Decimal | Read-only. |
|
||||
| Redeem Points | Total redeem points. | Decimal | Read-only. |
|
||||
| Points Redeemed Amount | Total redeem points amount. | Decimal | Read-only. |
|
||||
| Adjust Points | Total adjustment points. | Decimal | Read-only. |
|
||||
| Points Adjustment Amount | Total adjust point amount. | Decimal | Read-only. |
|
||||
| Award Points | Total award points. | Decimal | Read-only. |
|
||||
| Points Awarded Amount | Total award point amount. | Decimal | Read-only. |
|
||||
| Transaction Date | Transaction Date Time. | Date | Read-only. |
|
||||
| Post Date | Post Date. | Date | Read-only. |
|
||||
| Settlement Date | Settlement Date. | Date | Read-only. |
|
||||
| Cancellation Indicator | Cancellation Indicator. | Boolean | Read-only. |
|
||||
| MCC | Transaction MCC Code. | String | Read-only. |
|
||||
| Store | Transaction Store ID. | String | Read-only. |
|
||||
| Terminal | Transaction Terminal ID. | String | Read-only. |
|
||||
| Transaction Description | Transaction Description. | String | Read-only. |
|
||||
|
||||
#### Quick View Details (Right Panel)
|
||||
Provides a breakdown of the transaction into its component effects.
|
||||
|
||||
**Reward Details** (Award/Redeem/Adjust)
|
||||
- Campaign Rule triggered.
|
||||
- Transaction Type.
|
||||
- OLS Transaction Code.
|
||||
- Reward Pool.
|
||||
- Pool Unit / Amount.
|
||||
|
||||
**Counter Transaction Detail**
|
||||
- Campaign Rule triggered.
|
||||
- Counter updated.
|
||||
- Entity level.
|
||||
- Counter Value.
|
||||
- Bucket Number, Start Date, End Date.
|
||||
|
||||
**Item Redemption Detail**
|
||||
- Item, Description.
|
||||
- Redeemed Quantity, Redeemed Points, Cash Amount Used.
|
||||
|
||||
### Execution
|
||||
- **View-only screen.**
|
||||
- Represents all successful transaction impacts on balances, counters, and redemptions.
|
||||
|
||||
## Exception Flow
|
||||
- N/A
|
||||
Reference in New Issue
Block a user