Skip to main content

InvoicePayment

A payment made against an invoice.

type InvoicePayment {
id: ID!
paymentAmount: Float
paymentSource: String!
paymentDate: Date!
comment: String
cardDetails: PaymentCardDetails
sourceInvoiceId: ID
relatedPaymentId: ID
}

Fields​

InvoicePayment.id ● ID! non-null scalar​

InvoicePayment.paymentAmount ● Float scalar​

InvoicePayment.paymentSource ● String! non-null scalar​

The payment method code. Built-in methods use fixed values (e.g. CASH, DEBIT_CARD). For custom payment types, this is a normalised code derived from the label when the type was created (e.g. "Type test" → "TYPE_TEST").

InvoicePayment.paymentDate ● Date! non-null scalar​

InvoicePayment.comment ● String scalar​

InvoicePayment.cardDetails ● PaymentCardDetails object​

Card details where a card was used to take the payment.

InvoicePayment.sourceInvoiceId ● ID scalar​

The source invoice this payment is linked to (e.g. payment on account or credit note). Null if not linked.

InvoicePayment.relatedPaymentId ● ID scalar​

The paired payment on the linked invoice. Null if not linked.

Member Of​

Invoice object