Sperse ACTION
Create Invoice
Creates a new invoice in Sperse. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Sperse 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: "sperse-create-invoice",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
sperse: { authProvisionId: "apn_xxxxxxx" },
contactId: "Contact ID",
status: "Status",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "sperse-create-invoice",
"configured_props": {
"sperse": { "authProvisionId": "apn_xxxxxxx" },
"contactId": "Contact ID",
"status": "Status"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "sperse",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "sperse-create-invoice",
arguments: {
contactId: "Contact ID",
status: "Status",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
contactId Contact ID | string | The ID of the contact Required Dynamic |
status Status | string | The status of the invoice Required |
date Invoice Date | string | The date of the invoice in ISO 8601 format (e.g., 2026-02-16) Required |
currencyId Currency ID | string | The ID of the currency Required Dynamic |
grandTotal Grand Total | string | The grand total amount Required |
lines Invoice Lines | string[] | An array of invoice line items. Either priceOptionId or unitId should be specified, productCode or description should be specified. See the documentation Example: Required |
dueDate Due Date | string | The due date of the invoice in ISO 8601 format (e.g., 2026-10-15) Optional |
description Description | string | The description of the invoice Optional |
note Note | string | Additional notes for the invoice Optional |
taxTotal Tax Total | string | The total tax amount Optional |
discountTotal Discount Total | string | The total discount amount Optional |
shippingTotal Shipping Total | string | The total shipping cost Optional |
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
- sperse-create-invoice
- Version
- 0.0.1
- App
- Sperse
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗