Preview OCS Invoice

The Customer Sales Representative or Finance Department User wants to via CRM / Finance system GUI see Invoice for current or past open billing period. 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 Invoice in Preview Mode. The request body contains the Account details and period for which Invoice will be calculated.

The OCS.io calculates Invoice for given period, then returns calculated Invoice as a payload of the response.

The CRM / Finance system formats the Invoice and preview to the User in the GUI.

Primary Actor

Customer Sales Representative or Finance Department User.

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 Invoice will be displayed in Preview mode.
2.	CRM / Finance	Display Search Account	CRM / Finance System displays result of Search Account to the User.
3.	CSR / FIN User	Request for Preview OCS Invoice for Account	Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for 'Preview OCS Invoice for Account'.
4.	CRM / Finance	Call previewOcsInvoice API	CRM / Finance System calls Preview OCS Invoice 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 previewOcsInvoice Response	OCS.io returns Response to the CRM / Finance System.
8.	CRM / Finance	Result of Preview OCS Invoice for Account	CRM / Finance system displays result of 'Preview OCS Invoice for Account' to the User.

Step

Actor

Action

Description

CSR / FIN User

Search Account

Customer Sales Representative or Finance Department User via CRM / Finance GUI searches for an Account for which Invoice will be displayed in Preview mode.

CRM / Finance

Display Search Account

CRM / Finance System displays result of Search Account to the User.

CSR / FIN User

Request for Preview OCS Invoice for Account

Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for 'Preview OCS Invoice for Account'.

CRM / Finance

Call previewOcsInvoice API

CRM / Finance System calls Preview OCS Invoice API exposed by OCS.io.

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.

OCS.io

Perform Business Logic

OCS.io performs Business Logic implemented for the Use-Case.

OCS.io

Return previewOcsInvoice Response

OCS.io returns Response to the CRM / Finance System.

CRM / Finance

Result of Preview OCS Invoice for Account

CRM / Finance system displays result of 'Preview OCS Invoice for Account' to the User.

Request Validations

The following validations are performed when previewing an OCS invoice:

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.

Perform Business Logic

System performs Create OCS Invoice Process and returns calculated Invoice.