Skip to content

Commit 2a9b314

Browse files
Bill LeoutsakosBill Leoutsakos
Bill Leoutsakos
authored and
Bill Leoutsakos
committed
feat(quickbooks): expose document workflows
1 parent 9dbaa7d commit 2a9b314

7 files changed

Lines changed: 694 additions & 27 deletions

File tree

‎apps/docs/content/docs/en/integrations/quickbooks.mdx‎

Lines changed: 200 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: QuickBooks
3-
description: Manage QuickBooks Online company, sales, purchasing, payables, accounting, and reports
3+
description: Manage QuickBooks Online company, transactions, reports, emails, PDFs, and attachments
44
---
55

66
import { BlockInfoCard } from "@/components/ui/block-info-card"
@@ -27,7 +27,7 @@ Attachments are not exposed by this version of the block.
2727

2828
## Usage Instructions
2929

30-
Connect one QuickBooks Online company to manage bounded master-data, sales, purchasing, receivables, payables, general-accounting, and financial-reporting workflows.
30+
Connect one QuickBooks Online company to manage bounded master-data, sales, purchasing, receivables, payables, accounting, reports, transaction delivery, and document workflows.
3131

3232

3333

@@ -2573,3 +2573,201 @@ Run a fixed QuickBooks financial report with verified accountant-focused filters
25732573
| ↳ `Rows` | json | Nested native QuickBooks report rows |
25742574
| ↳ `Summary` | json | Section summary column data |
25752575
| `time` | string | QuickBooks response timestamp |
2576+
2577+
### `quickbooks_email_transaction`
2578+
2579+
Send a supported QuickBooks transaction by email. This causes an external email and Intuit limits sandbox email delivery.
2580+
2581+
#### Input
2582+
2583+
| Parameter | Type | Required | Description |
2584+
| --------- | ---- | -------- | ----------- |
2585+
| `transactionType` | string | Yes | Supported transaction type to email |
2586+
| `transactionId` | string | Yes | QuickBooks transaction ID |
2587+
| `recipient` | string | No | Optional single recipient override; otherwise QuickBooks uses the stored recipient |
2588+
| `confirmSend` | boolean | Yes | Explicit confirmation that an external email should be sent |
2589+
2590+
#### Output
2591+
2592+
| Parameter | Type | Description |
2593+
| --------- | ---- | ----------- |
2594+
| `transactionType` | string | Emailed QuickBooks transaction type |
2595+
| `transactionId` | string | Emailed QuickBooks transaction ID |
2596+
| `sent` | boolean | Whether QuickBooks accepted the email send request |
2597+
| `record` | json | Native QuickBooks transaction returned after sending |
2598+
| ↳ `Id` | string | QuickBooks sales transaction ID |
2599+
| ↳ `SyncToken` | string | Current transaction sync token |
2600+
| ↳ `DocNumber` | string | Transaction document number |
2601+
| ↳ `TxnDate` | string | Transaction date |
2602+
| ↳ `DueDate` | string | Invoice due date |
2603+
| ↳ `ExpirationDate` | string | Estimate expiration date |
2604+
| ↳ `CustomerRef` | json | Customer reference |
2605+
| ↳ `value` | string | QuickBooks entity ID |
2606+
| ↳ `name` | string | QuickBooks entity display name |
2607+
| ↳ `CustomerMemo` | json | Customer-facing memo |
2608+
| ↳ `DepositToAccountRef` | json | Deposit account reference |
2609+
| ↳ `value` | string | QuickBooks entity ID |
2610+
| ↳ `name` | string | QuickBooks entity display name |
2611+
| ↳ `PaymentMethodRef` | json | Payment method reference |
2612+
| ↳ `value` | string | QuickBooks entity ID |
2613+
| ↳ `name` | string | QuickBooks entity display name |
2614+
| ↳ `PaymentRefNum` | string | Customer payment reference number |
2615+
| ↳ `CurrencyRef` | json | Transaction currency reference |
2616+
| ↳ `value` | string | QuickBooks entity ID |
2617+
| ↳ `name` | string | QuickBooks entity display name |
2618+
| ↳ `Line` | array | Native QuickBooks transaction lines |
2619+
| ↳ `LinkedTxn` | array | Transactions linked by QuickBooks |
2620+
| ↳ `TotalAmt` | number | Transaction total amount |
2621+
| ↳ `Balance` | number | Remaining transaction balance |
2622+
| ↳ `UnappliedAmt` | number | Unapplied payment amount |
2623+
| ↳ `PrivateNote` | string | Internal transaction note |
2624+
| ↳ `TxnStatus` | string | Transaction status |
2625+
| ↳ `TxnTaxDetail` | json | Calculated tax details |
2626+
| ↳ `MetaData` | json | Transaction creation and update timestamps |
2627+
| ↳ `CreateTime` | string | Entity creation timestamp |
2628+
| ↳ `LastUpdatedTime` | string | Entity last-updated timestamp |
2629+
| `time` | string | QuickBooks response timestamp |
2630+
2631+
### `quickbooks_download_transaction_pdf`
2632+
2633+
Download a supported QuickBooks transaction as a bounded PDF file
2634+
2635+
#### Input
2636+
2637+
| Parameter | Type | Required | Description |
2638+
| --------- | ---- | -------- | ----------- |
2639+
| `transactionType` | string | Yes | Supported transaction type to download |
2640+
| `transactionId` | string | Yes | QuickBooks transaction ID |
2641+
| `fileName` | string | No | Optional safe PDF filename override |
2642+
2643+
#### Output
2644+
2645+
| Parameter | Type | Description |
2646+
| --------- | ---- | ----------- |
2647+
| `file` | file | Downloaded file stored in execution files |
2648+
| `fileName` | string | Safe downloaded filename |
2649+
| `mimeType` | string | Downloaded file MIME type |
2650+
| `size` | number | Downloaded file size in bytes |
2651+
| `transactionType` | string | Downloaded QuickBooks transaction type |
2652+
| `transactionId` | string | Downloaded QuickBooks transaction ID |
2653+
2654+
### `quickbooks_read_attachments`
2655+
2656+
List attachment metadata for a fixed QuickBooks entity or read one attachment by ID
2657+
2658+
#### Input
2659+
2660+
| Parameter | Type | Required | Description |
2661+
| --------- | ---- | -------- | ----------- |
2662+
| `readMode` | string | Yes | Read mode: list or by_id |
2663+
| `targetType` | string | No | Fixed QuickBooks entity type for List mode |
2664+
| `targetId` | string | No | QuickBooks entity ID for List mode |
2665+
| `attachmentId` | string | No | QuickBooks attachment ID for By ID mode |
2666+
| `startPosition` | number | No | One-based list start position; defaults to 1 |
2667+
| `maxResults` | number | No | List page size from 1 through 100; defaults to 25 |
2668+
2669+
#### Output
2670+
2671+
| Parameter | Type | Description |
2672+
| --------- | ---- | ----------- |
2673+
| `startPosition` | number | One-based position of the first item in this response |
2674+
| `maxResults` | number | Actual number of items reported for this response |
2675+
| `nextStartPosition` | number | Position to use when explicitly requesting the next page |
2676+
| `hasMore` | boolean | Conservative indication that another page may exist |
2677+
| `time` | string | QuickBooks response timestamp |
2678+
| `item` | json | Native QuickBooks attachment metadata |
2679+
| ↳ `Id` | string | QuickBooks attachment ID |
2680+
| ↳ `SyncToken` | string | Attachment sync token |
2681+
| ↳ `FileName` | string | Attached file name |
2682+
| ↳ `ContentType` | string | Attached file MIME type |
2683+
| ↳ `Size` | number | Attached file size in bytes |
2684+
| ↳ `Note` | string | Attachment note or description |
2685+
| ↳ `Category` | string | Native QuickBooks attachment category |
2686+
| ↳ `AttachableRef` | array | QuickBooks entities referenced by this attachment |
2687+
| ↳ `EntityRef` | json | Attached entity type and operational ID |
2688+
| ↳ `IncludeOnSend` | boolean | Whether QuickBooks includes the attachment when sending |
2689+
| ↳ `MetaData` | json | Attachment creation and update timestamps |
2690+
| ↳ `CreateTime` | string | Entity creation timestamp |
2691+
| ↳ `LastUpdatedTime` | string | Entity last-updated timestamp |
2692+
| ↳ `domain` | string | QuickBooks domain |
2693+
| ↳ `sparse` | boolean | Whether this is a sparse entity |
2694+
| `items` | array | Native QuickBooks attachment metadata page |
2695+
| ↳ `Id` | string | QuickBooks attachment ID |
2696+
| ↳ `SyncToken` | string | Attachment sync token |
2697+
| ↳ `FileName` | string | Attached file name |
2698+
| ↳ `ContentType` | string | Attached file MIME type |
2699+
| ↳ `Size` | number | Attached file size in bytes |
2700+
| ↳ `Note` | string | Attachment note or description |
2701+
| ↳ `Category` | string | Native QuickBooks attachment category |
2702+
| ↳ `AttachableRef` | array | QuickBooks entities referenced by this attachment |
2703+
| ↳ `EntityRef` | json | Attached entity type and operational ID |
2704+
| ↳ `IncludeOnSend` | boolean | Whether QuickBooks includes the attachment when sending |
2705+
| ↳ `MetaData` | json | Attachment creation and update timestamps |
2706+
| ↳ `CreateTime` | string | Entity creation timestamp |
2707+
| ↳ `LastUpdatedTime` | string | Entity last-updated timestamp |
2708+
| ↳ `domain` | string | QuickBooks domain |
2709+
| ↳ `sparse` | boolean | Whether this is a sparse entity |
2710+
2711+
### `quickbooks_add_attachment`
2712+
2713+
Attach one supported file or one note to a fixed QuickBooks entity
2714+
2715+
#### Input
2716+
2717+
| Parameter | Type | Required | Description |
2718+
| --------- | ---- | -------- | ----------- |
2719+
| `attachmentKind` | string | Yes | Attachment kind: file or note |
2720+
| `targetType` | string | Yes | Fixed QuickBooks entity type to attach to |
2721+
| `targetId` | string | Yes | QuickBooks target entity ID |
2722+
| `file` | file | No | Single Sim file to upload |
2723+
| `fileName` | string | No | Optional safe filename override |
2724+
| `contentType` | string | No | Optional compatible QuickBooks MIME type override |
2725+
| `description` | string | No | Optional file attachment description |
2726+
| `note` | string | No | Required nonempty note text in Note mode |
2727+
2728+
#### Output
2729+
2730+
| Parameter | Type | Description |
2731+
| --------- | ---- | ----------- |
2732+
| `attachment` | json | Created native QuickBooks attachment metadata |
2733+
| ↳ `Id` | string | QuickBooks attachment ID |
2734+
| ↳ `SyncToken` | string | Attachment sync token |
2735+
| ↳ `FileName` | string | Attached file name |
2736+
| ↳ `ContentType` | string | Attached file MIME type |
2737+
| ↳ `Size` | number | Attached file size in bytes |
2738+
| ↳ `Note` | string | Attachment note or description |
2739+
| ↳ `Category` | string | Native QuickBooks attachment category |
2740+
| ↳ `AttachableRef` | array | QuickBooks entities referenced by this attachment |
2741+
| ↳ `EntityRef` | json | Attached entity type and operational ID |
2742+
| ↳ `IncludeOnSend` | boolean | Whether QuickBooks includes the attachment when sending |
2743+
| ↳ `MetaData` | json | Attachment creation and update timestamps |
2744+
| ↳ `CreateTime` | string | Entity creation timestamp |
2745+
| ↳ `LastUpdatedTime` | string | Entity last-updated timestamp |
2746+
| ↳ `domain` | string | QuickBooks domain |
2747+
| ↳ `sparse` | boolean | Whether this is a sparse entity |
2748+
| `attachmentId` | string | Created QuickBooks attachment ID |
2749+
| `attachmentKind` | string | Created attachment kind |
2750+
| `targetType` | string | QuickBooks target entity type |
2751+
| `targetId` | string | QuickBooks target entity ID |
2752+
| `time` | string | QuickBooks response timestamp |
2753+
2754+
### `quickbooks_download_attachment`
2755+
2756+
Download a QuickBooks file attachment through its short-lived URL
2757+
2758+
#### Input
2759+
2760+
| Parameter | Type | Required | Description |
2761+
| --------- | ---- | -------- | ----------- |
2762+
| `attachmentId` | string | Yes | QuickBooks attachment ID |
2763+
| `fileName` | string | No | Optional safe filename override |
2764+
2765+
#### Output
2766+
2767+
| Parameter | Type | Description |
2768+
| --------- | ---- | ----------- |
2769+
| `file` | file | Downloaded file stored in execution files |
2770+
| `fileName` | string | Safe downloaded filename |
2771+
| `mimeType` | string | Downloaded file MIME type |
2772+
| `size` | number | Downloaded file size in bytes |
2773+
| `attachmentId` | string | Downloaded QuickBooks attachment ID |

0 commit comments

Comments
 (0)