View as Markdown
Invoiced icon

Invoiced ACTION

Create Payment

Creates a new payment 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 Payment 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-payment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    invoiced: { authProvisionId: "apn_xxxxxxx" },
    customerId: "Customer ID",
    date: "Date",
  },
})

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 Payment inputs
Property Type Description
customerId Customer ID string
The ID of the customer
Optional Dynamic
date Date string
Payment datetime, defaults to current timestamp. Format YYYY-MM-DDTHH:MM:SSZ.
Optional
method Payment Method string
Payment instrument used, defaults to other
Optional
currency Currency string
Optional
amount Amount string
Payment amount. Example: 100.00
Required
reference Reference string
Reference number, i.e. check #
Optional
achSenderId ACH Sender ID string
Originator ID (ACH payments)
Optional
source Source string
Source of the payment, defaults to keyed
Optional
notes Notes string
Internal notes
Optional
appliedTo Applied To string[]
JSON array of payment applications. Each application should have: type (invoice, credit_note, etc.), invoice (or credit_note ID), amount. Example: [{"type":"invoice","invoice":"44648","amount":800}] See the documentation for more details.
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-payment
Version
0.0.1
App
Invoiced
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes