← API reference
CANONICAL TYPE REFERENCE

PaymentState

A ledger entry recording a payment received against an invoice

Unique identifier

Invoice this payment applies to

amountFloat!

Payment amount

ISO 4217 currency code

Payment method

referenceString

Bank ref, cheque number, or card auth code

notesString

Internal notes

Date payment was received (ISO8601)

User who recorded this payment

createdAtString!

Creation timestamp (ISO8601)

updatedAtString!

Last update timestamp (ISO8601)

View exact 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!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.