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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_create

Creates an invoice schedule in GoHighLevel by defining contact, business, currency, line items, discounts, and recurrence rules for automated billing.

Instructions

Create Invoice Schedule API to create an invoice Schedule Endpoint: POST /invoices/schedule (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.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": {
      "body": "<body>"
    },
    "name": "ghl_invoice_schedule_create"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / attachments / items / title
      Added value: +"AttachmentsDto"
    • changedInput schema / properties / body / properties / businessDetails / properties / address / allOf
      Previous value: -[
      -  {
      -    "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"
      -  }
      -]New value: +[
      +  {
      +    "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"
      +  }
      +]
    • addedInput schema / properties / body / properties / businessDetails / title
      Added value: +"BusinessDetailsDto"
    • 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 / items / items / properties / taxes / items / title
      Added value: +"ItemTaxDto"
    • addedInput schema / properties / body / properties / items / items / title
      Added value: +"InvoiceItemDto"
    • changedInput schema / properties / body / properties / lateFeesConfiguration / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "enable": {
      -        "description": "Enable late fees",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "frequency": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "interval": {
      -                "description": "Late fees interval",
      -                "enum": [
      -                  "minute",
      -                  "hour",
      -                  "day",
      -                  "week",
      -                  "month",
      -                  "one_time"
      -                ],
      -                "example": "day",
      -                "type": "string"
      -              },
      -              "intervalCount": {
      -                "description": "Late fees interval count",
      -                "example": 10,
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "intervalCount",
      -              "interval"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Late Fees Frequency"
      -      },
      -      "grace": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "interval": {
      -                "description": "Late fees grace interval",
      -                "enum": [
      -                  "day"
      -                ],
      -                "example": "day",
      -                "type": "string"
      -              },
      -              "intervalCount": {
      -                "description": "Late fees grace interval count",
      -                "example": 10,
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "intervalCount",
      -              "interval"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Late Fees Grace"
      -      },
      -      "maxLateFees": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "type": {
      -                "enum": [
      -                  "fixed"
      -                ],
      -                "example": "fixed",
      -                "type": "string"
      -              },
      -              "value": {
      -                "description": "Max late fees to pay",
      -                "example": "10",
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "type",
      -              "value"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Max late fees payable"
      -      },
      -      "type": {
      -        "description": "Late Fees Type",
      -        "enum": [
      -          "fixed",
      -          "percentage"
      -        ],
      -        "example": "fixed",
      -        "type": "string"
      -      },
      -      "value": {
      -        "description": "Late Fees Value",
      -        "example": 10,
      -        "type": "number"
      -      }
      -    },
      -    "required": [
      -      "enable",
      -      "value",
      -      "type",
      -      "frequency"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "enable": {
      +        "description": "Enable late fees",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "frequency": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "interval": {
      +                "description": "Late fees interval",
      +                "enum": [
      +                  "minute",
      +                  "hour",
      +                  "day",
      +                  "week",
      +                  "month",
      +                  "one_time"
      +                ],
      +                "example": "day",
      +                "type": "string"
      +              },
      +              "intervalCount": {
      +                "description": "Late fees interval count",
      +                "example": 10,
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "intervalCount",
      +              "interval"
      +            ],
      +            "title": "LateFeesFrequencyDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Late Fees Frequency"
      +      },
      +      "grace": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "interval": {
      +                "description": "Late fees grace interval",
      +                "enum": [
      +                  "day"
      +                ],
      +                "example": "day",
      +                "type": "string"
      +              },
      +              "intervalCount": {
      +                "description": "Late fees grace interval count",
      +                "example": 10,
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "intervalCount",
      +              "interval"
      +            ],
      +            "title": "LateFeesGraceDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Late Fees Grace"
      +      },
      +      "maxLateFees": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "enum": [
      +                  "fixed"
      +                ],
      +                "example": "fixed",
      +                "type": "string"
      +              },
      +              "value": {
      +                "description": "Max late fees to pay",
      +                "example": "10",
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "type",
      +              "value"
      +            ],
      +            "title": "LateFeesMaxFeesDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Max late fees payable"
      +      },
      +      "type": {
      +        "description": "Late Fees Type",
      +        "enum": [
      +          "fixed",
      +          "percentage"
      +        ],
      +        "example": "fixed",
      +        "type": "string"
      +      },
      +      "value": {
      +        "description": "Late Fees Value",
      +        "example": 10,
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "enable",
      +      "value",
      +      "type",
      +      "frequency"
      +    ],
      +    "title": "LateFeesConfigurationDto",
      +    "type": "object"
      +  }
      +]
    • 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"
      +  }
      +]
    • addedInput schema / properties / body / properties / schedule / properties / rrule / title
      Added value: +"CustomRRuleOptionsDto"
    • addedInput schema / properties / body / properties / schedule / title
      Added value: +"ScheduleOptionsDto"
    • 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: +"CreateInvoiceScheduleDto"
  2. First observedv2.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds genuine value with the auth requirements and OAuth scope, but says nothing about lifecycle behavior — e.g. whether the created schedule starts inactive and must be activated with a sibling tool, or whether duplicate creation is possible given idempotentHint=false.

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?

Short and front-loaded with the action first, then endpoint, then auth. Some lines (source file path, version header) are developer metadata rather than agent-facing guidance, but nothing is verbose or padded.

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 tool with a very deep nested body (recurrence rules, line items, discounts, late fees) and no output schema, the description is thin: it never explains what a created schedule looks like, what the response returns, or how the schedule relates to activation/auto-payment siblings. Auth and endpoint details are present, but the semantic context an agent needs to call this correctly is largely left to the schema.

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?

There is a single `body` parameter with 100% schema description coverage, so the schema itself documents every nested field (rrule, items, contactDetails, late fees, etc.). The description adds no meaning beyond the boilerplate note that the body is carried verbatim from the OpenAPI spec, so 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 ('Create Invoice Schedule', POST /invoices/schedule), which is unambiguous against siblings like ghl_invoice_schedule_update or ghl_invoice_schedule_activate. It does not, however, explicitly contrast itself with the closest alternatives such as ghl_invoice_create or the activate/update-and-activate variants.

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

Usage Guidelines3/5

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

The description supplies invocation prerequisites (Agency or Sub-Account token, `invoices/schedule.write` scope), which is useful context for whether the caller can use it. But it gives no guidance on when to prefer this over ghl_invoice_create, ghl_invoice_schedule_update, or ghl_invoice_schedule_activate, so usage is only implied by the verb.

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