Create Profit and Loss Detail Report with QuickBooks API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Profit and Loss Detail 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#

Create a workflow to Create Profit and Loss Detail Report with the QuickBooks API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Profit and Loss Detail Report action
1. Connect your QuickBooks account
2. Optional- Select one or more Customer Ids
3. Optional- Select one or more Account IDs
4. Optional- Select a Accounting Method
5. Optional- Select a Date Macro
6. Optional- Configure Start Date
7. Optional- Configure End Date
8. Optional- Select a Adjusted Gain Loss
9. Optional- Select one or more Class IDs
10. Optional- Select a Payment Method
11. Optional- Select one or more Employee IDs
12. Optional- Select one or more Department IDs
13. Optional- Select one or more Vendor IDs
14. Optional- Select a Account Type
15. Optional- Select a Sort By
16. Optional- Select one or more Columns
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Profit and Loss Detail Report with QuickBooks API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + QuickBooks

Try it

Create Profit and Loss Detail Report with QuickBooks API on New Submission from Typeform API

Typeform + QuickBooks

Try it

Create Profit and Loss Detail Report with QuickBooks API on New Submission (Instant) from Jotform API

Jotform + QuickBooks

Try it

Create Profit and Loss Detail Report with QuickBooks API on New Scheduled Tasks from Pipedream API

Pipedream + QuickBooks

Try it

Create Profit and Loss Detail Report with QuickBooks API on New Download Counts from npm API

npm + QuickBooks

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.

Create Profit and Loss Detail Report on QuickBooks

Description:Creates a profit and loss report in Quickbooks Online. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/profitandloss#query-a-report)

Version:0.0.2

Key:quickbooks-create-pl-report

View on GitHub

Code#

import quickbooks from "../../quickbooks.app.mjs";
import {
  DATE_MACRO_OPTIONS, PAYMENT_METHOD_OPTIONS, ACCOUNT_TYPE_OPTIONS, PROFIT_LOSS_REPORT_COLUMNS,
} from "../../common/constants.mjs";

export default {
  key: "quickbooks-create-pl-report",
  name: "Create Profit and Loss Detail Report",
  description: "Creates a profit and loss report in Quickbooks Online. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/profitandloss#query-a-report)",
  version: "0.0.2",
  type: "action",
  props: {
    quickbooks,
    customerIds: {
      propDefinition: [
        quickbooks,
        "customer",
      ],
      type: "string[]",
      label: "Customer Ids",
      description: "Filters report contents to include information for specified customers",
      optional: true,
    },
    accountIds: {
      propDefinition: [
        quickbooks,
        "accountIds",
      ],
    },
    accountingMethod: {
      propDefinition: [
        quickbooks,
        "accountingMethod",
      ],
    },
    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,
    },
    adjustedGainLoss: {
      type: "string",
      label: "Adjusted Gain Loss",
      description: "Specifies whether unrealized gain and losses are included in the report",
      options: [
        "true",
        "false",
      ],
      optional: true,
    },
    classIds: {
      propDefinition: [
        quickbooks,
        "classIds",
      ],
    },
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "Filters report contents based on payment method",
      options: PAYMENT_METHOD_OPTIONS,
      optional: true,
    },
    employeeIds: {
      propDefinition: [
        quickbooks,
        "employeeIds",
      ],
    },
    departmentIds: {
      propDefinition: [
        quickbooks,
        "departmentIds",
      ],
    },
    vendorIds: {
      propDefinition: [
        quickbooks,
        "vendorIds",
      ],
    },
    accountType: {
      type: "string",
      label: "Account Type",
      description: "Account type from which transactions are included in the report",
      options: ACCOUNT_TYPE_OPTIONS,
      optional: true,
    },
    sortBy: {
      type: "string",
      label: "Sort By",
      description: "The column type used in sorting report rows",
      options: PROFIT_LOSS_REPORT_COLUMNS,
      optional: true,
    },
    columns: {
      propDefinition: [
        quickbooks,
        "columns",
      ],
      options: PROFIT_LOSS_REPORT_COLUMNS,
    },
  },
  async run({ $ }) {
    const response = await this.quickbooks.getProfitLossReport({
      $,
      params: {
        customer: this.customerIds,
        account: this.accountIds,
        accounting_method: this.accountingMethod,
        date_macro: this.dateMacro,
        start_date: this.startDate,
        end_date: this.endDate,
        adjusted_gain_loss: this.adjustedGainLoss,
        class: this.classIds,
        payment_method: this.paymentMethod,
        employee: this.employeeIds,
        department: this.departmentIds,
        vendor: this.vendorIds,
        account_type: this.accountType,
        sort_by: this.sortBy,
        columns: this.columns,
      },
    });
    if (response) {
      $.export("summary", "Successfully created Profit and Loss Detail Report");
    }
    return response;
  },
};

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
QuickBooks	`quickbooks`	`app`	This component uses the QuickBooks app.
Customer Ids	`customerIds`	`string[]`	Select a value from the drop down menu.
Account IDs	`accountIds`	`string[]`	Select a value from the drop down menu.
Accounting Method	`accountingMethod`	`string`	Select a value from the drop down menu:`CashAccrual`
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`
Adjusted Gain Loss	`adjustedGainLoss`	`string`	Select a value from the drop down menu:`truefalse`
Class IDs	`classIds`	`string[]`	Select a value from the drop down menu.
Payment Method	`paymentMethod`	`string`	Select a value from the drop down menu:`CashCheckDinners ClubAmerican ExpressDiscoverMasterCardVisa`
Employee IDs	`employeeIds`	`string[]`	Select a value from the drop down menu.
Department IDs	`departmentIds`	`string[]`	Select a value from the drop down menu.
Vendor IDs	`vendorIds`	`string[]`	Select a value from the drop down menu.
Account Type	`accountType`	`string`	Select a value from the drop down menu:`AccountsPayableAccountsReceivableBankCostOfGoodsSoldCreditCardEquityExpenseFixedAssetIncomeLongTermLiabilityNonPostingOtherAssetOtherCurrentAssetOtherCurrentLiabilityOtherExpenseOtherIncome`
Sort By	`sortBy`	`string`	Select a value from the drop down menu:`create_bycreate_datedoc_numlast_mod_bylast_mod_datememonamepmt_mthdsplit_acctx_datetxn_typetax_codeklass_namedept_namedebt_amtcredit_amtnat_open_balsubt_nat_amountsubt_nat_amount_ntrbal_nat_amountrbal_nat_amount_nttax_amountnet_amountdebt_home_amtcredit_home_amtcurrencyexch_ratenat_home_open_balnat_foreign_open_balsubt_nat_home_amountsubt_nat_amount_home_ntrbal_nat_home_amountrbal_nat_amount_home_nthome_tax_amounthome_net_amount`
Columns	`columns`	`string[]`	Select a value from the drop down menu:`create_bycreate_datedoc_numlast_mod_bylast_mod_datememonamepmt_mthdsplit_acctx_datetxn_typetax_codeklass_namedept_namedebt_amtcredit_amtnat_open_balsubt_nat_amountsubt_nat_amount_ntrbal_nat_amountrbal_nat_amount_nttax_amountnet_amountdebt_home_amtcredit_home_amtcurrencyexch_ratenat_home_open_balnat_foreign_open_balsubt_nat_home_amountsubt_nat_amount_home_ntrbal_nat_home_amountrbal_nat_amount_home_nthome_tax_amounthome_net_amount`

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