Skip to main content

CreatePaymentInput

A payment or collection recorded against a customer or vendor.

input CreatePaymentInput {
  allocations: [PaymentAllocationInput!]
  amount: Float!
  bankAccountId: ID
  checkDate: String
  checkNumber: String
  currencyCode: String!
  idempotencyKey: String
  invoiceId: ID
  notes: String
  partnerId: ID!
  paymentDate: String!
  paymentMethod: PaymentMethod!
  referenceNumber: String
  type: PaymentType!
}

Fields​

CreatePaymentInput.allocations ● [PaymentAllocationInput!] list input​

How the payment is split across invoices. Omit to leave it unallocated on account.

CreatePaymentInput.amount ● Float! non-null scalar​

Payment amount, in currencyCode.

CreatePaymentInput.bankAccountId ● ID scalar​

The ID of the bank account the payment went through.

CreatePaymentInput.checkDate ● String scalar​

Cheque date, as an ISO 8601 date.

CreatePaymentInput.checkNumber ● String scalar​

Cheque number, for cheque payments.

CreatePaymentInput.currencyCode ● String! non-null scalar​

ISO 4217 currency code of the payment.

CreatePaymentInput.idempotencyKey ● String scalar​

A unique key you generate, 8 to 128 characters. Retrying with the same key and the same payload returns the original payment; the same key with a different payload is refused.

CreatePaymentInput.invoiceId ● ID scalar​

The ID of the invoice this payment settles, if any.

CreatePaymentInput.notes ● String scalar​

Notes about the payment.

CreatePaymentInput.partnerId ● ID! non-null scalar​

The ID of the customer or supplier.

CreatePaymentInput.paymentDate ● String! non-null scalar​

Date of the payment, as an ISO 8601 date.

CreatePaymentInput.paymentMethod ● PaymentMethod! non-null enum​

How the payment was made.

CreatePaymentInput.referenceNumber ● String scalar​

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

CreatePaymentInput.type ● PaymentType! non-null enum​

COLLECTION for money received from a customer, PAYMENT for money paid to a supplier.

Member Of​

createPayment mutation