update_invoice

Updates a DRAFT invoice only. This tool cannot finalize, send, or collect payment for an invoice. Wraps the updateInvoice RPC.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
Preview the prompt that will be copied

Access

  • Effect: Changes data
  • Required scope: write (the mcp scope also grants it)

Example request

The JSON-RPC message an MCP client sends to call this tool. Your client builds it for you; this is for reference and debugging in a tool such as MCP Inspector.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_invoice",
    "arguments": {
      "invoice": {}
    }
  }
}

Example IDs refer to fictional demo data. Replace them with IDs from your account before calling the real server.

Description

Updates a DRAFT invoice only. This tool cannot finalize, send, or collect payment for an invoice. Wraps the updateInvoice RPC.

Get invoiceId from list_invoices or read_invoice.
If invoiceId is unknown, pass invoiceClientName (current client name) to resolve it across all your accounts, or add accountId to search one account. More than one match returns the candidates to ask about.
Only draft-editable invoice fields are accepted. If fieldMasks is omitted, masks are inferred from the provided invoice fields.

Input parameters

NameTypeRequiredDescription
accountIdstringNo
fieldMasksarrayNo
invoiceobjectYes
invoiceClientNamestringNo
invoiceIdstringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "accountId": {
      "type": "string"
    },
    "fieldMasks": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "path": {
            "type": "string"
          }
        },
        "required": [
          "path"
        ],
        "type": "object"
      },
      "type": [
        "null",
        "array"
      ]
    },
    "invoice": {
      "additionalProperties": false,
      "properties": {
        "clientName": {
          "type": [
            "null",
            "string"
          ]
        },
        "contact": {
          "type": [
            "null",
            "string"
          ]
        },
        "contactDetails": {
          "type": [
            "null",
            "string"
          ]
        },
        "deliveryMethod": {
          "type": [
            "null",
            "string"
          ]
        },
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "dueDate": {
          "type": [
            "null",
            "string"
          ]
        },
        "eTransferEmail": {
          "type": [
            "null",
            "string"
          ]
        },
        "eTransferPhone": {
          "type": [
            "null",
            "string"
          ]
        },
        "items": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "currency": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "discount": {
                "type": "number"
              },
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "quantity": {
                "type": "integer"
              },
              "taxRate": {
                "type": "number"
              },
              "unitPrice": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "description",
              "unitPrice",
              "currency",
              "quantity",
              "taxRate",
              "discount"
            ],
            "type": "object"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "lineItems": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "currency": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "discount": {
                "type": "number"
              },
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "quantity": {
                "type": "integer"
              },
              "taxRate": {
                "type": "number"
              },
              "unitPrice": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "description",
              "unitPrice",
              "currency",
              "quantity",
              "taxRate",
              "discount"
            ],
            "type": "object"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "paymentMethod": {
          "type": [
            "null",
            "string"
          ]
        },
        "payoutModel": {
          "type": [
            "null",
            "string"
          ]
        },
        "recurrence": {
          "additionalProperties": false,
          "properties": {
            "cronExpression": {
              "type": "string"
            },
            "endAt": {
              "type": "string"
            },
            "rrule": {
              "type": "string"
            },
            "scheduleType": {
              "type": "string"
            },
            "startAt": {
              "type": "string"
            },
            "timezone": {
              "type": "string"
            }
          },
          "required": [
            "startAt",
            "endAt"
          ],
          "type": [
            "null",
            "object"
          ]
        }
      },
      "type": "object"
    },
    "invoiceClientName": {
      "type": [
        "null",
        "string"
      ]
    },
    "invoiceId": {
      "type": "string"
    }
  },
  "required": [
    "invoice"
  ],
  "type": "object"
}