Skip to content

PaymentState ​

Type: Object

A ledger entry recording a payment received against an invoice

Fields ​

NameTypeArgsDescriptionDeprecated
amountFloat!Payment amount
createdAtString!Creation timestamp (ISO8601)
currencyCurrencyISO!ISO 4217 currency code
idPaymentID!Unique identifier
invoiceIdInvoiceID!Invoice this payment applies to
methodPaymentMethod!Payment method
notesStringInternal notes
receivedAtISO8601!Date payment was received (ISO8601)
recordedByUserIdUserIDUser who recorded this payment
referenceStringBank ref, cheque number, or card auth code
updatedAtString!Last update timestamp (ISO8601)

Connect machines, automate workflows, and build custom apps for print production.