Page Comparison

• "Number of instalment" field should be readonly if the recurring contribution is using a payment processor with "Payment_Manual" class.
• "Auto Renew?" field available on "Update Recurring Contribution" form
• "Payment Method" and "Cycle Day" field available on "Update Recurring Contribution" form.
• When admin click on save on "Update Recurring Contribution" form, if "Payment Method" or "Cycle Day" is changed, a popup should appear asking "Do you want to update any outstanding instalment contribution with the new Payment Method/ Cycle Day?".
  • If "No" → No existing contribution will get affected.
  • If "Yes" → Any existing Pending contribution under the recurring contribution will reflect the new "Payment Method" and "Cycle Day".

• When cancelling a recurring contribution, a popup will show up and ask for confirmation. A new dialog box containing two checkbox options should be used to replace the popup.
• The first checkbox is "Do you wish to cancel any pending instalment contribution?" which if checked and confirmed, as a result, all "Pending" contributions that are linked to the recurring contribution will also be cancelled.
• The second checkbox is "Do you wish to cancel any linked membership?" which if checked and confirmed, as a result, all memberships that are linked to the recurring contribution will also be cancelled.
• <add last comment mentioned in the ticket> 

BASW-113

Auto-refresh is not happening

Set Membership to Override Permanently = Cancelled if;

• Membership Status Override = "Override until selected date" and "cancel membership" option selected in the popup when cancelling a recurring contribution
• Membership Status Override = No and "cancel membership" option selected in the popup when cancelling a recurring contribution

• What is the behaviour when the 2nd checkbox is "Do you wish to cancel any linked membership?" is selected?
•  Will the expected work without selecting 2nd checkbox?
• Spec is not updated with this ticket requirement

• "Payment Plan Settings" menu available under Administer menu.
• In the settings page, a configuration checkbox "Use latest price when auto renew membership?" should be provided

• If the "Use latest price when auto renew membership?" is not checked, nothing changes.
• If the "Use latest price when auto renew membership?" is checked, when an offline auto renew membership is being renewed by the "Renew offline auto-renewal memberships" scheduled job
  • the generated contribution/ recurring contribution should reflect the current membership fee configured in the corresponding membership type for each membership line included in the recurring contribution
  • the line items and other sub-entities of the generated contributions should also reflect the current membership fee configured in the corresponding membership type

• "Offline auto-renew option" custom field-set available under Membership Entity with boolean custom field "Opt-out auto price update for offline auto-renew".

• When"Opt-out auto price update for offline auto-renew" = True and "Use latest price when auto renew membership?" = True →  membership should not reflect the new price when it gets auto-renewed by the offline auto-renew scheduled job.
• When"Opt-out auto price update for offline auto-renew" = False and "Use latest price when auto renew membership?" = True →  membership should reflect the new price when it gets auto-renewed by the offline auto-renew scheduled job.

• Only "edit contribution" permission gives access to Action button "View/Modify Future Instalments" in recurring contribution.
• Also check if can access Manage Instalment modal through URL

Db table "membershipextras_subscription_line" created upon installation of extension.

Following table fields created

• contribution_recur_id - integer - required
• line_item_id - integer - required
• start_date - date
• end_date - date
• auto_renew - boolean
• is_removed - boolean

• Create a copy of the line item with instalment contribution
• contribution_id is NULL for copied line item
• New record filled into "membershipextras_subscription_line" with:
  • contribution_recur_id - id of recurring contribution
  • line_item_id -  line item id copied from the instalment contribution
  • start_date - start date of recurring contribution
  • end_date - empty
  • auto_renew -
    • true: if recurring contribution is auto renewed
    • false: if not auto renewed
• is_removed - false

• Action button "View/Modify Future Instalments" added to payment plan with payment manual class.
• No action button on non payment manual class payment plans
• Once button selected modal "Manage Instalments" pops up
• Current Period tab is set as default

Following two conditions have to be met:

• Each line item should have a start date
• is_removed flag = false

Each row contains:

• Item - line item label
• Start Date - start date of line item
• End Date - largest end date in all the linked memberships
• Renew automatically - checked if recurring contribution set to auto renew
• Financial type - financial type of line item
• Tax - 
  • Percentage of financial type 
  • N/A if no tax in financial type 
• Amount - line item total with no tax
• Remove button - bin icon

• Add Membership
• Add Other Amount
• Close

• Untaxed amount (total of all amounts)
• Tax (total of all line item taxes)
• Total per instalment (Untaxed amount + Tax)

Next period tab shows up if recurring contribution has autorenewal. If not do not show auto renewal

• All line items that have auto renew should be shown on next period tab (ie; the ones which are renew automatically true in current period)
• is_removed = false

Each line item row has following details:

• Item - line item label
• Financial Type - of line item 
• Tax - percentage of financial type, show N/A if no tax
• Amount - line item total
• Bin icon - to delete line item

• Add Membership
• Add Other Amount
• Close

• Untaxed amount (total of all amounts)
• Tax (total of all line item taxes)
• Total per instalment (Untaxed amount + Tax)

On delete operation:

• if its only remaining line item:
  • then show warning "Cannot remove the last item in an order" 
  • cancel operation and line item should not be removed
• if more then one line item:
  • show modal with title "Remove <line item label> ?" 

• Has text: "The end date of the <line item label> will be set to today. If you want the <line item label> to end on a different date, you can adjust it below. <line item label> amount will be deducted from all remaining instalments after the new end date. Please note the changes should take effect immediately after clicking “Apply”."
• Adjust end date - checkbox
• End date - default to today, show date picker, only if "Adjust end date" is checked 
• Cancel button
• Apply button

• If "Adjust end date" not checked: membershipextras_subscription_line.end_date = today
• If "Adjust end date" is checked: membershipextras_subscription_line.end_date = date picked 

• membershipextras_subscription_line.auto_renew = false
• is_removed = true

If pending instalments with "Received date" => end_date: 

• line items quantity set to zero
• contribution amount corrected to new instalment amount 
• net amount and tax amount and total amount reflect the changes

If membership line item removed:

• membership end date must use new end date 

Following notices appear on successful removal:

• "<line item label> has been removed from the active order"
•  "<line item label> should no longer be continued in the next period"

Line items updated on Current Period screen 

• untaxed amount, tax and total per instalment should reflect the changes
• if auto_renew for removed line item is true, should no longer appear on next period tab

No line item removed

On delete operation:

Modal with title "Remove <line item label> as title

• Has text "Please note the changes should take effect immediately after "Apply"."
• Cancel button
• Apply button

• membershipextras_subscription_line.auto_renew = false
• If line item is membership: remove civicrm_membership.contribution_recurr_id 
• Notice with text: "<line_item_label> should no longer be continued in the next period."
• Manage instalments modal reloads
• "is_removed" = true
• untaxed amount, tax and total per instalment reflect changes

https://compucorp.atlassian.net/browse/BASW-219

Pending fix & issues

• No line item removed

• Perform same operation as 32, 33

New row with following items:

• Item - dropdown - required field
  • list membership types not belonging to any membership org of existing line items
• Start date - datepicker - required field
  • default to todays date or
  • if active membership of same membership type exists, then set to membership start date 
• End date - datepicker - required field
  • default to largest in all linked memberships
• Renew automatically - checkbox 
  • checked by default
  • only show if auto renewal recurring contrib
• Financial Type - text field
  • financial type of membership selected in item dropdown
• Tax -  text field
  • tax percentage of financial type
  • none if no tax in financial type
• Amount  - money - required field
  • default to minimum of membership type fee / no. of isntalments
• Confirm and Cancel action icons

• If row addition not completed yet, do not allow other row items to be be clickable.
• If user tries to click on other row items - row should flash 

If check icon clicked:

• If no pending instalment with Received date => today or start date (choose the latest) show notice with text:
  • "No outstanding instalment contribution from the selected start date. Suggest to follow the steps below:
    1. Add the the item to next period instead.
    2. (optional) Create the membership or contribution outside the recurring order."
• If there are pending instalment contributions with Received Date => today or start date (choose the latest) show dialog with title: "Add <line_item_label>?" should appear with the following:
  • Dialog text: "Please note the changes should take effect immediately after "Apply".
  • "Adjust the amount of the first instalment" checkbox.
  • "First instalment amount" money text field. Default to instalment amount. Show only if "Adjust the amount of the first instalment" checkbox is ticked.
  • Cancel button
  • Apply button

If cross icon clicked the row should be removed and no change done

Apply Action on dialog

• Line item with empty contribution_id created in civicrm_line_item table. Tax amount calculated: amount * tax rate
• membershipextras_subscription_line row created. 
  • link line item and recurring contribution
  • start date is selected start date
  • end date empty
• For pending instalment contributions with Received date => today / start date (choose latest);
  • copy of line item added
  • contribution amount adjusted and tax adjusted
  • if  "Adjust the amount of the first instalment" is used, 1st pending instalment contribution = "First instalment amount"
• If a membership of same membership type doesn't exist:
  • new membership should be created with start and end date 
  • link it to all pending instalment contribution with Received date => today / start date (choose latest)
• If a membership of same membership type exists:
  • update it with new start and end date
  • link it to all pending instalment contribution with Received date => today / start date (choose latest)
• If auto renew checked;
  • membershipextras_subscription_line.auto_renew = true
  • membership contribution_recurr_id = the id of recurring contribution
• If auto renew not checked;
  • membershipextras_subscription_line.auto_renew = false
  • membership contribution_recurr_id = emptied
• Show notice: "line_item_label" will now be continued in the next period.
• "Manage Instalments" modal reloads

https://compucorp.atlassian.net/browse/BASW-220

• Line item with empty contribution_id created in civicrm_line_item table - Not working

New row with following items:

• Item - dropdown - required field
  • list membership types not belonging to any membership org of existing line items
• Start date - datepicker - required field
  • default to todays date 
• End date - text - N/A
• Renew automatically - checkbox 
  • checked by default
  • only show if auto renewal recurring contrib
• Financial Type - text field
  • financial type of membership selected in item dropdown
• Tax -  text field
  • tax percentage of financial type
  • none if no tax in financial type
• Amount  - money - required field
• Confirm and Cancel action icons

• If row addition not completed yet, do not allow other row items to be be clickable.
• If user tries to click on other row items - row should flash 

If check icon clicked:

• If no pending instalment with Received date => today or start date (choose the latest) show notice with text:
  • "No outstanding instalment contribution from the selected start date. Suggest to follow the steps below:
    1. Add the the item to next period instead.
    2. (optional) Create the membership or one off contribution outside the recurring order."
• If there are pending instalment contributions with Received Date => today or start date (choose the latest) show dialog with title: "Add <line_item_label>?" should appear with the following:
  • Dialog text: "Please note the changes should take effect immediately after "Apply".
  • "Adjust the amount of the first instalment" checkbox.
  • "First instalment amount" money text field. Default to instalment amount. Show only if "Adjust the amount of the first instalment" checkbox is ticked.
  • Cancel button
  • Apply button

• Line item with empty contribution_id created. Tax amount calculated: amount * tax rate
• membershipextras_subscription_line row created. 
  • link line item and recurring contribution
  • start date is selected start date
  • end date empty
• For pending instalment contributions with Received date => today / start date (choose latest);
  • copy of line item added
  • contribution amount adjusted and tax adjusted
  • if  "Adjust the amount of the first instalment" is used, 1st pending instalment contribution = "First instalment amount"
• If auto renew checked;
  • membershipextras_subscription_line.auto_renew = true
  • Notice: "line_item_label" will now be continued in the next period."
• If auto renew unchecked;
  • membershipextras_subscription_line.auto_renew = false
  • Notice: "line_item_label" has been added to the active order."
• Manage Instalments" modal reloads

New row with following items:

• Item - dropdown - required field
  • list membership types not belonging to any membership org of existing line items
• Financial Type - text field
  • financial type of membership selected in item dropdown
• Tax -  text field
  • tax percentage of financial type
  • none if no tax in financial type
• Amount  - money - required field
  • default to minimum of membership type fee / no. of isntalments
• Confirm and Cancel action icons

https://compucorp.atlassian.net/browse/BASW-222

Two open issues related to Financial Type & Tax%

• If row addition not completed yet, do not allow other row items to be be clickable.
• If user tries to click on other row items - row should flash 

1. dialog body text - "Please note the changes should take effect immediately after "Apply"."
2. Cancel button
3. Apply button

Apply action on dialog

• Line item with empty contribution_id created. Tax amount calculated: amount * tax rate
• membershipextras_subscription_line row created. 
  • link line item and recurring contribution
  • start date empty
  • end date empty
• Notice: "line_item_label" will now be continued in the next period."
• "Manage Instalments" modal reloads

1.  A notice with warning sign will appear with text "This membership type is already enrolled in next period." when there is another membershipextras_subscription_line:
   1. linked to a line item with same membership type and membershipextras_subscription_line
   2. end date is empty
   3. auto-renew is TRUE
2. If user checks the "Renew automatically" field for any of membership lines in "Current period" tab and the scenario in point 8 does not apply, point 5-7 should apply here.

https://compucorp.atlassian.net/browse/BASW-222

Pending issues

New row with following items:

• Item - text - required field
• Financial Type - select - with all financial types
• Tax -  text field
  • tax percentage of financial type
  • none if no tax in financial type
• Amount  - money - required field
• Confirm and Cancel action icons

https://compucorp.atlassian.net/browse/BASW-223

Open Issues

• If row addition not completed yet, do not allow other row items to be be clickable.
• If user tries to click on other row items - row should flash 

1. dialog body text - "Please note the changes should take effect immediately after "Apply"."
2. Cancel button
3. Apply button

• Line item with empty contribution_id created in civicrm_line_item. Tax amount calculated: amount * tax rate 
• membershipextras_subscription_line row created. 
  • link line item and recurring contribution
  • start date empty
  • end date empty
• Notice: "line_item_label" will now be continued in the next period."
• "Manage Instalments" modal reloads

https://compucorp.atlassian.net/browse/BASW-223

Line item with empty contribution_id created in civicrm_line_item - Not working

Test cases 61 to 63 also apply here.

https://compucorp.atlassian.net/browse/BASW-223

Open observations in 'Renew-Automatically' field logic