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.

Tool

filmo_credit_notes_get

Readinvoices:read

invoices:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_credit_notes_get",
    "arguments": {
      "creditNoteId": "cred_8f2a1c"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "creditNoteNumber": "<creditNoteNumber>",
      "status": "draft",
      "issueDate": "2026-09-01T08:00:00Z",
      "currency": "EUR",
      "contactId": "cont_8f2a1c",
      "invoiceId": "invo_8f2a1c",
      "subTotal": "1234.50",
      "taxesPrice": "1234.50",
      "netPrice": "1234.50",
      "grossPrice": "1234.50",
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z"
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      },
      "etag": "\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
    }
  }
}

generated from the schema

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

Arguments

creditNoteIdstringRequired

Credit note identifier.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Credit note identifier.

creditNoteNumberstring | null

Credit note number; null while it is a draft.

statusstring

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

Available options: draft, validated, voided

issueDatestring<date-time> | null

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

currencystring

Currency, as an ISO 4217 code.

contactIdstring | null

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

invoiceIdstring | null

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

subTotalstring

Subtotal before discounts and taxes, as a decimal string.

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

taxesPricestring

Tax total, as a decimal string.

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

netPricestring

Taxable base, as a decimal string.

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

grossPricestring

Total including taxes, as a decimal string.

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

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/credit-notes/{creditNoteId}.

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.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Get a credit note

Safe writes

Errors