---
title: "List purchase credit notes"
method: GET
path: "/purchases/credit-notes/"
tags: ["Procurement"]
---

# List purchase credit notes

`GET /purchases/credit-notes/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `purchase` integer
- `document` integer
- `number` integer
- `date` string, date
- `note` string
- `created` string, date-time

## Headers

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

## Response `200`

Paginated purchase-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` PurchaseCreditNote[], required — The items in the current page.
    - `id` integer
    - `purchase` integer, required — Purchase ID being adjusted.
    - `document` integer, required — Credit-note document type.
    - `number` integer, required
    - `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` PurchaseCreditNoteLine[], required
      - `id` integer
      - `name` string, required
      - `description` string, nullable
      - `amount` number, required
      - `quantity` number, required
      - `exempt` boolean
      - `tax` number, nullable
      - `tax_percent` number, nullable
      - `total` number
      - `discount` number, nullable
      - `discount_scheme` '%' | '$', nullable
      - `code` string, nullable
      - `retention` number, nullable
      - `retention_percent` number
    - `created` string, date-time
    - `updated` string, date-time

---

[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)