Skip to content

OTCRecordPaymentPayload ​

Type: Object

Result of recordPayment: the payment ledger row, plus the updated invoice and, where linked, its order.

Fields ​

NameTypeArgsDescriptionDeprecated
errors[FieldError!]!Field-level validation errors — a non-positive amount, an unknown invoice, or an unpayable invoice status. Empty on success.
invoiceInvoiceStateThe invoice after the payment: paidAmount re-derived from the payment ledger, status paid (with paidAt set) once the ledger total reaches the invoice total, otherwise partiallyPaid. Null when errors is non-empty.
orderOrderStateThe order behind the invoice, with paymentStatus rolled up to paid or partiallyPaid. Null when the invoice is not linked to an order (or on failure).
paymentPaymentStateThe ledger row written for this payment. Null when errors is non-empty.

Relationships ​

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