Skip to main content

payInvoiceWith

Pays an invoice using existing credit in the patient's account (for example unallocated payments on account). Methods in payWith are tried in order until the amount is fully paid. Currently only PAYMENT_ON_ACCOUNT is supported. Omit amount to pay the full outstanding balance, or pass a specific amount for a partial payment.

payInvoiceWith(
  invoiceId: ID!
  amount: Float
  comment: String
  payWith: [InvoicePayWithMethod!]!
): PayInvoiceWithPayload

Arguments​

payInvoiceWith.invoiceId ● ID! non-null scalar​

payInvoiceWith.amount ● Float scalar​

Amount to pay in major units. Omit to pay the full outstanding balance.

payInvoiceWith.comment ● String scalar​

Optional note stored as the payment's comment on the invoice (max 500 characters).

payInvoiceWith.payWith ● [InvoicePayWithMethod!]! non-null enum​

Ordered list of account payment methods to draw from. Currently only PAYMENT_ON_ACCOUNT is allowed.

Type​

PayInvoiceWithPayload object​

The result of paying an invoice from existing account credit.