Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
*Change log:*
|| *Date:* || *Author:* || *Version:* || *Changes:* || Completed || *Ext.* || *Int.* || *Is in Core* || Jira Ref. ||
| {page-info:created-date|dateFormat=dd MMMM yyyy} | {page-info:created-user} | 0.1 | Doc. created | Yes/No | x | | N/A | |

*Contents*
{toc:all=true|depth=4|excerpt=true|indent=14px}
{pagebreak}
{table-plus:width=665|sortColumn=3|sortDescending=true}

h1. General

h2. What is a Customer in Rator

A customer in Rator is a complex structure consisting of an account with a number of users, billing groups and subscriptions.

Basically, a user object represents a person or a company including address details, email address, personal Id etc. A User object can be used to represent ownership of an account, billing groups and subscriptions as well as to represent a billing address or a delivery address. Multiple Users objects associated with one account.

An Account must have at least one billing group. The billing group represents financial information such as a monetary balance, currency, billing cycle, payment details etc.
When a customer subscribes to a product, a subscription is created. The subscription has information such a start date, sales channel/sales rep, user of subscription (link to a Users object). A Subscription always has a Service which is the object where information such as phone number and device info is stored.

A simple customer consists of:

* One [#Account]
* One [#User]
* One [#Billing Group]
* One [#Subscription]
* One [#Service]

See diagram:
!Customers:Simplified Data Model^CDRator_Model_Simplified.png!

h3. Account
{include:Customers:Account-0}

h3. Billing Group
{include:Customers:BillingGroup-0}

h3. Subscription
{include:Customers:Subscriptions-0}

h3. User
{include:Customers:User-0}


h1. How the API Works
{include:Customers:SOAP Workflow Service Usage}

{pagebreak}

h1. Appendix
{include:SOAP API Methods}
{table-plus}