View as Markdown
Zoho Books icon

Zoho Books ACTION

Create Customer Payment

Creates a new payment. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zoho Books account once, then configure and run Create Customer 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: "zoho_books-create-customer-payment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zoho_books: { authProvisionId: "apn_xxxxxxx" },
    customerId: "Customer Id",
    paymentMode: "Payment Mode",
  },
})

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 Customer Payment inputs
Property Type Description
customerId Customer Id string
Customer ID of the customer involved in the payment.
Required Dynamic
paymentMode Payment Mode string
Mode through which payment is made.
Required
amount Amount string
Amount paid in the respective payment.
Required
date Date string
Date on which payment is made. Format [yyyy-mm-dd]
Required
referenceNumber Reference Number string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
Optional
description Description string
Description about the payment.
Optional
invoices Invoices string[]
List of invoice objects associated with the payment. Each invoice object contains invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount. Example: {"invoice_id": "90300000079426", "amount_applied": 450}
Required
exchangeRate Exchange Rate string
Exchange rate for the currency used in the invoices and customer's currency. The payment amount would be the multiplicative product of the original amount and the exchange rate. Default is 1.
Optional
bankCharges Bank Charges string
Denotes any additional bank charges.
Optional
customFields Custom Fields string[]
A list of Additional field objects for the payments. Example: {"label": "label", "value": 129890}
Optional
invoiceId Invoice Id string
ID of the invoice to get payments of.
Required Dynamic
amountApplied Amount Applied string
Amount paid for the invoice.
Optional
taxAmountWithheld Tax Amount Withheld string
Amount withheld for tax.
Optional
accountId Account Id string
ID of the cash/bank account the payment has to be deposited.
Optional Dynamic
contactPersons Contact Persons string[]
IDs of the contact persons the thank you mail has to be triggered.
Optional Dynamic

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
zoho_books-create-customer-payment
Version
0.3.1
App
Zoho Books
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes