Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_invoice_update

Idempotent

Update an existing invoice by ID to modify items, dates, currency, contact, and payment details through the GoHighLevel API.

Instructions

Update invoice API to update invoice by invoice id Endpoint: PUT /invoices/{invoiceId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "invoiceId": "<invoiceId>",
      "body": "<body>"
    },
    "name": "ghl_invoice_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
invoiceIdYesInvoice Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / attachments / items / title
      Added value: +"AttachmentsDto"
    • changedInput schema / properties / body / properties / businessDetails / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "address": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "addressLine1": {
      -                "description": "Address Line 1",
      -                "example": "9931 Beechwood",
      -                "type": "string"
      -              },
      -              "addressLine2": {
      -                "description": "Address Line 2",
      -                "example": "Beechwood",
      -                "type": "string"
      -              },
      -              "city": {
      -                "description": "City",
      -                "example": "St. Houston",
      -                "type": "string"
      -              },
      -              "countryCode": {
      -                "description": "Country Code",
      -                "example": "US",
      -                "type": "string"
      -              },
      -              "postalCode": {
      -                "description": "Postal Code",
      -                "example": "559-6993",
      -                "type": "string"
      -              },
      -              "state": {
      -                "description": "State",
      -                "example": "TX",
      -                "type": "string"
      -              }
      -            },
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Business Address",
      -        "example": "9931 Beechwood, TX"
      -      },
      -      "customValues": {
      -        "description": "Custom Values",
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "logoUrl": {
      -        "description": "Business Logo URL",
      -        "example": "https://example.com/logo.png",
      -        "type": "string"
      -      },
      -      "name": {
      -        "description": "Business Name",
      -        "example": "ABC Corp.",
      -        "type": "string"
      -      },
      -      "phoneNo": {
      -        "description": "Business Phone Number",
      -        "example": "+1-214-559-6993",
      -        "type": "string"
      -      },
      -      "website": {
      -        "description": "Business Website Link",
      -        "example": "wwww.example.com",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "address": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "addressLine1": {
      +                "description": "Address Line 1",
      +                "example": "9931 Beechwood",
      +                "type": "string"
      +              },
      +              "addressLine2": {
      +                "description": "Address Line 2",
      +                "example": "Beechwood",
      +                "type": "string"
      +              },
      +              "city": {
      +                "description": "City",
      +                "example": "St. Houston",
      +                "type": "string"
      +              },
      +              "countryCode": {
      +                "description": "Country Code",
      +                "example": "US",
      +                "type": "string"
      +              },
      +              "postalCode": {
      +                "description": "Postal Code",
      +                "example": "559-6993",
      +                "type": "string"
      +              },
      +              "state": {
      +                "description": "State",
      +                "example": "TX",
      +                "type": "string"
      +              }
      +            },
      +            "title": "AddressDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Business Address",
      +        "example": "9931 Beechwood, TX"
      +      },
      +      "customValues": {
      +        "description": "Custom Values",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "logoUrl": {
      +        "description": "Business Logo URL",
      +        "example": "https://example.com/logo.png",
      +        "type": "string"
      +      },
      +      "name": {
      +        "description": "Business Name",
      +        "example": "ABC Corp.",
      +        "type": "string"
      +      },
      +      "phoneNo": {
      +        "description": "Business Phone Number",
      +        "example": "+1-214-559-6993",
      +        "type": "string"
      +      },
      +      "website": {
      +        "description": "Business Website Link",
      +        "example": "wwww.example.com",
      +        "type": "string"
      +      }
      +    },
      +    "title": "BusinessDetailsDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / contactDetails / properties / additionalEmails / items / title
      Added value: +"AdditionalEmailsDto"
    • addedInput schema / properties / body / properties / contactDetails / properties / address / title
      Added value: +"AddressDto"
    • addedInput schema / properties / body / properties / contactDetails / title
      Added value: +"ContactDetailsDto"
    • addedInput schema / properties / body / properties / discount / title
      Added value: +"DiscountDto"
    • addedInput schema / properties / body / properties / invoiceItems / items / properties / taxes / items / title
      Added value: +"ItemTaxDto"
    • addedInput schema / properties / body / properties / invoiceItems / items / title
      Added value: +"InvoiceItemDto"
    • changedInput schema / properties / body / properties / miscellaneousCharges / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "charges": {
      -        "description": "charges for the processing fee",
      -        "items": {
      -          "type": "array"
      -        },
      -        "type": "array"
      -      },
      -      "collectedMiscellaneousCharges": {
      -        "description": "collected miscellaneous charges",
      -        "example": 10,
      -        "type": "number"
      -      },
      -      "paidCharges": {
      -        "description": "paid miscellaneous charges",
      -        "items": {
      -          "properties": {
      -            "_id": {
      -              "description": "id of the processing fee",
      -              "example": "673d01d7d547648a8dab6211",
      -              "type": "string"
      -            },
      -            "amount": {
      -              "description": "amount of the processing fee",
      -              "example": 10,
      -              "type": "number"
      -            },
      -            "charge": {
      -              "description": "charge for the processing fee",
      -              "example": 10,
      -              "type": "number"
      -            },
      -            "name": {
      -              "description": "name of the processing fee",
      -              "example": "Processing Fee",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "name",
      -            "charge",
      -            "amount",
      -            "_id"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "charges"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "charges": {
      +        "description": "charges for the processing fee",
      +        "items": {
      +          "type": "array"
      +        },
      +        "type": "array"
      +      },
      +      "collectedMiscellaneousCharges": {
      +        "description": "collected miscellaneous charges",
      +        "example": 10,
      +        "type": "number"
      +      },
      +      "paidCharges": {
      +        "description": "paid miscellaneous charges",
      +        "items": {
      +          "properties": {
      +            "_id": {
      +              "description": "id of the processing fee",
      +              "example": "673d01d7d547648a8dab6211",
      +              "type": "string"
      +            },
      +            "amount": {
      +              "description": "amount of the processing fee",
      +              "example": 10,
      +              "type": "number"
      +            },
      +            "charge": {
      +              "description": "charge for the processing fee",
      +              "example": 10,
      +              "type": "number"
      +            },
      +            "name": {
      +              "description": "name of the processing fee",
      +              "example": "Processing Fee",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "charge",
      +            "amount",
      +            "_id"
      +          ],
      +          "title": "ProcessingFeePaidChargeDto",
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "charges"
      +    ],
      +    "title": "ProcessingFeeDto",
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / body / properties / paymentMethods / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "stripe": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "enableBankDebitOnly": {
      -                "description": "Enable Bank Debit Only",
      -                "example": false,
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "enableBankDebitOnly"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Payment Method"
      -      }
      -    },
      -    "required": [
      -      "stripe"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "stripe": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "enableBankDebitOnly": {
      +                "description": "Enable Bank Debit Only",
      +                "example": false,
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "enableBankDebitOnly"
      +            ],
      +            "title": "StripePaymentMethodDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Payment Method"
      +      }
      +    },
      +    "required": [
      +      "stripe"
      +    ],
      +    "title": "PaymentMethodDto",
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / body / properties / paymentSchedule / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "schedules": {
      -        "description": "payment schedule item",
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "type": {
      -        "description": "Payment schedule type",
      -        "enum": [
      -          "fixed",
      -          "percentage"
      -        ],
      -        "example": "percentage",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "schedules"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "schedules": {
      +        "description": "payment schedule item",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "type": {
      +        "description": "Payment schedule type",
      +        "enum": [
      +          "fixed",
      +          "percentage"
      +        ],
      +        "example": "percentage",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "schedules"
      +    ],
      +    "title": "PaymentScheduleDto",
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / body / properties / tipsConfiguration / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "tipsEnabled": {
      -        "description": "Tips enabled status",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "tipsPercentage": {
      -        "description": "Percentage of tips allowed",
      -        "example": [
      -          5,
      -          10,
      -          15
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "tipsPercentage",
      -      "tipsEnabled"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "tipsEnabled": {
      +        "description": "Tips enabled status",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "tipsPercentage": {
      +        "description": "Percentage of tips allowed",
      +        "example": [
      +          5,
      +          10,
      +          15
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "tipsPercentage",
      +      "tipsEnabled"
      +    ],
      +    "title": "TipsConfigurationDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"UpdateInvoiceDto"
  2. First observedv2.0.0

TDQS

B3.4/5.0
Behavior4/5

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

Adds genuinely useful behavior beyond the annotations: the concrete endpoint (PUT /invoices/{invoiceId}), the required v3 version header, token type, and OAuth scope. It does not, however, disclose what happens to fields omitted from the body, which matters given destructiveHint=false and idempotentHint=true.

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

Conciseness4/5

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

Five tight lines with the endpoint and auth facts front-loaded; there is minor redundancy between 'Update invoice' and 'API to update invoice by invoice id', but nothing wasteful.

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

Completeness3/5

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

For a mutation with a large nested request body and no output schema, the description covers transport and auth but omits the operation's most consequential trait: the mandatory field set in the body and whether unspecified fields are cleared. An agent can invoke it but may easily construct an invalid or unexpectedly destructive payload.

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?

Schema description coverage is 100%, so both parameters and the deeply nested body are already documented in the schema. The description only repeats the invoiceId concept and adds no semantics about the body contents, so the baseline 3 applies.

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

Purpose4/5

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

States a specific verb and resource (update invoice) and the lookup key (by invoice id), which distinguishes it from ghl_invoice_create, ghl_invoice_get, and ghl_invoice_void. It does not explicitly name a sibling, so it stops short of a 5.

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

Usage Guidelines2/5

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

Gives auth prerequisites (Agency or Sub-Account token, invoices.write scope) but never says when to choose this over alternatives such as ghl_invoice_void, ghl_invoice_send, or ghl_invoice_update_last_visited_at. Critically, it omits that the body requires altId, altType, name, currency, invoiceItems, issueDate and dueDate, so an agent cannot tell this is effectively a full invoice replacement rather than a partial patch.

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

Deploy Server

Other Tools