← All types
Ob Object

PaymentState

A ledger entry recording a payment received against an invoice

Fields

id

PaymentID!Non-null

Unique identifier

Invoice this payment applies to

amount

Float!Non-null

Payment amount

ISO 4217 currency code

Payment method

Possible values (7)
BANK_TRANSFER

Bank transfer / wire

CHEQUE

Cheque

CARD

Credit or debit card

DIRECT_DEBIT

Direct debit / ACH

CREDIT_NOTE

Offset against a credit note

CASH

Cash

OTHER

Other payment method

Bank ref, cheque number, or card auth code

notes

StringNullable

Internal notes

Date payment was received (ISO8601)

User who recorded this payment

Creation timestamp (ISO8601)

Last update timestamp (ISO8601)

Referenced by (3)
Exact type SDL
"""A ledger entry recording a payment received against an invoice"""
type PaymentState {
  """Unique identifier"""
  id: PaymentID!
  """Invoice this payment applies to"""
  invoiceId: InvoiceID!
  """Payment amount"""
  amount: Float!
  """ISO 4217 currency code"""
  currency: CurrencyISO!
  """Payment method"""
  method: PaymentMethod!
  """Bank ref, cheque number, or card auth code"""
  reference: String
  """Internal notes"""
  notes: String
  """Date payment was received (ISO8601)"""
  receivedAt: ISO8601!
  """User who recorded this payment"""
  recordedByUserId: UserID
  """Creation timestamp (ISO8601)"""
  createdAt: String!
  """Last update timestamp (ISO8601)"""
  updatedAt: String!
}