Customising the Payment Plans tab

Customising the Payment Plans tab

Payment plans are linked to instalment billing in Synergetic and allow each Community Portal user to choose their preferred payment method.

Note: For information about configuring and maintaining payment plans, see Configuring and maintaining payment plans in the Synergetic Online payments manual.

Note: Secure Sockets Layer (SSL) is required to view the Payment Plans tab. Contact your IT administrator.

You can customise the Payment Plans tab to suit the needs of your organisation using either:

  • the Admin Panel

  • configuration settings.

Customising the tab using the Admin Panel

Community Portal administrators can customise the tab using the Menu sub-tab of the Online Configuration window. See Online Configuration - Menu sub-tab.

Tip: Admin user logins are separated by commas between the <AdminUserNames></AdminUserNames> tags in the XML configuration file. See Editing the SynCommPortal.xml configuration file.


Tip: You can also access the Admin Panel if you have been assigned the CommunityPortalAdminPanel security resource in Group/User Security Maintenance. See Group Security Maintenance - Groups View in the Synergetic System maintenance manual.

Customising the tab using configuration settings

Note: The configuration settings for EnabledFlag, MenuOrder, ParentPageName and Text are only applicable when using the Portal 6 and below render method.

What you can do...

See...

What you can do...

See...

Determine the default text for the Available Payment Methods heading on the Payment Plans tab.

AvailablePaymentMethods configuration setting

Customise the text above the Available Payment Plans listing on the Payment Plans tab.

AvailablePaymentPlansText configuration setting

Determine the amount that debtor balances must exceed for inclusion in payment plan amounts.

BalanceThreshold configuration setting

Determine the label text for the balance summary heading on the Payment Plans tab.

BalanceTotalLabel configuration setting

Determine whether a bread crumb menu is displayed to guide the user through the payment plans process.

BreadCrumbsEnableFlag configuration setting

Determine whether terms and conditions functionality is enabled for the submission of direct debit account details.

ChangePaymentMethodHTML configuration setting

Determine the start of the charging period for the following year.

ChargesBeginDate configuration setting

Defines the text label displayed next to the charges to be paid figure for current instalment charges.

ChargesTotalToBePaidLabel configuration setting

Customise the text displayed when a user attempts to change payment plans after charging has begun.

ChargingHasBegunMessage configuration setting

Define the HTML text displayed on the Review your selections popup.

ConfirmPopupText configuration setting

Determine the title of the Fees Total heading in the Your Account Balance Summary section once the detailed view is no-longer displayed.

AfterDetailedViewEndDate configuration setting

Determine whether payment plan discounts are calculated based on the total of all instalment fee categories or only fee categories selected to be used for discounts.

DiscountBasedOnFeeCategory configuration setting

Determine the date after which users will no-longer see the detailed of list of charges and only their amount owing.

DetailedViewEndDate configuration setting

Determine whether the single payment discount is available after instalment charging has begun.

/wiki/spaces/SYNPORTAL/pages/2298807740

Determine whether the Self-administer option is enabled.

DiscountNoSelfAdministerFlag configuration setting

Customise the Email requirement text label.

EmailRequirement configuration setting

Define the text of the Available Payment Plans heading on the Payment Plans tab.

HeadingAvailablePaymentPlans configuration setting

Define the text of the Balance Summary heading on the Payment Plans tab.

HeadingBalanceSummary configuration setting

Define the text of the Current Plan Not Selectable heading on the Payment Plans tab.

HeadingCurrentPlanNotSelectable configuration setting

Defines the text of the Submit and Terms heading on the Payment Plans tab.

HeadingSubmitAndTerms configuration setting

Define the Update Managed Stored Cards heading on the Payment Plans tab.

HeadingUpdateManagedStoredCards configuration setting

Determine whether charged payment plan page information is displayed after charging has commenced.

HideOptionsWhenChargedFlag configuration setting

Customise the message displayed when debtors without active payment plans access the Payment Plans tab.

NoDebtorInstalmentsFound configuration setting

Defines the message displayed next to the I Agree field shown when users enter new direct debit details on the Payment Plans page of the Community Portal.

IAgreeText configuration setting

Determines whether non-instalment fees are included in payment plans.

IncludeNonInstalmentFees configuration setting

Determines whether instalments and payment plans are linked. Linked payment plans can only be updated prior to the first instalment charge whilst unlinked payment plans can be updated at any time.

LinkInstalmentsAndPlansFlag configuration setting

Determine whether discounts are offered for debtors with outstanding balances.

NoDiscountForDebtorOwingFlag configuration setting

Determine whether certain fee codes cause discounts not to be offered.

NoDiscountForFeeCode configuration setting

Customise the message displayed when debtors with fee codes entered in the NoDiscountForFeeCode configuration setting select to self-administer their payments.

NoDiscountForFeeCodeFlagMessage configuration setting

Customise the text displayed when the Payment Plans tab is unavailable.

NotAvailableMessage configuration setting

Customise the text next to the Overdue amount.

OverdueText configuration setting

Determine the Day of the Month for Override instalment details under Debtors.

OverrideInstalmentDay configuration setting

Customise the text above Payment methods.

PaymentMethodsText configuration setting

Determine whether the Payment Plans tab is displayed.

PaymentPlans:EnabledFlag configuration setting

Determine the position of the Payment Plans tab on the menu bar.

PaymentPlans:MenuOrder configuration setting

Determine whether the Payment Plans tab is displayed as a sub-tab of another tab.

PaymentPlans:ParentPageName configuration setting

Customise the title of the Payment Plans tab.

PaymentPlans:Text configuration setting

Customise the text on the Payment Plans tab.

PaymentPlans:Top configuration setting

Customise the URL of the Payment Plans tab.

PaymentPlans:URL configuration setting

Customise the text at the top of the Manage Stored Cards tab when the tab is accessed using the Manage Payment Plan Stored Cards button.

PaymentPlansManageStoredCards:Top configuration setting

Customise the text above the Agreed to terms and conditions checkbox.

PaymentPlansSubmitText configuration setting

Customise the subject used in the email sent when completing payment plan selections.

PaymentResult:MailSubject configuration setting

Customise the text displayed under the Payment results heading after the user has selected a payment plan.

PaymentResultsPageUpperText configuration setting

Customise the text next to the amount used for instalment plans.

PlanAmountNotice configuration setting

Stores the URL for the Community Portal loading page when using the Edit Debtor or Edit Owner buttons in Debtor Maintenance.

PortalHandOver:Debtors:OnlinePayments configuration setting

Determine whether an email is sent to the user once a payment plan is selected.

SendConfirmationEmail:Enabled configuration setting

Determine whether a grand total of the prior year balance and instalments for the current year is displayed on the Payment Plans tab.

ShowGrandTotal configuration setting

Determines whether the total owing figure is displayed as a single figure or split into prior year and not charged amounts.

SplitTotalOwing configuration setting

Customise the text next to the Sub total figure.

SubTotalText configuration setting

Customise the Fees total text label.

TotalFeesTextLabel configuration setting

Determine the text placed to the left of the Prior year outstanding amount.

TotalOfNotChargedText configuration setting

Determines the text placed to the left of Total owing amount figure.

TotalOwingText configuration setting

Customise the text next to the Prior years outstanding amount.

TotalOwingPriorYearsText configuration setting

Determine whether users are required to enter an email address when their default email in the Synergetic Community is blank.

UserEmailRequired configuration setting