---
title: "List credit notes"
method: GET
path: "/creditnotes/"
tags: ["Billing"]
---

# List credit notes

`GET /creditnotes/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `invoice` string
- `document` integer
- `number` integer
- `date` string, date
- `status` 'draft' | 'finalized' | 'cancelled'
- `note` string
- `created` string, date-time
- `expand` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated credit-note list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` CreditNote[], required — The items in the current page.
    - `id` integer
    - `invoice` string, required — Invoice ID this credit note adjusts.
    - `document` integer, nullable — Credit-note document type. Optional; the biller may assign one at finalize.
    - `number` integer
    - `date` string, date, required
    - `note` string, nullable
    - `internal_note` string, nullable
    - `amount` number, nullable
    - `exempt` number, nullable
    - `tax` number, nullable
    - `tax_percent` number, nullable
    - `subtotal` number, nullable
    - `total` number, nullable
    - `retention` number, nullable
    - `discount` number, nullable
    - `discount_scheme` '%' | '$', nullable
    - `status` 'draft' | 'finalized' | 'cancelled'
    - `biller_status` string
    - `tax_agency` object
    - `local_file` string, uri, nullable
    - `imported` boolean
    - `test_mode` boolean
    - `lines` CreditNoteLine[]
      - `id` integer
      - `name` string, required
      - `description` string, nullable
      - `amount` number, required
      - `quantity` number, required
      - `exempt` boolean, required
      - `tax` number, nullable
      - `tax_percent` number, nullable
      - `total` number
      - `discount` number, nullable
      - `discount_scheme` '%' | '$', nullable
      - `code` string, nullable
      - `code_scheme` string, nullable
      - `retention` number, nullable
      - `retention_percent` number
      - `retention_scheme` 'subtotal' | 'tax'
    - `created` string, date-time
    - `updated` string, date-time

## Other responses

- `401` — Authentication credentials missing or invalid.

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/versions/70cbc827dc7b/schema)