Skip to main content

Installment

API name

cpm__Installment__c

Description

The Installment object is central to FinDock payment management. It represents a single amount, and it always represent this particular amount. You can always track all payment actions for the amount.

All monetary transactions that go through FinDock are linked to an installment record. The Installment record types are:

  • Receivable: you collect the amount from the payer
  • Payable: you remit the amount to another party
  • Gift Aid: the amount is collected from the UK government through the Gift Aid scheme

Fields

The following table outlines key fields for this object. For complete details, please use the Salesforce Object Manager.

LabelTypeDescription
AmountCurrency(16,2)The initial, full amount of the installment
Due dateDateThe date the amount should be collected or paid out
Last Collection DateDateThe date money was last received; the date is take from the Collection Date of the most recent related payment record.
Open AmountCurrency(16,2)The remainder of the amount still due
Payment MethodPicklistThe payment method intended to be used for collecting or paying out the amount; this does not limit payment methods in practice
SourcePicklistThe source package of the installment (e.g.FinDock or NPSP)
StatusPicklistThe current status of the installment (see below for more information)

Status and counters

Every installment record has a status. Each status is considered either ‘open’ or ‘closed’ (similar to NPSP Opportunity stages). In addition to the Status field itself, the Installment object has to other fields used to manage status changes.

  • Last status date: this date is stored on insert of a payment for the installment. The date value comes from the Collection Date field of the payment record. If the installment has Failed and Cancelled status, today's date is stored on the installment on status change instead of on insert of a payment.
  • # of times statused: stores the number of times the installment was put to the current status.
StatusExplanationInstallment Date FieldInstallment Status Counter
CancelledThis installment is cancelled and no payment is expectedLast Cancelled Date (cpm__Last_Cancelled_Date__c)# of times Cancelled (cpm__of_times_cancelled__c)
CollectedThis installment is paid for at least the full amount or even more.Last Collection Date (cpm__Last_Collection_Date__c)Collection Count (cpm__Collection_Count__c)
FailedThis installment could not be processed, check the last status reason for more detailsLast Failed Date (cpm__Last_Failed_Date__c)# of times Failed (cpm__of_times_failed__c)
NewThis installment is ready for processingOpen status, therefore not applicable.Open status, therefore not applicable.
OutstandingThis installment is awaiting payment, but there is no active process collecting the money, meaning the payment will come in through either bank transfer or some other external system.Open status, therefore not applicable.Open status, therefore not applicable.
PaidThe installment has been paid.Last Paid Date (cpm__Last_Paid_Date__c)# of times Paid (cpm__of_times_paid__c)
Partially paidA payment was received, but not for the full amount, so a certain amount is still expected to be paid.Open status, therefore not applicable.Open status, therefore not applicable.
PendingThis installment is currently in processing and a result (positive or negative) is expectedOpen status, therefore not applicable.Open status, therefore not applicable.
Pending ProcessingThis installment is currently in processing and a result (positive or negative) is expected (this status is used for specific payment processors only)Open status, therefore not applicable.Open status, therefore not applicable.
Pending recollectionThis installment was reversed, but is now scheduled for re-collection at the next collection run.Open status, therefore not applicable.Open status, therefore not applicable.
RefundedThis installment was 'Paid back' to the debtor, and no new payment is expectedLast Refunded Date (cpm__Last_Refunded_Date__c)# of times Refunded (cpm__of_times_refunded__c)
RejectedThis installment was never paid, but has been rejected by the payment processor; the reason is stated in the last reason code received field.Last Rejected Date (cpm__Last_Rejection_Date__c)# of times Rejected (cpm__of_times_rejected__c)
ReversedThis installment was paid, but has been reversed, the reason is stated in the last reason code received field.Last Reversal Date (cpm__Last_Reversal_Date__c)# of times Reversed (cpm__of_times_reversed__c)

Installment GUIDs and payment references

Every installment that is processed through FinDock is automatically assigned a GUID (Globally Unique Identifier). These identifiers can be used when referencing the installment in a link for instance.

Each installment record has a payment reference. This reference can come from different sources, so three fields are used:

  • Custom Payment Reference: optional field for customized reference value
  • Final Payment Reference: the reference value used for the installment
  • Generated Payment Reference: an auto-generated reference value for the installment