Admin - Payment Planner

Part 1 — Global Payment Plan Configuration

Go to Admin → Payment Plans Configuration → Configuration tab.

1. Payment Plan Register — pick which Custom Register payment plan data will read/write against.

2. Once a register is selected, three more dropdowns populate from that register's numeric fields:

   • Register Cost Field

   • Register Revenue Field

   • Register Billing Field

3. These three must all be different fields — the form validates this and blocks Save otherwise.

4. If Baseline Change Control is enabled for the tenant, two extra fields appear:

   • Parent BCC Register

   • BCC Field — populated once a Parent BCC Register is chosen.

5. Click Save. This is a single tenant-wide configuration record — there's only one, and it's audited with a Payment_Planner_Configuration history entry.

Part 2 — Create a Payment Plan Template

Switch to the Payment Plans tab on the same page. This lists all existing payment plan templates, including Description, Archived flag, and Copy action.

1. Click Add to open the “Add Payment Plan” modal.

2. On the Attributes tab, complete the required configuration:

   • Description — required, max 100 characters.

   • Group — only shown if a grouping type applies.

   • Archive — hide this template from being newly applied to projects.

   • Costs by Period — toggles whether costs are tracked per period.

   • Notification Cost / Notification Revenue / Notification Billing — at least one must be checked.

3. Click Save or Save and Close.

4. Switch to the Fields tab to define the fields that will appear on this payment plan.

5. Click Add to open the field editor, then configure:

   • Name required, Help Text, Required, Not Visible, Allow Changes, and Archived.

   • Payment Plan Section — which section of the plan the field lives in.

   • Type — field type such as text, number, calculated field, linked field, or custom list.

   • If Type is Calculated Field, use the calculator icon to open the Formula Editor and define the formula.

   • If Type is Linked Field, pick the Linked Field to tie it to a register field.

   • If the source is a custom list, pick the Custom Source.

   • Sizing and format options include Display Width/Height, Max Length, Show Character Count, Decimal Places, Is Percentage, Is Currency, Min/Max Value, and Include in Total Row.

6. Click Save.

7. Reorder fields by dragging rows in the grid. Edit and Delete act on the selected row; system/default fields can't be deleted.

8. Click Close once the template is complete.

Part 3 — Applying The Plan

Once a template exists, project teams add it to a specific project via Payment Schedule → Add Payment Plan, where they select the Payment Plan Type and, if change-request tracking applies, a linked Change Request.