|
| 1 | +--- |
| 2 | +title: QuickBooks |
| 3 | +description: Query vendors, purchase orders, and bills in QuickBooks Online |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="quickbooks" |
| 10 | + color="#2CA01C" |
| 11 | +/> |
| 12 | + |
| 13 | +## Usage Instructions |
| 14 | + |
| 15 | +Integrate QuickBooks Online into procurement workflows. List vendors, purchase orders, and bills, or run custom QuickBooks Accounting API queries against a company. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Actions |
| 20 | + |
| 21 | +### `quickbooks_list_vendors` |
| 22 | + |
| 23 | +List vendors from QuickBooks Online |
| 24 | + |
| 25 | +#### Input |
| 26 | + |
| 27 | +| Parameter | Type | Required | Description | |
| 28 | +| --------- | ---- | -------- | ----------- | |
| 29 | +| `realmId` | string | Yes | QuickBooks company ID returned by Intuit as realmId during OAuth | |
| 30 | +| `activeOnly` | boolean | No | Only return active vendors | |
| 31 | +| `startPosition` | string | No | One-based start position for QuickBooks query pagination | |
| 32 | +| `maxResults` | string | No | Maximum number of vendors to return, up to 1000 | |
| 33 | +| `minorVersion` | string | No | QuickBooks Accounting API minor version. Defaults to 75. | |
| 34 | + |
| 35 | +#### Output |
| 36 | + |
| 37 | +| Parameter | Type | Description | |
| 38 | +| --------- | ---- | ----------- | |
| 39 | +| `items` | array | Vendors returned by QuickBooks | |
| 40 | +| ↳ `Id` | string | QuickBooks vendor ID | |
| 41 | +| ↳ `DisplayName` | string | Vendor display name | |
| 42 | +| ↳ `Active` | boolean | Whether the vendor is active | |
| 43 | +| `entity` | string | QuickBooks entity name | |
| 44 | +| `totalCount` | number | Total count returned by QuickBooks | |
| 45 | +| `startPosition` | number | Start position returned by QuickBooks | |
| 46 | +| `maxResults` | number | Maximum records returned by QuickBooks | |
| 47 | +| `query` | string | Query that was executed | |
| 48 | + |
| 49 | +### `quickbooks_list_purchase_orders` |
| 50 | + |
| 51 | +List purchase orders from QuickBooks Online |
| 52 | + |
| 53 | +#### Input |
| 54 | + |
| 55 | +| Parameter | Type | Required | Description | |
| 56 | +| --------- | ---- | -------- | ----------- | |
| 57 | +| `realmId` | string | Yes | QuickBooks company ID returned by Intuit as realmId during OAuth | |
| 58 | +| `startPosition` | string | No | One-based start position for QuickBooks query pagination | |
| 59 | +| `maxResults` | string | No | Maximum number of purchase orders to return, up to 1000 | |
| 60 | +| `minorVersion` | string | No | QuickBooks Accounting API minor version. Defaults to 75. | |
| 61 | + |
| 62 | +#### Output |
| 63 | + |
| 64 | +| Parameter | Type | Description | |
| 65 | +| --------- | ---- | ----------- | |
| 66 | +| `items` | array | Purchase orders returned by QuickBooks | |
| 67 | +| ↳ `Id` | string | QuickBooks purchase order ID | |
| 68 | +| ↳ `DocNumber` | string | Purchase order document number | |
| 69 | +| ↳ `TxnDate` | string | Purchase order transaction date | |
| 70 | +| ↳ `TotalAmt` | number | Purchase order total amount | |
| 71 | +| `entity` | string | QuickBooks entity name | |
| 72 | +| `totalCount` | number | Total count returned by QuickBooks | |
| 73 | +| `startPosition` | number | Start position returned by QuickBooks | |
| 74 | +| `maxResults` | number | Maximum records returned by QuickBooks | |
| 75 | +| `query` | string | Query that was executed | |
| 76 | + |
| 77 | +### `quickbooks_list_bills` |
| 78 | + |
| 79 | +List bills from QuickBooks Online |
| 80 | + |
| 81 | +#### Input |
| 82 | + |
| 83 | +| Parameter | Type | Required | Description | |
| 84 | +| --------- | ---- | -------- | ----------- | |
| 85 | +| `realmId` | string | Yes | QuickBooks company ID returned by Intuit as realmId during OAuth | |
| 86 | +| `startPosition` | string | No | One-based start position for QuickBooks query pagination | |
| 87 | +| `maxResults` | string | No | Maximum number of bills to return, up to 1000 | |
| 88 | +| `minorVersion` | string | No | QuickBooks Accounting API minor version. Defaults to 75. | |
| 89 | + |
| 90 | +#### Output |
| 91 | + |
| 92 | +| Parameter | Type | Description | |
| 93 | +| --------- | ---- | ----------- | |
| 94 | +| `items` | array | Bills returned by QuickBooks | |
| 95 | +| ↳ `Id` | string | QuickBooks bill ID | |
| 96 | +| ↳ `DocNumber` | string | Bill document number | |
| 97 | +| ↳ `TxnDate` | string | Bill transaction date | |
| 98 | +| ↳ `DueDate` | string | Bill due date | |
| 99 | +| ↳ `TotalAmt` | number | Bill total amount | |
| 100 | +| ↳ `Balance` | number | Open bill balance | |
| 101 | +| `entity` | string | QuickBooks entity name | |
| 102 | +| `totalCount` | number | Total count returned by QuickBooks | |
| 103 | +| `startPosition` | number | Start position returned by QuickBooks | |
| 104 | +| `maxResults` | number | Maximum records returned by QuickBooks | |
| 105 | +| `query` | string | Query that was executed | |
| 106 | + |
| 107 | +### `quickbooks_query` |
| 108 | + |
| 109 | +Run a QuickBooks Online Accounting API query |
| 110 | + |
| 111 | +#### Input |
| 112 | + |
| 113 | +| Parameter | Type | Required | Description | |
| 114 | +| --------- | ---- | -------- | ----------- | |
| 115 | +| `realmId` | string | Yes | QuickBooks company ID returned by Intuit as realmId during OAuth | |
| 116 | +| `query` | string | Yes | QuickBooks SQL-like query, e.g. SELECT * FROM Vendor MAXRESULTS 10 | |
| 117 | +| `minorVersion` | string | No | QuickBooks Accounting API minor version. Defaults to 75. | |
| 118 | + |
| 119 | +#### Output |
| 120 | + |
| 121 | +| Parameter | Type | Description | |
| 122 | +| --------- | ---- | ----------- | |
| 123 | +| `items` | array | Records returned by the QuickBooks query | |
| 124 | +| `entity` | string | QuickBooks entity name returned by the query | |
| 125 | +| `totalCount` | number | Total count returned by QuickBooks for the query | |
| 126 | +| `startPosition` | number | Start position returned by QuickBooks | |
| 127 | +| `maxResults` | number | Maximum records returned by QuickBooks | |
| 128 | +| `query` | string | Query that was executed | |
| 129 | + |
| 130 | + |
0 commit comments