CoCoCoCoCoCo / docs
← API reference
Mutation / commerce

recordPayment

Record a payment against an invoice: writes a payment ledger row and rolls the payment up onto the invoice (paidAmount, paid/partiallyPaid, paidAt) and its order (paymentStatus), atomically. Requires payment:write permission.

Arguments

inputOTCRecordPaymentInput!

The invoice being paid and the amount, plus the optional ledger detail (currency, method, reference, notes, receipt date) and the invoice-level payment method/reference.

Returns OTCRecordPaymentPayload!

Explore in a view

Order Intake
View exact SDL
"""
Record a payment against an invoice: writes a payment ledger row and rolls the payment up onto the invoice (`paidAmount`, `paid`/`partiallyPaid`, `paidAt`) and its order (`paymentStatus`), atomically. Requires payment:write permission.
"""
recordPayment(
  """
  The invoice being paid and the amount, plus the optional ledger detail (currency, method, reference, notes, receipt date) and the invoice-level payment method/reference.
  """
  input: OTCRecordPaymentInput!
): OTCRecordPaymentPayload! @topic(names: ["commerce"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.