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.

Customer Payment Details displays all information for a single AR customer payment identified by :id, including its application to invoices, with actions to apply, remove applications, generate a receipt PDF, and delete. Route: /fa/customer-payments/:id

​
Overview

The page loads the payment via useCustomerPayment(id, organizationId). Applications are loaded via useARPaymentApplications. Breadcrumb shows payment_number. Payment metadata includes: payment_date, payment_amount, payment_method (underscores replaced with spaces), check_number, and reference_number. The applications table (ARPaymentApplicationWithDetails[]) shows invoice linkages. Actions: Apply to invoice (PaymentApplicationDialog), remove an application (useRemoveARPaymentApplication, with confirmation), generate receipt PDF (usePaymentReceiptPdf), and delete the payment (useDeleteCustomerPayment, with confirmation). The PDF receipt includes vendor/customer name, payment number, date, amount, method, reference, and applied invoice numbers. Note: /fa/customer-payments redirects to /fa/receivables?tab=payments.

​
Who it’s for

No explicit permission gate on the detail route.

​
Before you start

  • A customer payment record must exist.
  • Invoices must exist to apply this payment.

​
Steps

1

Navigate to the payment

Go to /fa/customer-payments/:id or click a payment from the Customer Payments list.
2

Review payment details

View payment number, date, amount, method, and reference information.
3

Review applications

The applications section shows which invoices this payment has been applied to and the amounts.
4

Apply to an invoice

Click Apply to open PaymentApplicationDialog and select an invoice.
5

Remove an application (if needed)

Click remove on an application row. Confirm in the dialog to call useRemoveARPaymentApplication.
6

Generate receipt PDF (optional)

Click the receipt download button to generate and download a PDF via usePaymentReceiptPdf.
7

Delete the payment (if applicable)

Click Delete and confirm to call useDeleteCustomerPayment.

​
Key concepts

  • useCustomerPayment — Primary data hook; fetches a single payment by id and organizationId.
  • useARPaymentApplications — Hook fetching invoice application records for this payment.
  • ARPaymentApplicationWithDetails — Type for application rows including linked invoice data.
  • usePaymentReceiptPdf — Hook that generates a receipt PDF from payment and application data.
  • PaymentApplicationDialog — Component for applying the payment to an invoice.

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/CustomerPaymentDetailPage.tsx
  • src/cores/fa/hooks/useCustomerPayments.ts
  • src/cores/fa/hooks/useARPaymentApplications.ts
  • src/cores/fa/hooks/usePaymentReceiptPdf.ts
  • src/cores/fa/components/PaymentApplicationDialog.tsx
  • src/cores/fa/components/PaymentStatusBadge.tsx