Create Customer Payment with Zoho Books API on New Row (Custom Query) from MySQL API

Pipedream makes it easy to connect APIs for Zoho Books, MySQL and 2,400+ other apps remarkably fast.

Trigger workflow on

New Row (Custom Query) from the MySQL API

Next, do this

Create Customer Payment with the Zoho Books API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a MySQL trigger and Zoho Books action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Row (Custom Query) trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
4. Optional- Select a De-duplication Key
5. Configure Where condition
6. Configure Values
Configure the Create Customer Payment action
1. Connect your Zoho Books account
2. Select a Customer Id
3. Select a Payment Mode
4. Configure Amount
5. Configure Date
6. Optional- Configure Reference Number
7. Optional- Configure Description
8. Configure Invoices
9. Optional- Configure Exchange Rate
10. Optional- Configure Bank Charges
11. Optional- Configure Custom Fields
12. Select a Invoice Id
13. Optional- Configure Amount Applied
14. Optional- Configure Tax Amount Withheld
15. Optional- Select a Account Id
16. Optional- Select one or more Contact Persons
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Row (Custom Query) on MySQL

Description:Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)

Version:2.0.5

Key:mysql-new-row-custom-query

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";
import { v4 as uuidv4 } from "uuid";

const { mysql } = common.props;

export default {
  ...common,
  key: "mysql-new-row-custom-query",
  name: "New Row (Custom Query)",
  description: "Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)",
  version: "2.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    column: {
      propDefinition: [
        mysql,
        "column",
        (c) => ({
          table: c.table,
        }),
      ],
      label: "De-duplication Key",
      description:
        "The name of a column in the table to use for de-duplication",
      optional: true,
    },
    condition: {
      propDefinition: [
        mysql,
        "whereCondition",
      ],
    },
    values: {
      propDefinition: [
        mysql,
        "whereValues",
      ],
    },
  },
  methods: {
    ...common.methods,
    async listResults() {
      const {
        table,
        condition,
        values,
      } = this;

      const numberOfQuestionMarks = condition?.match(/\?/g)?.length;

      if (!numberOfQuestionMarks) {
        throw new Error("No valid condition provided. At least one question mark character ? must be provided.");
      }

      if (!Array.isArray(values)) {
        throw new Error("No valid values provided. The values property must be an array.");
      }

      if (values.length !== numberOfQuestionMarks) {
        throw new Error("The number of values provided does not match the number of question marks ? in the condition.");
      }

      const rows = await this.mysql.findRows({
        table,
        condition,
        values,
      });
      this.iterateAndEmitEvents(rows);
    },
    generateMeta(row) {
      const id = this.column
        ? row[this.column]
        : uuidv4();
      return {
        id,
        summary: `New Row ${id}`,
        ts: Date.now(),
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
De-duplication Key	`column`	`string`	Select a value from the drop down menu.
Where condition	`condition`	`string`	In this expression you can write your own conditions (eg. `column1 = ? or column2 = ?`). Depending on the number of `?` symbols likewise you need to add the same number of values.
Values	`values`	`string[]`	This is the list of values that will match every `?` symbol in the where expression. If you want to build yourself the values (eg. `{{["string1", "string2"]}}`)

Trigger Authentication#

MySQL uses API keys for authentication. When you connect your MySQL account, Pipedream securely stores the keys so you can easily authenticate to MySQL APIs in both code and no-code steps.

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

SSL Setup

Configure SSL on your MySQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About MySQL#

MySQL is an open-source relational database management system.

Action#

Create Customer Payment on Zoho Books

Description:Creates a new payment. [See the documentation](https://www.zoho.com/books/api/v3/customer-payments/#create-a-payment)

Version:0.3.0

Key:zoho_books-create-customer-payment

View on GitHub

Zoho Books Overview#

Zoho Books API unlocks the potential to automate and streamline accounting tasks by integrating with Pipedream's serverless platform. With this powerful combo, you can automate invoicing, manage your accounts, reconcile bank transactions, and handle contacts and items without manual input. By setting up event-driven workflows, you can ensure data consistency across platforms, trigger notifications, and generate reports, all while saving time and reducing human error.

Action Code#

// legacy_hash_id: a_XziR2J
import { PAYMENT_MODE_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-create-customer-payment",
  name: "Create Customer Payment",
  description: "Creates a new payment. [See the documentation](https://www.zoho.com/books/api/v3/customer-payments/#create-a-payment)",
  version: "0.3.0",
  type: "action",
  props: {
    zohoBooks,
    customerId: {
      propDefinition: [
        zohoBooks,
        "customerId",
      ],
    },
    paymentMode: {
      type: "string",
      label: "Payment Mode",
      description: "Mode through which payment is made.",
      options: PAYMENT_MODE_OPTIONS,
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "Amount paid in the respective payment.",
    },
    date: {
      type: "string",
      label: "Date",
      description: "Date on which payment is made. Format [yyyy-mm-dd]",
    },
    referenceNumber: {
      type: "string",
      label: "Reference Number",
      description: "Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description about the payment.",
      optional: true,
    },
    invoices: {
      type: "string[]",
      label: "Invoices",
      description: "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}**",
    },
    exchangeRate: {
      type: "string",
      label: "Exchange Rate",
      description: "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: true,
    },
    bankCharges: {
      type: "string",
      label: "Bank Charges",
      description: "Denotes any additional bank charges.",
      optional: true,
    },
    customFields: {
      propDefinition: [
        zohoBooks,
        "customFields",
      ],
      description: "A list of Additional field objects for the payments. **Example: {\"label\": \"label\", \"value\": 129890}**",
      optional: true,
    },
    invoiceId: {
      propDefinition: [
        zohoBooks,
        "invoiceId",
        ({ customerId }) => ({
          customerId,
        }),
      ],
    },
    amountApplied: {
      type: "string",
      label: "Amount Applied",
      description: "Amount paid for the invoice.",
      optional: true,
    },
    taxAmountWithheld: {
      type: "string",
      label: "Tax Amount Withheld",
      description: "Amount withheld for tax.",
      optional: true,
    },
    accountId: {
      propDefinition: [
        zohoBooks,
        "accountId",
      ],
      optional: true,
    },
    contactPersons: {
      propDefinition: [
        zohoBooks,
        "contactPersons",
        ({ customerId }) => ({
          customerId,
        }),
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.zohoBooks.createCustomerPayment({
      $,
      data: {
        customer_id: this.customerId,
        payment_mode: this.paymentMode,
        amount: this.amount,
        date: this.date,
        reference_number: this.referenceNumber,
        description: this.description,
        invoices: parseObject(this.invoices),
        exchange_rate: this.exchangeRate && parseFloat(this.exchangeRate),
        bank_charges: this.bankCharges && parseFloat(this.bankCharges),
        custom_fields: parseObject(this.customFields),
        invoice_id: this.invoiceId,
        amount_applied: this.amountApplied && parseFloat(this.amountApplied),
        tax_amount_withheld: this.taxAmountWithheld && parseFloat(this.taxAmountWithheld),
        account_id: this.accountId,
        contact_persons: parseObject(this.contactPersons),
      },
    });

    $.export("$summary", `Customer payment successfully created with Id: ${response.payment.payment_id}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Zoho Books	`zohoBooks`	`app`	This component uses the Zoho Books app.
Customer Id	`customerId`	`string`	Select a value from the drop down menu.
Payment Mode	`paymentMode`	`string`	Select a value from the drop down menu:`checkcashcreditcardbanktransferbankremittanceautotransactionothers`
Amount	`amount`	`string`	Amount paid in the respective payment.
Date	`date`	`string`	Date on which payment is made. Format [yyyy-mm-dd]
Reference Number	`referenceNumber`	`string`	Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
Description	`description`	`string`	Description about the payment.
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}
Exchange Rate	`exchangeRate`	`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.
Bank Charges	`bankCharges`	`string`	Denotes any additional bank charges.
Custom Fields	`customFields`	`string[]`	A list of Additional field objects for the payments. Example: {"label": "label", "value": 129890}
Invoice Id	`invoiceId`	`string`	Select a value from the drop down menu.
Amount Applied	`amountApplied`	`string`	Amount paid for the invoice.
Tax Amount Withheld	`taxAmountWithheld`	`string`	Amount withheld for tax.
Account Id	`accountId`	`string`	Select a value from the drop down menu.
Contact Persons	`contactPersons`	`string[]`	Select a value from the drop down menu.

Action Authentication#

Zoho Books uses OAuth authentication. When you connect your Zoho Books account, Pipedream will open a popup window where you can sign into Zoho Books and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho Books API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoBooks.fullaccess.all