Appearance
PaymentState
Type: Object
A ledger entry recording a payment received against an invoice
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| amount | Float! | Payment amount | ||
| createdAt | String! | Creation timestamp (ISO8601) | ||
| currency | CurrencyISO! | ISO 4217 currency code | ||
| id | PaymentID! | Unique identifier | ||
| invoiceId | InvoiceID! | Invoice this payment applies to | ||
| method | PaymentMethod! | Payment method | ||
| notes | String | Internal notes | ||
| receivedAt | ISO8601! | Date payment was received (ISO8601) | ||
| recordedByUserId | UserID | User who recorded this payment | ||
| reference | String | Bank ref, cheque number, or card auth code | ||
| updatedAt | String! | Last update timestamp (ISO8601) |