Get Cash Flow Report with QuickBooks API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for QuickBooks, HTTP / Webhook and 3,000+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Get Cash Flow Report with the QuickBooks 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 HTTP / Webhook trigger and QuickBooks action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Get Cash Flow Report action
1. Connect your QuickBooks account
2. Optional- Select one or more Customer IDs
3. Optional- Select one or more Vendor IDs
4. Optional- Select a Date Macro
5. Optional- Configure Start Date
6. Optional- Configure End Date
7. Optional- Select one or more Class IDs
8. Optional- Select one or more Item IDs
9. Optional- Select a Sort Order
10. Optional- Select a Summarize Column By
11. Optional- Select one or more Department IDs
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 Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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
N/A	`httpInterface`	`$.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.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Get Cash Flow Report on QuickBooks

Description:Retrieves the cash flow report from Quickbooks Online. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/cashflow#query-a-report)

Version:0.0.1

Key:quickbooks-get-cash-flow-report

View on GitHub

QuickBooks Overview#

The QuickBooks API allows for streamlined financial management within Pipedream's ecosystem, enabling automated accounting and data syncing across various platforms. With this API, you can manipulate invoices, manage sales receipts, handle expenses, and synchronize customer data. It's a robust tool for financial oversight and automation that can save time and reduce errors for businesses of all sizes.

Action Code#

import quickbooks from "../../quickbooks.app.mjs";
import { DATE_MACRO_OPTIONS } from "../../common/constants.mjs";
import { commaSeparateArray } from "../../common/utils.mjs";

export default {
  key: "quickbooks-get-cash-flow-report",
  name: "Get Cash Flow Report",
  description: "Retrieves the cash flow report from Quickbooks Online. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/cashflow#query-a-report)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    quickbooks,
    customer: {
      type: "string[]",
      label: "Customer IDs",
      description: "Filters report contents to include information for specified customers",
      optional: true,
      propDefinition: [
        quickbooks,
        "customer",
      ],
    },
    vendor: {
      propDefinition: [
        quickbooks,
        "vendorIds",
      ],
    },
    dateMacro: {
      type: "string",
      label: "Date Macro",
      description: "Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the **Start Date** and **End Date** to cover an explicit report date range",
      options: DATE_MACRO_OPTIONS,
      optional: true,
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "The start date of the report, in the format `YYYY-MM-DD`. **Start Date** must be less than **End Date**",
      optional: true,
    },
    endDate: {
      type: "string",
      label: "End Date",
      description: "The end date of the report, in the format `YYYY-MM-DD`. **Start Date** must be less than **End Date**",
      optional: true,
    },
    classIds: {
      propDefinition: [
        quickbooks,
        "classIds",
      ],
    },
    item: {
      type: "string[]",
      label: "Item IDs",
      description: "Filters report contents to include information for specified items",
      optional: true,
      propDefinition: [
        quickbooks,
        "itemId",
      ],
    },
    sortOrder: {
      type: "string",
      label: "Sort Order",
      description: "The sort order for report results",
      options: [
        "ascend",
        "descend",
      ],
      optional: true,
    },
    summarizeColumnBy: {
      type: "string",
      label: "Summarize Column By",
      description: "The criteria by which to group the report results",
      options: [
        "Total",
        "Month",
        "Week",
        "Days",
        "Quarter",
        "Year",
        "Customers",
        "Vendors",
        "Classes",
        "Departments",
        "Employees",
        "ProductsAndServices",
      ],
      optional: true,
    },
    department: {
      propDefinition: [
        quickbooks,
        "departmentIds",
      ],
    },
  },
  async run({ $ }) {
    const {
      quickbooks,
      customer,
      vendor,
      dateMacro,
      startDate,
      endDate,
      classIds,
      item,
      sortOrder,
      summarizeColumnBy,
      department,
    } = this;

    const response = await quickbooks.getCashFlowReport({
      $,
      params: {
        customer: commaSeparateArray(customer),
        vendor: commaSeparateArray(vendor),
        date_macro: dateMacro,
        start_date: startDate,
        end_date: endDate,
        class: commaSeparateArray(classIds),
        item: commaSeparateArray(item),
        sort_order: sortOrder,
        summarize_column_by: summarizeColumnBy,
        department: commaSeparateArray(department),
      },
    });
    $.export("$summary", "Successfully retrieved Cash Flow Report");
    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
QuickBooks	`quickbooks`	`app`	This component uses the QuickBooks app.
Customer IDs	`customer`	`string[]`	Select a value from the drop down menu.
Vendor IDs	`vendor`	`string[]`	Select a value from the drop down menu.
Date Macro	`dateMacro`	`string`	Select a value from the drop down menu:`TodayYesterdayThis WeekLast WeekThis Week-to-dateLast Week-to-dateNext WeekNext 4 WeeksThis MonthLast MonthThis Month-to-dateLast Month-to-dateNext MonthThis Fiscal QuarterLast Fiscal QuarterThis Fiscal Quarter-to-dateLast Fiscal Quarter-to-dateNext Fiscal QuarterThis Fiscal YearLast Fiscal YearThis Fiscal Year-to-dateLast Fiscal Year-to-dateNext Fiscal Year`
Start Date	`startDate`	`string`	The start date of the report, in the format `YYYY-MM-DD`. Start Date must be less than End Date
End Date	`endDate`	`string`	The end date of the report, in the format `YYYY-MM-DD`. Start Date must be less than End Date
Class IDs	`classIds`	`string[]`	Select a value from the drop down menu.
Item IDs	`item`	`string[]`	Select a value from the drop down menu.
Sort Order	`sortOrder`	`string`	Select a value from the drop down menu:`ascenddescend`
Summarize Column By	`summarizeColumnBy`	`string`	Select a value from the drop down menu:`TotalMonthWeekDaysQuarterYearCustomersVendorsClassesDepartmentsEmployeesProductsAndServices`
Department IDs	`department`	`string[]`	Select a value from the drop down menu.

Action Authentication#

QuickBooks uses OAuth authentication. When you connect your QuickBooks account, Pipedream will open a popup window where you can sign into QuickBooks and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any QuickBooks API.

Pipedream requests the following authorization scopes when you connect your account:

com.intuit.quickbooks.accountingopenidprofileemail

About QuickBooks#

QuickBooks Online is designed to help you manage your business finances with ease.

More Ways to Connect QuickBooks + HTTP / Webhook#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New Customer Created from QuickBooks API

QuickBooks + HTTP / Webhook