Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The New Payment Plan page lets authorized users create a structured repayment agreement for a customer, with the platform automatically generating installment records on save. Route: /fa/payment-plans/new.

​
Overview

Navigating to /fa/payment-plans/new renders a form backed by useCreatePaymentPlan. On successful submission the platform sets plan status to draft, generates installment records (generateInstallments: true), and redirects to the new plan’s detail page at /fa/payment-plans/:id.

​
Who it’s for

Requires permission fa.payment_plans.create.

​
Before you start

  • Confirm the correct customer record exists in the system.
  • Know the total amount, number of installments, payment frequency, and start date.
  • An optional linked invoice (invoice_id) may be provided.

​
Steps

  1. Navigate to Finance & Revenue → Accounts Receivable → Payment Plans and select New Payment Plan, or go directly to /fa/payment-plans/new.
  2. Complete the form fields: plan name, customer, invoice (optional), total amount, number of installments, payment frequency, and start date.
  3. Optionally enter an end date.
  4. Select Create (or the submit button). The plan is saved as draft and installments are generated automatically.
  5. You are redirected to the Payment Plan Details page to review the installment schedule.

​
Key concepts

Draft status — Plans are created in draft status. Submission for approval or activation is handled from the detail page. Automatic installment generation — The generateInstallments: true flag causes the hook to create individual installment records for the plan on creation.

Finance & Revenue

Finance & Revenue core overview.

Governance & parity

This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/fa.tsx
  • src/cores/fa/pages/PaymentPlanCreatePage.tsx
  • src/cores/fa/hooks/usePaymentPlans.ts
  • src/cores/fa/components/PaymentPlanForm.tsx