View as Markdown
OnlineCheckWriter icon

OnlineCheckWriter ACTION

Create Check

Creates a new check. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OnlineCheckWriter account once, then configure and run Create Check 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: "onlinecheckwriter-create-check",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    onlinecheckwriter: { authProvisionId: "apn_xxxxxxx" },
    bankAccountId: "Bank Account ID",
    payeeId: "Payee ID",
  },
})

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 Check inputs
Property Type Description
bankAccountId Bank Account ID string
Must be a bank account ID.
Required Dynamic
payeeId Payee ID string
Must be a payee ID.
Required Dynamic
categoryId Category ID string
Must be a category ID.
Optional Dynamic
issueDate Issue Date string
By default it will be check creation date, If an Issue Date is passed, that will override any default. Eg. 2021-12-31.
Optional
amount Amount string
The money value of the check.
Required
memo Memo string
Max of 150 characters to be included on the memo line of the check.
Optional
note Note string
An internal note that identifies this check. Must be no longer than 150 characters.
Optional
invoiceNumber Invoice Number string
Any invoice number associated with this check
Optional
noSign No Sign boolean
if true, the check will be created without signature. Default false.
Optional
noAmount No Amount boolean
if true, the check will be created without amount. Default false
Optional
noDate No Date boolean
if true, the check will be created without date. Default false
Optional
noPayee No Payee boolean
if true, the check will be created without payee. Default false
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
onlinecheckwriter-create-check
Version
0.0.2
App
OnlineCheckWriter
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes