Tweak layout on contribution view screen to make payments clearer

[eileenmcnaughton]

Overview

Per discussion on dev - move payment block within the view screen to clarify payments vs line items

Before

After

Technical Details

This is just a re-organisation of existing blocks on the screen

Comments

I also tried ....

[jamienovick]

Should we consider fee amount and net amount to be after payment?

Some sort of structure like:

Line 1:
Line 2:
Total amount due:

Payment details
Paid 1:
Paid 2:
Total amount paid:

(nb. The above is the normal approach for an invoice.) Then:

Fee amounts:
Net amount:

ps. If there are multiple payments could there be multiple fees?

Perhaps we also need to think about relabelling some fields - received date appears 3 times... total amount, contribution total,

[andrewperry]

A great improvement!

Agree with what Jamie's noted too.

Assuming the Fees are expenses incurred on each payment there could be multiple fees which would be recorded separately as expenses rather than a reduction in the income here in Australia.

I wouldn't let finding perfect get in the way of the improvement Eileen's proposed above though.

[JoeMurray]

Let's let this small PR go ahead then work on the other good suggestions here.

I think we submitted a PR at one point in recent months to rename one of the three date fields on this or a closely related form.

There are fees associated with payments so that could/should be a column on the payments section, with a total appearing as well.

Would be great in a new PR to rearrange with a bit of thought the fields so that the Payment Details Amount field was above the Contribution Amount(s) Total Paid.

[nganivet]

Where are the line items in the 'After' screenshot? Shouldn't they be under Total amount where the payments used to be? For most of my customers, they would prefer the line items block open by default, and the payments block closed by default as they only care about the balance due.

[eileenmcnaughton]

@nganivet - there is no line items block on this page currently before or after - only a payments block. The line item editor extension has a line item block and while it doesn't currently show on the view screen I imagine that would be a good step for the extension.

There is a problem with some fields that are on the contribution entity & kinda shouldn't be - total_amount, receive_date, fee_amount, net_amount, payment_method, check_number. That's a structural issue, out of the scope of re-ordering the fields. I feel like the additional suggestions above are suggesting changing what is exposed rather than re-ordering? In which case they should be follow on proposals (& may involve a lot more code change)

Note the label changes of 'fees' to 'Payment Summary' & 'Contribution(s) Amounts' to 'Contribution Total' above will also show 'somewhere else' that I haven't figured out yet

[nganivet]

Thanks Eileen, all clear. I will propose the line items table addition in a separate proposal.

…

------ Original Message ------ From: "Eileen McNaughton" <[email protected]> To: "civicrm/civicrm-core" <[email protected]> Cc: "nganivet" <[email protected]>; "Mention" <[email protected]> Sent: 3/22/2018 1:52:23 PM Subject: Re: [civicrm/civicrm-core] Tweak layout on contribution view screen to make payments clearer (#11863)

@nganivet - there is no line items block on this page currently before or after - only a payments block. The line item editor extension has a line item block and while it doesn't currently show on the view screen I imagine that would be a good step for the extension. There is a problem with some fields that are on the contribution entity & kinda shouldn't be - total_amount, receive_date, fee_amount, net_amount, payment_method, check_number. That's a structural issue, out of the scope of re-ordering the fields. I feel like the additional suggestions above are suggesting changing what is exposed rather than re-ordering? In which case they should be follow on proposals (& may involve a lot more code change) Note the label changes of 'fees' to 'Payment Summary' & 'Contribution(s) Amounts' to 'Contribution Total' above will also show 'somewhere else' that I haven't figured out yet — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

[eileenmcnaughton]

@nganivet I think it would be an easy lift (once this is merged) to add from lineitemeditor extension - which I think should we should aim to make a standard

[totten]

I agree that it's clearer to present payments under "Payment Details" rather than "Total Amount" -- and that it would be even better with line items in tabular format. I'm OK with this as an incremental layout improvement.

Regarding the overall layout of the page, it still feels like it could be improved. If someone wanted to sketch a couple layouts for presenting the same information better, that might provide more clarity on where it should go. However, the "After" really seems better than the "Before", and I don't want to be the blocker on incremental progress.

(CiviCRM Review Template WORD-1.1)

• (r-explain) Undecided: Not assessed
• (r-test) Pass
• (r-code) Undecided: Not assessed
• (r-doc) Undecided: I was concerned that the old layout might be documented -- necessitating an update to the doc. But there doesn't seem to be much explanation of those fields in the user guide. There is one stale image under "Invoicing", but maybe that's not a big deal. CC @joannechester @michaelmcandrew.
• (r-maint) Undecided: Not assessed
• (r-run) Undecided: Not assessed
• (r-user) Soft Pass: This does change some UI elements. However, there seems to be a consensus among folks who are active in CiviContribute that this is an improvement.
• (r-tech) Pass: This patch only affects visible layout -- doesn't appear to change any APIs, hooks, or technical semantics.

[eileenmcnaughton]

Hmm - I'm not sure that review progresses us very well - it's still very unclear what the path is to merging this is. I'm keen to close it if it's just going to stall

[colemanw]

I'm gong to merge this based on many positive comments and a lack of any fail in Tim's review.

[eileenmcnaughton]

Lol - absense of a fail is a pass :-)

[nganivet]

Cividesk is working on further improving the layout to include line items and will propose something soon.

[eileenmcnaughton]

@nganivet you should test the line item editor extension first with a view to bringing that block into core or changing that extension so it adds the view block on view as well as edit screens