feat: Grant commission on certain items only

[barredterra]

Close #27276

• "Amount Eligible for Commission" is calculated as the sum of net amounts of line items where "Grant Commission" is active.
• Total Commission = Amount Eligible for Commission * Commission Rate

Bildschirmaufnahme.2021-09-13.um.23.05.18.mov

Docs:

• Item: https://docs.erpnext.com/docs/v13/user/manual/en/stock/item/edit?wiki_page_patch=cf7d5e4852
• Sales Invoice Item: https://docs.erpnext.com/docs/v13/user/manual/en/accounts/sales-invoice/edit?wiki_page_patch=801ef0a039

Thanks to @aisenyi and @sagarvora for their help with this feature.

[codecov]

Codecov Report

Merging #27467 (a9bd71e) into develop (d0f4f03) will increase coverage by 0.01%.
The diff coverage is 87.50%.

@@             Coverage Diff             @@
##           develop   #27467      +/-   ##
===========================================
+ Coverage    55.22%   55.23%   +0.01%     
===========================================
  Files         1121     1121              
  Lines        66746    66748       +2     
===========================================
+ Hits         36859    36869      +10     
+ Misses       29887    29879       -8     

Impacted Files	Coverage Δ
erpnext/stock/get_item_details.py	79.60% <ø> (+0.15%)	⬆️
erpnext/controllers/selling_controller.py	78.12% <85.71%> (-0.18%)	⬇️
erpnext/controllers/accounts_controller.py	83.98% <100.00%> (ø)
...ctype/woocommerce_settings/woocommerce_settings.py	80.00% <0.00%> (-4.00%)	⬇️
...e/asset_value_adjustment/asset_value_adjustment.py	86.04% <0.00%> (-3.49%)	⬇️
erpnext/education/doctype/student/student.py	73.68% <0.00%> (-3.16%)	⬇️
...ion/doctype/course_enrollment/course_enrollment.py	44.00% <0.00%> (-2.00%)	⬇️
...ctype/accounting_dimension/accounting_dimension.py	64.06% <0.00%> (-1.57%)	⬇️
...e/period_closing_voucher/period_closing_voucher.py	88.23% <0.00%> (-1.48%)	⬇️
erpnext/portal/utils.py	28.98% <0.00%> (-1.45%)	⬇️
... and 16 more

[mujeerhashmi]

Oh, I totally missed out on this feature. It's great. One suggestion, the commission rate % may not be the same for all the items in a sales invoice. So defining the commission rate % in item master would be more feature-rich. Then calculate the commission per line item & totaling them would be more extensive.

[barredterra]

@mujeerhashmi currently the commission is defined per Sales Partner. So to make your suggestion work we would need a mapping between Item and Sales Partner. This makes things much more complicated, so I would suggest waiting until someone really has this requirement.

[barredterra]

@marination any other changes required?

[sagarvora]

Additional changes made:

• Make Grant Commission in Transaction Item Read Only
• Rename Commission Base to Amount Eligible for Commission
• Calculate Amount Eligible for Commission in backend as well
• Ignore Quotation, but include POS Invoice when calculating commission and contribution in the backend
• Add Test Case
• Semantic / Code Quality fixes

@barredterra Please update documentation if needed.

[hrwX]

@barredterra This looks good, works as expected 👌

[sagarvora]

@marination @deepeshgarg007 @nextchamp-saqib
It's been almost 2 months since this PR was last changed. Is it safe to assume that no further changes are required?

[nextchamp-saqib]

Looks good to me!

[mergify]

backport version-13-hotfix

✅ Backports have been created

• #28645 feat: Grant commission on certain items only (backport #27467) has been created for branch version-13-hotfix

[nextchamp-saqib]

This shouldn't be enabled by default right? @sagarvora @barredterra

[sagarvora]

Previously, this was applicable for all items. This keeps it backwards compatible. Alternative is patch with default as 0. But I think that there are generally lesser number of items where commission isn't granted.

[sagarvora]

If you think it is getting undue attention because the checkbox defaults to 1, we can change the field to be Don't Grant Commission instead.

[bhavesh95863]

Hey @barredterra ,
Why do we not have a patch to update the old document item table? I have updated one of my server and this feature blocks commission calculation.
I show there is a grant_commission checkbox in the item table but that value is 0 and because of that amount_eligible_for_commission is 0.