Skip to main content
inputCreateSalesCreditNoteRefundCommandRequestInput

Fields

salesCreditNoteId
ID!
required

The ID of the sales credit note. A sales invoice correction ID fails as not found.

amount
Decimal!
required

The amount to pay back, greater than 0, with at most two decimals. At most what the proposal allows.

execution

How the money is moved: bank transfer only. The payment transaction variant fails with REFUND_EXECUTION_NOT_SUPPORTED.

paymentReference
String

The text the recipient sees with the money. Omitted means a text naming the document. Bank transfers carry at most 140 characters of it.

internalNote
String

An internal note that is not sent to the payment provider or the bank.

idempotencyKey
String

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.