← Zoho Creator + Zoho Books integrations

Create Customer Payment with Zoho Books API on New Record from Zoho Creator API

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

Trigger workflow on
New Record from the Zoho Creator API
Next, do this
Create Customer Payment with the Zoho Books API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

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

  1. Select this integration
  2. Configure the New Record trigger
    1. Connect your Zoho Creator account
    2. Configure Polling interval
    3. Select a Application
    4. Select a Report
  3. Configure the Create Customer Payment action
    1. Connect your Zoho Books account
    2. Configure organization_id
    3. Configure customer_id
    4. Select a payment_mode
    5. Configure invoices
    6. Configure amount
    7. Configure date
    8. Optional- Configure reference_number
    9. Optional- Configure description
    10. Optional- Configure exchange_rate
    11. Optional- Configure bank_charges
    12. Optional- Configure custom_fields
    13. Optional- Configure invoice_id
    14. Optional- Configure amount_applied
    15. Optional- Configure tax_amount_withheld
    16. Optional- Configure account_id
    17. Optional- Configure contact_persons
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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

Description:Emit new records in a report. The `Added Time` field must be added as a **Grouping** field in the Zoho Creator *record properties* for the **Report** chosen in the dropdown below. See [the grouping help article](https://www.zoho.com/creator/newhelp/reports/display-records-as-groups-list-report.html) and [the docs](https://www.zoho.com/creator/help/api/v2/get-records.html) for more information.
Version:0.0.3
Key:zoho_creator-new-record

Zoho Creator Overview

Zoho Creator is a low-code platform that enables the building of custom applications tailored to business needs without extensive coding knowledge. Via its API, you can automate processes, manage data, and integrate with other services. Pipedream amplifies this capability by offering a serverless platform where events from various apps trigger workflows. You can use Zoho Creator’s API on Pipedream to create, read, update, and delete records, automate data flows, and link your custom apps with a myriad of other services for efficient, automated workflows.

Trigger Code

import common from "../common.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

const { zohoCreator } = common.props;
const { toSingleLineString } = utils;

export default {
  ...common,
  key: "zoho_creator-new-record",
  description: toSingleLineString(`
    Emit new records in a report. The \`Added Time\` field must be added as a **Grouping** field
    in the Zoho Creator *record properties* for the **Report** chosen in the dropdown below. See
    [the grouping help
    article](https://www.zoho.com/creator/newhelp/reports/display-records-as-groups-list-report.html)
    and [the docs](https://www.zoho.com/creator/help/api/v2/get-records.html) for more
    information.
  `),
  type: "source",
  name: "New Record",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    ...common.props,
    reportLinkName: {
      propDefinition: [
        zohoCreator,
        "reportLinkName",
        ({ appLinkName }) => ({
          appLinkName,
        }),
      ],
      description: toSingleLineString(`
        The link name of the target report. The \`Added Time\` field must be added as a
        **Grouping** field in the Zoho Creator *record properties* for the chosen report. See [the
        grouping help
        article](https://www.zoho.com/creator/newhelp/reports/display-records-as-groups-list-report.html).
      `),
    },
  },
  methods: {
    ...common.methods,
    getMetadata(record) {
      return {
        id: record.ID,
        summary: JSON.stringify(record),
        ts: Date.parse(record[constants.ADDED_TIME_FIELD]),
      };
    },
    validateRecord(record) {
      if (!record[constants.ADDED_TIME_FIELD]) {
        throw new ConfigurationError("Record is missing the \"Added Time\" field. Add the \"Added Time\" Grouping field in the Zoho Creator record properties for the Report.");
      }
    },
    processEvent(record) {
      this.validateRecord(record);
      this.$emit(record, this.getMetadata(record));
      this.setLastTimestamp(record[constants.ADDED_TIME_FIELD]);
    },
  },
  async run() {
    const {
      appLinkName,
      reportLinkName,
    } = this;

    // If last timestamp is not set, use timestamp of 1 day ago
    // to avoid fetching all records on first run of the source
    const lastAddedTime =
      this.getLastTimestamp()
      ?? await this.zohoCreator.daysAgoString({
        appLinkName,
        days: 1,
      });

    const recordsStream =
      await this.zohoCreator.getRecordsStream({
        appLinkName,
        reportLinkName,
        addedTime: lastAddedTime,
      });

    for await (const record of recordsStream) {
      this.processEvent(record);
    }
  },
};

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.
LabelPropTypeDescription
Zoho CreatorzohoCreatorappThis component uses the Zoho Creator app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
Polling intervaltimer$.interface.timer

How often to poll the Zoho Creator API for resources

ApplicationappLinkNamestringSelect a value from the drop down menu.
ReportreportLinkNamestringSelect a value from the drop down menu.

Trigger Authentication

Zoho Creator uses OAuth authentication. When you connect your Zoho Creator account, Pipedream will open a popup window where you can sign into Zoho Creator 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 Creator API.

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

ZohoCreator.form.CREATEZohoCreator.report.CREATEZohoCreator.report.READZohoCreator.report.UPDATEZohoCreator.report.DELETEZohoCreator.meta.form.READZohoCreator.meta.application.READZohoCreator.dashboard.READZohoCreator.bulk.CREATEZohoCreator.bulk.READ

About Zoho Creator

Low-code platform

Action

Description:Creates a new payment.
Version:0.2.1
Key:zoho_books-create-customer-payment

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 { axios } from "@pipedream/platform";

export default {
  key: "zoho_books-create-customer-payment",
  name: "Create Customer Payment",
  description: "Creates a new payment.",
  version: "0.2.1",
  type: "action",
  props: {
    zoho_books: {
      type: "app",
      app: "zoho_books",
    },
    organization_id: {
      type: "string",
      description: "In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc.\n\nThe parameter `organization_id` should be sent in with every API request to identify the organization.\n\nThe `organization_id` can be obtained from the GET `/organizations` API's JSON response. Alternatively, it can be obtained from the **Manage Organizations** page in the admin console.",
    },
    customer_id: {
      type: "string",
      description: "Customer ID of the customer involved in the payment.",
    },
    payment_mode: {
      type: "string",
      description: "Mode through which payment is made. This can be `check`, `cash`, `creditcard`, `banktransfer`, `bankremittance`, `autotransaction` or `others`. Max-length [100]",
      options: [
        "check",
        "cash",
        "creditcard",
        "banktransfer",
        "bankremittance",
        "autotransaction",
        "others",
      ],
    },
    invoices: {
      type: "any",
      description: "List of invoices associated with the payment. Each invoice object contains `invoice_id`, `invoice_number`, `date`, `invoice_amount`, `amount_applied` and `balance_amount`.",
    },
    amount: {
      type: "string",
      description: "Amount paid in the respective payment.",
    },
    date: {
      type: "string",
      description: "Date on which payment is made. Format [yyyy-mm-dd]",
    },
    reference_number: {
      type: "string",
      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",
      description: "Description about the payment.",
      optional: true,
    },
    exchange_rate: {
      type: "string",
      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,
    },
    bank_charges: {
      type: "string",
      description: "Denotes any additional bank charges.",
      optional: true,
    },
    custom_fields: {
      type: "any",
      description: "Additional fields for the payments.",
      optional: true,
    },
    invoice_id: {
      type: "string",
      description: "ID of the invoice to get payments of.",
      optional: true,
    },
    amount_applied: {
      type: "string",
      description: "Amount paid for the invoice.",
      optional: true,
    },
    tax_amount_withheld: {
      type: "string",
      description: "Amount withheld for tax.",
      optional: true,
    },
    account_id: {
      type: "string",
      description: "ID of the cash/bank account the payment has to be deposited.",
      optional: true,
    },
    contact_persons: {
      type: "string",
      description: "IDs of the contact personsthe thank you mail has to be triggered.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://www.zoho.com/books/api/v3/#Customer-Payments_Create_a_payment

    if (!this.organization_id || !this.customer_id || !this.payment_mode || !this.invoices || !this.amount || !this.date) {
      throw new Error("Must provide organization_id, customer_id, payment_mode, invoices, amount, and date parameters.");
    }

    return await axios($, {
      method: "post",
      url: `https://books.${this.zoho_books.$auth.base_api_uri}/api/v3/customerpayments?organization_id=${this.organization_id}`,
      headers: {
        Authorization: `Zoho-oauthtoken ${this.zoho_books.$auth.oauth_access_token}`,
      },
      data: {
        customer_id: this.customer_id,
        payment_mode: this.payment_mode,
        amount: this.amount,
        date: this.date,
        reference_number: this.reference_number,
        description: this.description,
        invoices: this.invoices,
        exchange_rate: this.exchange_rate,
        bank_charges: this.bank_charges,
        custom_fields: this.custom_fields,
        invoice_id: this.invoice_id,
        amount_applied: this.amount_applied,
        tax_amount_withheld: this.tax_amount_withheld,
        account_id: this.account_id,
        contact_persons: this.contact_persons,
      },
    });
  },
};

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.

LabelPropTypeDescription
Zoho Bookszoho_booksappThis component uses the Zoho Books app.
organization_idorganization_idstring

In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc.

The parameter organization_id should be sent in with every API request to identify the organization.

The organization_id can be obtained from the GET /organizations API's JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console.

customer_idcustomer_idstring

Customer ID of the customer involved in the payment.

payment_modepayment_modestringSelect a value from the drop down menu:checkcashcreditcardbanktransferbankremittanceautotransactionothers
invoicesinvoicesany

List of invoices associated with the payment. Each invoice object contains invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount.

amountamountstring

Amount paid in the respective payment.

datedatestring

Date on which payment is made. Format [yyyy-mm-dd]

reference_numberreference_numberstring

Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]

descriptiondescriptionstring

Description about the payment.

exchange_rateexchange_ratestring

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_chargesbank_chargesstring

Denotes any additional bank charges.

custom_fieldscustom_fieldsany

Additional fields for the payments.

invoice_idinvoice_idstring

ID of the invoice to get payments of.

amount_appliedamount_appliedstring

Amount paid for the invoice.

tax_amount_withheldtax_amount_withheldstring

Amount withheld for tax.

account_idaccount_idstring

ID of the cash/bank account the payment has to be deposited.

contact_personscontact_personsstring

IDs of the contact personsthe thank you mail has to be triggered.

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

About Zoho Books

Online accounting software

More Ways to Connect Zoho Books + Zoho Creator

Create Customer Payment with Zoho Books API on New or Updated Record from Zoho Creator API
Zoho Creator + Zoho Books
 
Try it
Create Employee with Zoho Books API on New or Updated Record from Zoho Creator API
Zoho Creator + Zoho Books
 
Try it
Create Employee with Zoho Books API on New Record from Zoho Creator API
Zoho Creator + Zoho Books
 
Try it
Create Invoice with Zoho Books API on New or Updated Record from Zoho Creator API
Zoho Creator + Zoho Books
 
Try it
Create Invoice with Zoho Books API on New Record from Zoho Creator API
Zoho Creator + Zoho Books
 
Try it
New or Updated Record from the Zoho Creator API

Emit new or updated records in a report. The Modified Time field must be added as Grouping field in the Zoho Creator record properties for the Report chosen in the dropdown below. See the grouping help article and the docs for more information.

 
Try it
New Record from the Zoho Creator API

Emit new records in a report. The Added Time field must be added as a Grouping field in the Zoho Creator record properties for the Report chosen in the dropdown below. See the grouping help article and the docs for more information.

 
Try it
Create Customer Payment with the Zoho Books API

Creates a new payment.

 
Try it
Create Employee with the Zoho Books API

Creates an employee for an expense.

 
Try it
Create Invoice with the Zoho Books API

Creates an invoice for your customer.

 
Try it
Create Item with the Zoho Books API

Creates a new item.

 
Try it
Create Sales Order with the Zoho Books API

Creates a sales order.

 
Try it

Explore Other Apps

1
-
24
of
2,100+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.