Read Payment Moral
The CRM / Ordering system reads Account’s Payment Moral from the OCS.io via the RESTful API. The request body contains the Account identification.
The OCS.io calculates the Payment Moral and return it as a payload of the response.
Basic Flow
| Step | Actor | Action | Description |
|---|---|---|---|
1. |
CSR / FIN User |
Search Account |
Customer Sales Representative or Finance Department User via CRM / Finance GUI searches for an Account for which Payment Moral will be displayed. |
2. |
CRM / Finance |
Display Search Account |
CRM / Finance System displays result of Search Account to the User. |
3. |
CSR / FIN User |
Request for Read Payment Moral for Account |
Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for 'Read Payment Moral for Account'. |
4. |
CRM / Finance |
Call readPaymentMoral API |
CRM / Finance System calls Read Payment Moral 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 |
Return readPaymentMoral Response |
OCS.io returns Response to the CRM / Finance System. |
8. |
CRM / Finance |
Result of Read Payment Moral for Account |
CRM / Finance system displays result of 'Read Payment Moral for Account' to the User. |
Request Validations
The following validations are performed when reading the payment moral:
-
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.