Count refunds when calculating amount due for an invoice

[mattwire]

Overview

Refunds are not being counted. So if you do something like this:

Contribution amount = £9.30.

1. Add payment for £9.30.
2. Add payment for £10.
3. Refund payment for £10.

You end up with an invoice that shows "Amount Due: £-10.00".

Before

If contribution payments include a refund, incorrect amount shown for "Amount Due":

After

If contribution payments include a refund, correct amount shown for "Amount Due":

Technical Details

Explained in overview - we need to count both "Completed" and "Refunded" as actual payments when doing the calculation.

Comments

@eileenmcnaughton @monishdeb

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[magnolia61]

Nice catch!

[eileenmcnaughton]

Change makes sense - @magnolia61 can you test?

[magnolia61]

Change makes sense - @magnolia61 can you test?

yes I can do so tomorrow morning. Thanks for the continuing work on getting everything around payment create, partial payments, etcetera, work as planned and coded solid and sound :-)

I was just thinking (should I open a gitlab issue for this?) that "the amount due" would be a very very welcome contribution token. Currently 'the amount due' is only available in the event context (event balance token).

[eileenmcnaughton]

@magnolia61 you can open a gitlab - I don't see it happening in a hurry but maybe down the track

[eileenmcnaughton]

@mattwire doesn't all this code replicate

$paymentAmt = CRM_Contribute_BAO_Contribution::getContributionBalance($this->_contributionId);

[mattwire]

@mattwire doesn't all this code replicate

$paymentAmt = CRM_Contribute_BAO_Contribution::getContributionBalance($this->_contributionId);

@eileenmcnaughton Well spotted - I've updated the PR and confirmed we can use those functions and remove a few more lines :-)

[eileenmcnaughton]

Looks good to me - @magnolia61 if you can confirm this passes your testing we will merge

[magnolia61]

Looks good to me - @magnolia61 if you can confirm this passes your testing we will merge

I am testing now Of course first I had to also patch with #16480

[magnolia61]

I cannot fully replicate the BEFORE behavior.
When I create a contribution of 10.
Pay 10
Further pay 2,50
Refund 2,50
The following invoice shows:

With the following corresponding contribution/payment screen:

[mattwire]

@magnolia61 Your invoice seems to be missing the "Less amount paid + Amount due" section. I created an invoice by Viewing Contribution -> Print Invoice. Do you have that in your Contributions - Invoice messagetemplate?

[magnolia61]

Strange. It had to do with the status of pay_later. My contribution had pay_later=1 and therefor did not show the LESS amount paid section (I have no clue why that would seem logical).

Anyway, with pay_later manually changed to 0 I ended up with the invoice like in your "before"

And with this PR applied:

[mattwire]

Thanks @magnolia61 for testing. Merging. @eileenmcnaughton may be worth looking at why pay_later is interfering with display of amount due/paid?

[eileenmcnaughton]

yes - sigh

[magnolia61]

I am working on the contribution invoice template. (see: #16569) So far I only did cosmetic / layout improvements but while I am at it I can take a look at the templates logic where it comes to te pay_later setting. I will report back here.