---
title: "List credit notes"
description: "The credit notes the Credit notes tab lists, newest first, as list rows: credit note number, the invoice and Shopify order it credits, customer, total, and when it was sent or printed. q matches the credit note number an"
url: https://docs.invoicefalcon.com/v3-reference/documents/list-credit-notes/
api: "API v3 reference"
method: GET
path: "/documents/credit_notes"
---

# List credit notes

`GET https://app.invoicefalcon.com/api/v3/external/documents/credit_notes`

The credit notes the Credit notes tab lists, newest first, as list rows: credit note number, the invoice and Shopify order it credits, customer, total, and when it was sent or printed. q matches the credit note number and the credited invoice number. Read-only.

`financial_status` values: `pending` (Payment pending), `authorized` (Authorized), `partially_paid` (Partially paid), `paid` (Paid), `partially_refunded` (Partially refunded), `refunded` (Refunded), `voided` (Voided), `expired` (Expired), `cancelled` (Cancelled).

## Query parameters

- `page` (integer): 1-based page number.
- `per_page` (integer): Rows per page, default 25, max 100.
- `q` (string): Free text over the credit note number, the credited invoice number and the customer email.
- `from` (string): Created on or after this date (ISO 8601).
- `to` (string): Created on or before this date (ISO 8601).

## Returns

- `items` (array of objects, required)
  - `id` (integer): e.g. `980191085`
  - `document_type` (string): e.g. `credit_note`
  - `invoice_number` (string): e.g. `1`
  - `title` (string): e.g. `Credit Note`
  - `order` (object, nullable)
  - `customer` (object)
    - `id` (integer): e.g. `49`
    - `name` (string): e.g. `Customer 1`
    - `email` (string): e.g. `cus1@gmail.com`
  - `financial_status` (string): e.g. `paid`
  - `currency` (string): e.g. `USD`
  - `total` (string): e.g. `1100.22`
  - `issued_on` (string): e.g. `2026-11-10`
  - `due_on` (string, nullable)
  - `sent_at` (string, nullable)
  - `printed_at` (string, nullable)
  - `reminder_sent_at` (string, nullable)
  - `paid` (boolean): e.g. `true`
  - `edited` (boolean): e.g. `false`
  - `trashed` (boolean): e.g. `false`
  - `e_invoice_status` (string, nullable)
  - `created_at` (string): e.g. `2026-11-10T09:56:58Z`
  - `credited` (object)
    - `invoice_number` (string): e.g. `#1001`
    - `invoice_id` (integer): e.g. `980191084`
    - `shopify_order_id` (string): e.g. `gid://shopify/Order/12213474623569`
- `page` (object, required): Offset paging of a list (`page`, `per_page` query params).
  - `number` (integer, required): 1-based page number.
  - `size` (integer, required): Rows per page, max 100.
  - `total` (integer, required): Rows across all pages.
  - `total_pages` (integer, required): e.g. `1`

Rate limit: this call costs 1 point ([rate limits](https://docs.invoicefalcon.com/v3/docs/api-v3/rate-limits/)).

## Example request

```sh
curl "https://app.invoicefalcon.com/api/v3/external/documents/credit_notes" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
```

## 200

One page of rows.

```json
{
  "items": [
    {
      "id": 980191085,
      "document_type": "credit_note",
      "invoice_number": "1",
      "title": "Credit Note",
      "order": null,
      "customer": {
        "id": 49,
        "name": "Customer 1",
        "email": "cus1@gmail.com"
      },
      "financial_status": "paid",
      "currency": "USD",
      "total": "1100.22",
      "issued_on": "2026-11-10",
      "due_on": null,
      "sent_at": null,
      "printed_at": null,
      "reminder_sent_at": null,
      "paid": true,
      "edited": false,
      "trashed": false,
      "e_invoice_status": null,
      "created_at": "2026-11-10T09:56:58Z",
      "credited": {
        "invoice_number": "#1001",
        "invoice_id": 980191084,
        "shopify_order_id": "gid://shopify/Order/12213474623569"
      }
    }
  ],
  "page": {
    "number": 1,
    "size": 25,
    "total": 1,
    "total_pages": 1
  }
}
```

## 401

Missing or unknown `X-Auth-Token`, or the shop uninstalled the app.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "unauthorized"
}
```

## 403

`v3_required`: the shop still runs the previous dashboard. `paid_plan_required`: API access needs a paid plan.

```json
{
  "errors": [
    "API access requires a paid plan"
  ],
  "code": "paid_plan_required"
}
```

## 422

The request failed validation. Nothing was saved.

```json
{
  "errors": [
    "id is missing"
  ]
}
```

## 429

Rate limited: cost-weighted per key (reads cost less than writes). Wait `Retry-After` seconds; see `X-RateLimit-*` headers.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited"
}
```

