View as Markdown
Sperse icon

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)

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
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:

[
  {
    "productCode": "123",
    "unitId": "Day",
    "quantity": 1,
    "rate": 100,
    "total": 100,
    "sortOrder": 1
  }
]
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