Calculate Open Balance
The Calculate Collection Balance Use-Case in the OCS.io focuses on accurately determining the Collection Balance for Payment Responsible Accounts. This Use-Case involves aggregating the outstanding invoices and overpayments up to the current date to derive the Collection Balance. By summing the amounts of due invoices and overpayments, the system provides a comprehensive view of the outstanding balance for each Payment Responsible Account.
Basic Flow
Calculate Open Balance
| Step | Actor | Action | Description | ||
|---|---|---|---|---|---|
1. |
Operation User |
Perform Calculate Open Balance Cron Job now |
Operation User via OCS.io Configuration GUI starts Calculate Open Balance Cron Job with immediate execution.
|
||
2. |
Config / CASM Server |
Trigger Calculate Open Balance Process |
OCS.io Configuration GUI / CASM Server triggers Calculate Open Balance Process. |
||
3. |
RM Server |
Start Process |
RM Server asynchronously starts Calculate Open Balance Process. |
Calculate Open Balance Process
| Step | Actor | Action | Description |
|---|---|---|---|
4. |
RM Server |
Get All Payment Responsible Accounts |
RM Server gets all Payment Responsible Accounts which are not in state Deactivated. |
5. |
RM Server |
Start Process |
RM Server asynchronously starts Calculate Open Balance Process per each Payment Responsible Account. |
Calculate Open Balance Process for Payment Responsible Account
| Step | Actor | Action | Description |
|---|---|---|---|
6. |
RM Server |
Read Configuration |
RM Server reads configuration for Open Balance Process. |
7. |
RM Server |
Get all account’s documents |
RM Server gets all documents belonging to Payment Responsible Account. |
8. |
RM Server |
Filter Document |
RM Server filters Document matching the required conditions. |
9. |
RM Server |
Calculate Open Balance from Document |
RM Server calculates Open Balance from non-filtered Document. |
10. |
RM Server |
Get all account’s payments |
RM Server gets all payments belonging to Payment Responsible Account. |
11. |
RM Server |
Filter Payment |
RM Server filters Payment matching the required conditions. |
12. |
RM Server |
Calculate Open Balance from Payment |
RM Server calculates Open Balance from non-filtered Payment. |
13. |
RM Server |
Store account’s Open Balance |
RM Server stores Open Balance on Payment Responsible Account level. |
14. |
RM Server |
Notify Open Balance calculated on Account |
RM Server notifies that Open Balance has been calculated for Payment Responsible Account. |
Process Notifications by External System
| Step | Actor | Action | Description |
|---|---|---|---|
15. |
External System |
Subscribe for Notifications |
External System subscribes for notifications related to Open Balance Process. |
16. |
External System |
Process Notifications |
External System process notifications. |
Read Configuration
Process reads following configuration:
-
Document Types - only Document types which are marked as Balance relevant are considered
-
Document Due Amount Threshold
Filter Document
Documents will be filtered out as follows:
-
Document type is unknown
-
Document type is not marked as Balance relevant
-
Document is marked as "Cancelled"
-
Due Amount Type is of type Account Receivable and Due Amount is lower than configured threshold
Calculate Open Balance from Document
Open Balance from Document will be calculated as follows:
-
if Due Amount of the document is lower than Due Amount Threshold, document is not considered