Overview
This article provides details on the various transaction types that used by the ledger journal.
Transaction Types
The Ledger Journal is made up of different transaction types that each serve a different purpose. These transaction types are described below.
Transaction Type | Description | links with prior journal | Appears on invoice |
|---|---|---|---|
| unallocatedPayment | The unallocatedPayment journal type represents the amount that a customer has paid, or represents the amount remaining to be allocated. The amount of the transaction should always be negative. More information regarding payments is available in the payments article. | Optionally. If the transaction is created as part of a payment allocation, it will link to a prior unallocatedPayment transaction. If the transaction is created as part of a Payment Reversal or Void, it will link to the reverseAllocatedPayment transaction | Yes, if linked to a payment directly. |
| offsetUnallocatedPayment | The offsetUnallocatedPayment is created when the unallocatedPayment journal is being allocated to an invoice, or partially refunded. The offsetUnallocatedPayment transaction amount will be positive and be the exact inverse of the unallocatedPayment being offset. Please see the business rules for payments being allocated to invoices for more information. | Yes. The unallocatedPayment journal. | No |
| allocateUnallocatedPayment | The allocateUnallocatedPayment is created with the offsetUnallocatedPayment transaction when the unallocatedPayment transaction is being allocated to an invoice. This transaction type is linked to the invoice directly and the amounts for this transaction type will always be negative. Please see the business rules for payments being allocated to invoices for more information. | Yes. The unallocatedPayment journal | No |
| reverseUnallocatedPayment | This transaction type is created when a specific payment allocation is being reversed. This transaction will follow on from the allocateUnallocatedPayment transaction and its amounts will be the inverse of the allocateUnallocatedPayment transaction it is being linked to. As part of the operation, it will also create a new unallocatedPayment transaction, which can be later allocated, refunded, voided or written off. Please see this article for more information. | Yes. The allocateUnallocatedPayment journal | No |
| voidUnallocatedPayment | This transaction type is used when a payment is made to disappear as if it never happened. This transaction type cannot be created against payments where any amount of the payment has been refunded. Please see this article for more information. | unallocatedPayment Journal | Yes |
| invoice | This is the transaction that is created when an invoice is approved and saved to the journal. If the sum total of the ledger cardlines for the invoice is negative (i.e. is a credit), the system will create a debit to offset the value of the invoice and an unallocatedPayment transaction against the account for the value of the invoice at the time the invoice is approved. | No | |
| credit | This transaction is used to apply a credit against an invoice directly in the ledger journal. Unlike creating a credit cardline, the credit updates the invoice outstanding amount immediately. | Yes | |
| debit | This transaction is used to apply a debit against the invoice directly in the ledger journal. This transaction type cannot be created in Cumulus and used in under-the-hood mechanics, or when the AutoPay attribute is enabled on the account. | Yes - if not created as part of an internally-created transaction. | |
| refund | A refund is used when giving an amount of the payment back to the customer. The refund will reference a prior unallocatedPayment transaction and the amounts will be positive. Where the refund amount doesn't match the amount of the original unallocatedPayment: The system will split the payment into two by creating an offsetUnallocatedPayment transaction, and two unallocatedPayment transactions to represent the amount being refund, verses the amount remaining. The unallocatedPayment amount being refunded will then have the refund attached to it. | unallocatedPayment Journal | Yes |
| creditWriteOff | A creditWriteOff is used to write off the positive balance of an account. A creditWriteOff will be created against any invoice where there is an amount outstanding greater than $0 for the total outstanding amount. | Yes | |
| debitWriteOff | A debitWriteOff is used to write off any unallocated payments on the account. Like creditWriteOff, a debitWriteOff will be created against any unallocated payment transactions that have not otherwise been allocated. | unallocatedPayment Journal | Yes |