Allocations
  • 12 Sep 2022
  • 2 Minutes to read
  • Dark
    Light

Allocations

  • Dark
    Light

Overview

Allocations allow you to allocate funds to multiple Line Items on the same Invoice from a single Transaction. For example, when a payment is made for four Invoices using the same Transaction, Allocations help to split the funds across those four Invoices.

H_01_01_Overview

Use Cases

  1. Receive a bulk payment and distribute the payment across multiple Invoices. For example, one $10,000 check can be applied from one Transaction across multiple Line Items on the same Invoice.
  2. Auto-create an Allocation record for each Line Item as part of a paid Event checkout.
  3. Manually create full or partial refund Allocations between a Transaction and one or more Line Items.

Limitation

You cannot allocate more than the amount that is submitted.

Parent Object Relationship

Allocations are related to the Invoice, Line Item, and Transaction objects. The Invoice lookup field is automatically populated from the Line Item's Invoice field. This allows you to relate your Allocation record to Line Item & Invoice or Invoice with Transaction that paid for this Invoice.

Instructions

Create an Allocation

  1. Navigate to the Allocation object.

    Lightning: Click the App Launcher > Under "All Items," click Allocation.

    Classic: Click "All Tabs" ("+" icon in the top right) > Click Allocation.
    H_01_01_Create an Allocation

  2. Click *New.

Fields

  1. Enter information in the following fields.
    • Amount: This field determines the amount for this Allocation.
    • Transaction: This field determines the transaction that paid for the Line Item.
    • Line Item: This field determines which Line Item this Allocation is associated with.
    • Invoice (optional): Automatically populates if the Line Item field is set. Populate this only if the Allocation is not associated with a Line Item.
    • Type: Set this field to either "Payment" or "Refund" depending on the type of Allocation. The default setting is "Payment".
  2. Click Save.

H_01_01_Fields

Automate the Allocation Creation for Event Checkout

You can automate the Allocation creation for Event checkouts.

  1. Navigate to Blackthorn | Payment Trigger Settings (Setup > Custom Settings).
    H_01_01_Automate 1

  2. Click Manage.
    H_01_01_Automate 2

  3. Set the Automatically Create Allocation = "True".
    H_01_01_Automate 3

  4. Click Save.

When this setting is enabled and an Invoice is created by the checkout process, the Allocations are automatically created for the Line Items and Invoice.

Use Allocation to show Refunds on Line Item and Invoice

You can use Allocations to handle refunds against the Line Items or the Invoice.

  1. Create an Allocation record.
  2. Set Allocation type = "Refund".
  3. Set the Line Item/Invoice lookup field. Setting a Line Item lookup will auto-populate the Invoice.
  4. Select the refund Transaction for the Allocation.
  5. Click Save.

Allocation Rollups

From Version 4.131 and above, we have introduced four new fields on the Line Item object.

  • Balance Due
  • Balance Paid
  • Retained Amount
  • Amount Refunded

The four fields interact in the following ways:

  • Balance Due = Total Amount - Balance Paid
  • Retained Amount = Total Amount Paid - Amount Refunded
  • When Allocation Type"Payment" is associated with the Line Item object, the value is automatically rolled up to Balance Paid.
  • When Allocation Type"Refund" is associated with the Line Item object, the value is automatically rolled up to Amount Refunded.

What's Next