View as Markdown
Invoiced icon

Invoiced ACTION

Create Invoice

Creates a new invoice in Invoiced. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Invoiced 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: "invoiced-create-invoice",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    invoiced: { authProvisionId: "apn_xxxxxxx" },
    customer: "Customer ID",
    name: "Name",
  },
})

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
customer Customer ID string
The ID of the customer this invoice is for
Required Dynamic
name Name string
Invoice name for internal use, defaults to "Invoice"
Optional
number Number string
The reference number assigned to the invoice, defaults to next # in auto-numbering sequence
Optional
currency Currency string
3-letter ISO code - defaults to account currency
Optional
autoplay Autoplay boolean
AutoPay enabled? - inherited from customer by default
Optional
paymentTerms Payment Terms string
Payment terms for the invoice, i.e. "NET 30" - inherited from customer by default
Optional
purchaseOrder Purchase Order string
The customer's purchase order number
Optional
date Date string
Invoice date - defaults to current timestamp. Format YYYY-MM-DDTHH:MM:SSZ.
Optional
dueDate Due Date string
Due date - computed from paymentTerms when not supplied. Format YYYY-MM-DDTHH:MM:SSZ.
Optional
draft Draft boolean
When false, the invoice is considered outstanding, or when true, the invoice is a draft
Optional
closed Closed boolean
Marks an invoice as closed
Optional
items Items string[]
JSON array of invoice items. Example: [{ "amount": 45, "catalog_item": null, "description": null, "discountable": true, "discounts": [], "id": 7, "metadata": [], "name": "Copy Paper, Case", "object": "line_item", "quantity": 1, "taxable": true, "taxes": [], "type": "product", "unit_cost": 45 }]
Required
notes Notes string
Additional notes displayed on invoice
Optional
discounts Discounts string[]
A list of coupon Ids
Optional Dynamic
taxes Taxes string[]
Array of Tax Rate IDs
Optional Dynamic
metadata Metadata object
A hash of key/value pairs that can store additional information about this object.
Optional
disabledPaymentMethods Disabled Payment Methods string[]
Array of payment method IDs to disable for the customer. i.e., ["wire_transfer", "credit_card"]
Optional
calculateTaxes Calculate Taxes boolean
Disables tax calculation, default is true
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
invoiced-create-invoice
Version
0.0.1
App
Invoiced
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes