Onit released new functionality to the ELM onit-mm-new environment to support alternative fee arrangements (AFAs). This guide helps app builders implement the new features in existing instances of ELM.

Due to the interconnectivity of the new features, this guide assumes that all the features are being implemented at the same time. However, if some of these features already exist, please skip them.

 The following features are included in this guide:

1. ELM Configuration
2. Vendor Discounts
3. Fee Arrangements 2.0

The first step in this implementation process is to package the apps for the new features from onit-mm-new into the receiving environment.

Package the following apps:

1. ELM Configuration
2. Vendor Discount Types
3. Fee Arrangements
4. Vendor Discounts
5. Discount Tiers
6. Vendor Fee Arrangements

1. Add ELM Configuration as a Transaction List Provider

2. Add Vendor Discount Types as a Transaction List Provider

3. Add Discount Tiers as a Transaction List Provider

4. Add Fee Arrangements as a Transaction List Provider

5. Add Vendor Fee Arrangements as a Transaction List Provider

6. Create one ELM Configuration Record. Select All Settings that Apply

VENDORS

FIELDS

1. Create a NEW Field (if it doesn’t exist)

• Name: invoices
• Inverse Relation: vendor
• Label: Invoices
• Data Type: HasMany
• Target App: Invoices
• Panel Display: Never display panel

2. Create a NEW Field to indicate the HasMany relationship between Vendors App and Vendor Discounts App

• Name: vendor_discounts
• Inverse Relation: vendor
• Data Type: HasMany
• Cascade Delete: true
• Target App: Vendor Discounts
• Panel Display: Never display panel

3. Create a NEW Field to indicate there are Vendor Discounts 

• Name: vendor_discounts_enabled
• Data Type: Checkbox
• Initial Value:
   

• Hidden Condition: true
• Calculated: true
• Calculation Type: Liquid
• Script:

4.    Create a New Field to indicate if Discounts are enabled on a client-level

• Name: vendor_discounts_enabled
• Label: Vendor Discounts Enabled
• Data Type: Checkbox
• Initial Value:

• Hidden If: true
• Calculated: true
• Calculation Type: Liquid
• Script:
   

5. Create a New Field that indicates if Discounts should apply to the Vendor

• Name: discounts_applicable
• Label: Discounts Applicable?
• Data Type: Checkbox
• Initial Value: false
• Hidden Condition:

6.    Create a New Field that holds the effective date of a perpetual discount

• Name: perpetual_effective_date
• Label: Perpetual Effective Date
• Data Type: Date
• Hidden Condition: true

7.    Create a New Field that holds the total fee spend for a vendor

• Name: total_fee_spend_client_currency
• Label: Total Fee Spend Client Currency
• Data Type: Multicurrency
• Hidden Condition: true

8.    Create a New Field that holds the current tier volume discount for a vendor

• Name: tvd_current_discount
• Label: Current Discount
• Data Type: Text
• Hidden Condition: true

9.    Create a New Field that holds the fee spend until the next tier of a TVD for a vendor

• Name: fee_spend_to_next_tier
• Label: Fee Spend To Next Tier
• Data Type: Text
• Hidden Condition: true

10.    Create a New Field that holds the next tier discount of a TVD for a vendor

• Name: next_tier_discount
• Label: Next Tier Discount
• Data Type: Text
• Hidden Condition: true

11.    Create a New Field that relates vendors to its fee arrangements

• Name: vendor_fee_arrangements
• Label: Vendor Fee Arrangements
• Inverse Relation: Vendors
• Data Type: HasMany
• Target App: Vendor Fee Arrangements
• Panel Display: Never display panel

CONDITIONS

1.    Create a Condition that checks if Vendor Discounts are enabled and if Discounts Applicable is true

• Name: Vendor Discount are Enabled and Applicable
• Condition:
   

2.    Create a Condition that checks if Blended Hourly Rates is enabled and if this is a BP vendor

• Name: Blended Hourly Rate Fees Enabled && BP Vendor
• Description: This condition checks if the fee arrangement is enabled in ELM Configuration settings and if this is a BP vendor.
• Condition:
   

3.    Create a Condition that checks if Fixed Fees is enabled and if this is a BP vendor

• Name: Fixed Fees Enabled && BP Vendor
• Description: This condition checks if the fee arrangement is enabled in ELM Configuration settings and if this is a BP vendor.
• Condition:
   

4.    Create a Condition that checks if Hourly Capped is enabled and if this is a BP vendor

• Name: Hourly Capped Fees Enabled && BP Vendor
• Description: This condition checks if the fee arrangement is enabled in ELM Configuration settings and if this is a BP vendor.
• Condition:
   

5.    Create a Condition that checks if Hourly is enabled and if this is a BP vendor

• Name: Hourly Fees Enabled && BP Vendor
• Description: This condition checks if the fee arrangement is enabled in ELM Configuration settings and if this is a BP vendor.
• Condition:
   

6.    Create a Condition that checks if Manual is enabled and if this is a BP vendor

• Name: Manual Fees Enabled && BP Vendor
• Description: This condition checks if the fee arrangement is enabled in ELM Configuration settings and if this is a BP vendor.
• Condition:

7.    Create a Condition that checks if Matter Level Timekeepers is enabled and if this is a BP vendor

• Name: Matter Level Timekeepers Fees Enabled && BP Vendor
• Description: This condition checks if the fee arrangement is enabled in ELM Configuration settings and if this is a BP vendor.
• Condition:
   

ACTIONS

1.    Create an action to Find or Create the Blended Hourly Rate fee arrangement

• Type: Find or Create Related Transaction
• Name: Create Blended Hourly Rate Fee Arrangement for this vendor (FoCRT)
• Description: This action creates the related blended hourly rate fee arrangement for the Vendor Assignment to Matter launch form.
• Related Property Name: Vendor Fee Arrangements (vendor_fee_arrangements)
• Operation: Upsert
• Relation Field Name:
   

• Params Liquid:

2.    Create an action to Find or Create the Fixed Fee fee arrangement

• Type: Find or Create Related Transaction
• Name: Create Fixed Fee Fee Arrangement for this vendor (FoCRT)
• Description: This action creates the related fixed fee arrangement for the Vendor Assignment to Matter launch form.
• Related Property Name: Vendor Fee Arrangements (vendor_fee_arrangements)
• Operation: Upsert
• Relation Field Name:
   

• Params Liquid:

3.    Create an action to Find or Create the Hourly Capped fee arrangement

• Type: Find or Create Related Transaction
• Name: Create Hourly Capped Fee Arrangement for this vendor (FoCRT)
• Description: This action creates the related hourly capped fee arrangement for the Vendor Assignment to Matter launch form.
• Related Property Name: Vendor Fee Arrangements (vendor_fee_arrangements)
• Operation: Upsert
• Relation Field Name:
   

• Params Liquid:

4.    Create an action to Find or Create the Hourly fee arrangement

• Type: Find or Create Related Transaction
• Name: Create Hourly Fee Arrangement for this vendor (FoCRT)
• Description: This action creates the related hourly fee arrangement for the Vendor Assignment to Matter launch form.
• Related Property Name: Vendor Fee Arrangements (vendor_fee_arrangements)
• Operation: Upsert
• Relation Field Name:
   

• Params Liquid:

5.    Create an action to Find or Create the Manual fee arrangement

• Type: Find or Create Related Transaction
• Name: Create Manual Fee Arrangement for this vendor (FoCRT)
• Description: This action creates the related manual fee arrangement for the Vendor Assignment to Matter launch form.
• Related Property Name: Vendor Fee Arrangements (vendor_fee_arrangements)
• Operation: Upsert
• Relation Field Name:
   

• Params Liquid:

6.    Create an action to Find or Create the Matter Level Timekeepers fee arrangement

• Type: Find or Create Related Transaction
• Name: Create Matter Level Timekeepers Fee Arrangement for this vendor (FoCRT)
• Description: This action creates the related matter level timekeeper fee arrangement for the Vendor Assignment to Matter launch form.
• Related Property Name: Vendor Fee Arrangements (vendor_fee_arrangements)
• Operation: Upsert
• Relation Field Name:
   

• Params Liquid:

7.    Create an action to conditionally find or create a vendor fee arrangement record

• Type: Conditional Compound Action
• Name: Create Blended Hourly Rate Fee Arrangement for this vendor (CCA)
• Description: Performs the one action by the same name if the fee arrangement is enabled in ELM Configuration settings.
• Condition: Blended Hourly Rate Fees Enabled && BP Vendor
• Actions:
  • Create Blended Hourly Rate Fee Arrangement for this vendor (FoCRT)

8.    Create an action to conditionally find or create a vendor fee arrangement record

• Type: Conditional Compound Action
• Name: Create Fixed Fee Fee Arrangement for this vendor (CCA)
• Description: Performs the one action by the same name if the fee arrangement is enabled in ELM Configuration settings.
• Condition: Fixed Fees Enabled && BP Vendor
• Actions:
  • Create Fixed Fee Fee Arrangement for this vendor (FoCRT)

9.    Create an action to conditionally find or create a vendor fee arrangement record

• Type: Conditional Compound Action
• Name: Create Hourly Capped Fee Arrangement for this vendor (CCA)
• Description: Performs the one action by the same name if the fee arrangement is enabled in ELM Configuration settings.
• Condition: Hourly Capped Fees Enabled && BP Vendor
• Actions:
  • Create Hourly Capped Fee Arrangement for this vendor (FoCRT)

10.    Create an action to conditionally find or create a vendor fee arrangement record

• Type: Conditional Compound Action
• Name: Create Hourly Fee Arrangement for this vendor (CCA)
• Description: Performs the one action by the same name if the fee arrangement is enabled in ELM Configuration settings.
• Condition: Hourly Fees Enabled && BP Vendor
• Actions:
  • Create Hourly Fee Arrangement for this vendor (FoCRT)

11.    Create an action to conditionally find or create a vendor fee arrangement record

• Type: Conditional Compound Action
• Name: Create Manual Fee Arrangement for this vendor (CCA)
• Description: Performs the one action by the same name if the fee arrangement is enabled in ELM Configuration settings.
• Condition: Manual Fees Enabled && BP Vendor
• Actions:
  • Create Manual Fee Arrangement for this vendor (FoCRT)

12.    Create an action to conditionally find or create a vendor fee arrangement record

• Type: Conditional Compound Action
• Name: Create Matter Level Timekeepers Fee Arrangement for this vendor (CCA)
• Description: Performs the one action by the same name if the fee arrangement is enabled in ELM Configuration settings.
• Condition: Matter Level Timekeepers Fees Enabled && BP Vendor
• Actions:
  • Create Matter Level Timekeepers Fee Arrangement for this vendor (FoCRT)

13.    Create an action to conditionally find or create a vendor fee arrangement record

• Type: Conditional Compound Action
• Name: Conditionally Initialize All Fee Arrangements (CCA)
• Description: This CCA runs each action to check if the fee arrangement is enabled, then if it is to Find or Create a Related record for that fee arrangement. This is called from a RAT in the ELM Configuration app
• Actions:
  • Create Blended Hourly Rate Fee Arrangement for this vendor (CCA)
  • Create Fixed Fee Fee Arrangement for this vendor (CCA)
  • Create Hourly Capped Fee Arrangement for this vendor (CCA)
  • Create Hourly Fee Arrangement for this vendor (CCA)
  • Create Manual Fee Arrangement for this vendor (CCA)
  • Create Matter Level Timekeepers Fee Arrangement for this vendor (CCA)

Buttons

1.    Create a Button to add Vendor Discounts

• Button Type: Create Related
• Name: Add Vendor Discounts
• Display Name: Add Vendor Discounts
• Related Atom Field: Vendor Discounts (vendor_discounts)
• Condition: Vendor Discounts are Enabled and Applicable

Business Rules

1.    Create a new Business Rule to set up the initial vendor fee arrangements for a new vendor

• Type: Transaction Created
• Name: Set up Vendor Fee Arrangements for new Vendor
• Description: This business rule sets up the fee arrangement child records for a new vendor.
• Enabled: True (Checked)
• Actions:
  • Conditionally Initialize All Fee Arrangements (CCA)

App Panels

1.    Create a Related App Panel for Discounts (see screenshot)

• App Panel Type: Related Atoms Dashboard
• Name: Vendor Discounts
• Hidden If:
   

• Height: 700
• Relation Field: Vendor Discounts (vendor_discounts)
• Data View: Vendor Discounts – Vendor Discount – Vendor App Panel

2.    Create a Related App Panel for Fee Arrangements

• App Panel Type: Related Atoms Dashboard
• Name: Vendor AFAs
• Hidden If:
• Height: 700
• Relation Field: Vendor Fee Arrangements (vendor_fee_arrangements)
• Data View: Vendor Fee Arrangements – Super Condensed Vendor Data View
• Editable?: True (checked)
• Do not render App Panel if no records: True (checked)

Widgets

1. Create a NEW widget

• Type: Portal
• Name: Vendors Header Widget
• Html: SEE Attached Code Sheet
   

Fields

1.    Create a NEW Field for the fee arrangement combo value

• Name: fee_arrangement_combo
• Label: Fee Arrangement Combo
• Data Type: Listcombo
• List: Vendor Fee Arrangements
• Search Column: fee_arrangement_type_value
• Value Column: fee_arrangement
• Filter Column: fee_arrangement_filter
• Filter by: fee_arrangement_filter
• UI Action: Update Fee Arrangement Fields (new)
• Hidden condition: 
   

• Required: True (Checked)
• Show on dashboard: False (Unchecked)
• Display In: Launch
• Description: This field holds the code, name, and filter value for the fee arrangement

2.    Edit an existing field for the fee arrangement name

• Name: fee_arrangement_id
• Label: Fee Arrangement
• Data Type: Text
• Display In: View
• View Page Tab: Financial
• Required: True (Checked)
• Read Only: True (Checked)
• Show on dashboard: True (Checked)
• Description: This field holds the name of the fee arrangement (e.g. "Hourly") 

3.    Edit an existing field for the fee arrangement BP Code

• Name: fee_arrangement_value
• Label: Fee Arrangement Code
• Data Type: Text
• Display In: View
• UI Action: Update Vendor Discount Fields
• Hidden Condition: true
• Required: True (Checked)
• Read Only: True (Checked)
• Show on dashboard: False (Unchecked)
• Description: This field holds the code for the fee arrangement (e.g. 10000000000001)

4.    Create a NEW Field for the blended hourly rate amount

Name: blended_hourly_rate_currency

• Label: Blended Hourly Rate
• Data Type: MultiCurrency
• Currency Code Field: matter_currency
• Hidden Condition: 
   

• Required: True (Checked)
• Show on dashboard: True (Checked)

5.    Create a NEW Field to hold the discount flag from the vendor

• Name: discounts_disabled_on_vendor
• Label: Discounts Disabled On Vendor
• Data Type: Checkbox
• Hidden Condition: true
• Read only: True (Checked)
• Show on dashboard: True (Checked)

6.    Create a NEW Field for the Early Payment Flag

• Name: early_payment_discount_flag
• Data Type: Checkbox
• Initial Value: false
• Hidden condition: true
• Read only: true

7.    Create a NEW Field for the Tiered Volume Flag

• Name: tiered_volume_discount_flag
• Data Type: Checkbox
• Initial Value: false
• Hidden condition: true
• Read only: true

8.    Create a NEW Field for Discount eligible Discounts

• Name: Invoices_for_this_matter_are_eligible_for_the_following_discounts
• Label:
   

• Data Type: Displaytext
• Hidden Condition:
   

• Read Only: true
• Show on dashboard: False (Unchecked)

9.    Create a NEW Field for enabling TVD on Invoices

• Name: Enable_tiered_volume_discount_on_invoices_for_this_matter
• Label: Tiered Volume Discount?
• Data Type: Checkbox
• Initial Value: false
• Hidden Condition:
   

10.    Create a NEW Field for enabling EPD on Invoices

• Name: enable_early_pay_discount_on_invoices_for_this_matter
• Label: Early Pay Discount?
• Data Type: Checkbox
• Initial Value: false
• Hidden Condition:
   

11.    Create a NEW Field for the Tiered Volume Discount Effective Date

• Name: tiered_volume_effective_date
• Hide Label: Tiered Volume Effective Date
• Data Type: Date
• Hidden Condition: true

12.    Create a NEW Field for loading discounts message

• Name: display_loading_info
• Label: Display Loading Info?
• Data Type: Checkbox
• Hidden Condition: true

13.    Create a NEW Field for the loading discounts message

• Name: Loading_discounts
• Hide Label: true
• Data Type: Displayfield
• Initial Value:  

• Hidden Condition:

• Read Only: true

14.    Create a NEW Field for no discounts found

• Name: No_discounts_found
• Hide Label: true
• Data Type: Displayfield
• Initial Value:
   

• Hidden Condition:

• Read only: true

15.    Create a NEW Field for vendor discounts enabled

• Name: vendor_discounts_enabled
• Data Type: Checkbox
• Initial Value:
   

• Hidden Condition: true
• Read only: true
• Calculated: true
• Calculation Type: Liquid
• Script:
   

16.    Update existing field: manual_invoices

• Name: manual_invoices
• Label: Manual Invoices
• Changes:
  • Label: Invoices

Conditions

1.    Update condition: Has Budget, FA, or Fixed Capped Fee Changed

• New Name: Watching VATM Field Changes
• Condition (See Attached Code Sheet):
   

2.    Create a NEW condition

• Name: Vendor Discounts are Disabled, and TVD selected
• Condition (See Attached Code Sheet):
   

3.    Create a NEW condition

• Name: Vendor Discounts are Disabled and EPD selected
• Condition (See Attached Code Sheet):
   

4.    Edit an existing condition

• Name: Check Fee Arrangement
• Condition:
   

5.    Edit an existing condition

• Name: Check Fee Arrangement and BAR is closed
• Condition:
   

Actions

1.    Create a NEW action

• Type: Update Transaction
• Name: Disable TVD checkboxes (UT)
• Field Updates:
  • 1.   
    • Field: enable_tiered_volume_discount_on_invoices_for_this_matter
    • Liquid: false
  • 2.   
    • Field: tiered_volume_discount_flag
    • Liquid: false

2.    Create a NEW action

• Type: Update Transaction
• Name: Disable EPD checkboxes (UT)
• Field Updates:
  • 1.
    • Field: enable_early_payment_discount_on_invoices_for_this_matter
    • Liquid: false
  • 2.   
    • Field: early_payment_discount_flag
    • Liquid: false

3.    Create a NEW action

• Type: Update Transaction
• Name: Update Discount Flags
• Shared Liquid (See Attached Code Sheet):
   

• Field Updates:
  • 1.   
    • Field: tiered_volume_discount_flag
    • Liquid: {{tvd_result}}
  • 2.   
    • Field: early_payment_discount_flag
    • Liquid: {{epd_result}}
  • 3.   
    • Field: vendor_discounts_enabled
    • Liquid: {{settings.at_least_one_discount_enabled}}

4.    Create a NEW action

• Type: Throw Error
• Name: Throw Error: Tiered Volume Discounts Have Been Disabled
• Error Message: Tiered Volume Discounts have been disabled for this environment! Please uncheck the discounts to continue.

5.    Create a NEW action

• Type: Throw Error
• Name: Throw Error: Early Payment Discounts Have Been Disabled
• Error Message: Early Payment Discounts have been disabled for this environment! Please uncheck the discounts to continue.

6.    Update an Create Client Project PSB Object Create Action

• Type: PSB Object Create
• Name: Create Client Project
• PSB Object: client_project
• Params Liquid:
   

• Upsert Key: false

Business Rules

1.    Create a NEW business rule

• Type: Transaction Updated
• Name: Uncheck TVD Flags
• Enabled: True (Checked)
• Condition: “Vendor Discounts are Disabled and TVD selected”
• Actions: “Disable TVD checkboxes (UT)”

2.    Create a NEW business rule

• Type: Transaction Updated
• Name: Uncheck EPD Flags
• Enabled: True (Checked)
• Condition: “Vendor Discounts are Disabled and EPD selected”
• Actions: “Disable EPD checkboxes (UT)”

3.    Create a NEW business rule

• Type: Transaction Updated
• Name: If transaction updated with checked TVD when TVD disabled, throw error
• Enabled: True (Checked)
• Condition: “Vendor Discounts are Disabled and TVD selected”
• Actions: “Throw Error: Tiered Volume Discounts Have Been Disabled”

4.    Create a NEW business rule

• Type: Transaction Updated
• Name: If transaction updated with checked EPD when EPD disabled, throw error
• Enabled: True (Checked)
• Condition: “Vendor Discounts are Disabled and EPD selected”
• Actions: “Throw Error: Early Payment Discounts Have Been Disabled”

5.    Create a NEW business rule

• Type: Transaction Updated
• Name: Update Vendor Discount Info
• Enabled: True (Checked)
• Condition:

• Actions: “Update Discount Flags”

  IMPORTANT

  • The above Transaction Updated Business Rules should be ordered as follows. Not ordering them in this way may cause issues.
    1. Uncheck Discount flag
    2. If transaction updated with checked discount when discounts disabled, throw error
    3. Update Vendor Discount Info
        

UI Actions

1.    Update Existing UI Action

• Name: Set Default Fee Arrangement for vendor
• Type: Update Fields
• Shared Liquid (See Attached Code Sheet):
   

• Field Updates:
  • 1.   
    • Field: fee_arrangement_value
    • Liquid: {{fid}}
  • 2.   
    • Field: fee_arrangement_filter
    • Liquid: {{filter}}
  • 3.   
    • Field: fee_arrangement_combo
    • Liquid: {{combo}}

2.    Create (or Update) a NEW (or Existing) UI Action

• Name: Set Defaults for Vendor
• Type: Update Fields
• Shared Liquid (See Attached Code Sheet):
   

• Field Updates:
  • 1.   
    • Field: tiered_volume_discount_flag
    • Liquid: {{tiered_volume_status}}
  • 2.   
    • Field: enable_tiered_volume_discount_on_invoices_for_this_matter
    • Liquid: {{tiered_volume_status_value}}
  • 3.   
    • Field: tiered_volume_effective_date
    • Liquid: {{tiered_volume_effective_date_value}}
  • 4.   
    • Field: display_loading_info
    • Liquid: false
  • 5.   
    • Field: currency
    • Liquid: {{r_vendor.currency_code}}
  • 6.   
    • Field: vendor_id
    • Liquid: {{r_vendor.id}}
  • 7.   
    • Field: vendor_is_preferred
    • Liquid:
       

• 8.   
  • Field: fee_arrangement_filter
  • Liquid: {{filter}}
• 9.   
  • Field: fee_arrangement_value
  • Liquid: {{id}}
• 10.   
  • Field: vendor_does_accruals
  • Liquid: 
     

• 11.   
  • Field: require_accruals_for_matter
  • Liquid:
     

• 12.
  • Field: outside_counsel_relationship
  • Liquid: 
     

• 13.  
  • Field: early_payment_discount_flag
  • Liquid: {{early_payment_status}}
• 14.  
  • Field: enable_early_payment_discount_on_invoices_for_this_matter
  • Liquid: {{early_payment_status_value}}
• 15.  
  • Field: discounts_disabled_on_vendor
  • Liquid: {{vendor_discount_disabled_flag}}
• 16.  
  • Field: fee_arrangement_combo
  • Liquid: {{combo}}
• 17.  
  • Field: fee_arrangement_id
  • Liquid: {{nm}}
• Field Validations:
  1.  
     • Field: display_loading_info
     • Message Type: Error
     • Validation Condition:
        

• Message: “Please wait for Discounts to load before continuing.”

3.   Update Existing UI Action

• Name: Set Default Fee Arrangement for vendor
• Type: Update Fields
• Shared Liquid:
   

• Field Updates
  • 1.   
    • Field: fee_arrangement_id
    • Liquid: {{nm}}
  • 2.   
    • Field: fee_arrangement_value
    • Liquid: {{id}}

4.   Create a NEW UI Action

• Name: Update Vendor Discount Fields
• Type: Update Fields
• Shared Liquid:
   

• Field Updates
  • 1.  
    • Field: tiered_volume_discount_flag
    • Liquid: {{tiered_volume_status}}
  • 2.  
    • Field: enable_tiered_volume_discount_on_invoices_for_this_matter
    • Liquid: {{tiered_volume_status_value}}
  • 3.  
    • Field: tiered_volume_effective_date
    • Liquid: {{tiered_volume_effective_date_value}}
  • 4.  
    • Field: early_payment_discount_flag
    • Liquid: {{early_payment_status}}
  • 5.  
    • Field: enable_early_payment_discount_on_invoices_for_this_matter
    • Liquid: {{early_payment_status_value}}
  • 6.  
    • Field: vendor_discounts_enabled
    • Liquid: {{settings.at_least_one_discount_enabled}}
  • 7.  
    • Field: display_loading_info
    • Liquid: false
  • 8.  
    • Field: discounts_disabled_on_vendor
    • Liquid: {{vendor_disocunt_disabled_flag}}
  • Field Validations
    • 1.  
      • Field: display_loading_info
      • Message Type: Error
      • Validation Condition:
        
         

• Message: “Please wait for Discounts to load before continuing.”

App Panels
1.    App Panels

• Update existing app panel
  • Name: Billing Authorizations
  • Type: Iframe Panel
  • Hidden If:
• Update existing app panel
  • Name: Manual Invoices
    • CHANGE TO: Invoices

Invoices

Fields
1.    Create a NEW field

• Name: total_fee_spend
• Label: Total Fee Spend
• Type: Text
• Hidden If: true

2.    Create a NEW field

• Name: total_fee_spend_client_currency
• Label: Total Fee Spend
• Type: MultiCurrency
• Read only: True (Checked)
• Hidden condition:

3.    Create a NEW field

• Name: calculated_discount_amount
• Label: Calculated Discount Amount
• Type: Text
• Hidden If: true
• Read only: True (Checked)

4.    Create a NEW field

• Name: success
• Label: Success
• Type: Checkbox
• Hidden If: true
• Read only: True (Checked)

5.    Create a NEW field

Name: tvd_discount_rate

• Label: Discount Rate
• Type: Text
• Read only: True (Checked)
• Hidden condition:

6.    Create a NEW field (note: this ID will be of a Discount Tier)

• Name: tvd_vendor_discount_id
• Label: TVD Vendor Discount ID
• Type: Text
• Hidden If: true
• Read only: True (Checked)

7.    Create a NEW field

• Name: tvd_discount_amount
• Label: Invoice Volume Discount Amount (USD)
• Type: Currency
• Currency: USD
• Read only: True (Checked)
• Hidden condition:
   

8.    Create a NEW field

• Name: discount_code
• Label: Invoice Discount Code
• Type: Text
• Read only: True (checked)
• Hidden condition:
   

9.    Create a NEW field

• Name: tvd_item_description
• Label: Invoice Discount Description
• Type: Text
• Read only: True (Checked)
• Hidden condition:
   

10.    Create a NEW field

• Name: amount_remaining_to_next_tier
• Label: Amount Remaining To Next Tier
• Type: Text
• Initial Value: (Same as Script)
• Hidden Condition: 
   

• Calculated: True (checked)
• Calculation Type: Liquid
• Script (See Attached Code Sheet):
   

11.    Create a NEW field (if it does not exist yet)

• Name: vendor
• Label Vendor
• Type: BelongsTo
• Target App: Vendors
• Panel Display: Never display panel
• Don’t render on form: true (checked)

12.    Create a NEW field

• Name: next_tier_discount
• Label: Next Tier Discount
• Type: Text
• Hidden If: 
   

• Initial Value: (Same as Script)
• Calculated: True (checked)
• Calculation Type: Liquid
• Script (See Attached Code Sheet):
   

13.     Create a NEW field

• Name: early_payment_discount_applicable
• Label: Early Payment Period Start Date
• Type: Checkbox
• Hidden condition: true
• Read only: True (Checked)

14.    Create a NEW field

• Name: early_payment_period_start_date
• Label: Early Payment Discount Applicable
• Type: Date
• Hidden condition: true
• Read only: True (Checked)
• Initial Value: 
   

• Hidden condition: true
• Read only: True (Checked_

15.    Create a NEW field

• Name: early_payment_approval_deadline
• Label: Early Payment Approval Deadline (Days)
• Include Tooltip: True (Checked)
• Tooltip Text: Number of days in which the invoice must be approved before sending to Accounting
• Type: Integer
• Hidden condition:
   

• Read only: True (Checked)
• Disable total on dashboard: True (Checked)

16.    Create a NEW field

• Name: early_payment_discount_rate
• Label: Early Payment Discount Rate
• Type: Decimal
• Hidden condition: 
   

• Read only: True (Checked)
• Disable total on dashboard: True (Checked)

17.    Create a NEW field

• Name: early_payment_discount_amount
• Label: Early Payment Discount Amount
• Type: MultiCurrency
• Hidden condition: 
   

18.    Create a NEW field

• Name: early_payment_discount
• Label: Early Payment Discount
• Type: Checkbox
• Hidden condition: 
   

• Read only: True (Checked)

Actions
1.    Update an Existing action

• Name: psb_sync_invoice_values
• Type: Update from PSB Object
• Psb Object Id Field: psb_invoice_id
• Psb Object Type: Invoice
• Params Liquid (Please add the following to the bottom of the list):
  1.    p_tvd_discount_rate:{{psb_object.custom_settings.discount_rate}}
  2.    p_tvd_vendor_discount_id:{{psb_object.custom_settings.discount_id}}
  3.    p_tvd_item_description:{{psb_object.custom_settings.tvd_01.item_description}}
  4.    p_tvd_discount_amount:{{psb_object.custom_settings.tvd_01.line_item_total}}
  5.    p_calculated_discount_amount:{{psb_object.custom_settings.tvd_discount_amount}}
  6.    p_success:{{psb_object.custom_settings.success}}
  7.    p_total_fee_spend:{{psb_object.custom_settings.total_fee_spend}}
  8.    p_discount_code:{{psb_object.custom_settings.tvd_01.discount_code}}
  9.    p_total_fee_spend_client_currency:{{psb_object.custom_settings.client_base_total_fee_spend}}

2.    Create a NEW action (if it doesn’t exist)

• Name: Relate Invoice to Vendor
• Type: Relate to Transaction
• Related Transaction Id: {{bar.matter_vendor.vendor.id}}
• Related Property Name: Vendor (vendor)

3.    Create a NEW action

• Name: Update Vendor Record (URT)
• Type: Update Related Transaction(s)
• Relation Property: Vendor (vendor)
• Params Liquid:
  1.    p_total_fee_spend_client_currency:{{total_fee_spend_client_currency.amount}}{{total_fee_spend_client_currency.currency}}
  2.    p_tvd_current_discount:{{tvd_discount_rate}}
  3.    p_fee_spend_to_next_tier:{{amount_remaining_to_next_tier}}
  4.    p_next_tier_discount:{{next_tier_discount}}

4.    Update an existing action

• Name: Create Payment
• Params Liquid (Please add the following to the bottom of the list):
  1.    p_early_payment_discount:{{early_payment_discount}}
  2.    p_early_payment_discount_amount:{{early_payment_discount_amount.amount}}{{early_payment_discount_amount.currency}}

5.    Update an existing action

• Name: Create PSB Payment
• Params Liquid (Please add the following to the bottom of the list):
  1.    early_payment_discount:{{early_payment_discount_amount.amount}}

6.    Create a NEW action

• Name: Notify Vendor Billing Contacts when EPD Applied to Invoice (Send Notification)
• Type: Send Notification
• Description: This action sends an email to the vendor's billing contacts notifying them that an early payment discount was taken on an invoice
• Reply-To Address: {{email_address.account}}@{{email_address.subdomain}}.app.onit.com
• Recipient Email Fields:
  1.    Billing_contact_email
  2.    Billing_contact_email2
  3.    Billing_contact_email3
  • Layout: Standard
  • Subject: Early Payment Discount applied to Invoice # {{name}}
  • Body:
     

• History Name: Email Sent
• History Message: Notification was sent to billing contacts because an EPD was applied to an invoice

7.    Create a NEW action

• Name: Notify Vendor Billing Contacts when new TVD tier is reached
• Type: Send Notification
• Description: This action sends an email to the vendor's billing contacts to notify them that this client's total fee spend has entered the next tier of the effective tiered volume discount (TVD) program.
• Reply-To Address: {{email_address.account}}@{{email_address.subdomain}}.app.onit.com
• Recipient Email Fields:
  1.    Billing_contact_email
  2.    Billing_contact_email2
  3.    Billing_contact_email3
• Layout: Standard
• Subject: New Tier Reached in Tiered Volume Discount
• Body:
   

• History Name: Email Sent
• History Message: Notifying the billing contact that the client has reached a new tier in TVD.

8.    Create a NEW action (if it does not exist):

• Name: Set Approved date
• Type: Update Transaction
• Params Liquid: p_approved_date:{{now}}

9.    Create a NEW action

• Name: Set EPD Amount and Flag
• Type: Update Transaction
• Shared Liquid:
   

• Field Updates:
  • 1.  
    • Field: early_payment_discount_amount
    • Liquid: {{epd_amount}}
  • 2.  
    • Field: early_payment_discount
    • Liquid: {{epd}}

10.    Create a NEW action

• Name: Set EPD Info (UT)
• Type: Update Transaction
• Description: This action gathers information regarding early payment discounts on this invoice. If an EPD is applicable, the current date is set as the start date for the period, and the other information is gathered.
• Shared Liquid: 
   

• Field Updates:
  • 1.   
    • Field: early_payment_discount_rate
    • Liquid: {{epd_rate}}
  • 2.   
    • Field: early_payment_discount_applicable
    • Liquid: {{epd_applicable}}
  • 3.   
    • Field: early_payment_approval_deadline
    • Liquid: {{epd_approval_deadline}}
  • 4.   
    • Field: early_payment_period_start_date
    • Liquid: {{ now | date: '%d/%m/%Y' }}

11.    Create a NEW action

• Name: Notify Vendor Billing Contacts when the new TVD tier is reached (CCA)
• Type: Conditional Compound Action
• Description: This action conditionally sends a TVD notification to the vendor's billing contacts, notifying them that the total fee spend has entered the next tier in the TVD program.
• Condition: New TVD Tier Reached (new)
• Actions: Notify Vendor Billing Contact when new TVD tier is reached

Conditions
1.    Create a NEW condition

• Name: Phase is start of process
• Condition:
  • Note: For this business rule, the condition should be refactored to trigger it in the first resting phase after an invoice is resubmitted. Please make sure the condition is updated accordingly.
  • Example: {% if phase == “Pending Approver 1” or phase == “Pending Counsel Approval” %}true{% else %}false{% endif %}

2.    Edit an existing condition

• Name: If Payment Created At changes (new invoice payment) and Phase is Pending Payment and not Final Payment
• Description: This condition checks if a new invoice payment has come in, whether it's the last payment, and whether the invoice is still waiting for additional payments. It also accounts for early payment discounts that might be applied to the invoice.
• Condition:
   

3.    Create a NEW condition

• Name: New TVD Tier Reached

4.    Create a NEW condition

• Name: Phase is First Approver && TVD exists on invoice
• Condition:
   

5.    Create a NEW condition

• Name: Phase is Paid and EPD taken
• Description: This condition checks if an early payment discount (EPD) was taken when an invoice is marked as paid.
• This determines whether to notify the vendor billing contacts about an EPD.
• Condition:
   

6.    Create a NEW condition

• Name: TVD exists on invoice
• Condition:
   

Business Rules
1.    Create a NEW business rule

• Type: Transaction Created
• Name: Update Vendor record on creation
• Actions:
  • Update Vendor Record (URT)
• Order: Place at the end of Transaction Created business rules, but before any final calculations.

2.    Create a NEW business rule

• Type: Transaction Phase Change
• Name: Update Vendor record when new invoice lands / resubmitted
• Condition: Phase is start of process
  • Note: The condition for this business rule should be refactored so that it is triggered in the first resting phase after an invoice is resubmitted. Please make sure the condition is updated accordingly.
  • Example: {% if phase == “Pending Approver 1” or phase == “Pending Counsel Approval” %}true{% else %}false{% endif %}
  • Actions:
    • Update Vendor Record (URT)

3.    Create a NEW business rule (if it doesn’t exist)

• Name: Relate Invoice to Vendor
• Type: Transaction Created
• Actions:
  • Relate Invoice to Vendor

4.    Create a NEW business rule

• Name: Set EPD Info on Create
• Actions: Set EPD Info (UT)

5.    Create a NEW business rule

• Name: When phase is approved, Set EPD amount and flag if applicable
• Condition: Phase is Approved
• Actions: Set EPD Amount and Flag

6.    Create a NEW business rule

• Name: When Phase is Paid, If EPD taken notify Billing Contact
• Description: This business rule emails the vendor's billing contacts if an invoice is marked as paid and an early payment discount was taken on it.
• Condition: Phase is Paid and EPD taken
• Actions: Notify Vendor Billing Contacts when EPD Applied to Invoice (Send Notification)

Data Views
 

1.    Update existing Data View

• Name: Matter Invoices
• Change: Drag the fields “Discount Amount (USD)” and “Invoice Discount Amount” to the Displayed Fields column such that they are between “Invoice Total (USD)” and “Invoice Date”

Widgets

1.    Create NEW widget

• Name: Collapsible Header Widget
• Type: Portal
• Size: Large
• HTML: SEE Attached Code Sheet
   

Fields
1.    Create a NEW field

• Name: tiered_volume_discount_enabled
• Label: Tiered Volume Discount Enabled
• Type: Checkbox
• Hidden If: true

2.    Create a NEW field

• Name: fee_arrangement_name
• Label: Fee Arrangement
• Type: Text
• Required: True (Checked)
• Read only: True (Checked)

3.    Edit an existing field

• Name: fee_arrangement_id
• Label: Fee Arrangement
• Type: Text
• Hidden condition: true
• Required: True (Checked)
• Show on dashboard: False (Unchecked)

4.    Create a NEW field

• Name: blended_hourly_rate
• Label: Blended Hourly Rate
• Type: MultiCurrency
• Hidden condition:
   

• Required: True (Checked)
• Read only: True (Checked)

5.    Create a NEW field

• Name: tiered_volume_discount_enabled
• Label: Tiered Volume Discount Enabled
• Type: Checkbox
• Hidden condition: true
• Read only: True (Checked)
   

Actions

1.    Update Existing action

• Name: Create Approved BAR
• Type: PSB BAR Request
• Params Liquid: Add tiered_volume_discount_enabled
   

2.    Update Existing action

• Name: Create Draft BAR
• Type: PSB BAR Request
• Params Liquid: Add tiered_volume_discount_enabled
   

3.    Update Existing action

• Name: receive_invoices
• Type: PSB Object Receiver
• Relate Property: invoices
• Psb Key Field: BAR Id (psb_bar_id)
• Psb Object Type: invoice
• Params Liquid (Please add the following to the bottom of the list):
  i.    p_tvd_discount_rate:{{psb_object.custom_settings.discount_rate}}
  ii.    p_tvd_vendor_discount_id:{{psb_object.custom_settings.discount_id}}
  iii.    p_tvd_item_description:{{psb_object.custom_settings.tvd_01.item_description}}
  iv.    p_tvd_discount_amount:{{psb_object.custom_settings.tvd_01.line_item_total}}
  v.    p_calculated_discount_amount:{{psb_object.custom_settings.tvd_discount_amount}}
  vi.    p_success:{{psb_object.custom_settings.success}}
  vii.    p_total_fee_spend:{{psb_object.custom_settings.total_fee_spend}}
  viii.    p_discount_code:{{psb_object.custom_settings.tvd_01.discount_code}}
  ix.    p_total_fee_spend_client_currency:{{psb_object.custom_settings.client_base_total_fee_spend}}

4.    Update Existing Action:

• Name: Copy MV fields
• Type: Update Transaction
• Params Liquid: Add tiered_volume_discount_enabled and blended_hourly_