R9 - Configuring Wallet Definitions

What does this section cover?

What are Wallet Definitions?

Wallet definitions is a set of business rules used to control the behavior of Wallet throughout their whole life cycle.

Creating, Editing & Deleting Validations & Restrictions

ActionValidationsRestrictions
General
  • Multiple Wallet definitions can exist in the system, but each one should have a unique name and alternative code
  • Only one active Wallet definition can exist at any given time
  • If no active Wallet definition exists, then no Wallet can be created
Create
  • Mandatory Fields must be defined
  • Name and alternative code must be unique
  • Not applicable
Edit
  • Mandatory Fields must be defined
  • Name and alternative code must be unique
  • Not applicable
Delete
  • Not applicable
  • Cannot be deleted if it is the active definition

Wallet Definition attributes 

Name

Description

Number*An auto generated number that uniquely identifies the wallet definitions
Name*The name of the wallet definition
 Alternative code*An alternative code for the definition. On creating a new definition it should default to the first letter of each word included in the name (in capitals), if nothing else is specified
DescriptionA description for the definition
StateThe state of the definition which can be active or inactive. Only one active definition can exist at any point
Log InformationIncludes the standard log information
Causes Creating Wallets

A definition of the causes that will result into automatically creating new wallets, and includes the following:

  • On creating New Accounts Receivable
  • On using an Accounts Receivable on a Prepaid Subscription
  • On using accounts receivable in reward participants

Wallets can also be created manually.

Causes Cancelling Wallets

A definition of the causes that will result into automatically cancelling wallets, and includes the following:

  • On Terminating an Accounts Receivable
  • On Terminating the relation of Wallets with any Subscriptions or Rewards Participants (Either last prepaid subscription or last Rewards Participant)

Wallets can also be cancelled manually.

Causes Debiting Wallets

A definition of the causes that will result into automatically debiting wallets, and includes the following:

  • During Prepaid Billing Run
    • Wallet Debit Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as debits are applicable.
  • On spend reward transactions
    • Wallet Debit Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as debits are applicable.
  • AVAILABLE FROM CRM.COM R9.0.0 - On Award Expiration Transactions:
    • Wallet Debit Transaction Type: The type of wallet transaction that will be used to create the wallet transaction. Only types classified as debits should be applicable. 

Wallets can also be debited manually.

Causes Crediting Wallets

A definition of the causes that will result into automatically crediting wallets, and includes the following:

  • On Payments posting (applicable for all payment type or specific types)
    • Wallet Credit Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as credit are applicable.
  • On Credit Note posting (applicable for all credit note type or specific types)
    • Wallet Credit Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as credits are applicable.
  • AVAILABLE FROM CRM.COM R9.0.0 - On Prepaid Billing Run
    If enabled then wallets will be credited if a subscription service was credited during a prepaid billing run. 
      • Wallet Credit Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as credits are applicable.
  • On award reward transactions
    • Wallet Credit Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as credits are applicable.

Wallets can also be credited manually.

Causes Reimbursing Wallets

A definition of the causes that will result into automatically reimbursing wallets, and includes the following:

  • On Cancelling a Wallet
    • Wallet Reimburse Transaction Type: The type of wallet transaction type that will be used to create the wallet transaction. Only types classified as reimburse are applicable.
  • On Changing a Prepaid Subscription Accounts Receivable
    • Wallet Reimburse Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as reimburse are applicable.

Wallets can also be reimbursed manually.

Causes Voiding Wallet Transactions

A definition of the causes that will result into automatically voiding wallet transactions, and includes the following:

  • On Cancelling a Payment (applicable for all payment cancellation types or specific types)
    • Wallet Void Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as void are applicable.
  • On Cancelling a Reward Award Transaction
    • Wallet Void Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as void are applicable.
  • On Cancelling a Spend Award Transaction
    • Wallet Void Transaction Type: The type of wallet transaction type that will be used to created the wallet transaction. Only types classified as void are applicable.
  • AVAILABLE FROM CRM.COM R9On Cancelling as Award Expiration Transaction:
    • Wallet Void Transaction Type: The type of wallet transaction that will be used to create the wallet transaction. Only types classified as voids should be applicable.

Wallet transactions can also be voided manually.

Crediting Rules

A set of rules that will be applied during crediting a wallet, which includes the following:

  • Debit the related Accounts Receivable (applicable for all wallet transaction type classified as credit or for specific types): If selected then an invoice will be posted against the related accounts receivable. The attributes below are used in order to automatically create the invoice
    • Invoice Type
    • Product
Reimbursing Rules

A set of rules that will be applied during reimbursing a wallet, which includes the following:

  • Credit the related Accounts Receivable (applicable for all wallet transaction type classified as reimburse or for specific types): If selected then a credit note will be posted against the related accounts receivable. The attributes below are used in order to automatically create the credit note
    • Credit Note Type
    • Product
  • Maximum Reimburse amount (applicable for all wallet transaction type classified as reimburse or for specific types): The maximum amount that should be reimbursed. If the reimburse is done automatically and the reimburse amount is more than the maximum amount, then it is automatically set to the maximum amount
Voiding Rules

A set of rules that will be applied during voiding a wallet transaction, which includes the following:

  • Cancel Any Related invoices on voiding wallet credit transactions (applicable for all wallet transaction type classified as credit or for specific types): If a wallet credit transaction is voided, and it was already related with an invoice, then the invoice will also get canceled. The attributes below are used in order to automatically cancel the related invoice:
    • Invoice Cancellation Type
  • Debit the related Accounts Receivable on voiding wallet reimburse transactions (applicable for all wallet transaction type classified as reimburse or for specific types): If a wallet reimburse transaction is voided, and it was already related with an credit note, then an invoice will be created mirroring the related credit note. The attributes below are used in order to automatically create the related invoice:
    • Invoice Type

Defining your own Wallet Definition tailored to your company's needs

  1. Navigate to CONFIGURATION > FINANCE APPLICATION > WALLETS > SET UP BUSINESS DEFINITIONS
  2. Either search for an existing one or from the Top Menu click on NEW
    WALLET DEFINITION
  3. MAIN INFORMATION

    1. Provide information for the following fields

      1. Name: Provide a unique name for the definition

      2. Alternative Code: Provide a unique alternative code for the definition

      3. Description: Provide a description for the definition

      4. State: State is Read Only. Check here how you can set a definition as active

  4. WALLET CAUSES
     WALLET DEFINITIONS - WALLET CAUSES

    1. CREATE WALLETS

      1. Check the boxes of the events that you would like to cause automatic creation of the wallet
        1. On Creating New Accounts Receivable
        2. On Using An Accounts Receivable on a Prepaid Subscription
        3. On Using Accounts Receivable in Rewards Participants
    2. CANCEL WALLETS

      1. Check the boxes of the events that you would like to cause automatic cancellation of the wallet
        1. On Terminating An Accounts Receivable
        2. On Terminating the Relation of a Wallet with a Subscription or a Rewards Participants
    3. DEBIT WALLETS

      1. Check the boxes of the events that you would like to cause automatic debiting of the wallet
        1. During Prepaid Billing Run: If checked then select from the drop down list the Debit Wallet Transaction Type to be created 
        2. On Spend Reward Transactions: If checked then select from the drop down list the Debit Wallet Transaction Type to be created 
    4. CREDIT WALLETS

      1. Check the boxes of the events that you would like to cause automatic crediting of the wallet
        1. On Award Reward Transaction: If checked then select from the drop down list the Credit Wallet Transaction Type to be created 
        2. On Payments Posting: If checked then click on ADD and define the following
          1. Wallet Transaction Type: Search for the wallet transaction type to be created based on the conditions defined below
          2. Conditions: Click on  ADD CONDITIONS  to open modal and select the payment Financial Transaction type that when posted will cause the creation of the Credit Wallet Transaction type defined
        3. On Credit Note Posting: If checked then click on ADD and define the following
          1. Wallet Transaction TypeSearch for the wallet transaction type to be created based on the conditions defined below
          2. Conditions: Click on  ADD CONDITIONS  to open modal and select the Credit Note Financial Transaction type that when posted will cause the creation of the Credit Wallet Transaction type defined
        4. AVAILABLE FROM CRM.COM R9.0.0 - On Prepaid Billing Run:  If checked then click on ADD and define the following 
          1. Wallet Transaction TypeSearch for the wallet transaction type to be created based on the conditions defined below
          2. Conditions: Click on  ADD CONDITIONS  to open modal and select the Credit Note Financial Transaction type that when created by the will cause the creation of the Credit Wallet Transaction type defined
    5. REIMBURSE WALLETS

      1. Check the boxes of the events that you would like to cause automatic reimbursing of the wallet
        1. On Cancelling a Wallet: If checked then select from the drop down list the Reimburse Wallet Transaction Type to be created 
        2. On Changing a Prepaid Subscription Accounts Receivable: If checked then select from the drop down list the Reimburse Wallet Transaction Type to be created 
    6. VOID WALLET TRANSACTIONS

      1. Check the boxes of the events that you would like to automatic void related wallet transactions
        1. On Cancelling a Reward Award Transaction: If checked then select from the drop down list the Void Wallet Transaction Type to be created 
        2. On Cancelling a Reward Spend Transaction: If checked then select from the drop down list the Void Wallet Transaction Type to be created 
        3. On Cancelling a Payment: If checked then click on ADD and define the following
          1. Wallet Transaction Type: Search for the Void wallet transaction type to be created based on the conditions defined below
          2. Conditions: Click on  ADD CONDITIONS  to open modal and select the Payment Financial Transaction type that when cancelled will cause the creation of the Void Wallet Transaction type defined
  5. WALLET RULES

    WALLET DEFINITIONS - WALLET RULES

    1. CREDITING RULES

      1. Check the boxes for the event that should happen when the conditions defined in the table below are met
        1. Debit the Related Accounts Receivable: If checked then click on ADD and define the following
          1. Financial Transaction Type: Select from the drop down the Debit Financial Transaction type to be used to debit the account when conditions defined at the table are met
          2. Product:Search for the product to be included in the lines of the invoice to be created
          3. Conditions: Click on  ADD CONDITIONS  to open modal and select the Credit Wallet Transaction Type that when created will cause the creation of the Debit Financial Transaction type defined
    2. REIMBURSING RULES

      1. Check the boxes for the event that should happen when the conditions defined in the table below are met
        1. Credit the Related Accounts Receivable: If checked then click on ADD and define the following
          1. Financial Transaction Type: Select from the drop down the Credit Financial Transaction type to be used to credit the account when conditions defined at the table are met
          2. Product:Search for the product to be included in the lines of the credit note to be created
          3. MAX Refund Amount: Provide an integer/decimal value for the maximum amount allowed to be refunded
          4. Conditions: Click on  ADD CONDITIONS  to open modal and select the Reimburse Wallet Transaction Type that when created will cause the creation of the Credit Financial Transaction type defined
    3. VOIDING RULES

      1. Check the boxes for the event that should happen when the conditions defined in the table below are met
        1. Cancel Any Related Invoice: If checked then click on ADD and define the following
          1. Financial Transaction Type: Select from the drop down the Invoice Cancellation Financial Transaction type to be created when voiding credit wallet transactions types as defined in the conditions
          2. Conditions: Click on  ADD CONDITIONS  to open modal and select the Credit Wallet Transaction Type that when voided will cause the creation of the Invoice Cancellation Financial Transaction type defined
        2. Debit Any Related Account: If checked then click on ADD and define the following
          1. Financial Transaction Type: Select from the drop down the Debit Financial Transaction type to be created when voiding reimburse wallet transactions types as defined in the conditions
          2. Conditions: Click on  ADD CONDITIONS  to open modal and select the Credit Wallet Transaction Type that when voided will cause the creation of the Debit Financial Transaction type defined
  6. From the Top Menu click on SAVE
  7. LOG INFORMATION

    Log information section keeps all the logging information related to the specific record

    • Basic set of information available in all entities
      • Created By User: The user that created the entity
      • Created By Unit: The unit of the user that created the entity
      • Updated By User: The user that last updated the entity
      • Updated by Unit: The unit of the user that last updated the entity
      • Date Created: The date the account was entity
      • Date Updated: The date the account was last entity
        LOG DETAILS

Deleting Wallet Definitions

  1. Search for the entity that you would like to delete
    Visit  Using Summary Pages   to find out how you can search using CRM.COM Summary Screens
  2. Click on the link of the record you would like to delete, to be transferred to the Data Entry page
  3. From the actions menu click on "DELETE"
     The entity will be deleted given that the validations are satisfied

Changing the Life Cycle State of Wallet Definition

  1. Navigate to the module you would like to activate a different definition for
  2. From the menu click of the Summary page click on ACTIONS >  ACTIVATE DEFINITION
    Activating
  3. From the Drop Down select the definition you would like to set as active
  4. Click on "SAVE"
    System will switch between active and inactive definitions

 

Related Areas

Popular Labels