---
title: "List credit notes"
method: GET
path: "/credit-notes"
tags: ["Credit Notes"]
---

# List credit notes

`GET /credit-notes`

## Request

- Base URL: `https://app-sandbox.resolvepay.com/api`
- URL: `https://app-sandbox.resolvepay.com/api/credit-notes`
- Auth: one of:
  - HTTP bearer
  - HTTP basic
- TypeScript: <https://skmtc.dev/resolvepay/apis/resolve-api-reference/docs/credit-notes/get.ts> (a function with typed inputs; its response is checked against the schema)

Return a list of credit notes.

## Query parameters

- `limit` integer
- `page` string
- `filter` object
  - `number` object
    - `eq` string
  - `customer_id` object
    - `eq` string
  - `invoice_id` object
    - `eq` string
  - `payment_id` object
    - `eq` string
  - `amount` object
    - `eq` number
    - `gt` number
    - `lt` number
    - `gte` number
    - `lte` number
  - `amount_balance` object
    - `eq` number
    - `gt` number
    - `lt` number
    - `gte` number
    - `lte` number
  - `amount_paid` object
    - `eq` number
    - `gt` number
    - `lt` number
    - `gte` number
    - `lte` number
- `sort` 'id' | '-id' | 'created_at' | '-created_at' | 'amount' | '-amount' | 'amount_balance' | '-amount_balance'

## Response `200`

A paginated list of credit notes.

- CreditNoteListResponse
  - `count` integer
  - `limit` integer
  - `page` integer
  - `results` CreditNote[]
    - `id` string: Unique identifier for the credit note.
    - `source` 'MERCHANT_USER' | 'ADMIN_USER' | 'API': Source of the credit note creation.
    - `customer_id` string: ID of the customer associated with the credit note.
    - `merchant_id` string: ID of the merchant.
    - `invoice_id` string: ID of the invoice this credit note is associated with.
    - `created_by_user_id` string: ID of the user who created the credit note.
    - `number` string: Credit note number identifier.
    - `amount` number, double: Total amount of the credit note.
    - `amount_balance` number, double: Remaining balance to be applied.
    - `amount_paid` number, double: Amount that has been applied/paid out.
    - `amount_voided` number, double: Amount that has been voided.
    - `amount_payout` number, double: Total payout amount for the credit note.
    - `amount_payout_balance` number, double: Remaining payout balance.
    - `amount_payout_paid` number, double: Amount that has been paid out.
    - `credit_note_url` string: The credit note PDF that you've uploaded to Resolve.
    - `resolve_credit_note_url` string: Resolve-issued credit note PDF.
    - `reason_code` 'chargeback' | 'duplicate' | 'fraudulent' | 'requested_by_customer' | 'missing_remittance' | 'overpayment_on_invoice' | 'invoice_was_refunded' | 'double_payment_on_invoice' | 'missing_invoice_in_resolve' | 'credit_transfer' | 'other': The reason code for issuing this credit note.
    - `reason_message` string: Additional details explaining the reason for the credit note.
    - `voided` boolean: Indicates whether the credit note is voided.
    - `voided_at` string, date-time: Date the credit note was voided.

## Other responses

- `400`: Bad request error
- `401`: Unauthorized error
- `429`: Rate limit error

---

[API](https://skmtc.dev/resolvepay/apis/resolve-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-api-reference/revisions/c62edc454aaa?raw)