Skip to main content

createPaymentOnAccount

Records a payment on the patient's account (credit not tied to a specific invoice). Use a practice payment type such as cash or bank transfer (Stripe and terminal types are not allowed). Amount must be at least 1. Payment date must not be before the practice invoice lock date.

createPaymentOnAccount(
  patientId: ID!
  amount: Float!
  paymentTypeId: ID!
  date: Date
  comment: String
): PaymentOnAccountPayload

Arguments​

createPaymentOnAccount.patientId ● ID! non-null scalar​

createPaymentOnAccount.amount ● Float! non-null scalar​

Amount to credit on the patient's account. Must be at least 1.

createPaymentOnAccount.paymentTypeId ● ID! non-null scalar​

Practice payment type id used to record how the account was funded. Stripe and terminal types are not allowed.

createPaymentOnAccount.date ● Date scalar​

Payment date. Defaults to now. Must not be before the practice invoice lock date.

createPaymentOnAccount.comment ● String scalar​

Optional note stored on the payment (max 500 characters).

Type​

PaymentOnAccountPayload object​

The result of creating or deleting a payment on account.