# Credit Note (/en/api-reference/objects/credit-note)

A Credit Note lowers the amount of an issued invoice without changing the invoice itself. It first reduces what the customer still owes (prePaymentAmount). Anything beyond that was already paid (postPaymentAmount) and goes back to the customer by a refund, as customer credit, or outside XPay. Refunding a payment of an invoice directly also writes its credit note.

## Fields

- `id` (string, required) — Credit note ID
- `object` (enum("credit_note"), required) — Object type
- `number` (string, required) — Credit note number: the invoice number, then CN and its count on that invoice
- `status` (enum("issued" | "void"), required) — issued or void
- `type` (enum("pre_payment" | "post_payment" | "mixed"), required) — pre_payment, post_payment or mixed
- `invoiceId` (string, required) — Invoice the credit note is for
- `customerId` (string, required) — Customer
- `currency` (enum("EGP" | "USD" | "EUR" | "GBP" | "SAR" | "AED" | "QAR" | "KWD" | "JOD" | "OMR" | "BHD" | "LYD" | "AUD" | "CAD" | "CNY"), required) — Currency, same as the invoice
- `reason` (enum("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory" | "other"), required) — Why it was issued
- `memo` (string | null, required) — Note printed on the credit note
- `effectiveAt` (string, required) — Date the credit takes effect (ISO 8601)
- `lines` (Array<CreditNoteLineItem>, required) — What is credited
  - `id` (string, required) — Credit note line ID
  - `object` (enum("credit_note_line_item"), required) — Object type
  - `type` (enum("invoice_line_item" | "custom_line_item"), required) — invoice_line_item or custom_line_item
  - `invoiceLineItemId` (string | null, required) — The credited invoice line, when type is invoice_line_item
  - `description` (string | null, required) — What is credited
  - `quantity` (number | null, required) — Quantity credited
  - `unitAmount` (integer | null, required) — Price of one unit, in minor units
  - `amount` (integer, required) — Amount credited before tax, in minor units
  - `discountAmount` (integer, required) — Discount credited, in minor units
  - `taxes` (Array<InvoiceTaxAmount>, required) — Tax credited on this line, per rate
    - `amount` (integer, required) — Tax amount in minor units
    - `taxableAmount` (integer, required) — Amount the tax was calculated on, in minor units
    - `taxBehavior` (enum("exclusive" | "inclusive"), required) — exclusive or inclusive
    - `taxRateDetails` (InvoiceTaxRateDetails, required) — The tax rate applied
- `amount` (integer, required) — Total of the credit note, including tax
- `amountShipping` (integer, required) — Shipping credited
- `discountAmount` (integer, required) — Discount credited
- `subtotal` (integer, required) — Total before exclusive tax
- `subtotalExcludingTax` (integer, required) — Total before any tax
- `total` (integer, required) — Total credited, including tax
- `totalExcludingTax` (integer, required) — Total credited before tax
- `totalTaxes` (Array<InvoiceTaxAmount>, required) — Tax credited, per rate
  - `amount` (integer, required) — Tax amount in minor units
  - `taxableAmount` (integer, required) — Amount the tax was calculated on, in minor units
  - `taxBehavior` (enum("exclusive" | "inclusive"), required) — exclusive or inclusive
  - `taxRateDetails` (InvoiceTaxRateDetails, required) — The tax rate applied
    - `taxRateId` (string, required) — Tax rate ID
    - `displayName` (string, required) — Tax name
    - `displayNameAr` (string | null, required) — Arabic tax name
    - `percentage` (number, required) — Tax percentage
- `prePaymentAmount` (integer, required) — Part that lowered what the customer still owed
- `postPaymentAmount` (integer, required) — Part that was already paid and went back: refunded, credited to the customer, or returned outside XPay
- `outOfBandAmount` (integer | null, required) — Returned to the customer outside XPay
- `refunds` (Array<CreditNoteRefund>, required) — Refunds that returned money for this note
  - `refundId` (string, required) — Refund that returned the money
  - `amountRefunded` (integer, required) — Amount of the refund that belongs to this credit note
- `customerBalanceTransactionId` (string | null, required) — Customer balance transaction that gave the customer credit, if any
- `voidedAt` (string | null, required) — When it was voided (ISO 8601)
- `metadata` (object | null, required) — Custom metadata
- `merchantId` (string, required) — Merchant ID
- `createdAt` (string, required) — Created timestamp (ISO 8601)
- `updatedAt` (string, required) — Updated timestamp (ISO 8601)