← Zoho Books

List Invoices with Zoho Books API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Invoices 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 1,000,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

Create a workflow to List Invoices with the Zoho Books API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

List Invoices with Zoho Books API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Zoho Books
 
Try it
List Invoices with Zoho Books API on New Item in Feed from RSS API
RSS + Zoho Books
 
Try it
List Invoices with Zoho Books API on New Message from Discord API
Discord + Zoho Books
 
Try it
List Invoices with Zoho Books API on New Message In Channels from Slack API
Slack + Zoho Books
 
Try it
List Invoices with Zoho Books API on New Message in Channel from Discord Bot API
Discord Bot + Zoho Books
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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 BookszohoBooksappThis component uses the Zoho Books app.
Invoice NumberinvoiceNumberstring

Search invoices by invoice number. Max-length [100]

Item NameitemNamestring

Search invoices by item name. Max-length [100]

Item IditemIdstring

Search invoices by item id.

Item DescriptionitemDescriptionstring

Search invoices by item description. Max-length [100]

Reference NumberreferenceNumberstring

The reference number of the invoice.

Customer NamecustomerNamestring

The name of the customer. Max-length [100]

Recurring Invoice IdrecurringInvoiceIdstring

ID of the recurring invoice from which the invoice is created.

Emailemailstring

Search contacts by email id. Max-length [100]

Totaltotalstring

The total amount to be paid.

Balancebalancestring

The unpaid amount.

Custom FieldcustomFieldstring

Search invoices by custom fields.

Datedatestring

Search invoices by invoice date. Default date format is yyyy-mm-dd.

Due DatedueDatestring

Search invoices by due date. Default date format is yyyy-mm-dd.

Last Modified TimelastModifiedTimestring
StatusstatusstringSelect a value from the drop down menu:sentdraftoverduepaidvoidunpaidpartially_paidviewed
Customer IdcustomerIdstring

ID of the customer the invoice has to be created.

Filter ByfilterBystringSelect a value from the drop down menu:Status.AllStatus.SentStatus.DraftStatus.OverDueStatus.PaidStatus.VoidStatus.UnpaidStatus.PartiallyPaidStatus.ViewedDate.PaymentExpectedDate
Search TextsearchTextstring

Search invoices by invoice number or purchase order or customer name. Max-length [100]

Sort ColumnsortColumnstringSelect a value from the drop down menu:customer_nameinvoice_numberdatedue_datetotalbalancecreated_time

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 Use Zoho Books

Triggers

New Customer from the Zoho Books API

Emit new event when a new customer is created.

 
Try it
New Expense from the Zoho Books API

Emit new event when a new expense is created.

 
Try it
New or Updated Invoice from the Zoho Books API

Emit new event when a new invoice is created or an existing invoice is updated.

 
Try it
New Sales Order from the Zoho Books API

Emit new event when a new sales order is created.

 
Try it

Actions

Create Customer with the Zoho Books API

Creates a new customer. See the documentation

 
Try it
Create Customer Payment with the Zoho Books API

Creates a new payment. See the documentation

 
Try it
Create Employee with the Zoho Books API

Creates an employee for an expense. See the documentation

 
Try it
Create Estimate with the Zoho Books API

Creates a new estimate. See the documentation

 
Try it
Create Invoice with the Zoho Books API

Creates an invoice for your customer. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,500+
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.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream 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
Cloud-based customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer support, and other business activities, ultimately aiming to improve customer relationships and streamline operations.
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
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
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.