CRM Integration

This section provides an overview of the implemented CRM Integration use-cases, showcasing the seamless integration between the Customer Relationship Management (CRM) system and the OCS.io solution. These use-cases demonstrate the various functionalities and interactions between CRM and OCS.io, enabling efficient customer management and order processing.

The implemented use-cases include:

Customer Creation: The CRM system can initiate the creation of a new customer in OCS.io, seamlessly transferring customer details such as name, contact information, and account preferences.

Account Management: CRM can manage customer accounts in OCS.io, enabling tasks such as updating account information, setting account preferences, and assigning account hierarchies.

Subscription Management: CRM can create and manage subscriptions for customers in OCS.io, allowing for the addition, modification, or cancellation of subscription plans and services.

Customer Management

Use-Case	Short Description
Create Customer	The CRM / Ordering system creates a Customer in the OCS.io via the RESTful API.
Update Customer	The CRM / Ordering system updates a Customer in the OCS.io via the RESTful API.
Update Customer’s External ID	The CRM / Ordering system updates a Customer’s External ID in the OCS.io via the RESTful API.
Update Customer’s Custom Name	The CRM / Ordering system updates a Customer’s Custom Name in the OCS.io via the RESTful API.
Update Customer’s Custom Attributes	The CRM / Ordering system updates a Customer’s Custom Attributes in the OCS.io via the RESTful API.
Update Customer’s Segment	The CRM / Ordering system updates a Customer’s Segment in the OCS.io via the RESTful API.
Update Customer State	The CRM / Ordering system updates a Customer State in the OCS.io via the RESTful API.
Create Subscription on Customer	The CRM / Ordering system creates an instance of the Offer Subscription on Customer level in the OCS.io via the RESTful API.

Use-Case

Short Description

Create Customer

The CRM / Ordering system creates a Customer in the OCS.io via the RESTful API.

Update Customer

The CRM / Ordering system updates a Customer in the OCS.io via the RESTful API.

Update Customer’s External ID

The CRM / Ordering system updates a Customer’s External ID in the OCS.io via the RESTful API.

Update Customer’s Custom Name

The CRM / Ordering system updates a Customer’s Custom Name in the OCS.io via the RESTful API.

Update Customer’s Custom Attributes

The CRM / Ordering system updates a Customer’s Custom Attributes in the OCS.io via the RESTful API.

Update Customer’s Segment

The CRM / Ordering system updates a Customer’s Segment in the OCS.io via the RESTful API.

Update Customer State

The CRM / Ordering system updates a Customer State in the OCS.io via the RESTful API.

Create Subscription on Customer

The CRM / Ordering system creates an instance of the Offer Subscription on Customer level in the OCS.io via the RESTful API.

Account Management

Use-Case	Short Description
Create Account	The CRM / Ordering system creates an Account in the OCS.io via the RESTful API.
Update Account	The CRM / Ordering system updates an Account in the OCS.io via the RESTful API.
Update Account’s External ID	The CRM / Ordering system updates an Account’s External ID in the OCS.io via the RESTful API.
Update Account’s Custom Name	The CRM / Ordering system updates an Account’s Custom Name in the OCS.io via the RESTful API.
Update Account’s Custom Attributes	The CRM / Ordering system updates an Account’s Custom Attributes in the OCS.io via the RESTful API.
Update Account’s Segment	The CRM / Ordering system updates an Account’s Segment in the OCS.io via the RESTful API.
Update Account State	The CRM / Ordering system updates an Account State in the OCS.io via the RESTful API.
Create Subscription on Account	The CRM / Ordering system creates an instance of the Offer Subscription on Account level in the OCS.io via the RESTful API.
Update Account’s Bill Cycle	The CRM / Ordering system updates an Account’s Bill Cycle in the OCS.io via the RESTful API.
Update Account’s Tax Exemption	The CRM / Ordering system updates an Account’s Tax Exemption flag in the OCS.io via the RESTful API.

Use-Case

Short Description

Create Account

The CRM / Ordering system creates an Account in the OCS.io via the RESTful API.

Update Account

The CRM / Ordering system updates an Account in the OCS.io via the RESTful API.

Update Account’s External ID

The CRM / Ordering system updates an Account’s External ID in the OCS.io via the RESTful API.

Update Account’s Custom Name

The CRM / Ordering system updates an Account’s Custom Name in the OCS.io via the RESTful API.

Update Account’s Custom Attributes

The CRM / Ordering system updates an Account’s Custom Attributes in the OCS.io via the RESTful API.

Update Account’s Segment

The CRM / Ordering system updates an Account’s Segment in the OCS.io via the RESTful API.

Update Account State

The CRM / Ordering system updates an Account State in the OCS.io via the RESTful API.

Create Subscription on Account

The CRM / Ordering system creates an instance of the Offer Subscription on Account level in the OCS.io via the RESTful API.

Update Account’s Bill Cycle

The CRM / Ordering system updates an Account’s Bill Cycle in the OCS.io via the RESTful API.

Update Account’s Tax Exemption

The CRM / Ordering system updates an Account’s Tax Exemption flag in the OCS.io via the RESTful API.

Subscriber Management

Use-Case	Brief Description
Create Subscriber	The CRM / Ordering system creates a Subscriber in the OCS.io via the RESTful API.
Update Subscriber	The CRM / Ordering system updates a Subscriber in the OCS.io via the RESTful API.
Update Subscriber’s External ID	The CRM / Ordering system updates a Subscriber’s External ID in the OCS.io via the RESTful API.
Update Subscriber’s Custom Name	The CRM / Ordering system updates a Subscriber’s Custom Name in the OCS.io via the RESTful API.
Update Subscriber’s Custom Attributes	The CRM / Ordering system updates a Subscriber’s Custom Attributes in the OCS.io via the RESTful API.
Update Subscriber’s Segment	The CRM / Ordering system updates a Subscriber’s Segment in the OCS.io via the RESTful API.
Update Subscriber State	The CRM / Ordering system updates a Subscriber State in the OCS.io via the RESTful API.
Create Subscription on Subscriber	The CRM / Ordering system creates an instance of the Offer Subscription on Subscriber level in the OCS.io via the RESTful API.
Create Subscriber Resource	The CRM / Ordering system creates an instance of the Resource on Subscriber level in the OCS.io via the RESTful API.
SWAP Subscriber Resource	The CRM / Ordering system updates a Resource on the Subscriber in the OCS.io via the RESTful API.

Use-Case

Brief Description

Create Subscriber

The CRM / Ordering system creates a Subscriber in the OCS.io via the RESTful API.

Update Subscriber

The CRM / Ordering system updates a Subscriber in the OCS.io via the RESTful API.

Update Subscriber’s External ID

The CRM / Ordering system updates a Subscriber’s External ID in the OCS.io via the RESTful API.

Update Subscriber’s Custom Name

The CRM / Ordering system updates a Subscriber’s Custom Name in the OCS.io via the RESTful API.

Update Subscriber’s Custom Attributes

The CRM / Ordering system updates a Subscriber’s Custom Attributes in the OCS.io via the RESTful API.

Update Subscriber’s Segment

The CRM / Ordering system updates a Subscriber’s Segment in the OCS.io via the RESTful API.

Update Subscriber State

The CRM / Ordering system updates a Subscriber State in the OCS.io via the RESTful API.

Create Subscription on Subscriber

The CRM / Ordering system creates an instance of the Offer Subscription on Subscriber level in the OCS.io via the RESTful API.

Create Subscriber Resource

The CRM / Ordering system creates an instance of the Resource on Subscriber level in the OCS.io via the RESTful API.

SWAP Subscriber Resource

The CRM / Ordering system updates a Resource on the Subscriber in the OCS.io via the RESTful API.

Subscription Management

Use-Case	Brief Description
Update Subscription	The CRM / Ordering system updates a Offer Subscription in the OCS.io via the RESTful API.
Update Subscription’s External ID	The CRM / Ordering system updates a Subscription’s External ID in the OCS.io via the RESTful API.
Update Subscription’s Custom Name	The CRM / Ordering system updates a Subscription’s Custom Name in the OCS.io via the RESTful API.
Update Subscription’s Custom Attributes	The CRM / Ordering system updates a Subscription’s Custom Attributes in the OCS.io via the RESTful API.
Update Subscription State	The CRM / Ordering system updates a Offer Subscription State in the OCS.io via the RESTful API.

Use-Case

Brief Description

Update Subscription

The CRM / Ordering system updates a Offer Subscription in the OCS.io via the RESTful API.

Update Subscription’s External ID

The CRM / Ordering system updates a Subscription’s External ID in the OCS.io via the RESTful API.

Update Subscription’s Custom Name

The CRM / Ordering system updates a Subscription’s Custom Name in the OCS.io via the RESTful API.

Update Subscription’s Custom Attributes

The CRM / Ordering system updates a Subscription’s Custom Attributes in the OCS.io via the RESTful API.

Update Subscription State

The CRM / Ordering system updates a Offer Subscription State in the OCS.io via the RESTful API.

Individual Offer Management

Use-Case	Brief Description
Create Individual Offer Subscription	The CRM / Ordering system creates an instance of the Individual Offer Subscription in the OCS.io via the RESTful API.
Create Balance Subscription	The CRM / Ordering system creates an instance of the Balance Subscription in the OCS.io via the RESTful API.
Create Monetary Balance Subscription	The CRM / Ordering system creates an instance of the Monetary Balance Offer Subscription in the OCS.io via the RESTful API.
Create One-Time Fee Subscription	The CRM / Ordering system creates an instance of the One-Time Fee Offer Subscription in the OCS.io via the RESTful API.
Create Recurrent Fee Subscription	The CRM / Ordering system creates an instance of the Recurrent Fee Offer Subscription in the OCS.io via the RESTful API.
Create Absolute Discount Subscription	The CRM / Ordering system creates an instance of the Absolute Discount Offer Subscription in the OCS.io via the RESTful API.
Create Percentage Discount Subscription	The CRM / Ordering system creates an instance of the Percentage Discount Offer Subscription in the OCS.io via the RESTful API.
Create Absolute Billing Discount Subscription	The CRM / Ordering system creates an instance of the Absolute Billing Discount Offer Subscription in the OCS.io via the RESTful API.
Create Percentage Billing Discount Subscription	The CRM / Ordering system creates an instance of the Percentage Billing Discount Offer Subscription in the OCS.io via the RESTful API.

Use-Case

Brief Description

Create Individual Offer Subscription

The CRM / Ordering system creates an instance of the Individual Offer Subscription in the OCS.io via the RESTful API.

Create Balance Subscription

The CRM / Ordering system creates an instance of the Balance Subscription in the OCS.io via the RESTful API.

Create Monetary Balance Subscription

The CRM / Ordering system creates an instance of the Monetary Balance Offer Subscription in the OCS.io via the RESTful API.

Create One-Time Fee Subscription

The CRM / Ordering system creates an instance of the One-Time Fee Offer Subscription in the OCS.io via the RESTful API.

Create Recurrent Fee Subscription

The CRM / Ordering system creates an instance of the Recurrent Fee Offer Subscription in the OCS.io via the RESTful API.

Create Absolute Discount Subscription

The CRM / Ordering system creates an instance of the Absolute Discount Offer Subscription in the OCS.io via the RESTful API.

Create Percentage Discount Subscription

The CRM / Ordering system creates an instance of the Percentage Discount Offer Subscription in the OCS.io via the RESTful API.

Create Absolute Billing Discount Subscription

The CRM / Ordering system creates an instance of the Absolute Billing Discount Offer Subscription in the OCS.io via the RESTful API.

Create Percentage Billing Discount Subscription

The CRM / Ordering system creates an instance of the Percentage Billing Discount Offer Subscription in the OCS.io via the RESTful API.

Balance Management

Use-Case	Brief Description
Update Subscription Balance	The CRM / Ordering system updates a Balance on Offer Subscription in the OCS.io via the RESTful API for those Offers having Balance service.
Update Subscription Balances	The CRM / Ordering system updates multiple Balances on Offer Subscription in the OCS.io via the RESTful API for those Offers having Balance service.

Use-Case

Brief Description

Update Subscription Balance

The CRM / Ordering system updates a Balance on Offer Subscription in the OCS.io via the RESTful API for those Offers having Balance service.

Update Subscription Balances

The CRM / Ordering system updates multiple Balances on Offer Subscription in the OCS.io via the RESTful API for those Offers having Balance service.