PaymentOnAccount

A payment on account is a credit held for a patient or contact that can be allocated to invoices over time.

type PaymentOnAccount {
  id: ID!
  invoiceNumber: Int
  date: Date
  accountId: ID
  accountHolderName: String
  patientId: ID
  patientTitle: String
  patientDob: Date
  patientName: String
  patient: Patient
  account: Account
  outstandingAmount: Float
  originalPayment: PaymentOnAccountPayment
  payments: [PaymentOnAccountPayment!]!
  metadata: [MetadataEntry!]!
  createdAt: DateTime
  updatedAt: DateTime
}

Fields

PaymentOnAccount.id ● ID! non-null scalar

PaymentOnAccount.invoiceNumber ● Int scalar

PaymentOnAccount.date ● Date scalar

PaymentOnAccount.accountId ● ID scalar

The account holder identifier (patient or contact).

PaymentOnAccount.accountHolderName ● String scalar

Invoice snapshot: account holder name stored at creation. For legacy patient-held payments on account that never stored this field, falls back to patientName when accountId matches patientId.

PaymentOnAccount.patientId ● ID scalar

PaymentOnAccount.patientTitle ● String scalar

PaymentOnAccount.patientDob ● Date scalar

PaymentOnAccount.patientName ● String scalar

Invoice snapshot: patient name stored on the invoice at creation.

PaymentOnAccount.patient ● Patient object

Current data: live patient record.

PaymentOnAccount.account ● Account union

Current data: live account holder (patient or contact).

PaymentOnAccount.outstandingAmount ● Float scalar

Remaining unallocated balance as a positive amount. Zero when fully allocated.

PaymentOnAccount.originalPayment ● PaymentOnAccountPayment object

The original payment recorded when this payment on account was created.

PaymentOnAccount.payments ● [PaymentOnAccountPayment!]! non-null object

Payments recorded on this payment on account, including allocations and refund credits.

PaymentOnAccount.metadata ● [MetadataEntry!]! non-null object

Partner metadata supplied when the PaymentIntent was created.

PaymentOnAccount.createdAt ● DateTime scalar

PaymentOnAccount.updatedAt ● DateTime scalar

Returned By

paymentOnAccount query

Member Of

PaymentOnAccountData object ● PayOnAccountWithSavedCardPayload object