Recurring Payment
API name: cpm__Recurring_Payment__c
Description
The Recurring Payment object is only used if FinDock is the source for payment data (as opposed to e.g. NPSP). The Recurring Payment object allows you to define a certain amount receivable to be collected on a regular basis over a given time period.
When performing a bulk collection run, the payment schedule generates a new installment for every recurring payment that has a next collection date earlier or equal to the selection date specified on the payment schedule. For more information, see Introduction to payment schedules.
Fields
The following table outlines key fields for this object. For complete details, please use the Salesforce Object Manager.
| Label | Type | Description |
|---|---|---|
| # of collected installments | Number(18, 0) | Counter of related installments with status Collected; updated via Apex job |
| Amount | Currency(16, 2) | The amount for each installment |
| Frequency | Picklist | How often the amount is to be paid |
| Payment Method | Picklist | The default payment method for the installment |
| Payment Processor | Picklist | The payment processor through which the installment should be processed |
| Last Collection Date | Date | Date of most recently collected installment |
| Next Collection Date | Date | Determine if a new installment should be created buy a given payment schedule, based on frequency and Last Collection Date |
| Payment Profile | Lookup | If the payment method requires additional (e.g. credit card token), this comes from the related payment profile |