---
title: "Lister les avoirs"
method: GET
path: "/credit-notes"
tags: ["CreditNotes"]
---

# Lister les avoirs

`GET /credit-notes`

## Request

- Base URL: `https://api.swipify.fr/api/v1`
- URL: `https://api.swipify.fr/api/v1/credit-notes`
- Auth: API key in header `X-API-Key`

Avoirs émis par l'organisation, paginés. Scope requis : `creditnotes:read`.

## Query parameters

- `page` integer
- `pageSize` integer
- `status` 'draft' | 'validated' | 'sent' | 'refunded'
- `dateFrom` string, date
- `dateTo` string, date
- `clientId` integer
- `sortOrder` 'asc' | 'desc'

## Response `200`

Liste paginée d'avoirs

- object
  - `data` CreditNote[]
    - `id` integer
    - `number` string, nullable
    - `draftNumber` string, nullable
    - `status` string
    - `creditType` string, nullable
    - `creditReason` string, nullable
    - `originalInvoiceId` integer, nullable
    - `originalInvoiceNumber` string, nullable
    - `date` string, date-time, nullable
    - `totalHT` string
    - `totalVAT` string
    - `totalTTC` string
    - `einvoiceStatus` 'pending' | 'delivered' | 'accepted' | 'rejected' | 'paid' | 'reported' | 'error' | 'null', nullable: Statut de cycle de vie e-invoice (PA). null si pas de cycle (brouillon/non conforme). `rejected` = refusée par la plateforme. `reported` = vente à un particulier, transmise en e-reporting : pas d'e-facture, donc ni remise ni acceptation client.
    - `createdAt` string, date-time
  - `pagination` Pagination
    - `page` integer
    - `pageSize` integer
    - `totalCount` integer
    - `totalPages` integer: Nombre total de pages (ceil(totalCount / pageSize)).
    - `hasMore` boolean: true s'il existe une page suivante (page < totalPages).

## Other responses

- `401`: Échec d'authentification : clé API manquante (`missing_api_key`) ou invalide/révoquée/expirée (`invalid_api_key`). Le client doit présenter une clé valide.
- `403`: Clé authentifiée mais non autorisée : scope insuffisant pour cette route (`scope_required`), ou organisation sans abonnement Pro actif (`pro_required`). `GET /me` reste accessible sans Pro pour diagnostiquer la clé.
- `429`: Trop de requêtes (quota de la clé API, ou de l'organisation pour les analyses de document, dépassé pour la fenêtre courante)

---

[API](https://skmtc.dev/swipify/apis/swipify-api-publique.md) · [All operations](https://skmtc.dev/swipify/apis/swipify-api-publique/llms.txt) · [OpenAPI document](https://skmtc.dev/swipify/apis/swipify-api-publique/revisions/44c17201b479?raw)