pipedream icon indicating copy to clipboard operation
pipedream copied to clipboard

feat(quickbooks): Add missing invoice, estimate, and purchase order actions

Open krikera opened this issue 7 months ago • 5 comments

This PR addresses GitHub issue #16906 by implementing missing QuickBooks Online API endpoints that are available in Zapier but were missing from Pipedream. This brings the Pipedream QuickBooks integration to feature parity with Zapier for invoice, estimate, and purchase order operations.

🔧 New API Methods Added to quickbooks.app.mjs:

  • sendInvoice() - Send invoice via email
  • updateInvoice() - Update existing invoice
  • voidInvoice() - Void an invoice
  • createPurchaseOrder() - Create purchase orders
  • createEstimate() - Create estimates/quotes
  • sendEstimate() - Send estimate via email
  • updateEstimate() - Update existing estimate
  • getEstimate() - Retrieve estimate by ID

📋 New Prop Definitions:

  • estimateId - For selecting estimates with customer context
  • vendor - For selecting vendors for purchase orders

Fixes #16906

Summary by CodeRabbit

  • New Features
    • Added actions to create, update, send, and void invoices in QuickBooks.
    • Introduced actions to create, update, and send estimates by email.
    • Enabled creation of purchase orders with configurable line items.
    • Enhanced selection options for estimates and vendors in the user interface.
    • Added utilities to construct line items for sales and purchase transactions.

krikera avatar May 31 '25 08:05 krikera

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jun 11, 2025 2:39pm

vercel[bot] avatar May 31 '25 08:05 vercel[bot]

@krikera is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 31 '25 08:05 vercel[bot]

Walkthrough

This update introduces new QuickBooks action modules to create, send, update, and void invoices and estimates, as well as create purchase orders. It also adds supporting methods and property definitions to the QuickBooks app module, enabling these endpoints and their required input handling.

Changes

File(s) Change Summary
components/quickbooks/actions/create-estimate/create-estimate.mjs New action: Create Estimate with flexible line item input, validation, and API call.
components/quickbooks/actions/create-purchase-order/create-purchase-order.mjs New action: Create Purchase Order with dynamic line item support and API integration.
components/quickbooks/actions/send-estimate/send-estimate.mjs New action: Send Estimate by email via QuickBooks API, supports optional recipient email.
components/quickbooks/actions/send-invoice/send-invoice.mjs New action: Send Invoice by email via QuickBooks API, supports optional recipient email.
components/quickbooks/actions/update-estimate/update-estimate.mjs New action: Update Estimate with dynamic properties, line item validation, and concurrency control.
components/quickbooks/actions/update-invoice/update-invoice.mjs New action: Update Invoice with dynamic line items, field support, and concurrency control.
components/quickbooks/actions/void-invoice/void-invoice.mjs New action: Void Invoice with SyncToken handling and API call.
components/quickbooks/quickbooks.app.mjs Added propDefinitions for estimateId and vendor; added methods for invoice, purchase order, estimate operations.
components/quickbooks/common/utils.mjs Added helper functions to build sales and purchase line items from input context.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ActionModule
    participant QuickBooksApp
    participant QuickBooksAPI

    User->>ActionModule: Provide input (e.g., create/update/send/void)
    ActionModule->>QuickBooksApp: Call appropriate method with input
    QuickBooksApp->>QuickBooksAPI: Make HTTP request to API endpoint
    QuickBooksAPI-->>QuickBooksApp: Return API response
    QuickBooksApp-->>ActionModule: Return processed result
    ActionModule-->>User: Output summary/result

Assessment against linked issues

Objective Addressed Explanation
Implement Create Invoice endpoint (POST /invoice) (#16906) No create invoice action/module or method observed in this PR.
Implement Send Invoice endpoint (POST /invoice/{invoiceId}/send) (#16906)
Implement Update Invoice endpoint (POST /invoice?operation=update) (#16906)
Implement Void Invoice endpoint (POST /invoice?operation=void) (#16906)
Implement Create Purchase Order endpoint (POST /purchaseorder) (#16906)
Implement Create Estimate endpoint (POST /estimate) (#16906)
Implement Send Estimate endpoint (POST /estimate/{estimateId}/send) (#16906)
Implement Update Estimate endpoint (POST /estimate?operation=update) (#16906)

Poem

In the fields of QuickBooks, where data flows free,
Rabbits code actions for invoice and P.O. spree!
Estimates are crafted, sent with a hop,
Updates and voids—no reason to stop.
With whiskers a-twitch and a carrot in hand,
This bunny brings endpoints just as you planned!
🐇✨

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/alttextify/alttextify.app.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:201:49)

components/capgo/capgo.app.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:201:49)

components/codeberg/codeberg.app.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:201:49)

  • 9 others

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf16225c3bb7b8bf632e345381b0a730b06b645f and bc60bcf94d9e9ca05676e39ffa941ce76ad8f441.

📒 Files selected for processing (12)
  • components/alttextify/alttextify.app.mjs (1 hunks)
  • components/amazon_redshift/amazon_redshift.app.mjs (1 hunks)
  • components/capgo/capgo.app.mjs (1 hunks)
  • components/codeberg/codeberg.app.mjs (1 hunks)
  • components/codeqr/codeqr.app.mjs (1 hunks)
  • components/deepsouce/deepsouce.app.mjs (1 hunks)
  • components/finalscout/finalscout.app.mjs (1 hunks)
  • components/keboola/keboola.app.mjs (1 hunks)
  • components/picqer/picqer.app.mjs (1 hunks)
  • components/predictleads/predictleads.app.mjs (1 hunks)
  • components/v1ce/v1ce.app.mjs (1 hunks)
  • components/yay_com/yay_com.app.mjs (1 hunks)
✅ Files skipped from review due to trivial changes (12)
  • components/yay_com/yay_com.app.mjs
  • components/codeqr/codeqr.app.mjs
  • components/predictleads/predictleads.app.mjs
  • components/keboola/keboola.app.mjs
  • components/finalscout/finalscout.app.mjs
  • components/v1ce/v1ce.app.mjs
  • components/capgo/capgo.app.mjs
  • components/picqer/picqer.app.mjs
  • components/alttextify/alttextify.app.mjs
  • components/amazon_redshift/amazon_redshift.app.mjs
  • components/codeberg/codeberg.app.mjs
  • components/deepsouce/deepsouce.app.mjs
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Lint Code Base
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
  • GitHub Check: pnpm publish
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 31 '25 08:05 coderabbitai[bot]

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist: