Get Invoice with Quickbooks Sandbox API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Quickbooks Sandbox, Schedule and 1000+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Get Invoice with the Quickbooks Sandbox API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Quickbooks Sandbox action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Get Invoice action
1. Connect your Quickbooks Sandbox account
2. Configure invoice_id
3. Optional- Configure minorversion
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

With Schedule - A trigger provided by Pipedream - You can easily build
automated workflows that run on regular times or intervals. Some examples of
things that you can build using the Schedule API include:

Automated data retrieval from a third-party service, like pulling stats from
your Salesforce account on a set schedule.
Uploading new data sets to a database with a predetermined interval.
Automatic emails to customers or leads at a certain time of the day.
Automating data analysis based on a set schedule.
Automatically optimizing social media postings according to a specified
timeline.
Updating webpages at a certain interval with newly available content.
Re-running reports on a periodic basis.
Refreshing a cache of data at a given frequency.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Get Invoice on Quickbooks Sandbox

Description:Returns info about an invoice.

Version:0.1.1

Key:quickbooks_sandbox-get-invoice

View on GitHub

Quickbooks Sandbox Overview#

QuickBooks Sandbox API provides a powerful and reliable platform to develop,
customize, and test applications related to accounting and finance. The API
allows developers to access a variety of features, such as:

Create, read, update and delete financial data.
Create and manage Invoices, Estimates, Orders, Payments and other objects.
Log in and manage customers, vendors, and suppliers.
Record and manage expenses, taxes, banking transactions and other financial
transactions.

With the Quickbooks Sandbox API, you can build the following applications:

A financial record-keeping and reporting app.
An expense manager and budget tracker.
A customer, vendor & supplier management system.
A payments & receipts processing application.
An invoicing & estimate management system.
An accounts receivable & payable system.
A multi-currency payment processing system.
A tax calculation and reporting tool.
A virtual banking application.
A dynamic accounting dashboard.

Action Code#

// legacy_hash_id: a_Q3ix1Q
import { axios } from "@pipedream/platform";

export default {
  key: "quickbooks_sandbox-get-invoice",
  name: "Get Invoice",
  description: "Returns info about an invoice.",
  version: "0.1.1",
  type: "action",
  props: {
    quickbooks_sandbox: {
      type: "app",
      app: "quickbooks_sandbox",
    },
    invoice_id: {
      type: "string",
      description: "Id of the invoice to get details of.",
    },
    minorversion: {
      type: "string",
      description: "Use the `minorversion` query parameter in REST API requests to access a version of the API other than the generally available version. For example, to invoke minor version 1 of the JournalEntry entity, issue the following request:\n`https://quickbooks.api.intuit.com/v3/company/<realmId>/journalentry/entityId?minorversion=1`",
      optional: true,
    },
  },
  async run({ $ }) {
  // See Quickbooks API docs at: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice#read-an-invoice

    if (!this.invoice_id) {
      throw new Error("Must provide invoice_id parameter.");
    }

    return await axios($, {
      url: `https://sandbox-quickbooks.api.intuit.com/v3/company/${this.quickbooks_sandbox.$auth.company_id}/invoice/${this.invoice_id}`,
      headers: {
        "Authorization": `Bearer ${this.quickbooks_sandbox.$auth.oauth_access_token}`,
        "accept": "application/json",
        "content-type": "application/json",
      },
      params: {
        minorversion: this.minorversion,
      },
    });
  },
};

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 Sandbox	`quickbooks_sandbox`	`app`	This component uses the Quickbooks Sandbox app.
invoice_id	`invoice_id`	`string`	Id of the invoice to get details of.
minorversion	`minorversion`	`string`	Use the `minorversion` query parameter in REST API requests to access a version of the API other than the generally available version. For example, to invoke minor version 1 of the JournalEntry entity, issue the following request: `https://quickbooks.api.intuit.com/v3/company/<realmId>/journalentry/entityId?minorversion=1`

Action Authentication#

Quickbooks Sandbox uses OAuth authentication. When you connect your Quickbooks Sandbox account, Pipedream will open a popup window where you can sign into Quickbooks Sandbox 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 Sandbox API.

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

com.intuit.quickbooks.accounting