# Create Invoice — Sperse

> Creates a new invoice in Sperse. See the documentation

- Key: `sperse-create-invoice`
- Type: Action (Write)
- Version: 0.0.1
- App: Sperse (`sperse`) — https://pipedream.com/apps/sperse.md
- This page (HTML): https://pipedream.com/apps/sperse/actions/create-invoice
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/sperse/actions/create-invoice/create-invoice.mjs

## Description

Creates a new invoice in Sperse. [See the documentation](https://app.sperse.com/app/api/swagger)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `contactId` | `string` | Yes | The ID of the contact Options are loaded from the connected account. |
| `status` | `string` | Yes | The status of the invoice |
| `date` | `string` | Yes | The date of the invoice in ISO 8601 format (e.g., 2026-02-16) |
| `currencyId` | `string` | Yes | The ID of the currency Options are loaded from the connected account. |
| `grandTotal` | `string` | Yes | The grand total amount |
| `lines` | `string[]` | Yes | 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 } ] |
| `dueDate` | `string` | No | The due date of the invoice in ISO 8601 format (e.g., 2026-10-15) |
| `description` | `string` | No | The description of the invoice |
| `note` | `string` | No | Additional notes for the invoice |
| `taxTotal` | `string` | No | The total tax amount |
| `discountTotal` | `string` | No | The total discount amount |
| `shippingTotal` | `string` | No | The total shipping cost |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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",
  },
})
```

**TypeScript**

```ts
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**

```bash
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"
    }
  }'
```

---

- App: https://pipedream.com/apps/sperse.md · All apps: https://pipedream.com/apps