Test recurring contributions with webform for first time membership signup

Test with each recurring unit and payment processor (Offline Recurring Contribution)

1. day
2. week
3. month
4. year

Number of recurring contributions created should be same as number of instalments 

Contribution status should be 'Pending' 

Each contribution total amount should be "membership duration / no. of instalments * membership fee"

Membership created should be made active (new or current status) and have the full membership duration once the first contribution is completed

Each contribution should have its own invoice. Amount in invoice should reflect the contribution amount for each instalment. Membership line item is shown as a percentage of the membership term (100 / no. of instalments)

Each contribution total amount should be "membership duration / no. of instalments * membership fee (with tax)"

Invoice should reflect the tax amount correclty 

Price fields should show the unit prices and tax amounts seperately like with any contribution made with pricesets (check default Civi behaviour for contribution payments with pricesets and tax)

Invoice should reflect the price fields and tax amount correclty 

Check the new options in

• new membership page
• existing membership page

Following options available:

• No
• Override Permanently
• Override until selected date

Membership status correctly reflects back on membership page:

• No - membership status rules will decide the status
• Override Permanently - membership status will be the selected one
• Override until selected date - membership status will be the selected one until date set. After that date move to 'No'

Scheduled job will not process overridden status set to either 'Expired, Pending or Cancelled'. So once the job is run it switches to 'No' but these statuses will not follow membership status rules.

"Status Override" dropdown added with following options in webform membership config section:

• No (Default)
• - User Select -
• Override Permanently
• Override until selected date

"Statue Override Until" checkbox added and if selected datepicker available

When "- User Select -" is selected, a "Status Override" select field will be added to the webform with all 3 options

According to conditionals the correct option should be selected and appropriate status reflected back in membership page on civicrm side

Recurring contribution with total amount as "membership duration / no. of instalments * membership fee" should be created

Instalments = no. of instalments selected

Contribution status should be 'Pending' 

Auto renew = True

Membership created should be made active (new or current status) and have the full membership duration once the first contribution is completed 

Recurring contribution with full membership fee will be created

Instalments = Null

Contribution status should be 'Pending' 

Auto renew = True

Membership created should be made active (new or current status) and have the full membership duration once the first contribution is completed

If the membership qualifies the following conditions, renew:
1. The last recurring contribution is using offline payment processor
2. The last recurring contribution is set to auto-renew
3. The last recurring contribution is not in status cancelled
4. The membership's end date is equals to or smaller than today

Memberships that satisfy the conditions are renewed

• If last contribution has instalments a recurring contribution  is created.
• This recurring contribution should copy the previous contribution details:
  • line items
  • sales tax
  • custom fields
• Only contribution amount and date should be based on this recurring contribution

New "Auto-renew Option" added to webform with options in webform membership config section:

• Not offered
• Give option
• Required

Membership created on civicrm side should reflect the auto renewal status:

• Not offered - don't alllow autorenewal
• Give option - "Auto-renewal option" field will be added to webform with a checkbox "Please renew my membership automatically." If selected, the membership will be set to auto-renew
• Required - the corresponding membership created by the webform will be set to auto-renew

Start Event "Membeship is in arrears (Payment Plan)" and End Event "Membership is no longer in arrears (Payment Plan)" is available

Note: 'In Arrears' needs to be the first one on the list on membership status rules page.

• Membership paid by recurring contributions in instalments
• Any pending instalment contribution received date is in past

• Membership paid by recurring contribution in instalments
• no pending instalment conrtibution in past

Transition does not happen for Expired, Pending, Cancelled to "In Arrears" 

Transition should happen for New, Current, Grace to "In Arrears" 

If "Override Permanently" is selected the membership status rules don't apply at any time

If "Override until selected date" is selected the membership status rules don't apply until set date

Ex: Set the membership status to have "Override until selected date" for 30 days. Once paid, the override is switched to No. If not paid after 30 days the above "Membership is in arrears" rule will apply

Following options available:

• No
• Override Permanently
• Override until selected date

Two tabs available:

• Contribution
• Payment Plan

Following fields available:

• Pay by a different contact
• Amount
• No. of instalments
• Interval and units
• Payment method
• Payment plan start date
• First instalment summary

Checbox not selectable and crossmark shown with message: "This membership is aleady set up to auto-renew. You can still choose to make an additional payment below"

• All non-payment plan contributions listed
• Table should look and behave the same as it is now

• All payment plans are listed
• Following columns available:
  • Instalment amount
  • Instalments
  • Frequency
  • Total amount
  • Paid
  • Due
  • Balance
  • Start date
  • End date
  • Status
• Expandable view of all contributions in payment plan (look and behave same as contribution table)
• Each contribution can be viewed or edited. Admin can add a new contribution to payment plan.

• Instalment amount - amount of each linked contribution
• Instalments - no. of instalments (empty if not paid in instalment)
• Frequency - gap between 2 contribution
• Total amount - amount of all linked contributions
• Paid - total amount of all received payments against all linked contributions
• Due - total amount of all contributions with received date <= current date
• Balance - "total amount - paid" (empty if not paid in instalment)
• Start date - start date of payment plan
• End date -  end date of payment plan  (empty if payment not ended)
• Status - status of payment plan (also shows next due date if not completed)

Following fields available:

• Contact
• Instalment amount
• Instalments
• Frequency
• Total amount
• Paid
• Due
• Balance
• Start date
• End date
• Status
• Next contribution
• Failure count
• Failure retry date
• Payment processor
• Financial type
• Payment method

Contribution accordion added and lists all contributions linked to this payment plan

• Contact - contact display name with link
• Instalment amount - amount of each linked contribution
• Instalments - no. of instalments (empty if not paid in instalment)
• Frequency - gap between 2 contribution
• Total amount - amount of all linked contributions
• Paid - total amount of all received payments against all linked contributions
• Due - total amount of all contributions with received date <= current date
• Balance - "total amount - paid" (empty if not paid in instalment)
• Start date - start date of payment plan
• End date -  end date of payment plan  (empty if payment not ended)
• Status - status of payment plan
• Next contribution - next due date 
• Failure count - count of failure to collect payments (unchnaged - only relavant to online payments)
• Failure retry date - next date to retry payment collection (unchnaged - only relavant to online payments)
• Payment processor - payment processor used to collect payment
• Financial type
• Payment method

Two tabs available:

• Contribution
• Payment Plan

• Lists all non payment plan contributions
• Look and behaviour same as it is now

Shows two sections:

• Active payment plans: currently pending or in progress payment plans
• Inactive payment plans: completed or cancelled payement plans

Table structure follows TC16

• "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