List Expenses with Zoho Books API on New User from Zoho CRM API

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

Trigger workflow on

New User from the Zoho CRM API

Next, do this

List Expenses 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 Zoho CRM 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 User trigger
1. Connect your Zoho CRM account
2. Configure Polling Interval
3. Select a User Type
Configure the List Expenses action
1. Connect your Zoho Books account
2. Optional- Configure Description
3. Optional- Configure Reference Number
4. Optional- Configure Date
5. Optional- Select a Status
6. Optional- Configure Amount
7. Optional- Configure Account Name
8. Optional- Configure Customer Name
9. Optional- Configure Vendor Name
10. Optional- Configure Customer Id
11. Optional- Configure Vendor Id
12. Optional- Configure Recurring Expense Id
13. Optional- Configure Paid Through Account Id
14. Optional- Configure Search Text
15. Optional- Select a Sort Column
16. Optional- Select a Filter By
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 User on Zoho CRM

Description:Emits an event each time a new user is created in Zoho CRM

Version:0.0.10

Key:zoho_crm-new-user

View on GitHub

Zoho CRM Overview#

The Zoho CRM API enables the manipulation and retrieval of data within Zoho CRM, a platform for managing your sales, marketing, support, and inventory in a single system. Leveraging this on Pipedream, you can automate tasks like syncing contacts, updating lead statuses, or creating custom CRM operations that trigger actions in other apps. Pipedream's serverless platform allows for real-time data processing, transforming, and orchestrating workflows that respond to events in Zoho CRM with minimal latency.

Trigger Code#

import common from "../common/timer-based/base.mjs";
import userTypes from "./common-user-types.mjs";

export default {
  ...common,
  key: "zoho_crm-new-user",
  name: "New User",
  description: "Emits an event each time a new user is created in Zoho CRM",
  version: "0.0.10",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    userType: {
      type: "string",
      label: "User Type",
      description: "The type of users to generate events for",
      options: userTypes,
    },
  },
  hooks: {
    async activate() {
      const userCount = await this.zohoCrm.getUserCount({
        type: this.userType,
      });
      this._setUserCount(userCount);
    },
  },
  methods: {
    ...common.methods,
    _getUserCount() {
      return this.db.get("userCount");
    },
    _setUserCount(userCount) {
      this.db.set("userCount", userCount);
    },
    generateMeta({
      user,
      event,
    }) {
      const {
        id,
        first_name: firstName = "",
        last_name: lastName = "",
      } = user;
      const lastNameInitial = lastName
        ? `${lastName.slice(0, 1)}.`
        : "";
      const userNameDisplay = `${firstName} ${lastNameInitial}`;
      const summary = `New User: ${userNameDisplay}`;
      const { timestamp: ts } = event;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      const lastUserCount = this._getUserCount();
      const usersPage = this.zohoCrm.computeLastUsersPage({
        userCount: lastUserCount,
      });
      let usersOffset = this.zohoCrm.computeUsersOffset({
        userCount: lastUserCount,
      });
      let newUserCount = lastUserCount;
      const userScan = await this.zohoCrm.getUsers({
        page: usersPage,
        type: this.userType,
      });
      for await (const user of userScan) {
        if (usersOffset > 0) {
          // The first items in the user retrieval could have been already
          // processed. `usersOffset` contains the amount of items that we need to
          // skip before we hit a new, unprocessed item.
          --usersOffset;
          continue;
        }

        const meta = this.generateMeta({
          user,
          event,
        });
        this.$emit(user, meta);
        ++newUserCount;
      }

      this._setUserCount(newUserCount);
    },
  },
};

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
Zoho CRM	`zohoCrm`	`app`	This component uses the Zoho CRM app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the Zoho API on this schedule
User Type	`userType`	`string`	Select a value from the drop down menu:`{ "value": "AllUsers", "label": "All users in your organization (both active and inactive users)" }{ "value": "ActiveUsers", "label": "Active Users" }{ "value": "DeactiveUsers", "label": "Users who were deactivated" }{ "value": "ConfirmedUsers", "label": "Confirmed users" }{ "value": "NotConfirmedUsers", "label": "Non-confirmed users" }{ "value": "DeletedUsers", "label": "Deleted users" }{ "value": "ActiveConfirmedUsers", "label": "Active users who are also confirmed" }{ "value": "AdminUsers", "label": "Admin users" }{ "value": "ActiveConfirmedAdmins", "label": "Active users with the administrative privileges and are also confirmed" }{ "value": "CurrentUser", "label": "The current CRM user" }`

Trigger Authentication#

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

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

ZohoCRM.settings.allZohoCRM.users.allZohoCRM.org.allZohoCRM.modules.allZohoCRM.bulk.allZohoCRM.notifications.readZohoCRM.notifications.createZohoCRM.notifications.updateZohoCRM.notifications.deleteZohoCRM.coql.READZohoCRM.functions.execute.READZohoCRM.functions.execute.CREATEZohoCRM.templates.email.READZohoCRM.templates.inventory.READ

About Zoho CRM#

Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.

Action#

List Expenses on Zoho Books

Description:List all the Expenses. [See the documentation](https://www.zoho.com/books/api/v3/expenses/#list-expenses)

Version:0.3.1

Key:zoho_books-list-expenses

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_gnir81// legacy_hash_id: a_RAiV28
import {
  FILTER_BY_OPTIONS,
  SORT_COLUMN_OPTIONS,
  STATUS_OPTIONS,
} from "../../common/constants.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-list-expenses",
  name: "List Expenses",
  description: "List all the Expenses. [See the documentation](https://www.zoho.com/books/api/v3/expenses/#list-expenses)",
  version: "0.3.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    zohoBooks,
    description: {
      type: "string",
      label: "Description",
      description: "Search expenses by description.Variants `description_startswith` and `description_contains`. Max-length [100]",
      optional: true,
    },
    referenceNumber: {
      type: "string",
      label: "Reference Number",
      description: "Search expenses by reference number. Variants `reference_number_startswith` and `reference_number_contains`. Max-length [100]",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Search expenses by expense date. Variants `date_start`, `date_end`, `date_before` and `date_after`. Format [yyyy-mm-dd]",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Search expenses by expense status.",
      options: STATUS_OPTIONS,
      optional: true,
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "Search expenses by amount.",
      optional: true,
    },
    accountName: {
      type: "string",
      label: "Account Name",
      description: "Search expenses by expense account name. Max-length [100]",
      optional: true,
    },
    customerName: {
      type: "string",
      label: "Customer Name",
      description: "Search expenses by customer name. Max-length [100]",
      optional: true,
    },
    vendorName: {
      type: "string",
      label: "Vendor Name",
      description: "Search expenses by vendor name.",
      optional: true,
    },
    customerId: {
      type: "string",
      label: "Customer Id",
      description: "ID of the expense account.",
      optional: true,
    },
    vendorId: {
      type: "string",
      label: "Vendor Id",
      description: "ID of the vendor the expense is made.",
      optional: true,
    },
    recurringExpenseId: {
      type: "string",
      label: "Recurring Expense Id",
      description: "Search expenses by recurring expense id.",
      optional: true,
    },
    paidThroughAccountId: {
      type: "string",
      label: "Paid Through Account Id",
      description: "Search expenses by paid through account id.",
      optional: true,
    },
    searchText: {
      type: "string",
      label: "Search Text",
      description: "Search expenses by account name or description or `customer name` or `vendor name`. Max-length [100]",
      optional: true,
    },
    sortColumn: {
      type: "string",
      label: "Sort Column",
      description: "Sort expenses.",
      optional: true,
      options: SORT_COLUMN_OPTIONS,
    },
    filterBy: {
      type: "string",
      label: "Filter By",
      description: "Filter expenses by expense status.",
      optional: true,
      options: FILTER_BY_OPTIONS,
    },
  },
  async run({ $ }) {
    const response = this.zohoBooks.paginate({
      fn: this.zohoBooks.listExpenses,
      fieldName: "expenses",
      params: {
        description: this.description,
        reference_number: this.referenceNumber,
        date: this.date,
        status: this.status,
        amount: this.amount,
        account_name: this.accountName,
        customer_name: this.customerName,
        vendor_name: this.vendorName,
        customer_id: this.customerId,
        vendor_id: this.vendorId,
        recurring_expense_id: this.recurringExpenseId,
        paid_through_account_id: this.paidThroughAccountId,
        search_text: this.searchText,
        sort_column: this.sortColumn,
        filter_by: this.filterBy,
      },
    });

    const responseArray = [];
    for await (const item of response) {
      responseArray.push(item);
    }

    $.export("$summary", `Successfully fetched ${responseArray.length} expenses(s)`);
    return responseArray;
  },
};

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.
Description	`description`	`string`	Search expenses by description.Variants `description_startswith` and `description_contains`. Max-length [100]
Reference Number	`referenceNumber`	`string`	Search expenses by reference number. Variants `reference_number_startswith` and `reference_number_contains`. Max-length [100]
Date	`date`	`string`	Search expenses by expense date. Variants `date_start`, `date_end`, `date_before` and `date_after`. Format [yyyy-mm-dd]
Status	`status`	`string`	Select a value from the drop down menu:`unbilledinvoicedreimbursednon-billablebillable`
Amount	`amount`	`string`	Search expenses by amount.
Account Name	`accountName`	`string`	Search expenses by expense account name. Max-length [100]
Customer Name	`customerName`	`string`	Search expenses by customer name. Max-length [100]
Vendor Name	`vendorName`	`string`	Search expenses by vendor name.
Customer Id	`customerId`	`string`	ID of the expense account.
Vendor Id	`vendorId`	`string`	ID of the vendor the expense is made.
Recurring Expense Id	`recurringExpenseId`	`string`	Search expenses by recurring expense id.
Paid Through Account Id	`paidThroughAccountId`	`string`	Search expenses by paid through account id.
Search Text	`searchText`	`string`	Search expenses by account name or description or `customer name` or `vendor name`. Max-length [100]
Sort Column	`sortColumn`	`string`	Select a value from the drop down menu:`dateaccount_nametotalbcy_totalreference_numbercustomer_namecreated_time`
Filter By	`filterBy`	`string`	Select a value from the drop down menu:`Status.AllStatus.BillableStatus.NonbillableStatus.ReimbursedStatus.InvoicedStatus.Unbilled`

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

List Expenses with Zoho Books API on New User from Zoho CRM API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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