View as Markdown
Square icon

Square ACTION

Create Invoice

Creates a draft invoice for an order. You must send (publish) the invoice before Square can process it. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Square account once, then configure and run Create Invoice from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "square-create-invoice",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    square: { authProvisionId: "apn_xxxxxxx" },
    location: "Location",
    order: "Order",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Invoice inputs
Property Type Description
location Location string
The source of orders and fulfillments for a physical or virtual business
Required Dynamic
order Order string
The ID of the order
Required Dynamic
customer Customer string
The ID of the customer
Required Dynamic
dueDate Due Date string
The due date for the payment request, in YYYY-MM-DD format
Required
acceptedPaymentMethods Accepted Payment Methods string[]
The payment methods that customers can use to pay the invoice on the Square-hosted invoice page. This setting is independent of any automatic payment requests for the invoice.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
square-create-invoice
Version
0.0.6
App
Square
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes