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

# List credit notes

`GET /v1/credit-notes`

## Request

- Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from)
- URL: `https://light.inc/v1/credit-notes`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer

Returns a paginated list of credit notes

## Query parameters

- `sort` string: Sort string in the format `field:direction`. To provide multiple sort fields, separate them with commas. Available directions: `asc`, `desc`. Available fields: `amount`, `businessPartnerName`, `status`, `documentDate`.
- `filter` string: Filter string in the format `field:operator:value`. To provide multiple filters, separate them with commas. Available operators: `eq`, `ne`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`. - For `in` and `not_in` operators, provide multiple values separated by the pipe character (`|`). Available fields: `businessPartnerId`, `status`, `companyEntityId`, `documentDate`, `toBeAdjustedAccDocType`, `updatedAt`.
- `limit` integer
- `offset` integer
- `cursor` string

## Response `default`

default response

- ExternalPaginatedResponseV1ModelExternalCreditNoteV1Model
  - `records` ExternalCreditNoteV1Model[]: List of records for the current page
    - `id` string, uuid: Unique identifier for the object
    - `companyId` string, uuid: ID of the company
    - `companyEntityId` string, uuid, nullable: ID of the entity
    - `amount` integer, nullable: Total credit note amount in cents
    - `businessPartnerName` string, nullable: Name of the vendor
    - `businessPartnerId` string, uuid, nullable: ID of the vendor
    - `status` 'DRAFT' | 'APPROVAL_PENDING' | 'APPROVED' | 'POSTED' | 'PARTIALLY_CLEARED' | 'CLEARED' | 'ARCHIVED': Status of the credit note ⚠️ This enum is not exhaustive; new values may be added in the future.
    - `description` string, nullable: Description of the credit note
    - `currency` string
    - `postingDate` string, date, nullable: Date when the credit note should be posted to the ledger
    - `documentDate` string, date, nullable: Date when the credit note was issued
    - `valuationDate` string, date, nullable: Date used when applying foreign exchange rate
    - `areLinesWithTax` boolean: Whether the credit note line amount is inclusive of tax or not. True means tax is already included in the line amount and will not be added on top, false means tax will be added on top of the line amount
    - `lines` ExternalCreditNoteLineV1Model[]: List of credit note line items
      - `id` string, uuid: Unique identifier for the object
      - `companyId` string, uuid: ID of the company
      - `creditNoteId` string, uuid: ID of the credit note this line belongs to
      - `grossTransactionAmount` DirectedAmount
        - `amount` integer
        - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
      - `netTransactionAmount` DirectedAmount
        - `amount` integer
        - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
      - `description` string, nullable: Description of the credit note line item
      - `ledgerTaxId` string, uuid, nullable: ID of the tax code
      - `taxTransactionAmount` DirectedAmount
        - `amount` integer
        - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
      - `ledgerAccountId` string, uuid, nullable: ID of the ledger account
      - `costCenterId` string, uuid, nullable: ID of the cost center
      - `createdAt` string, date-time: Timestamp when the credit note line item was created
      - `updatedAt` string, date-time: Timestamp when the credit note line item was last updated
      - `accrualTemplateId` string, uuid, nullable: ID of the accrual template
      - `accrualStartDate` string, date, nullable: Start date for accrual
      - `accrualEndDate` string, date, nullable: End date for accrual
      - `accrualDefaultDuration` integer, nullable: Default duration for accrual in months
    - `createdAt` string, date-time: Timestamp when the credit note was created
    - `updatedAt` string, date-time: Timestamp when the credit note was last updated
    - `updatedBy` string, uuid, nullable: ID of the user who last updated the credit note
    - `localCurrencyFxRate` number, nullable: FX rate applied for the ledger's local currency
    - `groupCurrencyFxRate` number, nullable: FX rate applied for the ledger's group currency
    - `senderEmail` string, nullable: The email of the user who sent the document that this credit note was created from
    - `documentName` string, nullable: The name of the document that this credit note was created from
  - `hasMore` boolean: Boolean flag indicating if there are more records available
  - `total` integer, nullable: Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.
  - `nextCursor` string, nullable: Cursor for fetching the next page (only for cursor pagination)
  - `prevCursor` string, nullable: Cursor for fetching the previous page (only for cursor pagination)

---

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