UpdatePaymentCommandRequestInput
Changes a payment. Fields that are omitted stay as they are. A changed amount can change the payment status of the document the payment counts for (for a payment of an invoice correction, of the corrected invoice), and a document that becomes fully paid starts its workflows. Where the payment counts is changed with the move operations. Errors: PAYMENT_NOT_FOUND (the payment was not found); PAYMENT_METHOD_NOT_FOUND (the payment method was not found); AMOUNT_NOT_POSITIVE (the amount is not greater than 0); PAYMENT_CANNOT_BE_CHANGED (the payment cannot be changed. The error lists the blocker codes: PAYMENT_IS_VOUCHER_REDEMPTION (for the amount, the date, the transaction ID and the note), PAYMENT_BOOKED_BY_REFUND, PaymentFromPaymentTransaction (for the amount)). - Request
UpdatePaymentCommandRequestInputFields
The ID of the payment.
The new amount as a positive number with at most two decimals; a payout stays a payout.
The new date of the payment.
The new payment method.
The new transaction ID; null removes it.
The new note; null removes it.
Whether the payment is a down payment.
The new general ledger account; null removes it.
Whether the payment is left out of the accounting export.
Whether to suppress the workflows this call would start because a sales order or a sales invoice becomes fully paid. Defaults to false when omitted.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?