CreateSupplierPaymentInput

A payment made to a vendor.

input CreateSupplierPaymentInput {
  allocations: [PaymentAllocationInput!]
  amount: Float!
  attachments: [String!]
  bankAccountId: ID
  checkDate: DateTime
  checkNumber: String
  currency: String!
  exchangeRate: Float
  idempotencyKey: String
  internalNotes: String
  notes: String
  paymentDate: DateTime!
  paymentMethod: PaymentMethod!
  referenceNumber: String
  supplierId: ID!
  transactionId: String
}

Fields

CreateSupplierPaymentInput.allocations ● [PaymentAllocationInput!] list input

The supplier invoices to allocate the payment to and the amount for each.

CreateSupplierPaymentInput.amount ● Float! non-null scalar

Payment amount, in the payment currency. Must be greater than zero.

CreateSupplierPaymentInput.attachments ● [String!] list scalar

Attachments to record on the payment, as strings.

CreateSupplierPaymentInput.bankAccountId ● ID scalar

The ID of the bank account the payment went through.

CreateSupplierPaymentInput.checkDate ● DateTime scalar

Cheque date.

CreateSupplierPaymentInput.checkNumber ● String scalar

Cheque number, for cheque payments.

CreateSupplierPaymentInput.currency ● String! non-null scalar

ISO 4217 currency code of the payment.

CreateSupplierPaymentInput.exchangeRate ● Float scalar

Exchange rate to the organization's base currency. Must be greater than zero.

CreateSupplierPaymentInput.idempotencyKey ● String scalar

A unique key you generate, 8 to 128 characters. Retrying with the same key returns the original payment.

CreateSupplierPaymentInput.internalNotes ● String scalar

Notes for your team only.

CreateSupplierPaymentInput.notes ● String scalar

Notes about the payment.

CreateSupplierPaymentInput.paymentDate ● DateTime! non-null scalar

Date of the payment.

CreateSupplierPaymentInput.paymentMethod ● PaymentMethod! non-null enum

How the payment was made.

CreateSupplierPaymentInput.referenceNumber ● String scalar

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

CreateSupplierPaymentInput.supplierId ● ID! non-null scalar

The ID of the supplier being paid.

CreateSupplierPaymentInput.transactionId ● String scalar

Transaction identifier from the bank or gateway.

Member Of

createSupplierPayment mutation