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 Customer Payment page records a customer payment against the organization’s accounts receivable. It is accessible at route /fa/customer-payments/new.

​
Overview

The page renders CustomerPaymentForm inside a “Payment Information” card. The payment number is auto-generated via useGeneratePaymentNumber. On submit, useCreateCustomerPayment is called with:
  • organization_id, payment_number (generated), customer_id, payment_date, payment_amount, payment_method, optional check_number, reference_number, notes, created_by
On success, navigates to /fa/customer-payments/:id (the created payment’s detail page). Primary mutations: useCreateCustomerPayment Permission gate: None at route level.

​
Who it’s for

No explicit permission gate on this route.

​
Before you start

  • At least one active customer must exist.
  • Have the payment details ready: date, amount, payment method, and optionally check or reference number.

​
Steps

  1. Navigate to /fa/customer-payments/new.
  2. Complete the Payment Information form via CustomerPaymentForm:
    • Customer, payment date, payment amount, payment method
    • Optional: check number, reference number, notes
  3. Submit. On success, you are redirected to the payment detail page.
SME: The exact fields and payment method options in CustomerPaymentForm are not fully observable from the page component alone. Confirm available options with the implementation team.

​
Key concepts

  • Payment number: Auto-generated by useGeneratePaymentNumber. Not user-entered.

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/CustomerPaymentCreatePage.tsx
  • src/cores/fa/hooks/useCustomerPayments.ts
  • src/cores/fa/components/CustomerPaymentForm.tsx