Payment

A payment made out to a vendor or a collection received from a customer, with its allocations to invoices.

type Payment {
  allocatedAmount: Float!
  allocationState: PaymentAllocationState
  allocations: [PaymentAllocation!]!
  amount: Float!
  awaitingAcceptance: Boolean!
  bankAccountId: String
  checkDate: DateTime
  checkNumber: String
  createdAt: DateTime!
  currencyCode: String!
  deletedAt: DateTime
  enteredBy: String!
  exchangeRate: Float
  id: ID!
  linkedOrder: SalesOrder
  notes: String
  organizationId: String!
  partner: Partner
  partnerId: String!
  paymentDate: DateTime!
  paymentMethod: PaymentMethod!
  paymentNumber: String!
  referenceNumber: String
  status: PaymentStatus!
  type: PaymentType!
  unallocatedAmount: Float!
  updatedAt: DateTime!
  updatedBy: String!
  version: Int!
}

Fields

Payment.allocatedAmount ● Float! non-null scalar

The part of the payment applied to invoices so far.

Payment.allocationState ● PaymentAllocationState enum

Derived: AWAITING_ALLOCATION (unallocated cash, partner has open invoices), OVERPAID (excess beyond everything owed) or FULLY_ALLOCATED. Null for draft/cancelled/reversed/refunded payments.

Payment.allocations ● [PaymentAllocation!]! non-null object

The allocations that apply this payment to invoices, including reversals.

Payment.amount ● Float! non-null scalar

The payment amount, in currencyCode.

Payment.awaitingAcceptance ● Boolean! non-null scalar

True for a customer's portal bank transfer the seller has not accepted yet. Accepting it counts the money as received and posts it to the customer's balance once.

Payment.bankAccountId ● String scalar

The ID of the bank account the payment moved through.

Payment.checkDate ● DateTime scalar

The cheque date, for cheque payments.

Payment.checkNumber ● String scalar

The cheque number, for cheque payments.

Payment.createdAt ● DateTime! non-null scalar

When the record was created.

Payment.currencyCode ● String! non-null scalar

Currency code of the payment amount.

Payment.deletedAt ● DateTime scalar

When the record was deleted. Null while it is active.

Payment.enteredBy ● String! non-null scalar

The ID of the user who created the record.

Payment.exchangeRate ● Float scalar

Exchange rate between the document currency and the organization's base currency, when they differ.

Payment.id ● ID! non-null scalar

Unique identifier of the record.

Payment.linkedOrder ● SalesOrder object

The sales order this payment is tied to before it is invoiced, if any.

Payment.notes ● String scalar

Notes on the document, visible to the customer.

Payment.organizationId ● String! non-null scalar

The ID of the organization (tenant) that owns the record.

Payment.partner ● Partner object

The customer or supplier the payment is with.

Payment.partnerId ● String! non-null scalar

The ID of the customer or supplier the payment is with.

Payment.paymentDate ● DateTime! non-null scalar

The date the payment was made.

Payment.paymentMethod ● PaymentMethod! non-null enum

How the payment was made. See PaymentMethod.

Payment.paymentNumber ● String! non-null scalar

The human-readable payment number, unique within the organization.

Payment.referenceNumber ● String scalar

The reference of the payment, such as a bank transfer or transaction reference.

Payment.status ● PaymentStatus! non-null enum

Where the payment is in its lifecycle. See PaymentStatus.

Payment.type ● PaymentType! non-null enum

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

Payment.unallocatedAmount ● Float! non-null scalar

The part of the payment not yet applied to any invoice.

Payment.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Payment.updatedBy ● String! non-null scalar

The ID of the user who last changed the record.

Payment.version ● Int! non-null scalar

Optimistic-concurrency counter — pass back as expectedVersion on the next mutation.

Returned By

allocatePayment mutation ● confirmPayment mutation ● createCustomerCollection mutation ● createPayment mutation ● createSupplierPayment mutation ● payment query ● processPayment mutation ● reversePaymentAllocations mutation ● updateCustomerCollection mutation ● updatePayment mutation ● voidPayment mutation

Member Of

PaymentConnection object ● PaymentDashboard object