1. Docs
2. /
3. Tool reference
4. /
5. Commerce
6. /
7. previewInvoice

Commerce

previewInvoice

Preview Invoice

Preview the exact customer, lines, tax, currency, total, due date, and memo for a shop invoice.

read

Ask Claude, ChatGPT, Cursor or any AI connected to The Cloud "preview an invoice", and it calls previewInvoice.

Example call

The MCP tools/call params, with the required arguments only.

{
  "arguments": {
    "customer": {},
    "idempotencyKey": "<idempotencyKey>"
  },
  "name": "previewInvoice"
}

Arguments

• attachmentFileIdsstring[]optionalStorage file ids (from uploads) shown as thumbnails: photos, before and after, receipts.
• currencystringoptionalNo description is declared in the tool schema.
• customerobjectrequiredNo description is declared in the tool schema.
• dueDatestringoptionalYYYY-MM-DD. Required with terms custom; ignored otherwise.
• idempotencyKeystringrequiredNo description is declared in the tool schema.
• internalNotestringoptionalThe shop's own note; the customer never sees it.
• invoiceNumberstringoptionalThe shop's own number, e.g. 7378 to continue a QuickBooks sequence. Absent = the next number after the shop's last invoice.
• itemsobject[]optionalThe invoice's lines with every invoice option. For plain lines, lineItems is shorter; the two add up.
• lineItemsobject[]optionalWhat is billed, one line each: name, detail (one short line), qty and amountCents (one unit, required here). The page says the cadence once; never write it into a line.
• locationOfSalestringoptionalNo description is declared in the tool schema.
• memostringoptionalSame as noteToCustomer.
• noteToCustomerstringoptionalPrinted on the invoice and sent in its email.
• paymentMethodsstring[]optionalHow the customer may pay. Absent = the shop's invoice template, then its cart setting, else ChargePack's base pack: card, plus bank on USD once the Stripe account has ACH switched on. Bank is dropped from any source while ACH is off, and…
• poReferencestringoptionalNo description is declared in the tool schema.
• propertiesobject[]optionalColumns the shop adds without a schema change, e.g. { key: "job_site", label: "Job site", value: { type: "text", text: "12 Baker St" } }.
• spacestringoptionalThe Space (shop) the invoice belongs to: its id, slug or exact name. Omit for the caller's personal shop.
• spaceIdstringoptionalA Space id or its team id; same as space.
• tagsstring[]optionalNo description is declared in the tool schema.
• taxLabelstringoptionalThe name of the invoice's tax, e.g. GET. Default Tax.
• taxRatePercentnumberoptionalApplied to taxable lines that name no rate of their own, e.g. 4.712 for Hawaii GET.
• termsstringoptionalWhen the money is due. Absent = due on receipt, or custom when dueDate is given.

Returns

When a person asks for an invoice, a bill, a mock-up, a quote or a proposal, call this and return payUrl and previewUrl; never answer with a typed table.

Declared limits

• attachmentFileIds: maximum items 20
• currency: minimum length 3
• currency: maximum length 3
• idempotencyKey: minimum length 8
• idempotencyKey: maximum length 100
• internalNote: minimum length 1
• internalNote: maximum length 1000
• invoiceNumber: minimum length 1
• invoiceNumber: maximum length 40
• items: maximum items 50
• lineItems: maximum items 20
• locationOfSale: minimum length 1
• locationOfSale: maximum length 1000
• memo: minimum length 1
• memo: maximum length 1000
• noteToCustomer: minimum length 1
• noteToCustomer: maximum length 1000
• poReference: minimum length 1
• poReference: maximum length 120
• properties: maximum items 40
• tags: maximum items 20
• taxLabel: minimum length 1
• taxLabel: maximum length 60
• taxRatePercent: minimum 0
• taxRatePercent: maximum 100

Ask for it

The Cloud routes these requests to this verb.

• preview an invoice
• show me the invoice before I send it
• what would this invoice say

Pair it with

The verbs that finish the job.

• createInvoice
• listInvoices
• sendInvoice

Questions

• What does previewInvoice do?

  Preview the exact customer, lines, tax, currency, total, due date, and memo for a shop invoice. It is one of the tools The Cloud MCP server gives every connected AI.

• How do I use previewInvoice from Claude or ChatGPT?

  Connect your AI to The Cloud at https://mcp.thecloud.so/mcp and sign in once. Then ask Claude, ChatGPT, Cursor or any AI connected to The Cloud "preview an invoice", and it calls previewInvoice.

• Is previewInvoice safe to let an AI call?

  previewInvoice is read-only: it changes nothing.

Connect

One endpoint gives your AI this tool and every other one: connect Claude, ChatGPT, Cursor or Gemini, read what The Cloud is, or see pricing.