← Zoho Books

List Expenses with Zoho Books API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Expenses 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 Expenses 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 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
  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 Expenses with Zoho Books API on New User from Zoho CRM API
Zoho CRM + Zoho Books
 
Try it
List Expenses with Zoho Books API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Zoho Books
 
Try it
List Expenses with Zoho Books API on New Item in Feed from RSS API
RSS + Zoho Books
 
Try it
List Expenses with Zoho Books API on New Message from Discord API
Discord + Zoho Books
 
Try it
List Expenses with Zoho Books API on New Message In Channels from Slack API
Slack + 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 Expenses on Zoho Books
Description:List all the Expenses.
Version:0.2.1
Key:zoho_books-list-expenses

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

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 Bookszoho_booksappThis component uses the Zoho Books app.
organization_idstring

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.

descriptionstring

Search expenses by description.Variants description_startswith and description_contains. Max-length [100]

reference_numberstring

Search expenses by reference number. Variants reference_number_startswith and reference_number_contains. Max-length [100]

datestring

Search expenses by expense date. Variants date_start, date_end, date_before and date_after. Format [yyyy-mm-dd]

statusstringSelect a value from the drop down menu:unbilledinvoicedreimbursednon-billablebillable
amountstring

Search expenses by amount. Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_than.

account_namestring

Search expenses by expense account name. Variants account_name_startswith and account_name_contains. Max-length [100

customer_namestring

Search expenses by customer name. Variants: customer_name_startswith and customer_name_contains. Max-length [100]

vendor_namestring

Search expenses by vendor name. Variants: vendor_name_startswith and vendor_name_contains.

customer_idstring

ID of the expense account.

vendor_idstring

ID of the vendor the expense is made.

recurring_expense_idstring

Search expenses by recurring expense id.

paid_through_account_idstring

Search expenses by paid through account id.

search_textstring

Search expenses by account name or description or customer name or vendor name. Max-length [100]

sort_columnstringSelect a value from the drop down menu:dateaccount_nametotalbcy_totalreference_numbercustomer_namecreated_time
filter_bystringSelect a value from the drop down menu:Status.AllStatus.BillableStatus.NonbillableStatus.ReimbursedStatus.InvoicedStatus.Unbilled
pagestring

By default first page will be listed. For navigating through pages, use the page parameter.

per_pagestring

The per_page parameter can be used to set the number of records that you want to receive in response.

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

Actions

Create Customer Payment with the Zoho Books API

Creates a new payment.

 
Try it
Create Employee with the Zoho Books API

Creates an employee for an expense.

 
Try it
Create Invoice with the Zoho Books API

Creates an invoice for your customer.

 
Try it
Create Item with the Zoho Books API

Creates a new item.

 
Try it
Create Sales Order with the Zoho Books API

Creates a sales order.

 
Try it

Explore Other Apps

1
-
24
of
2,400+
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.
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
Web services API for interacting with Salesforce
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.
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.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.