Credit notes

Get a credit note

Returns a credit note by its identifier: what is refunded to the customer and against which invoice, the same card as GET /api/v1/credit-notes.

GET

/api/v1/credit-notes/{creditNoteId}

curl https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "credit_note_9f3a2b",
    "creditNoteNumber": "2026-0001",
    "status": "draft",
    "issueDate": "2026-09-01T08:00:00.000Z",
    "currency": "EUR",
    "contactId": "contact_9f3a2b",
    "invoiceId": "invoice_9f3a2b",
    "subTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// No body.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "invoices:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

The signed tax document, the tax breakdown, the lines and the reason for the correction are not published.

Authorizations

Bearer API key with the scope below. invoices:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

creditNoteIdstringRequired

Credit note identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: CreditNoteDto

Envelope: CreditNoteResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Credit note: what is refunded to the customer. The signed fiscal document, the tax breakdown and the lines are not published.

Show child attributes

data.idstring

Credit note identifier.

data.creditNoteNumberstring | null

Credit note number; null while it is a draft.

data.statusstring

Document lifecycle status: draft, validated or voided (the same values the status filter takes).

Available options: draft, validated, voided

data.issueDatestring<date-time> | null

Issue date in ISO 8601 UTC; null if not recorded.

data.currencystring

Currency, as an ISO 4217 code.

data.contactIdstring | null

Contact the credit note is issued to; null if not recorded.

data.invoiceIdstring | null

Invoice this credit note rectifies; null if it is not attached to any.

data.subTotalstring

Subtotal before discounts and taxes, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

data.taxesPricestring

Tax total, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

data.netPricestring

Taxable base, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

data.grossPricestring

Total including taxes, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

data.createdAtstring<date-time>

Creation date in ISO 8601 UTC.

data.updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
404	`not_found`	It does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Finance
Credit note
Credit note: what is refunded to the customer.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Response

Errors

Deprecation

Related

Related pages

Credit note