> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Refund

> Money the ERP pays back to a customer through a payment account. Creating it books a payout on the sales document at once.



**Kind**: `object`

## Fields

**`id`**: `ID!`

The ID of the refund.

---

**`status`**: `RefundStatus!`

Where the refund stands.

---

**`method`**: `RefundMethod!`

How the refund moves the money.

---

**`amount`**: `Decimal!`

The amount paid back, positive, with two decimals.

---

**`currencyCode`**: `String!`

The currency of the amount (ISO 4217).

---

**`paymentAccountId`**: `ID!`

The payment account that carries out the refund.

---

**`customerId`**: `ID`

The customer who gets the money.

---

**`salesInvoiceCorrectionId`**: `ID`

The sales invoice correction the refund pays out. Empty for a sales credit note, and after the correction is cancelled.

---

**`salesCreditNoteId`**: `ID`

The sales credit note the refund pays out. Empty after the credit note is cancelled; its payout then has no document.

---

**`salesOrderId`**: `ID`

The sales order the refund belongs to, through its payout or its invoice correction. Empty for a sales credit note.

---

**`payoutPaymentId`**: `ID`

The payout the refund booked on the sales document. Empty without a document; GetPayment no longer finds it once the credit note is cancelled.

---

**`refundedPaymentId`**: `ID`

The earlier payment that is refunded.

---

**`refundedPaymentTransactionId`**: `ID`

The earlier incoming payment transaction that is refunded. Set exactly when 'method' is 'PaymentTransaction'.

---

**`confirmingPaymentTransactionId`**: `ID`

The outgoing transaction of the payment provider or the bank that carries out the refund, once it is imported and matched.

---

**`recipientName`**: `String!`

The name of the recipient.

---

**`recipientAccount`**: `String`

The account of the recipient: the IBAN for a bank transfer, otherwise the account at the payment provider as far as it is known, for example an e-mail address.

---

**`recipientBic`**: `String`

The BIC of the recipient's bank.

---

**`paymentReference`**: `String!`

The text the recipient sees with the money.

---

**`internalNote`**: `String`

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

---

**`providerTransactionId`**: `String`

The ID the payment provider gave the refund when it accepted it. Banks return none.

---

**`lastErrorMessage`**: `String`

The message of the last failed attempt to send the refund.

---

**`lastErrorAt`**: `DateTime`

When the last attempt to send the refund failed.

---

**`createdAt`**: `DateTime!`

When the refund was created.

---

**`createdBy`**: `ID`

The user who created the refund.

---

**`sentAt`**: `DateTime`

When the refund was sent successfully.

---

**`sentBy`**: `ID`

The user who sent the refund.