Create Sales Receipt with QuickBooks API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Sales Receipt 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 Sales Receipt with the QuickBooks API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Sales Receipt action
1. Connect your QuickBooks account
2. Configure Enter Line Items as Objects
3. Optional- Select a Currency Code
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 Sales Receipt with Quickbooks API on New Requests from HTTP / Webhook API

HTTP / Webhook + QuickBooks

Try it

Create Sales Receipt with Quickbooks API on New Submission from Typeform API

Typeform + QuickBooks

Try it

Create Sales Receipt with Quickbooks API on New Submission (Instant) from Jotform API

Jotform + QuickBooks

Try it

Create Sales Receipt with Quickbooks API on New Custom Webhook Events from Stripe API

Stripe + QuickBooks

Try it

Create Sales Receipt with Quickbooks API on New Scheduled Tasks from Pipedream API

Pipedream + 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 Sales Receipt on QuickBooks

Description:Creates a sales receipt. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt#create-a-salesreceipt)

Version:0.0.11

Key:quickbooks-create-sales-receipt

View on GitHub

Code#

import quickbooks from "../../quickbooks.app.mjs";
import { parseLineItems } from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "quickbooks-create-sales-receipt",
  name: "Create Sales Receipt",
  description: "Creates a sales receipt. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt#create-a-salesreceipt)",
  version: "0.0.11",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    quickbooks,
    lineItemsAsObjects: {
      propDefinition: [
        quickbooks,
        "lineItemsAsObjects",
      ],
      reloadProps: true,
    },
    currencyRefValue: {
      propDefinition: [
        quickbooks,
        "currency",
      ],
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.lineItemsAsObjects) {
      props.lineItems = {
        type: "string[]",
        label: "Line Items",
        description: "Line items of a sales receipt. Set DetailType to `SalesItemLineDetail` or `GroupLineDetail`. Example: `{ \"DetailType\": \"SalesItemLineDetail\", \"Amount\": 100.0, \"SalesItemLineDetail\": { \"ItemRef\": { \"name\": \"Services\", \"value\": \"1\" } } }` [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt#create-a-salesreceipt) for more information.",
      };
      return props;
    }
    props.numLineItems = {
      type: "integer",
      label: "Number of Line Items",
      description: "The number of line items to enter",
      reloadProps: true,
    };
    if (!this.numLineItems) {
      return props;
    }
    for (let i = 1; i <= this.numLineItems; i++) {
      props[`item_${i}`] = {
        type: "string",
        label: `Line ${i} - Item ID`,
        options: async ({ page }) => {
          return this.quickbooks.getPropOptions({
            page,
            resource: "Item",
            mapper: ({
              Id: value, Name: label,
            }) => ({
              value,
              label,
            }),
          });
        },
      };
      props[`amount_${i}`] = {
        type: "string",
        label: `Line ${i} - Amount`,
      };
    }
    return props;
  },
  methods: {
    buildLineItems() {
      const lineItems = [];
      for (let i = 1; i <= this.numLineItems; i++) {
        lineItems.push({
          DetailType: "SalesItemLineDetail",
          Amount: this[`amount_${i}`],
          SalesItemLineDetail: {
            ItemRef: {
              value: this[`item_${i}`],
            },
          },
        });
      }
      return lineItems;
    },
  },
  async run({ $ }) {
    const lines = this.lineItemsAsObjects
      ? parseLineItems(this.lineItems)
      : this.buildLineItems();

    lines.forEach((line) => {
      if (line.DetailType !== "SalesItemLineDetail" && line.DetailType !== "GroupLineDetail") {
        throw new ConfigurationError("Line Item DetailType must be `SalesItemLineDetail` or `GroupLineDetail`");
      }
    });

    const response = await this.quickbooks.createSalesReceipt({
      $,
      data: {
        Line: lines,
        CurrencyRef: this.currencyRefValue && {
          value: this.currencyRefValue,
        },
      },
    });

    if (response) {
      $.export("summary", `Successfully created sales receipt with ID ${response.SalesReceipt.Id}`);
    }

    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.
Enter Line Items as Objects	`lineItemsAsObjects`	`boolean`	Enter line items as an array of objects
Currency Code	`currencyRefValue`	`string`	Select a value from the drop down menu.

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