> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# QuickBooks

> Quickbooks is a cloud-based accounting software that helps you manage your finances, track your income and expenses, and get insights into your business

Quickbooks is a cloud-based accounting software that helps you manage your finances, track your income and expenses, and get insights into your business

`quickbooks` · **114 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth quickbooks
run auth quickbooks --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run quickbooks          # common commands
run quickbooks --all    # every command
```

```ts theme={"theme":"github-dark"}
import { quickbooks } from "@boxd/run";
```

## Common tools

| Tool                                | What it does                                                                                                                                                  |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `create-bill`                       | Create a new bill in QuickBooks Online. A Bill is an AP transaction representing a request-for-payment from a third party for goods or services.              |
| `create-bill-payment`               | Create a bill payment in QuickBooks to record payment against one or more bills.                                                                              |
| `create-deposit`                    | Creates a new deposit in QuickBooks Online. A deposit represents funds received and deposited to an asset account (typically a bank account).                 |
| `create-estimate`                   | Creates a new estimate in QuickBooks Online. An estimate represents a proposal for goods or services that a customer may purchase.                            |
| `create-item`                       | Create a new item in QuickBooks Online. Items represent the products or services that a company buys, sells, or resells.                                      |
| `create-journal-entry`              | Tool to create a new journal entry in QuickBooks Online. Use when you need to make adjusting or correcting entries that directly affect account balances.     |
| `create-payment`                    | Creates a payment record in QuickBooks Online. The Payment entity records payment from customers against single or multiple invoices and credit memos.        |
| `create-purchase-order`             | Create a new purchase order in QuickBooks. Use when you need to send a request to a vendor to deliver goods or services.                                      |
| `create-sales-receipt`              | Tool to create a new sales receipt in QuickBooks Online. Use when recording a sale where the customer pays immediately (cash, check, credit card).            |
| `get-aged-receivables-report`       | Generate an aged receivables report showing outstanding customer balances by age.                                                                             |
| `get-balance-sheet-report`          | Generate a Balance Sheet report showing company assets, liabilities, and equity at a point in time.                                                           |
| `get-changed-entities`              | Tool to retrieve entities that changed since a specified timestamp using QuickBooks Change Data Capture (CDC) API.                                            |
| `get-company-info`                  | Tool to read company information from QuickBooks Online. Returns basic company info including name, addresses, fiscal year settings, and subscription status. |
| `get-general-ledger-report`         | Generate a General Ledger report showing all transactions with debits, credits, and running balances.                                                         |
| `get-profit-and-loss-detail-report` | Generate a detailed Profit and Loss report showing company income and expenses with transaction-level details.                                                |
| `get-profit-and-loss-report`        | Generate a Profit and Loss report showing company income and expenses over a period.                                                                          |
| `get-report-account-list`           | Retrieve the AccountList report from QuickBooks showing a list of all accounts.                                                                               |
| `get-report-aged-payables`          | Retrieve an Aged Payables aging summary report from QuickBooks showing outstanding vendor balances grouped by age.                                            |
| `get-report-cash-flow`              | Generate a cash flow report in QuickBooks showing cash inflows and outflows categorized by operating, investing, and financing activities.                    |
| `get-report-customer-income`        | Generate a customer income report in QuickBooks showing revenue by customer.                                                                                  |
| `get-report-customer-sales`         | Generate a customer sales report in QuickBooks showing sales transactions and totals for customers.                                                           |
| `get-reports`                       | Retrieve QuickBooks reports such as TransactionList, BalanceSheet, ProfitAndLoss, and others.                                                                 |
| `get-report-trial-balance`          | Generate a Trial Balance report showing account debits, credits, and balances for a specified period.                                                         |
| `get-transaction-list-report`       | Get the Transaction List report showing all transactions in the company.                                                                                      |
| `list-departments`                  | Query Department entities in QuickBooks using SQL-like syntax.                                                                                                |

<Accordion title="All 114 tools" icon="list">
  | Tool                                | What it does                                                                                                                                                            |
  | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `capture-charge`                    | Tool to capture funds for an existing charge that was authorized but not captured.                                                                                      |
  | `create-account`                    | Create a new account in QuickBooks with the given parameters.                                                                                                           |
  | `create-bank-account`               | Create a new bank account on file for a customer in QuickBooks Payments API.                                                                                            |
  | `create-bill`                       | Create a new bill in QuickBooks Online. A Bill is an AP transaction representing a request-for-payment from a third party for goods or services.                        |
  | `create-bill-payment`               | Create a bill payment in QuickBooks to record payment against one or more bills.                                                                                        |
  | `create-class`                      | Create a new class in QuickBooks Online. Use when you need to categorize transactions by department, location, or other business segments.                              |
  | `create-credit-memo`                | Tool to create a new credit memo in QuickBooks Online. Use when issuing credit to a customer for returns, refunds, or adjustments.                                      |
  | `create-customer`                   | Create a new customer in QuickBooks with the given parameters.                                                                                                          |
  | `create-deposit`                    | Creates a new deposit in QuickBooks Online. A deposit represents funds received and deposited to an asset account (typically a bank account).                           |
  | `create-echeck-payment`             | Tool to create an eCheck payment using ACH bank transfer in QuickBooks Payments API.                                                                                    |
  | `create-employee`                   | Create a new employee in QuickBooks.                                                                                                                                    |
  | `create-estimate`                   | Creates a new estimate in QuickBooks Online. An estimate represents a proposal for goods or services that a customer may purchase.                                      |
  | `create-invoice`                    | Creates a new invoice in QuickBooks for a customer. An invoice represents a sales transaction where goods or services are sold to a customer on...                      |
  | `create-item`                       | Create a new item in QuickBooks Online. Items represent the products or services that a company buys, sells, or resells.                                                |
  | `create-journal-entry`              | Tool to create a new journal entry in QuickBooks Online. Use when you need to make adjusting or correcting entries that directly affect account balances.               |
  | `create-payment`                    | Creates a payment record in QuickBooks Online. The Payment entity records payment from customers against single or multiple invoices and credit memos.                  |
  | `create-purchase`                   | Tool to create a new purchase transaction in QuickBooks Online.                                                                                                         |
  | `create-purchase-order`             | Create a new purchase order in QuickBooks. Use when you need to send a request to a vendor to deliver goods or services.                                                |
  | `create-refund-receipt`             | Tool to create a new refund receipt in QuickBooks Online. Use when a customer receives a refund for returned goods or services.                                         |
  | `create-sales-receipt`              | Tool to create a new sales receipt in QuickBooks Online. Use when recording a sale where the customer pays immediately (cash, check, credit card).                      |
  | `create-tax-agency`                 | Create a new tax agency in QuickBooks Online. Use when you need to set up a new tax authority or agency for tax reporting purposes.                                     |
  | `create-taxservice-taxcode`         | Create a new tax code with associated tax rates using the TaxService endpoint.                                                                                          |
  | `create-time-activity`              | Create a new time activity record in QuickBooks Online. TimeActivity tracks employee or vendor time worked on jobs or projects.                                         |
  | `create-vendor`                     | Create a new vendor in QuickBooks with the given details.                                                                                                               |
  | `create-vendor-credit`              | Tool to create a new vendor credit in QuickBooks Online. Use when recording a credit from a vendor that reduces what you owe.                                           |
  | `customer-balance-detail`           | Generate a balance detail report for a customer in QuickBooks with the given customer ID.                                                                               |
  | `customer-balance-report`           | Generate a customer balance report in QuickBooks showing outstanding balances for customers.                                                                            |
  | `delete-bank-account`               | Tool to delete a bank account on file for a customer in QuickBooks Payments API.                                                                                        |
  | `delete-item`                       | Delete an item in QuickBooks Online by marking it as inactive (soft delete).                                                                                            |
  | `execute-batch-operation`           | Execute multiple QuickBooks operations in a single request. Operations are performed serially.                                                                          |
  | `get-aged-receivables-report`       | Generate an aged receivables report showing outstanding customer balances by age.                                                                                       |
  | `get-attachable`                    | Tool to read details of a specific attachable by ID in QuickBooks Online.                                                                                               |
  | `get-balance-sheet-report`          | Generate a Balance Sheet report showing company assets, liabilities, and equity at a point in time.                                                                     |
  | `get-bank-account`                  | Tool to retrieve a specific bank account by ID from QuickBooks Payments API.                                                                                            |
  | `get-bill`                          | Tool to fetch a QuickBooks bill by ID. Use when needing to retrieve bill details including vendor reference, line items, amounts, and payment status.                   |
  | `get-bill-payment`                  | Tool to retrieve details of a specific bill payment by ID in QuickBooks Online.                                                                                         |
  | `get-changed-entities`              | Tool to retrieve entities that changed since a specified timestamp using QuickBooks Change Data Capture (CDC) API.                                                      |
  | `get-company-info`                  | Tool to read company information from QuickBooks Online. Returns basic company info including name, addresses, fiscal year settings, and subscription status.           |
  | `get-credit-memo`                   | Tool to fetch a QuickBooks credit memo by ID. Use when needing full credit memo details including metadata, customer info, line items, and remaining credit amount.     |
  | `get-credit-memo-pdf`               | Tool to download a QuickBooks credit memo as a PDF file. Use when you need to retrieve the printable PDF version of a credit memo.                                      |
  | `get-department`                    | Read details of a specific department by ID in QuickBooks Online.                                                                                                       |
  | `get-deposit`                       | Tool to read details of a specific deposit by ID in QuickBooks Online.                                                                                                  |
  | `get-estimate`                      | Tool to fetch a QuickBooks estimate by ID. Use when needing full estimate details including metadata, line items, and sync token.                                       |
  | `get-estimate-pdf`                  | Tool to download a QuickBooks estimate as a PDF file. Use when you need to retrieve the printable PDF version of an estimate.                                           |
  | `get-exchange-rate`                 | Tool to get exchange rate for a specific currency code and date in QuickBooks Online.                                                                                   |
  | `get-general-ledger-report`         | Generate a General Ledger report showing all transactions with debits, credits, and running balances.                                                                   |
  | `get-inventory-valuation-summary`   | Generate an Inventory Valuation Summary report showing inventory quantities and their current values.                                                                   |
  | `get-invoice-pdf`                   | Tool to download a QuickBooks invoice as a PDF file. Use when you need to retrieve the printable PDF version of an invoice.                                             |
  | `get-item`                          | Tool to retrieve a specific item by its ID from QuickBooks Online.                                                                                                      |
  | `get-journal-entry`                 | Tool to read details of a specific QuickBooks journal entry by ID.                                                                                                      |
  | `get-payment`                       | Tool to fetch details of a specific payment by ID in QuickBooks Online.                                                                                                 |
  | `get-payment-method`                | Read details of a specific payment method by ID in QuickBooks Online.                                                                                                   |
  | `get-payment-pdf`                   | Tool to download a QuickBooks payment record as a PDF file. Use when you need to retrieve the printable PDF version of a payment.                                       |
  | `get-preferences`                   | Tool to read company preferences that control application behavior in QuickBooks Online.                                                                                |
  | `get-profit-and-loss-detail-report` | Generate a detailed Profit and Loss report showing company income and expenses with transaction-level details.                                                          |
  | `get-profit-and-loss-report`        | Generate a Profit and Loss report showing company income and expenses over a period.                                                                                    |
  | `get-purchase`                      | Tool to fetch details of a specific purchase by ID in QuickBooks Online.                                                                                                |
  | `get-purchase-order`                | Tool to fetch a QuickBooks purchase order by ID. Use when needing full purchase order details including line items, vendor information, and metadata.                   |
  | `get-purchase-order-pdf`            | Tool to download a QuickBooks purchase order as a PDF file. Use when you need to retrieve the printable PDF version of a purchase order.                                |
  | `get-refund-receipt`                | Tool to fetch a QuickBooks refund receipt by ID. Use when needing details of a specific refund issued to a customer.                                                    |
  | `get-refund-receipt-pdf`            | Tool to download a QuickBooks refund receipt as a PDF file. Use when you need to retrieve the printable PDF version of a refund receipt.                                |
  | `get-report-account-list`           | Retrieve the AccountList report from QuickBooks showing a list of all accounts.                                                                                         |
  | `get-report-aged-payable-detail`    | Generate an aged payable detail report showing aging detail for accounts payable.                                                                                       |
  | `get-report-aged-payables`          | Retrieve an Aged Payables aging summary report from QuickBooks showing outstanding vendor balances grouped by age.                                                      |
  | `get-report-aged-receivable-detail` | Generate an aged receivable detail report showing aging detail for accounts receivable.                                                                                 |
  | `get-report-cash-flow`              | Generate a cash flow report in QuickBooks showing cash inflows and outflows categorized by operating, investing, and financing activities.                              |
  | `get-report-class-sales`            | Generate a ClassSales report in QuickBooks showing sales amounts grouped by class.                                                                                      |
  | `get-report-customer-income`        | Generate a customer income report in QuickBooks showing revenue by customer.                                                                                            |
  | `get-report-customer-sales`         | Generate a customer sales report in QuickBooks showing sales transactions and totals for customers.                                                                     |
  | `get-report-department-sales`       | Generate a department sales report in QuickBooks showing sales data broken down by department.                                                                          |
  | `get-report-item-sales`             | Generate an ItemSales report showing sales data for products and services.                                                                                              |
  | `get-reports`                       | Retrieve QuickBooks reports such as TransactionList, BalanceSheet, ProfitAndLoss, and others.                                                                           |
  | `get-report-trial-balance`          | Generate a Trial Balance report showing account debits, credits, and balances for a specified period.                                                                   |
  | `get-sales-receipt`                 | Tool to fetch a QuickBooks sales receipt by ID. Use when needing full sales receipt details including customer info, line items, payment details, and metadata.         |
  | `get-salesreceipt-pdf`              | Tool to download a QuickBooks sales receipt as a PDF file. Use when you need to retrieve the printable PDF version of a sales receipt.                                  |
  | `get-tax-rate`                      | Tool to read details of a specific tax rate by ID in QuickBooks Online.                                                                                                 |
  | `get-term`                          | Read details of a specific payment term by ID in QuickBooks Online.                                                                                                     |
  | `get-time-activity`                 | Tool to read details of a specific time activity by ID in QuickBooks Online.                                                                                            |
  | `get-transaction-list-report`       | Get the Transaction List report showing all transactions in the company.                                                                                                |
  | `get-transfer`                      | Tool to fetch a QuickBooks transfer by ID. Use when needing to retrieve transfer details including from/to account references and transfer amount.                      |
  | `get-vendor-credit`                 | Tool to fetch a QuickBooks vendor credit by ID. Use when needing to retrieve vendor credit details including vendor reference, line items, amounts, and balance status. |
  | `get-vendor-expenses-report`        | Retrieve a vendor expenses report from QuickBooks showing expense transactions by vendor.                                                                               |
  | `list-cards`                        | Tool to retrieve all payment cards on file for a customer in QuickBooks Payments API.                                                                                   |
  | `list-departments`                  | Query Department entities in QuickBooks using SQL-like syntax.                                                                                                          |
  | `list-invoices`                     | Tool to list invoices via QuickBooks Query endpoint. Use when retrieving invoices with optional pagination and custom fields.                                           |
  | `query-account`                     | Query Account entities in QuickBooks using SQL-like syntax. IMPORTANT: Queries the Account entity ONLY (chart of accounts).                                             |
  | `query-accounts`                    | Query Account entities in QuickBooks using SQL-like syntax. Use this action when you need to retrieve multiple accounts from the chart of accounts...                   |
  | `query-attachable`                  | Query Attachable entities in QuickBooks using SQL-like syntax.                                                                                                          |
  | `query-bills`                       | Query Bill entities in QuickBooks using SQL-like syntax. Returns bills with vendor information, line items, amounts, due dates, and payment status.                     |
  | `query-customers`                   | Query Customer entities in QuickBooks using SQL-like syntax.                                                                                                            |
  | `query-entities`                    | Execute SQL-like queries on QuickBooks Online entities. Supports all entity types (Customer, Invoice, Bill, Payment, Purchase, Account, etc.) with...                   |
  | `query-estimates`                   | Query Estimate entities in QuickBooks using SQL-like syntax.                                                                                                            |
  | `query-invoices`                    | Query QuickBooks invoices with flexible filtering and pagination support.                                                                                               |
  | `query-items`                       | Query Item entities in QuickBooks using SQL-like syntax. Use this action to search, filter, and retrieve products and services from the QuickBooks catalog.             |
  | `query-payments`                    | Query Payment entities in QuickBooks using SQL-like syntax. Use when searching, filtering, or listing payments by date, customer, amount, or other attributes.          |
  | `query-vendors`                     | Query Vendor entities in QuickBooks using SQL-like syntax. Returns vendors matching the specified criteria with full details.                                           |
  | `read-account`                      | Read an account in QuickBooks with the given account ID.                                                                                                                |
  | `read-class`                        | Read details of a specific class by ID in QuickBooks Online.                                                                                                            |
  | `read-customer`                     | Read a customer in QuickBooks with the given customer ID.                                                                                                               |
  | `read-employee`                     | Read an employee's details in QuickBooks with the given employee ID.                                                                                                    |
  | `read-invoice`                      | Tool to fetch a QuickBooks invoice by ID or the most recent if no ID provided.                                                                                          |
  | `read-vendor`                       | Read a vendor in QuickBooks with the given vendor ID.                                                                                                                   |
  | `send-credit-memo`                  | Tool to send a credit memo to a specified email address. Use when you need to email a credit memo to a customer.                                                        |
  | `update-attachable`                 | Tool to update an existing attachable in QuickBooks Online. Use when you need to modify attachable properties like note text or entity references.                      |
  | `update-company-info`               | Tool to update company information in QuickBooks Online. Use when you need to update company details like name, address, or contact information.                        |
  | `update-department`                 | Tool to update an existing department in QuickBooks Online. Use when you need to modify department details.                                                             |
  | `update-full-invoice`               | Tool to fully replace an Invoice. Use when you need to update all aspects of an existing invoice in a single operation.                                                 |
  | `update-payment-method`             | Tool to update an existing payment method in QuickBooks Online.                                                                                                         |
  | `update-preferences`                | Update company preferences in QuickBooks Online. Requires Id and SyncToken from a previous read.                                                                        |
  | `update-sparse-invoice`             | Tool to perform a sparse update of an existing invoice. Use when you need to update only specific invoice fields without overwriting other data.                        |
  | `update-term`                       | Tool to update an existing payment term in QuickBooks Online.                                                                                                           |
  | `update-transfer`                   | Tool to update an existing transfer in QuickBooks Online. Use when you need to modify a transfer between accounts.                                                      |
  | `vendor-balance-detail`             | Generate a balance detail report for a vendor in QuickBooks with the given vendor ID.                                                                                   |
  | `vendor-balance-report`             | Retrieve a vendor balance report from QuickBooks showing outstanding balances for vendors.                                                                              |
</Accordion>

[Open QuickBooks in the console →](https://app.boxd.sh/integrations/detail/quickbooks)
