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

# List credit notes

`GET /credit_notes`

## Request

- Base URL: `https://api.upflow.io/v1`
- URL: `https://api.upflow.io/v1/credit_notes`
- Auth: API key in header `X-Api-Key` and API key in header `X-Api-Secret`

List credit notes with optional filtering.

## Query parameters

- `offset` integer
- `page` integer
- `limit` integer
- `customer.id` string
- `customer.externalId` string
- `updatedAt` RangeQueryUpdateSpecs: Only return entities that were updated during the given date range. (ISO 8601 format)
  - `updatedAt.gt` string, date-time: Minimum value to filter by (exclusive)
  - `updatedAt.gte` string, date-time: Minimum value to filter by (inclusive)
  - `updatedAt.lt` string, date-time: Maximum value to filter by (exclusive)
  - `updatedAt.lte` string, date-time: Maximum value to filter by (inclusive)
- `customId` string

## Response `200`

Paginated list of credit notes.

- CreditNotesListResponse
  - `offset` integer: 0-based index of the first item returned. Returned when using offset-based pagination or by default.
  - `page` integer: Page number (1-based). Returned when using page-based pagination.
  - `limit` integer, required: Maximum number of items returned.
  - `total` integer, required: Total items in the set.
  - `items` CreditNote[], required
    - `customId` string, required: Credit note custom identifier (e.g., document number).
    - `externalId` string: Credit note external identifier.
    - `issuedAt` string, date-time: The date at which the credit note was issued (ISO 8601 format).
    - `dueDate` string, date-time: The date when the credit note is due (ISO 8601 format). Often same as issuedAt.
    - `name` string: The credit note name or description.
    - `currency` 'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP', required: ISO 4217 Currency Code
    - `grossAmount` integer, required: Amount including taxes (in cents).
    - `netAmount` integer, required: Amount net of taxes (in cents).
    - `updatedAt` string, date-time: The date at which the credit note was last updated (ISO 8601 format).
    - `id` string, uuid, required: The Credit Note ID.
    - `pdfUrl` string, uri, nullable: URL to the credit note PDF.
    - `customer` CustomerLite, required: Minimal customer information.
      - `id` string, uuid, required: The Customer ID.
      - `externalId` string: An external ID that uniquely references the customer.
      - `companyName` string, required: Customer name.
      - `accountingRef` string: (Deprecated) Customer accounting reference (used in accounting tool). Use a custom field instead.
    - `linkedInvoices` LinkedInvoice[], required: The list of invoices linked to this credit note.
      - `amountLinked` integer, required: Amount allocated to the invoice (in cents).
      - `invoice` InvoiceLite, required: Minimal invoice information.
        - `id` string, uuid, required: The Invoice ID.
        - `currency` 'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP', required: ISO 4217 Currency Code
        - `status` 'DUE' | 'OVERDUE' | 'PAID' | 'WRITTEN_OFF' | 'DISPUTED', required: Status of the invoice.
        - `amountOutstanding` integer, required: Outstanding amount (in cents).
        - `customId` string: Invoice custom identifier.
        - `grossAmount` integer, required: Amount including taxes (in cents).
        - `netAmount` integer, required: Amount net of taxes (in cents).
        - `name` string: The invoice name or description.
        - `issuedAt` string, date-time, required: The date at which the invoice was issued (ISO 8601 format).
        - `dueDate` string, date-time, required: The date when the invoice is due (ISO 8601 format).
        - `paidDate` string, date-time, nullable: The date when the invoice was paid (ISO 8601 format).
        - `externalId` string: Invoice external identifier.
    - `createdAt` string, date-time: The date at which the credit note was created (ISO 8601 format).

---

[API](https://skmtc.dev/upflow/apis/upflow-api.md) - [All operations](https://skmtc.dev/upflow/apis/upflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upflow/apis/upflow-api/revisions/898a98ca0587?raw)