---
title: "List debit notes"
method: GET
path: "/v1/erp/payouts/debit_notes"
tags: ["Debit Note"]
---

# List debit notes

`GET /v1/erp/payouts/debit_notes`

## Request

- Base URL: `https://api.cardda.com`
- URL: `https://api.cardda.com/v1/erp/payouts/debit_notes`
- Auth: HTTP bearer

Returns a paginated list of the company's debit notes (notas de débito). The listing
scopes to records whose document type is a debit-note type and whose STI class is
`Erp::Payouts::DebitNote` or `Erp::Payouts::Payable`. Each entry embeds its
`counterpart_company`, `business_partner`, `linked_tradable`, `source`, and its `type`.
The internal `embedding` vector is always omitted.

## Parameters

- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/1` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/2` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/3` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/4` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1reviews/get/parameters/5` (unresolved $ref)

## Response `200`

Paginated list of debit notes (default 25 per page).

- DebitNote[]
  - `id` string, uuid, required
  - `company_id` string, uuid, required
  - `type` string: STI class, one of `Erp::Payouts::DebitNote` or `Erp::Payouts::Payable` (a debit note that has already been converted into a payable). Serialized via the `type` method.
  - `amount` integer
  - `currency` string
  - `document_type` integer: SII document type code (see the document_types mapping).
  - `source_type` string, nullable
  - `source_id` string, nullable
  - `counterpart_company_id` string, uuid, nullable
  - `business_partner_id` string, uuid, nullable
  - `linked_tradable_id` string, uuid, nullable
  - `description` string, nullable
  - `review_status` string, nullable
  - `payment_status` string, nullable
  - `due_date` string, date-time, nullable
  - `issue_date` string, date-time, nullable
  - `payment_date` string, date-time, nullable
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `counterpart_company` object, nullable: Included in the `index` response.
  - `business_partner` object, nullable: Included in the `index` response.
  - `linked_tradable` object, nullable: Included in the `index` response.
  - `source` object, nullable: Included in the `index` response.

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/cardda/apis/erp-api.md) - [All operations](https://skmtc.dev/cardda/apis/erp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cardda/apis/erp-api/revisions/0730ed26bc3c?raw)