Monetization Web Docs | Tridens Technology – Business Configuration

Docs: Finance

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Accounts
General ledger groups
General ledgers
Taxes
Tax suppliers
Customer types
Bill Items

To access this section in Monetization, from the Menu, select Business configuration, and click Finance.

Accounts

To access this section, click Accounts. A paginated list of all accounts is shown in a tabular format.

An account is used for general ledger mappings and financial bookkeeping.

Three actions/subpages can be performed/viewed under this section, namely:

Create account
Details account page
Update account

Create account

Under accounts, to create an account, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

In addition, choose the type of account; they refer directly to accounting types. They are as follows:

Asset
Expense
Equity
Liability
Revenue

Details account page

Under accounts, to see the full details of a particular account, click Details. It contains the following:

Name
Code
Description
Type

Update account

Under accounts, to update an account, first, click Details; it shows the details of the account. Then to update, click Update.

Information:

All information filled out under the create account section can be updated except for the Code.

General ledger groups

To access this section, click General ledger groups. A paginated list of all general ledger groups is shown in a tabular format.

A general ledger group can be used to group multiple general ledgers. Groups of general ledgers can be targeted for financial reports.

Four actions/subpages can be performed/viewed under this section, namely:

Create a general ledger group
Details general ledger group page
Update general ledger group
Delete general ledger group

Create a general ledger group

Under general ledger groups, to create a general ledger group, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Details general ledger group page

Under general ledger groups, to see the full details of a particular general ledger group, click Details. It contains the following:

Name
Code
Description

Update general ledger group

Under general ledger groups, to update a general ledger group, first, click Details; it shows the details of the general ledger group. Then to update, click Update.

Information:

All information filled out under the create a general ledger group section can be updated except for the Code.

Delete general ledger group

Under general ledger groups, to delete a general ledger group, click Delete.

Note:

Deleting a general ledger group already used in a general ledger cannot be done. Every particular reference to the general ledger group first has to be deleted.

General ledgers

To access this section, click General ledgers. A paginated list of all general ledgers is shown in a tabular format.

A general ledger can have account mappings, which are used to keep track of financial journals.

Four actions/subpages can be performed/viewed under this section, namely:

Create a general ledger
Details general ledger page
Update general ledger
Delete general ledger

Create a general ledger

Under general ledgers, to create a general ledger, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

To include a general ledger as part of a group of general ledgers, select the general ledger group.

To add an account mapping, under Account mappings, click Add mapping. Choose the condition, amount type, debit account, and credit account.

Information:

The debit/credit account is created under accounts. For more information, see Accounts.

Example of an account mapping

Condition	Amount type	Debit Account	Credit Account
billed	tax	Subscriptions: Tax	Accounts Receivable
billed	net	Subscriptions	Accounts Receivable
billed	discount	Accounts Receivable	Subscriptions: Discount
unbilled	net	Subscriptions	Accounts Receivable
unbilled	discount	Accounts Receivable	Subscriptions: Discount
unbilled	tax	Subscriptions: Tax	Accounts Receivable

Details general ledger page

Under general ledgers, to see the full details of a particular general ledger, click Details. It contains the following:

Name
Code
Description
Account mappings (if any)

Update general ledger

Under general ledgers, to update a general ledger, first, click Details; it shows the details of the general ledger. Then to update, click Update.

Information:

All information filled out under the create a general ledger section can be updated except for the Code.

Delete general ledger

Under general ledgers, to delete a general ledger, click Delete.

Note:

Deleting a general ledger already used in other parts of Monetization cannot be done. Every particular reference to the general ledger first has to be deleted.

Taxes

To access this section, click Taxes. A paginated list of all taxes is shown in a tabular format.

A tax is an object that can be added to a price to calculate a tax, such as VAT.

Four actions/subpages can be performed/viewed under this section, namely:

Create tax
Details tax page
Update tax
Delete tax

Create tax

Under taxes, to create a tax, click Create new. Provide a name, code, description, and validity period.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Information:

The provider is only applicable in the case of a third-party taxation gateway provider that Monetization provides. Otherwise, the tax is percentage based.

Details tax page

Under taxes, to see the full details of a particular tax, click Details. It contains the following:

Name
Code
Description
Validity
Provider
Value
Type

Update tax

Under taxes, to update a tax, first, click Details; it shows the details of the tax. Then to update, click Update.

Information:

All information filled out under the create tax section can be updated except for the Code.

Delete tax

Under taxes, to delete a tax, click Delete.

Note:

Deleting a tax already used in other parts of Monetization cannot be done. Every particular reference to the tax first has to be deleted.

Tax suppliers

To access this section, click Tax suppliers. A paginated list of all tax suppliers is shown in a tabular format.

A tax supplier refers to your company and includes any information relevant to reporting to the tax authorities.

Four actions/subpages can be performed/viewed under this section, namely:

Create tax supplier
Details tax supplier page
Update tax supplier
Delete tax supplier

Create tax supplier

Under tax suppliers, to create a tax supplier, click Create new. Provide a name, code, description, address, country, city, and zip code.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Other configurations, which include whether your company is facilities-based, is a franchise and is regulated, can impact how taxes are treated when working with third-party integration.

Furthermore, choose the service class, which can be local or primary long distance, and the business class, which can be ILEC or CLEC.

Details tax supplier page

Under tax suppliers, to see the full details of a particular tax supplier, click Details. It contains the following:

Name
Code
Description
Address
Country
State
City
ZIP
Facilities based
Franchise
Regulated
Service class
Business class

Update tax supplier

Under tax suppliers, to update a tax supplier, first, click Details; it shows the details of the tax. Then to update, click Update.

Information:

All information filled out under the create tax supplier section can be updated except for the Code.

Delete tax supplier

Under tax suppliers, to delete a tax supplier, click Delete.

Note:

Deleting a tax supplier already used in other parts of Monetization cannot be done. Every particular reference to the tax supplier first has to be deleted.

Customer types

To access this section, click Customer types. A paginated list of all customer types is shown in a tabular format.

The customer type in Monetization is used to segregate customers or to create different customer categories, which can be helpful for statistics and analytics purposes.

Examples of a customer type

Vendor
Reseller
Company
Supplier
Partner
Agent
Person
Operator

Note:

During the onboarding process of a customer, you must insert a customer type.

Information:

Under analytics in Monetization, you can filter by customer types for usage.

Four actions/subpages can be performed/viewed under this section, namely:

Create customer type
Details customer type page
Update customer type
Delete customer type

Create customer type

Under customer types, to create a customer type, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

A customer type can be marked as sensitive data; use the Sensitive data toggle switch to enable/disable. If enabled, any customer object of this type represents a person or legal entity in Monetization.

Note:

Sensitive customer types cannot be accessed from the onboarding process of the self-care portal. By default, all customer types are sensitive.

Non-sensitive customer types are meant to represent customer objects which do not contain sensitive (personal) data and are only used for tracking relationships between different customer objects in special use cases such as utilities (Customer – Apartment).

Details customer type page

Under customer types, to see the full details of a particular customer type, click Details. It contains the following:

Name
Code
Description
Sensitive data

Update customer type

Under customer types, to update a customer type, first, click Details; it shows the details of the customer type. Then to update, click Update.

Information:

All information filled out under the create customer type section can be updated except for the Code.

Delete customer type

Under customer types, to delete a customer type, click Delete.

Note:

Deleting a customer type already used in other parts of Monetization cannot be done. Every particular reference to the customer type first has to be deleted.

Bill Items

To access this section, click Bill Items. A paginated list of all bill items is shown in a tabular format.

A bill item is in charge of how Monetization represents charges on the bill/invoice. When a product is created, or when any impact occurs that affects the monetary resource, the bill item must be provided for Monetization to know how to represent the charge(s) on the bill/invoice.

Example of bill item

The bill item Subscription Monthly Fee can be used for three different products:

Monthly Package Gold @ $30
Monthly Package Silver @ $25
Monthly Package Bronze @ $20

Even though the products are different with different prices, on the invoice, it will be displayed as Subscription Monthly Fee with their specific price due to the common bill item.

Four actions/subpages can be performed/viewed under this section, namely:

Create bill item
Details bill item page
Update bill item
Delete bill item

Create bill item

Under bill items, to create a bill item, click Create new. Provide a name, code, and type (Cumulative or Individual). Optionally, add a description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Information:

A bill item either has a cumulative/individual type. Setting the bill item to have an individual type means if there are multiple items with the same bill item on the same invoice, they would be presented on separate lines.

However, setting the bill item to have a cumulative type means if there are multiple items with the same bill item on the same invoice, they would be grouped together.

To include the bill item on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.

Note:

Only include the information needed on the invoice for performance optimization.

Details bill item page

Under bill items, to see the full details of a particular bill item, click Details. It contains the following information:

Name
Code
Description
Type
Included on invoice?

Update bill item

Under bill items, to update the bill item, first, click Details; it shows the details of the bill item. Then to update, click Update.

Information:

All information filled out under the create bill item section can be updated except for the Code.

Delete bill item

Under bill items, to delete a bill item, click Delete.

Note:

Deleting a bill item already used in other parts of Monetization cannot be done. Every particular reference to the bill item first has to be deleted.

Docs: Charging

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Tags
Resources
Thresholds
Notifications
Credit limits
Credit profiles
Event types
Rounding modes

To access this section in Monetization, from the Menu, select Business configuration, and click Charging.

Resources

To access this section, click Resources. A paginated list of all resources is shown in a tabular format.

Information:

This section shows how to create resources in Monetization, for example, monetary resources (e.g., Euro, US Dollar, etc.), free resources (e.g., free SMS, free data, etc.), etc.

A resource represents an object in Monetization that can hold a value—for example, a monetary resource with a value of 10.

In addition, a resource can exist as a balance for a customer. A balance is one unique resource value inside a specific balance group.

Balances of a resource are created automatically in Monetization whenever a customer purchases a product or triggers a usage event. For instance, if a plan has a product that grants 100 free minutes. Upon the customer purchasing the plan, a balance of 100 free minutes will be created in the related balance group.

Information:

A balance can also be manually created via the API, which is used more for management than automation.

Resources are essential when creating a product catalog because the products a customer can purchase will result in a resource balance impact—for example, charging a customer 100 euros or granting them 100 free credits.

Examples of a resource

Below are five examples of a resource, including their industry.

Euro — Any industry — It represents the current monetary balance of a customer within the current cycle.
Free minutes — Telecommunications
Total consumption kWh — Utility
Minimum fare fee — Car sharing/Taxis — An helper resource holding the minimum fee that the customer has to pay for every ride
API calls total — Cloud services — To keep track of how many generated API call events

Note:

A resource balance can increase or decrease due to a customer purchasing a product or generating a usage event. A customer’s balance will be affected whenever they buy a product or use a service that triggers a usage event.

Four actions/subpages can be performed/viewed under this section, namely:

Create resource
Details resource page
Update resource
Delete resource

Create resource

Under resources, to create a resource, click Create new. It includes mandatory and optional input fields.

The mandatory input fields include the following:

Name
Code
Balance consumption order
Default value
Validity period

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional input fields include the following:

Description
Temporary
Currency
Included on invoice

Note:

The most important resource in Monetization is the monetary resource because it represents a currency that the customer is paying in.

Monetary resource

Monetary resource means actual money in Monetization; it represents monetary currency (e.g., euros, dollars, etc.). To create a monetary resource, under create resource, provide a name (e.g., euro), a code (e.g., euro), a description (e.g., euro monetary resource), and a balance consumption order.

For a monetary resource, the earliest start time and earliest expiration time (ESTEET) is configured for the balance consumption order because the oldest balance should be consumed first.

Typically, the default value is set to 0. However, it can be modified to either a positive or negative value, for example, 100. Whenever Monetization creates a balance for the resource initially, it starts with the default value.

Tip:

It is a good practice not to change the default value of a free resource from zero because the default value will be applied globally to all customers for all the created resource balances. Instead, create a product that will grant some amount of free resources to the customer.

Typically, Monetization basis free resources on the customer plan. One customer can have 1GB of free data, while another has 2GB. Hence, create a product for that plan, which will grant the correct amount depending on the plan.

Information:

A resource can be created whose balance represents a counter that will count downward toward zero. In that case, the default value can be set to any positive number.

Instead of initially setting the resource balance with the purchase of a product, the resource balance will be set to the default value of the resource upon the creation of the resource balance. For more information about the usefulness, see helper resources.

To make the resource a temporary resource, use the Temporary toggle switch to enable/disable. Enabling this feature means that the resource will return to the default value immediately after Monetization completes rating. It is used mainly for helper resources.

By default, a resource is always valid from the day it is created to an infinite period. However, it can be configured to expire sometime in the future. Typically, a monetary resource should have infinite validity.

Note:

A resource becomes a monetary resource when a currency is assigned to the resource. In contrast, for a non-monetary resource, see non-monetary resource.

To include the resource on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.

Note:

Only include the information needed on the invoice for performance optimization.

Balance consumption order

The balance consumption order specifies the order to which the resource balance should be impacted when multiple balances of the same resource exist in a balance group.

For instance, a customer balance group has the following:

100 free minutes valid from the 1st of January to the 15th of February
50 free minutes valid from the 1st of February to the 1st of March

Assume today is the 10th of February; both balances are valid. Therefore, the customer currently has 150 free minutes in total. The customer then generates an event for 120 free minutes; the balance consumption order configuration decides which balance should be consumed first based on the validity period.

If the balance consumption order is set to ESTEET, the customer will end up with 30 free minutes, valid from the 1st of February to the 1st of March. However, suppose the balance consumption order is set to consume the latest resource first. In that case, the customer will end up with 30 free minutes valid from the 1st of January to the 15th of February.

Explanation of some terms

EST: Configuring the balance consumption order to earliest start time (EST) means that the balance with the earliest validity start time is used first.
LST: Configuring the balance consumption order to latest start time (LST) means that the balance with the latest validity start time is used first.
EET: Configuring the balance consumption order to earliest expiration time (EET) means that the balance with the earliest validity end time is used first.
LET: Configuring the balance consumption order to latest expiration time (LET) means that the balance with the latest validity end time is used first.
ESTLET: Configuring the balance consumption order to earliest start time and latest expiration time (ESTLET) means that the balance with the earliest validity start time is used first. If multiple balances have the same validity start time, the one with the latest end time is used first.
ESTEET: Configuring the balance consumption order to earliest start time and earliest expiration time (ESTEET) means that the balance with the earliest validity start time is used first. If multiple balances have the same validity start time, the one with the earliest end time is used first.

Tip:

The ESTEET should be used as the default balance consumption order.

LSTEET: Configuring the balance consumption order to latest start time and earliest expiration time (LSTEET) means that the balance with the latest validity start time is used first. If multiple balances have the same validity start time, the one with the earliest end time is used first.
LSTLET: Configuring the balance consumption order to latest start time and latest expiration time (LSTLET) means that the balance with the latest validity start time is used first. If multiple balances have the same validity start time, the one with the latest end time is used first.
EETEST: Configuring the balance consumption order to earliest expiration time and earliest start time (EETEST) means that the balance with the earliest validity end time is used first. If multiple balances have the same validity end time, the one with the earliest start time is used first.
EETLST: Configuring the balance consumption order to earliest expiration time and latest start time (EETLST) means that the balance with the earliest validity end time is used first. If multiple balances have the same validity end time, the one with the latest start time is used first.
LETEST: Configuring the balance consumption order to latest expiration time and earliest start time (LETEST) means that the balance with the latest validity end time is used first. If multiple balances have the same validity end time, the one with the earliest start time is used first.
LETLST: Configuring the balance consumption order to latest expiration time and latest start time (LETLST) means that the balance with the latest validity end time is used first. If multiple balances have the same validity end time, the one with the latest start time is used first.

Helper resources

A helper resource is not directly relevant to the customer; however, Monetization uses it for rating. For example, a counter resource, which Monetization uses to keep track of something.

Example of a helper resource

Assume a resource MBs used in a session to track how many MBs the customer has used in one data session/event. A helper resource in the form of a counter resource can be used.

If the pricing is expected to change after the customer has consumed 10MBs within one session, that is, there is multi-tier pricing, immediately Monetization receives a data event, it will be rated according to the rate plan. The counter resource can track how many quantities the customer has used to know when to start rating with a different price.

After the single event has been rated, the helper resource MBs used in a session in the form of a counter resource will be reset to zero for it to be ready for the next event.

Note:

For a resource to reset to its default value after each rating, the Temporary toggle switch should be enabled.

Non-monetary resource

A non-monetary resource does not have a monetary value; hence, it is not treated as money. Examples of non-monetary resources can include free data, free SMS, etc.

Information:

To learn how to generally create a resource, see monetary resource.

Note:

A non-monetary resource should not be given a currency. Assigning a currency to the resource turns it into a monetary resource.

Details resource page

Under resources, to see the full details of a resource, click Details. It contains the following:

Status — a resource with an active status means the resource is still valid.
Name
Code
Description
Balance consumption order
Default value
Type (Standard or Temporary)
Valid from
Valid to
Currency (if any)
Included on invoice

Update resource

Under resources, to update a resource, first, click Details; it shows the details of the resource. Then to update, click Update.

Information:

All information filled out under the create resource section can be updated except for the Code.

Delete resource

Under resources, to delete a resource, click Delete.

Note:

Deleting a resource already used in other parts of Monetization cannot be done. Every particular reference to the resource first has to be deleted.

Thresholds

To access this section, click Thresholds. A paginated list of all thresholds is shown in a tabular format.

A threshold is a configured value that can trigger a notification whenever a resource balance exceeds a threshold defined on the credit limit and linked to the resource by a credit profile.

Four actions/subpages can be performed/viewed under this section, namely:

Create threshold
Details threshold page
Update threshold
Delete threshold

Create threshold

Under thresholds, to create a threshold, click Create new. It includes mandatory and optional input fields.

The mandatory fields include the following:

Name (e.g., T_200)
Code (e.g., T_200)
Type (amount or percentage)
Value (e.g., 200)

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional field includes:

Description (e.g., threshold for 200)

A threshold configured as an amount means the value is fixed—for example, 200. Therefore, when the balance exceeds 200, it will trigger a notification.

Note:

A threshold value configured as an amount can also be negative.

A threshold configured as a percentage means the value is relative to another resource balance. For instance, assume two balances:

Resource name	Balance
Granted free MBs	1000
Free MBs	900

If a percentage threshold for Free MBs is configured to be 80% of the Granted free MBs balance, then the threshold will trigger at 800.

Tip:

The percentage threshold is useful because it can change the value based on a different resource balance—allowing for more flexibility on the customer level. While the amount threshold is always constant based on the configured value.

Information:

Once a threshold is created, it will not be connected to anything, but rather it is an object that exists in Monetization that can be used when creating a credit limit.

Details threshold page

Under thresholds, to see the full details of a threshold, click Details. It contains the following:

Name
Code
Description
Type
Value

Update threshold

Under thresholds, to update a threshold, first, click Details; it shows the details of the threshold. Then to update, click Update.

Information:

All information filled out under the create threshold section can be updated except for the Code.

Delete threshold

Under thresholds, to delete a threshold, click Delete.

Note:

Deleting a threshold already linked to a credit limit cannot be done. Every particular reference to the threshold first has to be deleted.

Notifications

Monetization triggers a notification whenever a balance of a specific resource exceeds or falls below a threshold. The threshold is linked to a credit limit and configured for a particular resource by a credit profile.

The notifications can be seen in Monetization under the customer account page. For more information, see Notifications.

Credit limits

To access this section, click Credit limits. A paginated list of all credit limits is shown in a tabular format.

A credit limit can be used to restrict how far a customer can use a resource in terms of positive or negative value. You can also add multiple thresholds, which a customer can breach as they go over the configured value.

It describes a resource balance’s minimum and maximum limits and which thresholds can be triggered when breached.

Four actions/subpages can be performed/viewed under this section, namely:

Create a credit limit
Details credit limit page
Update credit limit
Delete credit limit

Create a credit limit

Under credit limits, to create a credit limit, click Create new. It includes mandatory and optional input fields.

The mandatory fields include the following:

Name
Code
Start
Stop

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional fields include the following:

Description
Thresholds

Multiple thresholds can be added. For example, assume a credit limit with a threshold value of 200; therefore, whenever the resource balance exceeds 200, it will trigger a notification.

Note:

The Start and Stop fields represent the minimum and maximum values, respectively, one resource balance can have.

The Start and Stop fields can be configured as either positive or negative numbers. In addition, the Start and Stop fields can also be configured to No minimum or No maximum, which is more user-friendly, by clicking Pick value.

The No minimum and No maximum value means that the value can be unlimited, as it goes from minus infinite to plus infinite.

Tip:

A prepaid monetary resource should have its Stop value configured to zero. This would enable the resource balance not to exceed zero.

This is typical because prepaid customers can only use the service(s) while they have money available. Therefore, it does not make sense to let their monetary balance fall below zero.

In addition, if the limit is set to zero, then Monetization can tell when the money ran out and will no longer rate events.

Note:

It is impossible to bring a resource balance outside of the credit limit Start and Stop values. In addition, the service the customer consumes can be disabled as soon as the resource limit is reached—for example, a prepaid customer who runs out of money.

Details credit limit page

Under credit limits, to see the full details of a credit limit, click Details. It contains the following:

Name
Code
Description
Thresholds
Start
Stop

Update credit limit

Under credit limits, to update a credit limit, first, click Details; it shows the details of the credit limit. Then to update, click Update.

Information:

All information filled out under the create a credit limit section can be updated except for the Code.

Delete credit limit

To delete a credit limit, click Delete.

Note:

Deleting a credit limit already linked to a credit profile cannot be done. Every particular reference to the credit limit first has to be deleted.

Credit profiles

To access this section, click Credit profiles. A paginated list of all credit profiles is shown in a tabular format.

A credit profile links a credit limit to a particular resource for a specific payment type. For example, how the euro (monetary) resource has to behave, which credit limit should it use when it is available as a balance on a customer’s account.

Four actions/subpages can be performed/viewed under this section, namely:

Create a credit profile
Details credit profile page
Update credit profile
Delete credit profile

Create a credit profile

Under credit profiles, to create a credit profile, click Create new. It includes mandatory and optional input fields.

The mandatory fields include the following:

Name
Code
Payment type
Resource
Credit limit

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional field includes:

Description

Note:

A credit profile must be created for each payment type because it describes balance behaviours in relation to a payment type. If non-existent, then the balance can not be created.

Information:

Configuring a credit profile will enable each resource to be given a description that depicts how it will be limited based on the payment type of the customer.

For a postpaid payment type

For a postpaid payment type, the credit limit with a Start value of No minimum and a Stop value of No maximum is recommended.

This means the resource that belongs to the customer can either be a negative value (because the customer was given some credit) or a positive value (because the customer will owe something).

For a pay-now payment type

The credit limit with a Start value of No minimum and a Stop value of No maximum is recommended for a pay-now payment type.

This means the resource that belongs to the customer can either be a negative value (because the customer was given some credit) or a positive value (because the customer will owe something).

For a prepaid payment type

For prepaid payment type, it is recommended that the credit limit with a Start value of No minimum and a Stop value of 0 should be chosen because the customer balance should not exceed zero.

For instance, assume a prepaid customer purchases a product that offers 100 euros, which is a monetary resource. It will be shown in the customer’s balance as -100 euros of credit. The customer can consume the resource and would not owe anything.

However, as they continue consuming the resource, the balance will reduce until it reaches zero, which indicates that the customer has exhausted the resource.

Details credit profile page

Under credit profiles, to see the full details of a credit profile, click Details. It contains the following:

Name
Code
Description
Payment type
Credit limit
Resource

Update credit profile

Under credit profiles, to update a credit profile, first, click Details; it shows the details of the credit profile. Then to update, click Update.

Information:

All information filled out under the create a credit profile section can be updated except for the Code.

Delete credit profile

Under credit profiles, to delete a credit profile, click Delete.

Event types

To access this section, click Event types. A paginated list of all event types is shown in a tabular format.

An event type represents a time interval in Monetization. It is created to be configured for a recurring product to determine how the product will renew. It is also configured for a customer to determine how frequently the customer will be charged.

Different cycles can be configured for an event type. For instance, monthly cycle, three months cycle, semi-annual cycle, annual cycle, etc.

Four actions/subpages can be performed/viewed under this section, namely:

Create event type
Details event type page
Update event type
Delete event type

Create event type

Under event types, to create an event type, click Create new. The name, code, interval unit, interval duration, and interval time are required, while the description is optional.

The interval unit constitutes three values:

Days
Weeks
Months

The interval duration specifies the length of time given to the interval unit—for example, six months; the interval time, which default value is 12:00 AM.

For instance, given the below table:

Interval unit	Interval duration	Interval time
Months	6	12:00 AM

If a recurring product is given the above event type, it means that the product will renew every six months at 12:00 AM. Similarly, configuring the event type for a customer under the billing profile means that the customer will be charged every six months at 12:00 AM.

Details event type page

Under event types, to see the full details of an event type, click Details. It contains the following:

Name
Code
Description
Interval unit
Interval duration
Interval time

Update event type

Under event types, to update an event type, first, click Details; it shows the details of the event type. Then to update, click Update.

Information:

All information filled out under the create event type section can be updated except for the Code.

Delete event type

Under event types, to delete an event type, click Delete.

Note:

Deleting an event type already used in other parts of Monetization cannot be done. Every particular reference to the event type first has to be deleted.

Rounding modes

To access this section, click Rounding modes.

Rounding modes are configured for each site to determine how many decimal places to round the calculations made during different stages of rating.

There are four distinct components to applying a scale for, which are:

Rating
Discounting
Taxation
Billing

Whenever one of these four components gets triggered in Monetization, the rounding mode is applied to round the values to the configured decimal places.

The Scale refers to a number that denotes the number of decimal places. The Mode can be configured to Half Up or Half Down. For example, if configured to be Half Up, a value of 7.5 will be rounded to 8, while if configured to be Half Down, a value of 7.5 will be rounded to 7.

Tip:

The Scale value should be adjusted to the point that will enable bills to be generated, especially when dealing with very low values.

Docs: Service Design

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Service fields
Service types
Unit groups
Rating metrics
Charge intervals

To access this section in Monetization, from the Menu, select Business configuration, and click Service design.

Information:

Monetization must be taught what service(s) are required for a business to operate internally. For example, assume a telecommunication industry with a data, voice, and SMS service. These services will consist of several fields or parameters. You can then use part of those fields to determine the quantity to be rated.

Service fields

To access this section, click Service fields. A paginated list of all service fields is shown in a tabular format.

A service field is a parameter that can be part of a service type. The parameter will hold information about one session/event in Monetization.

Service fields example

Assume a telecommunication company that enables customers to make phone calls. The service fields can include the following:

start_time
origin
destination
duration
direction
quantity

Information:

These service fields can then be included in a service. Then, whenever a usage event comes in for the service, these are the fields Monetization will expect, and it can get the ratable quantity from these fields.

Reserved fields

The session identifier and identifier are reserved fields that must exist as part of the service fields. They are created automatically when a site is created in Monetization.

The identifier will represent the service identifier of one customer—for instance, a mobile phone number for data or voice service. The identifier must be unique for each site; it could be an integer number, a device, or anything that can be used to identify a customer uniquely.

The session identifier should be included in each usage event. This ensures that the same event will only be rated once and cannot be duplicated.

Four actions/subpages can be performed/viewed under this section, namely:

Create a service field
Details service field page
Update service field
Delete a service field

Create a service field

Under service fields, to create a service field, click Create new. Provide a name and code. Optionally, add a description.

Information:

Multiple service fields can be created.

Details service field page

Under service fields, to see the full details of a service field, click Details. It contains the following:

Name
Code
Description

Update service field

Under service fields, to update a service field, first, click Details; it shows the details of the service field. Then to update, click Update.

Information:

All information filled out under the create a service field section can be updated except for the Code.

Delete a service field

Under service fields, to delete a service field, click Delete.

Note:

Deleting a service field already used in other parts of Monetization cannot be done. Every particular reference to the service field first has to be deleted.

Service types

To access this section, click Service types. A paginated list of all service types is shown in a tabular format.

A service type describes one service in Monetization—for instance, a voice or data service. It determines which service fields are meant to be part of one session/event for that particular service.

In addition, a service type defines a service by depicting the optional or mandatory service fields and rating set fields Monetization needs in usage events for a specific service.

Information:

A purchased product can offer a service when the created product contains a service type. Monetization can rate events for service usage.

Four actions/subpages can be performed/viewed under this section, namely:

Create service type
Details service type page
Update service type
Delete service type

Create service type

Under service types, to create a service type, click Create new.

The mandatory input fields include the following:

name
code
mandatory service field(s)
authorization strategy

The optional input fields include the following:

description
optional service field(s)
rating set fields
Included on invoice
Impact balances

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Information:

Including the session identifier and identifier as mandatory fields is good practice. They are known as reserved fields. For more information, see Reserved fields.

To include the service details on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.

Note:

Only include the information needed on the invoice for performance optimization.

If Impact balances toggle switch is enabled then this service will be impacting, reserving, and working with balances in real-time. In case this is not necessary, turning this off will increase rating performance.

Rating set fields

A rating set field is a field that, instead of being matched as raw strings, is compared against a rating sets object, which can have multiple matches. It is helpful for prefix matching.

Tip:

Monetization will map the rating set field towards a pattern.

Rating set field example

The Slovenia rating sets in the telecommunication industry can have multiple matches: 003865, 003867, 003864, etc., representing telephone number prefixes. If an origin service field is defined as a rating set field on a service type, the field’s contents will be compared to all prefixes in Slovenia when Monetization tries to find a match. Therefore, if the origin is 003865123123, the Slovenia rating set will be matched.

Information:

Comparing a service field to a hierarchy of zones becomes a rating set field.

Details service type page

Under service types, to see the full details of a service type, click Details. It contains the following:

Name
Code
Description
Mandatory fields
Optional fields
Rating set fields
Authorization strategy
Included on invoice
Impact balances

Update service type

Under service types, to update a service type, first, click Details; it shows the details of the service type. Then to update, click Update.

Information:

All information filled out under the create service type section can be updated except for the Code.

Note:

When updating the information from services used by customers and events, if a new service field is added to the service type, the service field will be missing from all previous events. This is because the service field was unknown to Monetization then.

Delete service type

Under service types, to delete a service type, click Delete.

Note:

Deleting a service type already used in other parts of Monetization cannot be done. Every particular reference to the service type first has to be deleted.

Unit groups

To access this section, click Unit groups. A paginated list of all unit groups is shown in a tabular format.

A unit group is designed to create related units in Monetization. A conversion factor must also be provided to enable Monetization to make conversions between the units automatically.

Example of a unit group

Assume a telecommunication company provides data service to customers. After configuring the units in kilobytes (kB), megabytes (MB), and gigabytes (GB), the usage event can have input in kB; at the same time, pricing can work in MB.

Note:

Each unit group should hold units that belong together. For example, the data unit group can comprise kB, MB, and GB. Also, it should include a conversion factor that allows Monetization to convert between the units automatically—for example, converting between kB and MB.

Information:

When creating a rate plan, a unit can be provided for possible quantity unit conversion.

Four actions/subpages can be performed/viewed under this section, namely:

Create unit group
Details unit group page
Update unit group
Delete unit group

Create unit group

Under unit groups, to create a unit group, click Create new. Provide a name and code. Optionally, provide a description and some units.

To add a unit, under Units, click Add unit. Provide a name, symbol, and factor. To make a particular unit the base unit, check the checkbox Base unit.

Note:

The base unit must have a factor of one, while others should have a factor compared to the base unit.

For example, assume the following units in a unit group:

Name	Symbol	Factor
kilobyte	kB	1
megabye	MB	1024
gigabyte	GB	1048576

To delete a unit, under Units, click Delete

Details unit group page

Under unit groups, to see the full details of a unit group, click Details. It contains the following:

Name
Code
Description
Units - The units are shown in a tabular format.

Update unit group

Under unit groups, to update a unit group, first, click Details; it shows the details of the unit group. Then to update, click Update.

Information:

All information filled out under the create unit group section can be updated except for the Code.

Delete unit group

Under unit groups, to delete a unit group, click Delete.

Rating metrics

To access this section, click Rating metrics. A paginated list of all rating metrics is shown in a tabular format.

Monetization uses a rating metric to determine the quantity to be rated based on the service field(s) from the session/event. In other words, a rating metric enables Monetization to know how to get the ratable quantity out of an event.

Information:

When a rating metric is created in Monetization, it is not tied to a service or product. This is done when creating a rate plan.

Four actions/subpages can be performed/viewed under this section, namely:

Create rating metric
Details rating metric page
Update rating metric
Delete rating metric

Create rating metric

Under rating metrics, to create a rating metric, click Create new. Provide a name and code. Optionally, provide a description and a metric expression(s).

To add a metric expression, under Metric expressions, click Add metric expression. Provide a priority, expression, and unit. The unit is configured under unit groups. For more information, see Unit groups.

Note:

The Expression should refer directly to the service fields from the service type.

For example, assume a quantity service field is inserted as the rating metric expression; Monetization will get the ratable quantity from the quantity service field.

Note:

Multiple metric expressions can be created with different priorities. For example, priority 0, priority 1, priority 2, etc. However, Monetization will initially use the metric expression with a greater priority number.

Basic math expressions like addition, subtraction, and multiplication can be performed in a metric expression to determine the ratable quantity. For example, assume an end_timeand start_time service field; from that, a rating metric expression of the form end_time - start_time can be created.

Information:

The actual assignment of the metric happens later when the service product is being created.

Details rating metric page

Under rating metrics, to see the full details of a rating metric, click Details. It contains the following:

Name
Code
Description
Metric expressions - The metric expressions are shown in a tabular format.

Update rating metric

Under rating metrics, to update a rating metric, first, click Details; it shows the details of the rating metric. Then to update, click Update.

Information:

All information filled out under the create rating metric section can be updated except for the Code.

Delete rating metric

Under rating metrics, to delete a rating metric, click Delete.

Note:

Deleting a rating metric already used in other parts of Monetization cannot be done. Every particular reference to the rating metric first has to be deleted.

Charge intervals

To access this section, click Charge intervals. A paginated list of all charge intervals is shown in a tabular format.

A charge interval describes how Monetization will round the ratable quantity from the rating metric. After the rating metric calculates the raw quantity-to-be-rated, the charge interval can round up or down based on the configurations.

Note:

When Monetization receives an event, the ratable quantity is gotten. It is then compared to the charge interval to round up or down to the next step. Once rounded, that will be the new ratable quantity.

Four actions/subpages can be performed/viewed under this section, namely:

Create charge interval
Details charge interval page
Update charge interval
Delete charge interval

Create charge interval

Under charge intervals, to create a charge interval, click Create new. Provide a name and code. Optionally, provide a description, minimum step, step, rounding mode, and unit.

The minimum step represents the smallest quantity that can be rated. Therefore, if Monetization receives an event below that, it will be rounded to the minimum step. For instance, assume a minimum step configuration of zero, and Monetization receives an event below zero; the event will be rounded to zero.

The step represents how the ratable quantity should increment. For example, Monetization receives an event and figures out the ratable quantity to be 550 through the rating metric; if the step is configured to be 100, Monetization will round the quantity up or down depending on the configuration of the rounding mode.

If the rounding mode is configured to Up, the new ratable quantity will be 600, while if the rounding mode is configured to Down, the new ratable amount will be 500.

Details charge interval page

Under charge intervals, to see the full details of a charge interval, click Details. It contains the following:

Name
Code
Description
Min step
Step
Rounding mode
Unit

Update charge interval

Under charge intervals, to update the charge interval, first, click Details; it shows the details of the charge interval. Then to update, click Update.

Information:

All information filled out under the create charge interval section can be updated except for the Code.

Delete charge interval

Under charge intervals, to delete a charge interval, click Delete.

Note:

Deleting a charge interval already used in other parts of Monetization cannot be done. Every particular reference to the charge interval first has to be deleted.

Docs: Voucher

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Voucher vs. Coupon
- Example of a coupon
- Example of a voucher
Create voucher
- Explanation of some terms
- Practical example
Details voucher page

To access this section in Monetization, from the Menu, select Business configuration, and click Voucher. A paginated list of all vouchers is shown in a tabular format.

Vouchers give specific bundles that contain a discount to the customer when consumed. It is similar to a coupon.

Voucher vs. Coupon

The difference between a coupon and a voucher is that a coupon only lasts for that specific purchase. In contrast, a voucher can give something to the customer on a prolonged basis. For instance, a customer can get a discount that lasts two years through a voucher.

Note:

A coupon is used and only valid during purchase, while a voucher can be consumed anytime.

Example of a coupon

A customer is purchasing an add-on for 1GB, which costs 10 euros and has a coupon code for a 50% discount.

Example of a voucher

A customer receives a reward voucher code, which, when consumed, will grant 100 free MB.

Two actions/subpages can be performed/viewed under this section, namely:

Create a voucher
Details voucher page

Create a voucher

Under voucher, to create a voucher, click Create new. Provide a name, code, vendor, code character set, code template, quantity, redemption quantity, range start, bundle, and validity period; the remaining input fields are optional.

Explanation of some terms

Vendor

This means the name of the entity that owns the voucher. It is only used for information purposes. Your organization name can be used under this section.

Code character set

This can either be numerical or alphanumerical. If numerical is selected, the generated codes will only include numbers, while if alphanumerical is selected, the generated codes will include both letters and numbers.

The code template

This provides the template that Monetization will use to generate the voucher codes.

Note:

Use # as a placeholder for auto-generated codes.

Quantity

This represents the number of voucher codes to be generated.

Redemption quantity

This represents how many times the customer can use each code.

Range start

This represents the starting point for the auto-generated codes.

Practical example

The below shows an example of a voucher configuration setting.

code template = voucher_##
character set = numerical
quantity = 5
redemption quantity = 1
range start = 87

This will yield five generated voucher codes, which the customer can only use once. The codes will be generated as follows based on the code template and range start:

voucher_87
voucher_88
voucher_89
voucher_90
voucher_91

Details voucher page

Under voucher, to see the full details of a voucher, click Details. It contains the following:

Name
Code
Description
Vendor
Type
Code character set
Code template
Quantity
Redemption quantity
Range start
bundle
Validity period

Below the information will be the generated voucher codes shown in a tabular format, including their status and remaining quantity.

Information:

You can filter for the voucher codes by New, In use, Used, Expired, or Canceled.

Docs: Dunning

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Business configuration, and click Dunning. Provide a name and description.

The Amount Due Threshold refers to the minimum amount on the bill before the dunning process can pick it up. This means that the bill due amount needs to be above the amount due threshold to be picked up.

Actions like applying penalty fees, sending payment reminders, and recollecting unpaid bills can be configured. To achieve this, under Actions, click Create new. Each action has a type. They include the following:

Fee
Notification
Recollect
Block

Fee

This means the customer will be charged a penalty fee for the unpaid bill. To configure, provide a name and description for the action.

In addition, choose the bundle. The bundle is configured to charge the customer a specific amount for failing to pay the bill at the appropriate time. Therefore, the action will purchase an add-on bundle on the customer’s subscription.

Notification

This will send a notification in the form of an email or SMS to the customer. For instance, a customer receives a payment reminder email if their bill has been overdue for three days.

For this configuration type, you are required to choose a mail or SMS template. The mail template is configured in Monetization under Business configuration Template Mail template.

Recollect

This will automatically try to recollect the payment for an unpaid bill. For this dunning process, a payment gateway integration has to be configured in Monetization. In addition, the customer must have included a credit card.

Block

This will send an API request to your third-party service control system, which would block the customer’s service because of unpaid bills.

Note:

For each dunning configuration action, the Overdue days means the action will only be triggered when a bill has been due for that number of days.

For instance, assume a bill was due on the 15th day of the month and has yet to be paid on the 20th day. On the 20th day, the bill will be overdue for five days. Therefore, the action will be executed if the Overdue days is configured to five days.

To delete each action for the dunning configurations, click Delete.

Docs: Template

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Document templates
Mail templates

To access this section in Monetization, from the Menu, select Business configuration, and click Template.

Document templates

To access this section, click Document templates. A paginated list of all document templates is shown in a tabular format.

A document template is used to configure the layout for the documents generated in Monetization for the invoice, dunning, and financial reports.

Information:

The template can include content like images or text.

Four actions/subpages can be performed/viewed under this section, namely:

Create a document template
Details document template page
Update document template
Delete document template

Create a document template

Under document templates, to create a document template, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

There are three categories for a document template, which are:

Dunning
Invoice
Financial

The category determines where the template can be used. For instance, exporting invoices can only use invoice templates, and exporting financial reports can only use financial templates.

In addition, configure the title and body for the template.

Note:

The title represents how the template would be referenced in other parts/sections of Monetization.

Information:

Monetization provides a rich editor to customize the template body, as shown below.

Note: You can also import your template.

Figure 1: Document template body

Details document template page

Under document templates, to see the full details of a document template, click Details. It contains the following:

Name
Code
Category
Language
Title
Content

Update document template

Under document templates to update a document template, first, click Details; it shows the details of the document template. Then to update, click Update.

Information:

All information filled out under the create a document template section can be updated except for the Code.

Delete document template

Under document templates, to delete a document template, click Delete.

Mail templates

To access this section, click Mail templates. A paginated list of all mail templates is shown in a tabular format.

A mail template is used to configure the layout for the mails generated in Monetization for the invoice, dunning, and financial reports.

Information:

The template can include content like images or text.

Four actions/subpages can be performed/viewed under this section, namely:

Create a mail template
Details mail template page
Update mail template
Delete mail template

Create a mail template

Under mail templates, to create a mail template, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

There are three categories for a mail template, which are:

Dunning
Invoice
Financial

The category determines where the template can be used. For instance, sending mail for an invoice will use the invoice template.

Additional configurable parameters for the mail template include the following:

subject
from address
to
Cc
Bcc
reply to

Information:

The from address represents the sender address, while the to represents the receiver address.

Note: Dynamic placeholder can be used for the subject. It is used to get the customer’s information or other data—for example, first name.

In addition, configure the body for the template.

Information:

Monetization provides a rich editor to customize the template body, as shown below.

Note: You can also import your template.

Figure 2: Mail template body

To include attachments to the mail, under Attachments, click Add. Provide the name, type, format, and template.

Information:

To enable compression on an attachment, check the checkbox Compression.

Details mail template page

Under mail templates, to see the full details of a mail template, click Details. It contains the following:

Name
Code
Description
Category
Subject
Publishing type
From address
To
Cc
Bcc
Reply to
Attachments
Content (if any)

Update mail template

Under mail templates to update a mail template, first, click Details; it shows the details of the mail template. Then to update, click Update.

Information:

All information filled out under the create a mail template section can be updated except for the Code.

Delete mail template

Under mail templates, to delete a mail template, click Delete.

Docs: Hosted Payment Page

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Configuring Hosted Payment Page
Set Up Checkout Page
- Configure Redirect URL
- Configure Legal Information

Configuring Hosted Payment Page

The Hosted Payment Page make online transactions a breeze for your customers. Designed for ease and security, it’s the perfect checkout solution for your business. Upon subscription or selecting Checkout, your users will be redirected to new URL dedicated to reviewing their order and inputting their payment details.

To access this section in Monetization, from the Menu, select Business configuration, and click Hosted Payment Page.

Set Up Hosted Payment Page

The Hosted Payment Page can be created via accessing the hosted page URL where a user can choose from different plans or checkout from pre-selected plan.

Additionally, you have the option to set up a redirect URL, and any necessary legal information for the users.

Configure Redirect URL

When using hosted pages, configure redirect URL where users will be redirected upon successful checkout.

Configure Legal Information

Legal Information specifies the Privacy Policy and Terms of Service for the subscription and checkout. Provide URL for this information.

Monetization Web Docs | Tridens Technology – Business Configuration

Docs: Finance

Accounts

Create account

Note:

Details account page

Update account

Information:

General ledger groups

Create a general ledger group

Note:

Details general ledger group page

Update general ledger group

Information:

Delete general ledger group

Note:

General ledgers

Create a general ledger

Note:

Information:

Example of an account mapping

Details general ledger page

Update general ledger

Information:

Delete general ledger

Note:

Taxes

Create tax

Note:

Information:

Details tax page

Update tax

Information:

Delete tax

Note:

Tax suppliers

Create tax supplier

Note:

Details tax supplier page

Update tax supplier

Information:

Delete tax supplier

Note:

Customer types

Examples of a customer type

Note:

Information:

Create customer type

Note:

Note:

Details customer type page

Update customer type

Information:

Delete customer type

Note:

Bill Items

Example of bill item

Create bill item

Note:

Information:

Note:

Details bill item page

Update bill item

Information:

Delete bill item

Note:

Docs: Charging

Tags

Note:

Create a tag

Note:

Charge vs. Resource tags

Note:

Information:

Details tag page

Update tag

Information:

Delete tag

Note:

Resources