Skip to main content
Glama

Update invoice (draft)

update_invoice

Update fields of a Draft invoice (dates, payment terms, notes, or reassign the company). Only Draft invoices can be modified - a Sent/certified invoice is immutable.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
notesNoNotes printed on the invoice (max 2000 characters); null to clear.
due_dateNoNew due date, YYYY-MM-DD, on or after issue_date.
company_idNoReassign the invoice to another company UUID (the client snapshot is rebuilt); null to detach.
invoice_idYesThe Draft invoice UUID.
issue_dateNoNew issue date, YYYY-MM-DD.
payment_termsNoNew payment terms printed on the invoice.
internal_notesNoPrivate notes never printed (max 2000 characters); null to clear.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesInvoice UUID.
typeYesDocument type: invoice, credit_note, provision or quote.
notesYesNotes printed on the document.
statusYesDocument status: Draft, Sent, Paid, Overdue, Cancelled, Rectified, Accepted, Rejected or Expired.
paid_atYesPayment timestamp (ISO 8601), null while unpaid.
sent_atYesIssue timestamp (ISO 8601), null while Draft.
currencyYesISO 4217 currency code (EUR, USD, GBP or CHF).
due_dateYesDue date, YYYY-MM-DD.
matter_idYesMatter (dossier) UUID, null when unassigned.
net_totalYesTotal excl. VAT, in the document currency.
tax_totalYesVAT amount, in the document currency.
amount_dueYesGross total minus applied provisions, null when not computed.
company_idYesClient company UUID.
created_atYesCreation timestamp (ISO 8601).
issue_dateYesIssue date, YYYY-MM-DD.
updated_atYesLast update timestamp (ISO 8601).
gross_totalYesTotal incl. VAT, in the document currency.
valid_untilYesQuote validity limit, YYYY-MM-DD; null for other types.
vat_scenarioYesFiscal scenario frozen at creation (e.g. domestic, eu_b2b_reverse_charge).
payment_termsYesPayment terms: Net-15, Net-30, Net-60, Net-90 or Due on Receipt.
advances_totalYesSum of provisions applied, in the document currency.
created_sourceYesOrigin of the document: manual (app) or mcp (agent).
credit_note_idYesCredit note UUID that cancelled this invoice.
internal_notesYesPrivate notes, never printed.
invoice_numberYesHuman-readable document number.
invopop_statusYesFiscal certification status from the provider, null before issuance.
source_quote_idYesQuote UUID this invoice was converted from.
delivery_channelYesDelivery channel: Email, e-Invoice or Manual.
replaces_invoice_idYesOriginal invoice UUID when this is a rectificative.
replaced_by_invoice_idYesRectificative UUID when this invoice was rectified.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • addedInput schema / properties / company_id / description
      Added value: +"Reassign the invoice to another company UUID (the client snapshot is rebuilt); null to detach."
    • addedInput schema / properties / due_date / description
      Added value: +"New due date, YYYY-MM-DD, on or after issue_date."
    • addedInput schema / properties / internal_notes / description
      Added value: +"Private notes never printed (max 2000 characters); null to clear."
    • addedInput schema / properties / invoice_id / description
      Added value: +"The Draft invoice UUID."
    • addedInput schema / properties / issue_date / description
      Added value: +"New issue date, YYYY-MM-DD."
    • addedInput schema / properties / notes / description
      Added value: +"Notes printed on the invoice (max 2000 characters); null to clear."
    • addedInput schema / properties / payment_terms / description
      Added value: +"New payment terms printed on the invoice."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "advances_total": {
      +      "description": "Sum of provisions applied, in the document currency.",
      +      "type": "number"
      +    },
      +    "amount_due": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Gross total minus applied provisions, null when not computed."
      +    },
      +    "company_id": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Client company UUID."
      +    },
      +    "created_at": {
      +      "description": "Creation timestamp (ISO 8601).",
      +      "type": "string"
      +    },
      +    "created_source": {
      +      "description": "Origin of the document: manual (app) or mcp (agent).",
      +      "type": "string"
      +    },
      +    "credit_note_id": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Credit note UUID that cancelled this invoice."
      +    },
      +    "currency": {
      +      "description": "ISO 4217 currency code (EUR, USD, GBP or CHF).",
      +      "type": "string"
      +    },
      +    "delivery_channel": {
      +      "description": "Delivery channel: Email, e-Invoice or Manual.",
      +      "type": "string"
      +    },
      +    "due_date": {
      +      "description": "Due date, YYYY-MM-DD.",
      +      "type": "string"
      +    },
      +    "gross_total": {
      +      "description": "Total incl. VAT, in the document currency.",
      +      "type": "number"
      +    },
      +    "id": {
      +      "description": "Invoice UUID.",
      +      "type": "string"
      +    },
      +    "internal_notes": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Private notes, never printed."
      +    },
      +    "invoice_number": {
      +      "description": "Human-readable document number.",
      +      "type": "string"
      +    },
      +    "invopop_status": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Fiscal certification status from the provider, null before issuance."
      +    },
      +    "issue_date": {
      +      "description": "Issue date, YYYY-MM-DD.",
      +      "type": "string"
      +    },
      +    "matter_id": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Matter (dossier) UUID, null when unassigned."
      +    },
      +    "net_total": {
      +      "description": "Total excl. VAT, in the document currency.",
      +      "type": "number"
      +    },
      +    "notes": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Notes printed on the document."
      +    },
      +    "paid_at": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Payment timestamp (ISO 8601), null while unpaid."
      +    },
      +    "payment_terms": {
      +      "description": "Payment terms: Net-15, Net-30, Net-60, Net-90 or Due on Receipt.",
      +      "type": "string"
      +    },
      +    "replaced_by_invoice_id": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Rectificative UUID when this invoice was rectified."
      +    },
      +    "replaces_invoice_id": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Original invoice UUID when this is a rectificative."
      +    },
      +    "sent_at": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Issue timestamp (ISO 8601), null while Draft."
      +    },
      +    "source_quote_id": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Quote UUID this invoice was converted from."
      +    },
      +    "status": {
      +      "description": "Document status: Draft, Sent, Paid, Overdue, Cancelled, Rectified, Accepted, Rejected or Expired.",
      +      "type": "string"
      +    },
      +    "tax_total": {
      +      "description": "VAT amount, in the document currency.",
      +      "type": "number"
      +    },
      +    "type": {
      +      "description": "Document type: invoice, credit_note, provision or quote.",
      +      "type": "string"
      +    },
      +    "updated_at": {
      +      "description": "Last update timestamp (ISO 8601).",
      +      "type": "string"
      +    },
      +    "valid_until": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Quote validity limit, YYYY-MM-DD; null for other types."
      +    },
      +    "vat_scenario": {
      +      "description": "Fiscal scenario frozen at creation (e.g. domestic, eu_b2b_reverse_charge).",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "invoice_number",
      +    "type",
      +    "status",
      +    "company_id",
      +    "matter_id",
      +    "issue_date",
      +    "due_date",
      +    "valid_until",
      +    "currency",
      +    "payment_terms",
      +    "delivery_channel",
      +    "net_total",
      +    "tax_total",
      +    "gross_total",
      +    "advances_total",
      +    "amount_due",
      +    "notes",
      +    "internal_notes",
      +    "paid_at",
      +    "sent_at",
      +    "invopop_status",
      +    "vat_scenario",
      +    "source_quote_id",
      +    "replaces_invoice_id",
      +    "replaced_by_invoice_id",
      +    "credit_note_id",
      +    "created_source",
      +    "created_at",
      +    "updated_at"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description transparently indicates a write operation (update) and the constraint on Draft status. It does not contradict the annotations (readOnlyHint=false, destructiveHint=false), and the side effect of rebuilding the client snapshot is captured in the parameter description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, concise and directly to the point. It includes the essential scope and constraint without unnecessary elaboration.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given that an output schema exists and all parameters are well-documented, the description covers the necessary context for correct usage. It communicates the key restriction (Draft-only) and the fields involved, which is sufficient for this straightforward update operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

All parameters are fully described in the schema with coverage at 100%, so the baseline is 3. The description adds only a brief summary of field types ('dates, payment terms, notes, or reassign the company') without providing additional meaning beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Update', the resource 'invoice', and the specific scope 'Draft invoice'. It also lists the fields that can be updated, making it unambiguous and distinct from sibling tools like create_invoice or issue_invoice.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly states that only Draft invoices can be modified and that Sent/certified invoices are immutable, providing a clear condition for when to use this tool. It does not explicitly compare to alternatives, but the scope is distinct enough.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.