Cancel Document
The Customer Sales Representative or Finance Department User wants to via CRM / Finance system GUI cancel created document. This operation is available in the CRM / Finance system GUI for users with correct privileges.
The CRM / Finance system via the RESTful API requests for cancellation of the document in the OCS.io. The request body contains the Account details and identification of the document which shall be cancelled.
The OCS.io cancels the document, then returns result of the operation as a payload of the response.
The CRM / Finance system presents the result of the operation to the User in the GUI.
Basic Flow
| Step | Actor | Action | Description |
|---|---|---|---|
1. |
CSR / FIN User |
Search Document |
Customer Sales Representative or Finance Department User via CRM / Finance GUI searches for a Document to be cancelled. |
2. |
CRM / Finance |
Display Search Document |
CRM / Finance System displays result of Search Document to the User. |
3. |
CSR / FIN User |
Request for Operation |
Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for Operation. |
4. |
CRM / Finance |
Call cancelDocument API |
CRM / Finance System calls Cancel Document API exposed by OCS.io. |
5. |
OCS.io |
Request Validations |
OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc. Additionally, OCS.io validates Request against Business Logic. This typically includes, that referenced entity exists in the system, entity has proper state, etc. |
6. |
OCS.io |
Perform Business Logic |
OCS.io performs Business Logic implemented for the Use-Case. |
7. |
OCS.io |
Publish Business Transaction |
OCS.io publishes zero to many messages to Streaming Platform that impacted entities have been changed. |
8. |
OCS.io |
Return cancelDocument Response |
OCS.io returns Response to the CRM / Finance System. Response codes are as follows:
|
9. |
CRM / Finance |
Result of Operation |
CRM / Finance system displays result of the operation to the User. |
10. |
Finance System |
Subscribe for Business Transactions |
Finance System subscribes for Business Transactions to be delivered by Streaming Platform. |
11. |
Finance System |
Process Business Transactions |
Finance System process Business Transactions internally. This typically includes storing of changed entities, update indexes, update metrics, etc. |
12. |
DWH |
Subscribe for Business Transactions |
DWH subscribes for Business Transactions to be delivered by Streaming Platform. |
13. |
DWH |
Process Business Transactions |
DWH process Business Transactions internally. This typically includes storing of changed entities, update indexes, update metrics, etc. |
Request Validations
The following validations are performed when cancelling a document:
-
Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.
-
Payer must be already created in the system.
-
Document must exist in the system.
-
Cancellation Reason must be configured in the system.
Perform Business Logic
-
System sets following attributes on Payment:
-
Cancellation Reason = provided Cancellation Reason
-
Cancelled Date = Date/Time of the Request
-
Cancelled By = Identification of the User performed the operation
-
Cancellation Amount = Due Amount of the Document at the time of the Request
-
Due Amount = 0
-