Skip to main content

UpdatePaymentInput

Changes to a payment. Omitted fields stay as they are.

input UpdatePaymentInput {
  amount: Float
  checkDate: String
  checkNumber: String
  currencyCode: String
  expectedVersion: Int
  notes: String
  paymentDate: String
  paymentMethod: PaymentMethod
  referenceNumber: String
}

Fields​

UpdatePaymentInput.amount ● Float scalar​

Payment amount, in currencyCode.

UpdatePaymentInput.checkDate ● String scalar​

Cheque date, as an ISO 8601 date.

UpdatePaymentInput.checkNumber ● String scalar​

Cheque number, for cheque payments.

UpdatePaymentInput.currencyCode ● String scalar​

ISO 4217 currency code of the payment.

UpdatePaymentInput.expectedVersion ● Int scalar​

Optimistic-concurrency check: the version this client read. Stale → typed VERSION_CONFLICT under COMMAND_CAS=enforce.

UpdatePaymentInput.notes ● String scalar​

Notes about the payment.

UpdatePaymentInput.paymentDate ● String scalar​

Date of the payment, as an ISO 8601 date.

UpdatePaymentInput.paymentMethod ● PaymentMethod enum​

How the payment was made.

UpdatePaymentInput.referenceNumber ● String scalar​

Your reference for the payment, such as a bank or transaction reference.

Member Of​

updatePayment mutation