Invoices

Void an invoice

Voids a VALIDATED invoice with a reason, which is required and is kept.

Tool

filmo_invoices_void

Destructiveinvoices:write

invoices:write
120/min
Server annotation: Destructive
Requires human confirmation
Not reversible

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_invoices_void",
    "arguments": {
      "invoiceId": "invo_8f2a1c",
      "reason": "<reason>"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "invoiceNumber": "<invoiceNumber>",
      "status": "draft",
      "isRectification": true,
      "invoiceDate": "2026-09-01T08:00:00Z",
      "dueDate": "2026-09-01T08:00:00Z",
      "currency": "EUR",
      "contact": {
        "id": "id_8f2a1c",
        "name": "Example"
      },
      "orderId": "orde_8f2a1c",
      "orderNumber": "<orderNumber>",
      "projectId": "proj_8f2a1c",
      "subTotal": "1234.50",
      "discountTotal": "1234.50",
      "taxesPrice": "1234.50",
      "netPrice": "1234.50",
      "grossPrice": "1234.50",
      "totalPaid": "1234.50",
      "paymentStatus": "unpaid",
      "paymentMethod": "<paymentMethod>",
      "tags": [
        {
          "id": "id_8f2a1c",
          "name": "Example"
        }
      ],
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z",
      "projectName": "Example",
      "taxBreakdown": [
        {
          "taxType": "1234.50",
          "label": "Example",
          "rate": 1,
          "baseAmount": "1234.50",
          "amount": "1234.50"
        }
      ],
      "productDiscountTotal": "1234.50",
      "globalDiscountTotal": "1234.50",
      "insuranceTotal": "1234.50",
      "depositTotal": "1234.50",
      "exchangeRate": 1,
      "billingAddress": {
        "label": "Example",
        "addressLine1": "<addressLine1>",
        "addressLine2": "<addressLine2>",
        "city": "<city>",
        "province": "<province>",
        "postcode": "<postcode>",
        "country": "ES"
      },
      "sourceQuoteIds": [
        "sour_8f2a1c"
      ],
      "sourceProformaIds": [
        "sour_8f2a1c"
      ]
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

Not reversible

Voiding takes the document to voided, and no operation undoes it.

Requires human confirmation

Put this tool on your client's “ask before running” list. The annotations are hints that the server declares, not guarantees: do not decide the approval from destructiveHint alone. The server flags this tool with _meta["anthropic/requiresUserInteraction"], which clients that honor it use to ask a person before every call.

The invoice keeps its number —voiding does not release the numbering, which is what keeps the series continuous— and moves to voided. Only from validated: a draft is deleted from the application, not voided. It does NOT issue any credit note: if money has to be refunded, that is another document. Returns the full invoice, the same projection as its GET.

Arguments

invoiceIdstringRequired

Invoice identifier.

Limits: min length 1

reasonstringRequired

Reason for voiding. It is stored on the invoice and in its history.

Limits: min length 1, max length 500

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

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

Unique invoice identifier.

invoiceNumberstring | null

Invoice number; null while it is a draft (the number is assigned on validation).

statusstring

Document lifecycle status: draft, validated (validated and numbered) or voided.

Available options: draft, validated, voided

isRectificationboolean

Whether the invoice rectifies a previous one. Invoices created in Filmo are never rectifications, and credit notes are served by /api/v1/credit-notes; but /api/v1/invoices can still return imported rectifying documents (for example from a Rentman import) with this set to true, so deduplicate them against the credit notes by number.

invoiceDatestring<date-time> | null

Issue date in ISO 8601 with offset; null while it is a draft.

dueDatestring<date-time> | null

Due date in ISO 8601 with offset; null if not set.

currencystring

Invoice currency as an ISO 4217 code (for example "EUR").

contactobject | null

Compact reference to the invoiced contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

orderIdstring | null

Identifier of the source order; null if the invoice does not come from an order.

orderNumberstring | null

Number of the source order; null if the invoice does not come from an order.

projectIdstring | null

Identifier of the linked project; null if not linked.

subTotalstring

Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).

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

discountTotalstring

Total discounts as a decimal string "1234.50" (ROUND_HALF_UP).

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

taxesPricestring

Tax total as a decimal string "1234.50" (ROUND_HALF_UP).

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

netPricestring

Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP).

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

grossPricestring

Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP).

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

totalPaidstring | null

Amount collected to date as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded.

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

paymentStatusstring

Payment status: unpaid (nothing collected yet, also for invoices without a recorded collection), partially_paid, paid, overpaid (collected above the total), overdue (past due and unpaid) or voided (the document is voided, whatever was collected before). The paymentStatus filter uses the same values.

Available options: unpaid, partially_paid, paid, overpaid, overdue, voided

paymentMethodstring | null

Payment method of the invoice; null if not recorded.

tagsobject[]

Tags attached to the invoice, with their identifier and name.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

projectNamestring | null

Name of the linked project; null if not linked.

taxBreakdownobject[] | null

Tax breakdown by type; null if not calculated.

Show child attributes

taxBreakdown.taxTypestring

Tax type key (for example "IVA_21").

taxBreakdown.labelstring

Human-readable tax label.

taxBreakdown.ratenumber

Tax rate applied, as a percentage (for example 21 for 21%).

taxBreakdown.baseAmountstring

Taxable base the tax is applied to, as a decimal string "1234.50" (ROUND_HALF_UP).

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

taxBreakdown.amountstring

Tax amount as a decimal string "1234.50" (ROUND_HALF_UP).

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

productDiscountTotalstring

Total discounts applied at product level, as a decimal string "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.

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

globalDiscountTotalstring

Global discount total of the document, as a decimal string "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.

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

insuranceTotalstring

Insurance total as a decimal string "1234.50" (ROUND_HALF_UP).

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

depositTotalstring

Deposit total as a decimal string "1234.50" (ROUND_HALF_UP).

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

exchangeRatenumber | null

Exchange rate applied when the currency differs from the base currency; null if not applicable.

billingAddressobject | null

Billing address; null if not recorded.

Show child attributes

billingAddress.labelstring | null

Descriptive label of the address; null if not recorded.

billingAddress.addressLine1string | null

First address line; null if not recorded.

billingAddress.addressLine2string | null

Second address line; null if not recorded.

billingAddress.citystring | null

City; null if not recorded.

billingAddress.provincestring | null

Province or region; null if not recorded.

billingAddress.postcodestring | null

Postal code; null if not recorded.

billingAddress.countrystring | null

Country; null if not recorded.

sourceQuoteIdsstring[] | null

Identifiers of the source quotes; null if the invoice does not come from quotes.

sourceProformaIdsstring[] | null

Identifiers of the source proformas; null if the invoice does not come from proformas.

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 POST /api/v1/invoices/{invoiceId}/void.

Invoices
Void an invoice
Voids a VALIDATED invoice with a reason, which is required and is kept.
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

Void an invoice

Safe writes

Errors