Create Item with Zoho Books API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Item 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Item action
1. Connect your Zoho Books account
2. Configure Name
3. Configure Rate
4. Optional- Configure Description
5. Optional- Select a Tax Id
6. Optional- Configure Tax Percentage
7. Optional- Configure SKU
8. Optional- Select a Product Type
9. Optional- Configure HSN Or SAC
10. Optional- Configure Is Taxable
11. Optional- Configure Tax Exemption Id
12. Optional- Select a Account Id
13. Optional- Select a Item Type
14. Optional- Configure Purchase Description
15. Optional- Configure Purchase Rate
16. Optional- Configure Purchase Account Id
17. Optional- Configure Inventory Account Id
18. Optional- Configure Vendor Id
19. Optional- Configure Reorder Level
20. Optional- Configure Initial Stock
21. Optional- Configure Initial Stock Rate
22. Optional- Configure Item Tax Preferences
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Create Item on Zoho Books

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

Version:0.3.1

Key:zoho_books-create-item

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_Xzi1qo
import {
  ITEM_TYPE_OPTIONS, PRODUCT_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-create-item",
  name: "Create Item",
  description: "Creates a new item. [See the documentation](https://www.zoho.com/books/api/v3/items/#create-an-item)",
  version: "0.3.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    zohoBooks,
    name: {
      type: "string",
      label: "Name",
      description: "Name of the item. Max-length [100]",
    },
    rate: {
      type: "string",
      label: "Rate",
      description: "Price of the item.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description for the item. Max-length [2000]",
      optional: true,
    },
    taxId: {
      propDefinition: [
        zohoBooks,
        "taxId",
      ],
      description: "ID of the tax to be associated to the item.",
      optional: true,
    },
    taxPercentage: {
      type: "string",
      label: "Tax Percentage",
      description: "Percent of the tax.",
      optional: true,
    },
    sku: {
      type: "string",
      label: "SKU",
      description: "SKU value of item,should be unique throughout the product",
      optional: true,
    },
    productType: {
      type: "string",
      label: "Product Type",
      description: "Specify the type of an item.",
      optional: true,
      options: PRODUCT_TYPE_OPTIONS,
    },
    hsnOrSac: {
      type: "string",
      label: "HSN Or SAC",
      description: "HSN Code.",
      optional: true,
    },
    isTaxable: {
      type: "boolean",
      label: "Is Taxable",
      description: "Boolean to track the taxability of the item.",
      optional: true,
    },
    taxExemptionId: {
      type: "string",
      label: "Tax Exemption Id",
      description: "ID of the tax exemption. Mandatory, if is_taxable is false.",
      optional: true,
    },
    accountId: {
      propDefinition: [
        zohoBooks,
        "accountId",
      ],
      description: "ID of the account to which the item has to be associated with.",
      optional: true,
    },
    itemType: {
      type: "string",
      label: "Item Type",
      description: "Type of the item. Default value will be sales.",
      optional: true,
      options: ITEM_TYPE_OPTIONS,
    },
    purchaseDescription: {
      type: "string",
      label: "Purchase Description",
      description: "Purchase description for the item.",
      optional: true,
    },
    purchaseRate: {
      type: "string",
      label: "Purchase Rate",
      description: "Purchase price of the item.",
      optional: true,
    },
    purchaseAccountId: {
      type: "string",
      label: "Purchase Account Id",
      description: "ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.",
      optional: true,
    },
    inventoryAccountId: {
      type: "string",
      label: "Inventory Account Id",
      description: "ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.",
      optional: true,
    },
    vendorId: {
      type: "string",
      label: "Vendor Id",
      description: "Preferred vendor ID.",
      optional: true,
    },
    reorderLevel: {
      type: "string",
      label: "Reorder Level",
      description: "Reorder level of the item.",
      optional: true,
    },
    initialStock: {
      type: "string",
      label: "Initial Stock",
      description: "Opening stock of the item.",
      optional: true,
    },
    initialStockRate: {
      type: "string",
      label: "Initial Stock Rate",
      description: "Unit price of the opening stock.",
      optional: true,
    },
    itemTaxPreferences: {
      type: "string[]",
      label: "Item Tax Preferences",
      description: "A list of item tax objects. **Format: {\"tax_id\":\"12312312031200\",\"tax_specification\":\"intra\"}**",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.zohoBooks.createItem({
      $,
      data: {
        name: this.name,
        rate: this.rate && parseFloat(this.rate),
        description: this.description,
        tax_id: this.taxId,
        tax_percentage: this.taxPercentage,
        sku: this.sku,
        product_type: this.productType,
        hsn_or_sac: this.hsnOrSac,
        is_taxable: this.isTaxable,
        tax_exemption_id: this.taxExemptionId,
        account_id: this.accountId,
        item_type: this.itemType,
        purchase_description: this.purchaseDescription,
        purchase_rate: this.purchaseRate,
        purchase_account_id: this.purchaseAccountId,
        inventory_account_id: this.inventoryAccountId,
        vendor_id: this.vendorId,
        reorder_level: this.reorderLevel,
        initial_stock: this.initialStock,
        initial_stock_rate: this.initialStockRate,
        item_tax_preferences: parseObject(this.itemTaxPreferences),
      },
    });

    $.export("$summary", `Item successfully created with Id: ${response.item.item_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.
Name	`name`	`string`	Name of the item. Max-length [100]
Rate	`rate`	`string`	Price of the item.
Description	`description`	`string`	Description for the item. Max-length [2000]
Tax Id	`taxId`	`string`	Select a value from the drop down menu.
Tax Percentage	`taxPercentage`	`string`	Percent of the tax.
SKU	`sku`	`string`	SKU value of item,should be unique throughout the product
Product Type	`productType`	`string`	Select a value from the drop down menu:`goodsservicedigital_service`
HSN Or SAC	`hsnOrSac`	`string`	HSN Code.
Is Taxable	`isTaxable`	`boolean`	Boolean to track the taxability of the item.
Tax Exemption Id	`taxExemptionId`	`string`	ID of the tax exemption. Mandatory, if is_taxable is false.
Account Id	`accountId`	`string`	Select a value from the drop down menu.
Item Type	`itemType`	`string`	Select a value from the drop down menu:`salespurchasessales_and_purchasesinventory`
Purchase Description	`purchaseDescription`	`string`	Purchase description for the item.
Purchase Rate	`purchaseRate`	`string`	Purchase price of the item.
Purchase Account Id	`purchaseAccountId`	`string`	ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.
Inventory Account Id	`inventoryAccountId`	`string`	ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
Vendor Id	`vendorId`	`string`	Preferred vendor ID.
Reorder Level	`reorderLevel`	`string`	Reorder level of the item.
Initial Stock	`initialStock`	`string`	Opening stock of the item.
Initial Stock Rate	`initialStockRate`	`string`	Unit price of the opening stock.
Item Tax Preferences	`itemTaxPreferences`	`string[]`	A list of item tax objects. Format: {"tax_id":"12312312031200","tax_specification":"intra"}

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

Create Item with Zoho Books API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Zoho Books, Pipedream 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