*REST API › Objects › Finance*

# Credit note

> Credit note: what is refunded to the customer.

A credit note: what is returned to the customer, tied to the invoice it corrects. Its document lifecycle runs from draft to validated to voided, but `status` is a free string: tolerate any value. Only the totals are published; the signed tax document, the tax breakdown, the lines and the reason are not. It shares the scope of invoices.

Schemas: `CreditNoteDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Credit note identifier. |
| `creditNoteNumber` | string | Credit note number; null while it is a draft. |
| `status` | string | Document lifecycle status: draft, validated or voided (the same values the `status` filter takes). `draft`, `validated`, `voided` |
| `issueDate` | string<date-time> | Issue date in ISO 8601 UTC; null if not recorded. |
| `currency` | string | Currency, as an ISO 4217 code. |
| `contactId` | string | Contact the credit note is issued to; null if not recorded. |
| `invoiceId` | string | Invoice this credit note rectifies; null if it is not attached to any. |
| `subTotal` | string | Subtotal before discounts and taxes, as a decimal string. |
| `taxesPrice` | string | Tax total, as a decimal string. |
| `netPrice` | string | Taxable base, as a decimal string. |
| `grossPrice` | string | Total including taxes, as a decimal string. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |

## Values

| Field | Values |
| --- | --- |
| `status` | `draft`, `validated`, `voided` |

## Example

*Credit note · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "creditNoteNumber": "string",
  "status": "draft",
  "issueDate": "2026-09-01T08:00:00Z",
  "currency": "EUR",
  "contactId": "string",
  "invoiceId": "string",
  "subTotal": "1234.50",
  "taxesPrice": "1234.50",
  "netPrice": "1234.50",
  "grossPrice": "1234.50",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Returned by

- [`GET /api/v1/credit-notes`](https://docs.filmo.io/rest-api/endpoint-reference/credit-notes/list-credit-notes) — List credit notes
- [`GET /api/v1/credit-notes/{creditNoteId}`](https://docs.filmo.io/rest-api/endpoint-reference/credit-notes/get-a-credit-note) — Get a credit note

## Modified by

- [`POST /api/v1/credit-notes/{creditNoteId}/validate`](https://docs.filmo.io/rest-api/endpoint-reference/credit-notes/validate-a-credit-note) — Validate a credit note
- [`POST /api/v1/credit-notes/{creditNoteId}/void`](https://docs.filmo.io/rest-api/endpoint-reference/credit-notes/void-a-credit-note) — Void a credit note

---

Canonical URL: https://docs.filmo.io/rest-api/objects/credit-note  
Last updated: 2026-10-25