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,000+ 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

4 min

Watch now ➜

Trusted by 800,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. Configure organization_id
3. Optional- Configure description
4. Optional- Configure reference_number
5. Optional- Configure date
6. Optional- Select a status
7. Optional- Configure amount
8. Optional- Configure account_name
9. Optional- Configure customer_name
10. Optional- Configure vendor_name
11. Optional- Configure customer_id
12. Optional- Configure vendor_id
13. Optional- Configure recurring_expense_id
14. Optional- Configure paid_through_account_id
15. Optional- Configure search_text
16. Optional- Select a sort_column
17. Optional- Select a filter_by
18. Optional- Configure page
19. Optional- Configure per_page
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.

Version:0.2.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
import { axios } from "@pipedream/platform";

export default {
  key: "zoho_books-list-expenses",
  name: "List Expenses",
  description: "List all the Expenses.",
  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.",
    },
    description: {
      type: "string",
      description: "Search expenses by description.Variants `description_startswith` and `description_contains`. Max-length [100]",
      optional: true,
    },
    reference_number: {
      type: "string",
      description: "Search expenses by reference number. Variants `reference_number_startswith` and `reference_number_contains`. Max-length [100]",
      optional: true,
    },
    date: {
      type: "string",
      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",
      description: "Search expenses by expense status. Allowed Values `unbilled`, `invoiced`, `reimbursed`, `non-billable` and `billable`.",
      optional: true,
      options: [
        "unbilled",
        "invoiced",
        "reimbursed",
        "non-billable",
        "billable",
      ],
    },
    amount: {
      type: "string",
      description: "Search expenses by amount. Variants: `amount_less_than`, `amount_less_equals`, `amount_greater_than` and `amount_greater_than`.",
      optional: true,
    },
    account_name: {
      type: "string",
      description: "Search expenses by expense account name. Variants `account_name_startswith` and `account_name_contains`. Max-length [100",
      optional: true,
    },
    customer_name: {
      type: "string",
      description: "Search expenses by customer name. Variants: `customer_name_startswith` and `customer_name_contains`. Max-length [100]",
      optional: true,
    },
    vendor_name: {
      type: "string",
      description: "Search expenses by vendor name. Variants: `vendor_name_startswith` and `vendor_name_contains`.",
      optional: true,
    },
    customer_id: {
      type: "string",
      description: "ID of the expense account.",
      optional: true,
    },
    vendor_id: {
      type: "string",
      description: "ID of the vendor the expense is made.",
      optional: true,
    },
    recurring_expense_id: {
      type: "string",
      description: "Search expenses by recurring expense id.",
      optional: true,
    },
    paid_through_account_id: {
      type: "string",
      description: "Search expenses by paid through account id.",
      optional: true,
    },
    search_text: {
      type: "string",
      description: "Search expenses by account name or description or `customer name` or `vendor name`. Max-length [100]",
      optional: true,
    },
    sort_column: {
      type: "string",
      description: "Sort expenses.Allowed Values `date`, `account_name`, `total`, `bcy_total`, `reference_number`, `customer_name` and `created_time`.",
      optional: true,
      options: [
        "date",
        "account_name",
        "total",
        "bcy_total",
        "reference_number",
        "customer_name",
        "created_time",
      ],
    },
    filter_by: {
      type: "string",
      description: "Filter expenses by expense status. Allowed Values `Status.All`, `Status.Billable`, `Status.Nonbillable`, `Status.Reimbursed`, `Status.Invoiced` and `Status.Unbilled`.",
      optional: true,
      options: [
        "Status.All",
        "Status.Billable",
        "Status.Nonbillable",
        "Status.Reimbursed",
        "Status.Invoiced",
        "Status.Unbilled",
      ],
    },
    page: {
      type: "string",
      description: "By default first page will be listed. For navigating through `pages`, use the `page` parameter.",
      optional: true,
    },
    per_page: {
      type: "string",
      description: "The `per_page` parameter can be used to set the number of records that you want to receive in response.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://www.zoho.com/books/api/v3/#Expenses_List_Expenses

    if (!this.organization_id) {
      throw new Error("Must provide organization_id parameters.");
    }

    return await axios($, {
      method: "get",
      url: `https://books.${this.zoho_books.$auth.base_api_uri}/api/v3/expenses?organization_id=${this.organization_id}`,
      headers: {
        Authorization: `Zoho-oauthtoken ${this.zoho_books.$auth.oauth_access_token}`,
      },
      params: {
        description: this.description,
        reference_number: this.reference_number,
        date: this.date,
        status: this.status,
        amount: this.amount,
        account_name: this.account_name,
        customer_name: this.customer_name,
        vendor_name: this.vendor_name,
        customer_id: this.customer_id,
        vendor_id: this.vendor_id,
        recurring_expense_id: this.recurring_expense_id,
        paid_through_account_id: this.paid_through_account_id,
        search_text: this.search_text,
        sort_column: this.sort_column,
        filter_by: this.filter_by,
        page: this.page,
        per_page: this.per_page,
      },
    });
  },
};

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	`zoho_books`	`app`	This component uses the Zoho Books app.
organization_id	`organization_id`	`string`	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.
description	`description`	`string`	Search expenses by description.Variants `description_startswith` and `description_contains`. Max-length [100]
reference_number	`reference_number`	`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. Variants: `amount_less_than`, `amount_less_equals`, `amount_greater_than` and `amount_greater_than`.
account_name	`account_name`	`string`	Search expenses by expense account name. Variants `account_name_startswith` and `account_name_contains`. Max-length [100
customer_name	`customer_name`	`string`	Search expenses by customer name. Variants: `customer_name_startswith` and `customer_name_contains`. Max-length [100]
vendor_name	`vendor_name`	`string`	Search expenses by vendor name. Variants: `vendor_name_startswith` and `vendor_name_contains`.
customer_id	`customer_id`	`string`	ID of the expense account.
vendor_id	`vendor_id`	`string`	ID of the vendor the expense is made.
recurring_expense_id	`recurring_expense_id`	`string`	Search expenses by recurring expense id.
paid_through_account_id	`paid_through_account_id`	`string`	Search expenses by paid through account id.
search_text	`search_text`	`string`	Search expenses by account name or description or `customer name` or `vendor name`. Max-length [100]
sort_column	`sort_column`	`string`	Select a value from the drop down menu:`dateaccount_nametotalbcy_totalreference_numbercustomer_namecreated_time`
filter_by	`filter_by`	`string`	Select a value from the drop down menu:`Status.AllStatus.BillableStatus.NonbillableStatus.ReimbursedStatus.InvoicedStatus.Unbilled`
page	`page`	`string`	By default first page will be listed. For navigating through `pages`, use the `page` parameter.
per_page	`per_page`	`string`	The `per_page` parameter can be used to set the number of records that you want to receive in response.

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,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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