PaymentState
A ledger entry recording a payment received against an invoice
Fields
Unique identifier
Invoice this payment applies to
Payment amount
ISO 4217 currency code
Payment method
Possible values (7)
BANK_TRANSFERBank transfer / wire
CHEQUECheque
CARDCredit or debit card
DIRECT_DEBITDirect debit / ACH
CREDIT_NOTEOffset against a credit note
CASHCash
OTHEROther payment method
Bank ref, cheque number, or card auth code
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!
}