Details
-
Type:
New Feature
-
Status: Done/Fixed
-
Priority:
Major
-
Resolution: Fixed/Completed
-
Affects Version/s: 3.2
-
Fix Version/s: 3.2.3
-
Component/s: CiviPledge
-
Labels:None
Description
This modification affects back-office (admin / staff) recording of pledge payments (both Record and "Submit Credit Card payment" modes). Currently, payment amount on the "Record Payment" form is read-only (holds the scheduled payment amount).
1. Schema changes
1.1 Add actual_amount paid to pledge payment table
- Add 'actual_amount' column to civicrm_pledge_payment table to record the amount received. (This is a cache of the amount stored in the linked contribution record - and is being added to prevent performance issues while calculating 'Total Paid' for Pledge selectors and reporting.)
- Post process is modified for the Contribution form, and for online pledge payments to always record the 'actual amount' in the new pledge_payment column.
- Pledge selector query is modified to use actual_amount when calculated Total Paid column.
- Pledge payment selector can be simplified to use actual_amount rather than joining on contribution record
- If user edits contribution record which is linked to a pledge_payment and modifies the contribution amount, update pledge_payment.actual_amount so records are kept in synch
1.2 Add original_installment_amount to pledge table
This will allow us to accurately display the "original" pledge total and payment schedule on Pledge View and Pledge Edit screens regardless of whether subsequent payment adjustments / adjustments to pledged total have been made.
- Display original pledge total on these screens as a status message if the original pledge total has been modified (screenshot attached).
2. Adjust pledge payment when recording a payment
- Add link next to Amount Field -> "adjust payment amount"
- Clicking this link opens the amount field for input
- User can enter a different amount (more or less than scheduled amount)
- Contribution and pledge payment.actual_amount will be set to value entered.
- If user enters a different amount, show a radio button with two options:
- [o] Adjust Pledge Payment Schedule?" (default)
- [ ] Adjust Total Pledge Amount?"
- If "Adjust Pledge Payment Schedule" is selected - payment schedule is adjusted as follows:
- If this is NOT the last scheduled payment: add or subtract the difference between expected and actual amount to the NEXT scheduled payment.
- If this is the last scheduled payment, and payment is LESS than expected: insert one more pledge payment record for the remaining amount due, using the existing payment interval.
- If this is the last scheduled payment, and payment is MORE than expected: set contribution and pledge payment to amount entered. Also adjust the Total Pledge Amount (civicrm_pledge.amount) to reflect the new total paid. NOTE: The calculated "Amount Paid" value for the pledge will automatically show the actual (larger) amount on pledge listings since it's the same a actual_amount rows.
- If "Adjust Total Pledge Amount" is selected
- Adjust the Total Pledge Amount (add or subtract) accordingly (civicrm_pledge.amount). The payment schedule (amounts / dates for future pending pledge payments) is not modified.
3. Adjust pledge payment amount for scheduled (pending) payments
- Change link on Pledge Payment selector from "Edit Schedule" to "Edit Scheduled Payment"
- Add "Scheduled Amount" as an editable field to the '"Edit Pledge Payment" form (default is current scheduled_amount)
- If user enters a different amount, show a radio button with two options:
- [o] Adjust Pledge Payment Schedule?" (default)
- [ ] Adjust Total Pledge Amount?"
- Same post-process rules as above...
4. Use buildForm hook to limit user options
- If a site wants to force either the Yes or No behavior for "Adjust Total Pledge Amount" - they can implement a buildForm hook which replaces the radio button w/ a hidden field containing the desired option.
5. Fix 'Pledge Acknowledgment' activity record to log original pledge amount
- Currently we generate an activity record when a new pledge is recorded (activity type = Pledge Acknowledgment). However, we do not include basic Pledge info in the activity record (the Description column is empty). Modify this behavior to include pledge amount and schedule in activity.description:
=====================
Total Amount $ 600.00
To be paid in 12 installments of $ 50.00 every 1 month(s) {info}=====================
Attachments
Activity
Slight modification to specification per input from Pogstone. For "Adjust Payment Schedule" option, when adjusting last payment up, we should "Also adjust the Total Pledge Amount (civicrm_pledge.amount) to reflect the new total paid."
Also need to handle the same in upgrade for the pledge payments that have been made. Actual amount of the pledge payment should be set to the associated contribution total amount.
I have noticed the following issue: When overpaying a scheduled payment in the middle ( such as #7 of 12 ) and I overpay so much that, that payments #8, 9, 10, 11, and 12 are all set to 0. However, the total pledge amount is not increased to take into the account the extra money.
To see an example of this issue in the sandbox, look at: http://sandbox.civicrm.org/civicrm/contact/view?reset=1&cid=105
Notice the pledge amount does not match the total paid. Also the "balance" is shown as $220. ( The cause is that I paid $600 for payment #10. )
I think the logic should be to increase the total pledge amount to match the total amount paid.
There is a type in my previous comment. I meant to say:
. Also the "balance" is shown as $ -220.
When I go to someone's contact dashboard ( the one the contact can see for themselves ) and click the "Make Payment" link, I get an error message. The URL for the page with the error: http://sandbox.civicrm.org/civicrm/contribute/transact?reset=1&id=3&pledgeId=4
----------------------------------------
CiviContribute
Sorry. A non-recoverable error has occurred.
Oops. It looks like you have an incorrect or incomplete link (URL). Please make sure you've copied the entire link, and try again. Contact the site administrator if this error persists.
Return to home page.
-------------------------------------------
I was testing this with the "Wilma Flinstone" contact.
Sarah : We fixed a couple of bugs and updated the sandbox accordingly. Would be great if you could check the sandbox for more feedback.
Also fixed a typo and adjusted report column titles on Pledge Summary and Pledged but not Paid reports to be consistent with Pledge Dashbard / selectors.
There is a issue with the "scheduled amount" column for pledge payments not being accurate in all situations.
Look at the pledge for "Sally Saucer" http://sandbox.civicrm.org/civicrm/contact/view?reset=1&force=1&cid=105&selectedChild=pledge
When Sally underpays by $20 in September, the next scheduled payment amount is adjusted up to $120. ( this is correct. )
When Sally overpays by $20 in December, the next scheduled payment amount is adjusted down to $80. ( this is correct )
However when Sally overpays by $100 in October, the next scheduled payment amount is NOT adjusted. It is left at $100. ( This wrong, it should be changed to $0. )
Sarah :
While paying for a installment, if we have happen to over-pay as much as to cover the next installment we simply mark the next payment as completed instead of making that 0$ since scheduled amount = $0 does NOT really convey much IMO. "Completed" pledge payments (due to overpayment) are linked to a single contribution ("view' link) - so it is clear that their scheduled amount was "covered" by the previous overpayment.
This approach also helps us keep Scheduled / Paid in balance. At the end we want sum of all the scheduled amount = sum of the paid amounts as well right (assuming you dont over pay and just auto-adjust)
So when Sally overpays by $100 in October, the next scheduled payment amount in November is marked Completed with paid amount = 0 since the one in October has covered for it by having actual amount = $ 220.00 which is also (of course) marked Completed.
This is still a bug, look at the $100 pledge I made for Sally Saucer. Currently the "scheduled payments" column only adds up to $95, while the total paid column adds up to $100.
Also, "scheduled" amount does convey information: It displays to the bookkeeper what is "expected" for that payment. It is extremely confusing for a bookkeeper to see that sometimes that number is adjusted, sometimes it is not adjusted, depending on the amount of the over payment.
Sarah : We 've made the changes as per your earlier comment. It would be great if you could confirm the same on our sandbox.
Here is the patch for the same :
https://fisheye2.atlassian.com/changelog/CiviCRM?cs=29613
Let me know if you come across any issues.
I have done more testing in the sandbox and this feature is looking very good. One concern: When someone underpays, ( eg $100 is due and they only pay $40 ) the status for that installment is shown as "Completed" The status should be "Partial" for the underpayment situations.
1. we dont have a partial status as yet
2. this seems to be a feature request / enhancement
"Completed" in the status columns means "a payment was received". I'm not sure it makes sense to have different varieties of "Completed" since then we'd need Partial, Over-paid ... The fact of the underpayment is visible since Amount Due > Amount Paid AND the underpayment amount is added to the next Amount Due.
Updated specification supports both modifying payment schedule OR modifying total pledge amount.