Update Account’s Bill Cycle

The CRM / Ordering system updates an Account’s Bill Cycle in the OCS.io via the RESTful API. The request body contains updated Account details. The OCS.io updates the instance of the Account, then returns Business Transaction containing updated Account as a payload of the response. Other systems may be notified about the Business Transaction via the Streaming Platform.

Primary Actor

CRM / Ordering system.

Basic Flow

Update Account’s Bill Cycle Basic Flow
Step Actor Action Description

1.

CRM / Ordering

Call updateAccountBillCycle API

CRM / Ordering system calls Update Account’s Bill Cycle API exposed by OCS.io.

2.

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.

3.

OCS.io

Perform Business Logic

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

4.

OCS.io

Publish Business Transaction

OCS.io publishes zero to many messages to Streaming Platform that impacted entities have been changed.

5.

OCS.io

Return updateAccountBillCycle Response

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

6.

DWH

Subscribe for Business Transactions

DWH subscribes for Business Transactions to be delivered by Streaming Platform.

7.

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 updating an account’s bill cycle:

  • Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.

Perform Business Logic

  1. System updates Account’s Bill Cycle.

Publish Business Transaction

Following entities will be published to Streaming Platform as part of Business Transaction:

Cancellation of the Account’s Bill Cycle Change

The cancellation of an Account’s Bill Cycle update can be performed before the planned change is executed. Once the change is executed, it cannot be canceled, and the Account’s Bill Cycle will transition to the new Bill Cycle as planned.

Cancel Account’s Bill Cycle Change Basic Flow
Step Actor Action Description

1.

CRM / Ordering

Call cancelAccountBillCycleChange API

CRM / Ordering system calls Cancel Account’s Bill Cycle Change API exposed by OCS.io.

2.

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.

3.

OCS.io

Perform Business Logic

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

4.

OCS.io

Publish Business Transaction

OCS.io publishes zero to many messages to Streaming Platform that impacted entities have been changed.

5.

OCS.io

Return cancelAccountBillCycleChange Response

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

6.

DWH

Subscribe for Business Transactions

DWH subscribes for Business Transactions to be delivered by Streaming Platform.

7.

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 an account’s bill cycle change:

  • Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.

  • The account must have a bill cycle change in progress.

Perform Business Logic

  1. System cancels planned bill cycle change on Account.

Publish Business Transaction

Following entities will be published to Streaming Platform as part of Business Transaction:

Immediate Change of the Account’s Bill Cycle

The immediate change of an Account’s Bill Cycle can be performed before the planned change is executed automatically. Once the change is executed, it cannot be canceled.

Perform Account’s Bill Cycle Change Basic Flow
Step Actor Action Description

1.

CRM / Ordering

Call performAccountBillCycleChange API

CRM / Ordering system calls Perform Account’s Bill Cycle Change API exposed by OCS.io.

2.

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.

3.

OCS.io

Perform Business Logic

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

4.

OCS.io

Publish Business Transaction

OCS.io publishes zero to many messages to Streaming Platform that impacted entities have been changed.

5.

OCS.io

Return performAccountBillCycleChange Response

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

6.

DWH

Subscribe for Business Transactions

DWH subscribes for Business Transactions to be delivered by Streaming Platform.

7.

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 executing an account’s bill cycle change:

  • Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.

  • The account must have a bill cycle change in progress.

Perform Business Logic

  1. System immediate performs planned bill cycle change on Account.

Publish Business Transaction

Following entities will be published to Streaming Platform as part of Business Transaction: