List Invoices with Zoho Books API on New Document Status Changed from Docsumo API

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

Trigger workflow on

New Document Status Changed from the Docsumo API

Next, do this

List Invoices 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 Docsumo 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 Document Status Changed trigger
1. Connect your Docsumo account
2. Configure timer
Configure the List Invoices action
1. Connect your Zoho Books account
2. Optional- Configure Invoice Number
3. Optional- Configure Item Name
4. Optional- Configure Item Id
5. Optional- Configure Item Description
6. Optional- Configure Reference Number
7. Optional- Configure Customer Name
8. Optional- Configure Recurring Invoice Id
9. Optional- Configure Email
10. Optional- Configure Total
11. Optional- Configure Balance
12. Optional- Configure Custom Field
13. Optional- Configure Date
14. Optional- Configure Due Date
15. Optional- Configure Last Modified Time
16. Optional- Select a Status
17. Optional- Configure Customer Id
18. Optional- Select a Filter By
19. Optional- Configure Search Text
20. Optional- Select a Sort Column
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 Document Status Changed on Docsumo

Description:Emit new event when document status is changed

Version:0.0.1

Key:docsumo-document-status-changed

View on GitHub

Docsumo Overview#

The Docsumo API offers robust capabilities for extracting and processing data from various types of documents, like invoices, receipts, and bank statements. It applies intelligent OCR (Optical Character Recognition) to transform unstructured documents into structured data. With Pipedream, you can harness this power to automate workflows, such as digitizing financial records, validating document data, or integrating extracted information into databases or other apps, all with minimal code.

Trigger Code#

import app from "../../docsumo.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  name: "New Document Status Changed",
  description: "Emit new event when document status is changed",
  key: "docsumo-document-status-changed",
  version: "0.0.1",
  type: "source",
  props: {
    app,
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
  },
  hooks: {
    async deploy() {
      const documents = await this.listAllDocuments();
      this.setDocuments(this.getDocumentsStatusMap(documents));
    },
  },
  methods: {
    setDocuments(documents) {
      this.db.set("documents", documents);
    },
    getDocuments() {
      return this.db.get("documents") || {};
    },
    getDocumentsStatusMap(documents) {
      const documentsStatusMap = {};
      for (const document of documents) {
        documentsStatusMap[document.doc_id] = document.status;
      }
      return documentsStatusMap;
    },
    getDocumentsMappedByDocId(documents) {
      const documentsMap = {};
      for (const document of documents) {
        documentsMap[document.doc_id] = document;
      }
      return documentsMap;
    },
    async listAllDocuments(params) {
      const PAGE_SIZE = 200;
      let page = 0;
      const documents = [];

      while (true) {
        const res = await this.app.listDocuments({
          ...params,
          limit: PAGE_SIZE,
          offset: (page * PAGE_SIZE),
        });
        if (res.data.documents.length === 0) {
          break;
        }
        documents.push(...res.data.documents);
        page++;
      }

      return documents;
    },
    emitEvent(doc, isNew) {
      this.$emit(doc, {
        id: `${doc.doc_id}-${doc.status}`,
        summary: `${isNew
          ? "New"
          : "Changed"
        } - ${doc.doc_id}`,
        ts: Date.now(),
      });
    },
  },
  async run() {
    const documents = await this.listAllDocuments();
    const changedDocuments = [];
    const newDocuments = [];
    const documentsMappedByDocId = this.getDocumentsMappedByDocId(documents);
    const prevDocumentsStatusMap = this.getDocuments();

    // Iterate over documentsStatusMap map
    for (const [
      docId,
      doc,
    ] of Object.entries(documentsMappedByDocId)) {
      // If document is new
      if (!prevDocumentsStatusMap[docId]) {
        newDocuments.push(doc);
      }

      // If document status has changed
      else if (prevDocumentsStatusMap[docId] !== doc.status) {
        changedDocuments.push(doc);
      }
    }

    this.setDocuments(this.getDocumentsStatusMap(documents));
    for (const doc of changedDocuments) {
      this.emitEvent(doc, false);
    }
    for (const doc of newDocuments) {
      this.emitEvent(doc, true);
    }
  },
};

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
Docsumo	`app`	`app`	This component uses the Docsumo app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Docsumo#

Make fast & accurate decisions from unstructured documents. Document AI software that converts unstructured documents to actionable data.

Action#

List Invoices on Zoho Books

Description:Lists all invoices. [See the documentation](https://www.zoho.com/books/api/v3/contacts/#list-contacts)

Version:0.3.0

Key:zoho_books-list-invoices

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_PNin2N// legacy_hash_id: a_RAiV28
import {
  INVOICE_FILTER_BY_OPTIONS,
  INVOICE_SORT_COLUMN_OPTIONS,
  INVOICE_STATUS_OPTIONS,
} from "../../common/constants.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-list-invoices",
  name: "List Invoices",
  description: "Lists all invoices. [See the documentation](https://www.zoho.com/books/api/v3/contacts/#list-contacts)",
  version: "0.3.0",
  type: "action",
  props: {
    zohoBooks,
    invoiceNumber: {
      type: "string",
      label: "Invoice Number",
      description: "Search invoices by invoice number. Max-length [100]",
      optional: true,
    },
    itemName: {
      type: "string",
      label: "Item Name",
      description: "Search invoices by item name. Max-length [100]",
      optional: true,
    },
    itemId: {
      type: "string",
      label: "Item Id",
      description: "Search invoices by item id.",
      optional: true,
    },
    itemDescription: {
      type: "string",
      label: "Item Description",
      description: "Search invoices by item description. Max-length [100]",
      optional: true,
    },
    referenceNumber: {
      type: "string",
      label: "Reference Number",
      description: "The reference number of the invoice.",
      optional: true,
    },
    customerName: {
      type: "string",
      label: "Customer Name",
      description: "The name of the customer. Max-length [100]",
      optional: true,
    },
    recurringInvoiceId: {
      type: "string",
      label: "Recurring Invoice Id",
      description: "ID of the recurring invoice from which the invoice is created.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Search contacts by email id. Max-length [100]",
      optional: true,
    },
    total: {
      type: "string",
      label: "Total",
      description: "The total amount to be paid.",
      optional: true,
    },
    balance: {
      type: "string",
      label: "Balance",
      description: "The unpaid amount.",
      optional: true,
    },
    customField: {
      type: "string",
      label: "Custom Field",
      description: "Search invoices by custom fields.",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Search invoices by invoice date. Default date format is `yyyy-mm-dd`.",
      optional: true,
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "Search invoices by due date. Default date format is `yyyy-mm-dd`.",
      optional: true,
    },
    lastModifiedTime: {
      type: "string",
      label: "Last Modified Time",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Search invoices by invoice status.",
      options: INVOICE_STATUS_OPTIONS,
      optional: true,
    },
    customerId: {
      type: "string",
      label: "Customer Id",
      description: "ID of the customer the invoice has to be created.",
      optional: true,
    },
    filterBy: {
      type: "string",
      label: "Filter By",
      description: "Filter invoices by any status or payment expected date.",
      optional: true,
      options: INVOICE_FILTER_BY_OPTIONS,
    },
    searchText: {
      type: "string",
      label: "Search Text",
      description: "Search invoices by invoice number or purchase order or customer name. Max-length [100]",
      optional: true,
    },
    sortColumn: {
      type: "string",
      label: "Sort Column",
      description: "Sort invoices.",
      options: INVOICE_SORT_COLUMN_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    const response = this.zohoBooks.paginate({
      fn: this.zohoBooks.listInvoices,
      fieldName: "invoices",
      params: {
        invoice_number: this.invoiceNumber,
        item_name: this.itemName,
        item_id: this.itemId,
        item_description: this.itemDescription,
        reference_number: this.referenceNumber,
        customer_name: this.customerName,
        recurring_invoice_id: this.recurringInvoiceId,
        email: this.email,
        total: this.total,
        balance: this.balance,
        custom_field: this.customField,
        date: this.date,
        due_date: this.dueDate,
        last_modified_time: this.lastModifiedTime,
        status: this.status,
        customer_id: this.customerId,
        filter_by: this.filterBy,
        search_text: this.searchText,
        sort_column: this.sortColumn,
      },
    });

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

    $.export("$summary", `Successfully fetched ${responseArray.length} invoices(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.
Invoice Number	`invoiceNumber`	`string`	Search invoices by invoice number. Max-length [100]
Item Name	`itemName`	`string`	Search invoices by item name. Max-length [100]
Item Id	`itemId`	`string`	Search invoices by item id.
Item Description	`itemDescription`	`string`	Search invoices by item description. Max-length [100]
Reference Number	`referenceNumber`	`string`	The reference number of the invoice.
Customer Name	`customerName`	`string`	The name of the customer. Max-length [100]
Recurring Invoice Id	`recurringInvoiceId`	`string`	ID of the recurring invoice from which the invoice is created.
Email	`email`	`string`	Search contacts by email id. Max-length [100]
Total	`total`	`string`	The total amount to be paid.
Balance	`balance`	`string`	The unpaid amount.
Custom Field	`customField`	`string`	Search invoices by custom fields.
Date	`date`	`string`	Search invoices by invoice date. Default date format is `yyyy-mm-dd`.
Due Date	`dueDate`	`string`	Search invoices by due date. Default date format is `yyyy-mm-dd`.
Last Modified Time	`lastModifiedTime`	`string`
Status	`status`	`string`	Select a value from the drop down menu:`sentdraftoverduepaidvoidunpaidpartially_paidviewed`
Customer Id	`customerId`	`string`	ID of the customer the invoice has to be created.
Filter By	`filterBy`	`string`	Select a value from the drop down menu:`Status.AllStatus.SentStatus.DraftStatus.OverDueStatus.PaidStatus.VoidStatus.UnpaidStatus.PartiallyPaidStatus.ViewedDate.PaymentExpectedDate`
Search Text	`searchText`	`string`	Search invoices by invoice number or purchase order or customer name. Max-length [100]
Sort Column	`sortColumn`	`string`	Select a value from the drop down menu:`customer_nameinvoice_numberdatedue_datetotalbalancecreated_time`

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 Invoices with Zoho Books API on New Document Status Changed from Docsumo API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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