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

# List credit notes

`GET /api/v1/creditNotes`

Returns a collection with all credit notes.

## Query parameters

- `filter` union
  - object
    - `id` string[]
  - object[]
    - `key` 'search' | 'id' | 'creditNote' | 'date' | 'status' | 'customerName' | 'customerNumber' | 'country' | 'projectId' | 'projectName' | 'projectAbbr' | 'paymentMethod' | 'paymentStatus' | 'amount' | 'currency'
    - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
    - `value` union
      - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
      - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'creditNote' | 'date' | 'customerName' | 'customerNumber' | 'country' | 'project' | 'paymentMethod' | 'amount' | 'currency' | 'paymentStatus' | 'status'
  - `dir` 'asc' | 'desc'

## Response `200`

Operation completed successfully.

## Other responses

- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)