Skip to main content
QuickBooks logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 114
  • Triggers: 0
  • Slug: QUICKBOOKS
  • Version: 20261101_00

Frequently Asked Questions

If this appears while connecting QuickBooks and the auth config includes the com.intuit.quickbooks.payment scope, check whether the QuickBooks Payments module is enabled for the selected QuickBooks company.That scope requires payment-module access in QuickBooks. If you do not need payment tools, remove com.intuit.quickbooks.payment from the auth config and reconnect. If you do need payment tools, enable QuickBooks Payments for that company/account, then start a fresh connection.
This behavior is intentional on Claude’s side. QuickBooks has tools that can process payments, so Claude can classify it under Payment Processing and block execution in consumer MCP sessions. Use Claude Code or Claude Cowork with Composio through the CLI/developer path where the agent can still access QuickBooks through Composio.
For QuickBooks sandbox accounts, pass https://sandbox-quickbooks.api.intuit.com as the URL/base URL when initiating the connection. Production connections should use the production Intuit API base URL.

Tools

Slug: QUICKBOOKS_CAPTURE_CHARGETool to capture funds for an existing charge that was authorized but not captured. Use when you need to complete a previously authorized payment transaction in QuickBooks Payments API. This action finalizes the charge and transfers the funds from the customer’s payment method.

Input Parameters

string
The amount to capture. If not provided, captures the full authorized amount. For partial captures, specify the amount as a decimal string (e.g., ‘10.55’, ‘25.00’). The amount must not exceed the authorized amount.
object
Additional context information for the capture. This is an optional field that can contain merchant-specific metadata or transaction context.
string
required
The ID of the charge to capture. This is the unique identifier for the authorized charge in QuickBooks Payments (e.g., ‘EMU123456789’, ‘ECH123456789’). Use this to capture funds from a charge that was previously authorized but not captured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_ACCOUNTCreate a new account in QuickBooks with the given parameters.

Input Parameters

string
required
User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:).
boolean
Whether or not the account is active. Inactive accounts may be hidden from display and cannot be posted to. Default is true if not specified.
object
Reference to another entity.
string
User-entered description for the account. May include information to guide bookkeepers in deciding what to post to the account. Maximum length is 100 characters for QuickBooks Online, 200 characters for QuickBooks Desktop.
boolean
Specifies whether this is a subaccount. Set to true to create a subaccount. Must also provide parent_ref when true.
string ("Bank" | "Other Current Asset" | "Fixed Asset" | "Other Asset" | "Accounts Receivable" | "Equity" | "Expense" | "Other Expense" | "Cost of Goods Sold" | "Accounts Payable" | "Credit Card" | "Long Term Liability" | "Other Current Liability" | "Income" | "Other Income")
required
Type of the account to be created. Required field. Valid values: ‘Bank’, ‘Other Current Asset’, ‘Fixed Asset’, ‘Other Asset’, ‘Accounts Receivable’, ‘Equity’, ‘Expense’, ‘Other Expense’, ‘Cost of Goods Sold’, ‘Accounts Payable’, ‘Credit Card’, ‘Long Term Liability’, ‘Other Current Liability’, ‘Income’, ‘Other Income’.
object
Reference to another entity.
string
User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. must not contain colon (:). For France locales:
number
Opening balance amount when creating a new Balance Sheet account. Used only at account creation for accounts like Bank, Credit Card, etc.
string
Sub-type of the account. Must use exact enum values (no spaces/slashes). Examples: ‘AdvertisingPromotional’ (NOT ‘Advertising/Promotional’), ‘Checking’, ‘Inventory’, ‘OtherCurrentAssets’, ‘Vehicles’, ‘RetainedEarnings’, ‘Insurance’, ‘InterestEarned’. See QuickBooks API docs for complete list.
string
Date of the opening balance. Format: YYYY-MM-DD. Required if opening_balance is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_BANK_ACCOUNTCreate a new bank account on file for a customer in QuickBooks Payments API. Use this when you need to add ACH/eCheck payment capabilities for a customer.

Input Parameters

string
required
Account holder name (full name of the person or business).
string
Phone number associated with the bank account holder.
string
required
The customer ID for whom to create the bank account.
string ("PERSONAL_CHECKING" | "PERSONAL_SAVINGS" | "BUSINESS_CHECKING" | "BUSINESS_SAVINGS")
required
Type of bank account. Must be one of: PERSONAL_CHECKING, PERSONAL_SAVINGS, BUSINESS_CHECKING, or BUSINESS_SAVINGS.
string
required
Bank account number.
string
required
Bank routing number (must be valid and pass checksum validation). Use a valid 9-digit ABA routing number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_BILLCreate 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. Use this action when recording vendor bills for purchases, expenses, or services received.

Input Parameters

array
required
List of line items for the bill. At least one line item is required. Each line must specify DetailType, Amount, and the appropriate detail object.
string
Date when payment for the bill is due in YYYY-MM-DD format.
string
Date of the transaction in YYYY-MM-DD format. Defaults to the current date if not provided.
string
Reference number for the bill (e.g., vendor invoice number).
object
required
Reference to the vendor from whom the bill is received. Required field.
object
Reference to the currency. Format: {‘value’: ‘USD’}.
string
User-entered private note about the bill.
object
Reference to the Accounts Payable account. Format: {‘value’: ‘account_id’}. If not specified, uses the default AP account.
number
Currency exchange rate for multi-currency transactions.
object
Reference to the payment terms. Format: {‘value’: ‘term_id’}. Defines when payment is due.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default version.
object
Reference to the department. Format: {‘value’: ‘department_id’}.
string
Method in which tax is applied. Valid values: TaxExcluded, TaxInclusive, NotApplicable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_BILL_PAYMENTCreate a bill payment in QuickBooks to record payment against one or more bills. Use when paying vendor bills via check or credit card.

Input Parameters

array
required
List of line items indicating which bills are being paid and the amounts applied to each.
string ("Check" | "CreditCard")
required
Payment method type. Must be either ‘Check’ or ‘CreditCard’.
string
Date of the transaction in YYYY-MM-DD format. Defaults to current date if not specified.
number
required
Total amount of the bill payment. Must be positive and match the sum of all line amounts.
object
required
Reference to the vendor receiving the payment.
string
Private note for internal use, not visible to the vendor. Maximum 4000 characters.
object
Check payment details for bill payment.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default from headers.
object
Reference to the department for location/department tracking. Must be a dict with ‘value’ key.
object
Credit card payment details for bill payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_CLASSCreate a new class in QuickBooks Online. Use when you need to categorize transactions by department, location, or other business segments.

Input Parameters

string
required
The name of the class. Must be unique and cannot contain a colon (:).
boolean
Whether the class is active. Inactive classes are hidden from most display areas. Default is true.
boolean
Whether this is a subclass. If true, ParentRef must be provided.
object
Reference to another entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_CREDIT_MEMOTool to create a new credit memo in QuickBooks Online. Use when issuing credit to a customer for returns, refunds, or adjustments.

Input Parameters

array
required
Array of line items for the credit memo. At least one line item is required.
string
Transaction date in YYYY-MM-DD format. Defaults to current date if not provided.
object
Physical address structure.
object
Reference to the class for categorization. Format: {‘value’: ‘class_id’}.
object
Physical address structure.
string
Shipping date in YYYY-MM-DD format.
string
Email address to send the credit memo to. Must be a valid email format.
string
Reference number for the credit memo (maximum 21 characters).
object
Reference to currency.
array
Array of custom fields for the credit memo.
object
required
Reference to the customer receiving the credit memo. Required field.
string
Email status of the credit memo. Valid values: ‘NotSet’, ‘NeedToSend’, ‘EmailSent’.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default version from headers.
string
Print status of the credit memo. Valid values: ‘NotSet’, ‘NeedToPrint’, ‘PrintComplete’.
string
Private note about the credit memo, not visible to the customer.
string
Message to the customer that appears on the credit memo. Maximum 1000 characters.
number
Exchange rate for currency conversion.
object
Reference to the department associated with the credit memo. Format: {‘value’: ‘department_id’}.
object
Reference to the sales term. Format: {‘value’: ‘term_id’}.
object
Reference to the shipping method. Format: {‘value’: ‘ship_method_id’}.
string
Method in which tax is applied. Valid values: ‘TaxExcluded’, ‘TaxInclusive’, ‘NotApplicable’.
boolean
Whether to apply tax after discount. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_CUSTOMERCreate a new customer in QuickBooks with the given parameters.

Input Parameters

object
Fax number of the customer.
boolean
Whether this customer record represents a job. Default is false.
string
Free-form notes or comments about the customer.
string
Title of the person (max 16 characters - keep it short like ‘Mr.’, ‘Dr.’, ‘CEO’). This tag supports i18n, all locales. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, Suffix, or FullyQualifiedName attributes are required during create.
boolean
Whether the customer is currently active. Default is true.
object
Mobile phone number of the customer.
string
Suffix of the name. For example, Jr. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
number
Opening balance amount for this customer at the OpenBalanceDate.
boolean
Whether the customer is taxable. Default is true.
object
Website address (URI) of the customer.
object
Billing address of the customer.
object
Shipping address of the customer.
object
Reference to the immediate parent customer for sub-customers.
string
Resale number or tax-exempt number for the customer.
string
Given name or first name of a person. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
string
Company name associated with the customer.
object
Reference to the currency used for transactions with this customer (e.g., {‘value’: ‘USD’}).
string
Family name or the last name of the person. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
string
Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
object
Primary phone number of the customer.
string
The name as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: Title, GivenName, MiddleName, FamilyName, and Suffix.
object
Alternate phone number of the customer.
boolean
Whether this sub-customer should be billed with its parent customer. Default is false.
string
Date of the opening balance for the customer in YYYY-MM-DD format.
object
Primary email address of the customer.
string
Name to be printed on checks issued to this customer. If not provided, DisplayName is used.
string ("Print" | "Email" | "None")
Preferred delivery method for invoices and communications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_DEPOSITCreates a new deposit in QuickBooks Online. A deposit represents funds received and deposited to an asset account (typically a bank account). Use this action to record deposits of customer payments, refunds, or other funds into your bank accounts. Each deposit must specify the destination account and at least one line item showing the source and amount of funds.

Input Parameters

array
required
List of deposit line items. Each line item represents funds being deposited. At least one line is required. Each line must include: (1) ‘Amount’ as a positive number, (2) ‘DetailType’ set to ‘DepositLineDetail’, (3) ‘DepositLineDetail’ with ‘AccountRef’ containing the source account ID. Example: [{‘Amount’: 100.00, ‘DetailType’: ‘DepositLineDetail’, ‘DepositLineDetail’: {‘AccountRef’: {‘value’: ‘87’}}}]
string
Transaction date for the deposit in YYYY-MM-DD format (e.g., ‘2026-02-23’). If not provided, the current date will be used.
object
Reference to a currency.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). If not specified, uses the default API version.
string
Private note about the deposit (internal use only).
string
Exchange rate for multi-currency transactions. Default is 1 for home currency.
object
Reference to a department.
object
required
Reference to the asset account (bank account) where the deposit will be made. Must be a valid bank account ID. Example: {‘value’: ‘35’} for account ID 35. Use QUICKBOOKS_QUERY_ACCOUNT or QUICKBOOKS_READ_ACCOUNT to get valid account IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_ECHECK_PAYMENTCreate an eCheck payment through the QuickBooks Payments API using customer bank account and routing details for an ACH debit. Requires the QuickBooks Payments authorization scope.

Input Parameters

string
required
Payment amount as a string (e.g., ‘10.55’, ‘100.00’). Must be a positive number with up to 2 decimal places.
object
Transaction context information.
string
required
Currency code for the payment (e.g., ‘USD’). Currently only USD is supported by QuickBooks Payments.
object
required
Bank account details from which the eCheck payment will be debited. Includes account number, routing number, account type, name, and phone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_EMPLOYEECreate a new employee in QuickBooks.

Input Parameters

object
Fax number of the employee.
string
Social Security Number. Maximum 15 characters for QuickBooks Online, 1024 characters for QuickBooks Desktop.
string
Title or honorific of the employee.
boolean
Indicates whether the entity is enabled. Default is true. Employees are deactivated (active=false) rather than deleted.
string
Gender of the employee.
object
Mobile phone number of the employee.
string
Name suffix of the employee. QuickBooks Online only. Maximum 15 characters.
object
Website address or URI associated with the employee.
number
Hourly billing rate for the employee. QuickBooks Online only.
number
Cost rate associated with the employee.
string
Birth date of the employee, in YYYY-MM-DD format.
string
required
Given name (first name) of the employee. Required field. Maximum 100 characters.
string
Date the employee was hired, in YYYY-MM-DD format.
object
Other physical address(es) of the employee.
string
required
Family name (last name) of the employee. Required field. Maximum 100 characters.
string
Middle name(s) of the employee. Maximum 5-15 characters depending on product.
string
Company name associated with the employee.
array
Array of custom fields associated with the employee.
string
Display name of the employee. Must be unique across all customer, employee, and vendor objects. Populated from FullName if not provided. Must not contain colon, tab, or newline characters.
boolean
Internal flag for organizational structure.
object
Physical street address for this employee. If QuickBooks Payroll is enabled for the company, the following address fields are required: city, country_sub_division_code, and postal_code.
boolean
Indicates whether employee time is billable. QuickBooks Online only.
string
Employee type classification.
object
Primary phone number of the employee.
string
Date the employee left the company, in YYYY-MM-DD format.
boolean
Indicates whether time sheets create paychecks for this employee.
object
Alternate phone number of the employee.
string
Employee directory number. Maximum 15 for QuickBooks Online, 99 for QuickBooks Desktop.
array
List of additional contact information entities.
object
Primary email address of the employee.
string
Name as it should appear on printed checks.
object
Reference to the default tax code associated with the employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_ESTIMATECreates a new estimate in QuickBooks Online. An estimate represents a proposal for goods or services that a customer may purchase. Use this to provide pricing quotes to customers before they commit to a purchase. This action requires a valid customer ID and at least one line item with item details and amount. The created estimate can later be converted to an invoice when the customer accepts the proposal.

Input Parameters

array
required
List of estimate line items. Each line item must include DetailType, Amount, and appropriate detail object (e.g., SalesItemLineDetail for item-based lines).
string
Date of the estimate transaction in YYYY-MM-DD format (e.g., ‘2024-01-15’). If not specified, the current date is used.
object
Physical address structure.
object
Reference to a class for categorization.
object
Physical address structure.
string
Date for delivery of goods or services in YYYY-MM-DD format (e.g., ‘2024-03-15’).
string
Email address where the estimate should be sent.
string
Reference number for the estimate. If not specified, QuickBooks generates one automatically.
string
required
ID of the customer for whom the estimate is created. This is the unique identifier for the customer in QuickBooks (e.g., ‘1’, ‘3’). Use QUICKBOOKS_READ_CUSTOMER or QUICKBOOKS_CREATE_CUSTOMER to get valid customer IDs.
object
Reference to a currency.
array
Custom fields for the estimate. QuickBooks Online supports up to 3 custom fields. The custom fields must already exist in QuickBooks.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). If not specified, uses the default API version from headers.
string
User-entered private note about the estimate, not visible to the customer. Maximum 4000 characters.
string
Shipping provider’s tracking number for the delivery of goods. Maximum 31 characters.
string
Message to the customer that appears on the estimate.
number
The exchange rate for the transaction. Applicable if multi-currency is enabled. Defaults to 1.
object
Reference to a department.
object
Reference to sales terms.
string
Date by which the estimate must be accepted in YYYY-MM-DD format (e.g., ‘2024-02-28’).
object
Reference to a shipping method.
string
Method in which tax is applied. Valid values: TaxExcluded, TaxInclusive, NotApplicable. Default is TaxExcluded.
boolean
If true, tax is applied after discount. If false or null, calculate sales tax first then apply discount. US QuickBooks companies only. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_INVOICECreates a new invoice in QuickBooks for a customer. An invoice represents a sales transaction where goods or services are sold to a customer on credit or for immediate payment. This action requires: - A valid customer ID (obtain from QUICKBOOKS_CREATE_CUSTOMER or QUICKBOOKS_READ_CUSTOMER) - At least one line item with a valid item/service ID and amount The created invoice will have a unique ID, document number, due date, total amount, and balance. Use this to bill customers for products or services rendered. To update the invoice later, re-read it first to obtain the current SyncToken; stale tokens cause update rejections.

Input Parameters

string
Free On Board (FOB) designation for shipping terms. Defines when ownership and liability transfer from seller to buyer.
array
required
List of invoice line items. Each line item must be a dictionary with: (1) ‘DetailType’ set to ‘SalesItemLineDetail’, (2) ‘Amount’ as a number representing the line total, (3) ‘SalesItemLineDetail’ as a dictionary containing ‘ItemRef’ with a ‘value’ key for the item ID (e.g., {‘ItemRef’: {‘value’: ‘1’}}). Optional fields include ‘Description’ (text), ‘Qty’ (quantity as number), and ‘UnitPrice’ (price per unit as number). Example: [{‘DetailType’: ‘SalesItemLineDetail’, ‘Amount’: 100.00, ‘SalesItemLineDetail’: {‘ItemRef’: {‘value’: ‘1’}, ‘Qty’: 2, ‘UnitPrice’: 50.00}}]
string
Date when payment for the invoice is due in YYYY-MM-DD format (e.g., ‘2026-03-25’). Calculated from TxnDate and SalesTermRef if not explicitly provided.
string
Date when the transaction occurred in YYYY-MM-DD format (e.g., ‘2026-02-25’). This is the posting date that affects financial statements. If not supplied, the current server date is used.
object
Bill-to address of the invoice. Provide as a dictionary with keys like ‘Line1’, ‘City’, ‘CountrySubDivisionCode’, ‘PostalCode’. If not provided, defaults to the customer’s billing address.
object
Reference to the class associated with the transaction for categorization and reporting. Provide as a dictionary with ‘value’ key for the class ID (e.g., {‘value’: ‘5’}).
string
Purchase order number provided by the customer. Maximum 25 characters (QuickBooks Windows) or 15 characters (QuickBooks Online).
string
Optional idempotency key (maximum 50 characters) to prevent duplicate writes on retries. If provided, QuickBooks will not create a duplicate invoice if the same requestid is used again.
object
Shipping address for the invoice. Provide as a dictionary with keys like ‘Line1’, ‘City’, ‘CountrySubDivisionCode’, ‘PostalCode’. If not provided, defaults to the customer’s shipping address.
string
Date when the product was shipped or service was performed in YYYY-MM-DD format (e.g., ‘2026-02-25’).
object
Email address where the invoice should be sent. Provide as a dictionary with ‘Address’ key (e.g., {‘Address’: ‘customer@example.com’}).
string
Reference number for the transaction. Maximum 21 characters for QuickBooks Online. If not provided, QuickBooks auto-generates this by incrementing the last number.
string
required
ID of the customer to invoice. This is the unique identifier for the customer in QuickBooks (e.g., ‘1’, ‘92’). Use QUICKBOOKS_CREATE_CUSTOMER or QUICKBOOKS_READ_CUSTOMER to get valid customer IDs. Customer must be active; inactive customer IDs will cause invoice creation to fail. Similarly, all ItemRef values in lines must reference active items/services.
object
Reference to the project associated with the invoice. Provide as a dictionary with ‘value’ key for the project ID (e.g., {‘value’: ‘10’}).
object
Reference to the currency in which all amounts on the invoice are expressed. Provide as a dictionary with ‘value’ key for the currency code (e.g., {‘value’: ‘USD’}).
array
Array of custom fields for the invoice. QuickBooks Online supports up to 3 custom fields. Each field should be a dictionary with ‘DefinitionId’, ‘Name’, ‘Type’, and value keys (e.g., [{‘DefinitionId’: ‘1’, ‘Name’: ‘Field1’, ‘Type’: ‘StringType’, ‘StringValue’: ‘Value1’}]).
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version.
string
User-entered, organization-private note about the transaction that will not appear on customer-facing records. Maximum 4000 characters.
object
Reference to the template used for formatting the invoice. Provide as a dictionary with ‘value’ key for the template ID (e.g., {‘value’: ‘5’}).
string
Shipping provider’s tracking number for the delivery. Maximum 31 characters.
object
CC email address for the invoice. Provide as a dictionary with ‘Address’ key (e.g., {‘Address’: ‘cc@example.com’}).
object
User-entered message to the customer that appears on the invoice. Provide as a dictionary with ‘value’ key (e.g., {‘value’: ‘Thank you for your business’}). Maximum 1000 characters.
number
Currency exchange rate for multi-currency environments. Exchange rates are always recorded as the number of home currency units per one foreign currency unit.
object
BCC email address for the invoice. Provide as a dictionary with ‘Address’ key (e.g., {‘Address’: ‘bcc@example.com’}).
object
Reference to the department for location tracking (QuickBooks Online). Provide as a dictionary with ‘value’ key for the department ID (e.g., {‘value’: ‘1’}).
object
Reference to the sales terms (payment terms) that determine the invoice due date. Provide as a dictionary with ‘value’ key for the term ID (e.g., {‘value’: ‘3’}).
object
Ship-from address for the invoice. Provide as a dictionary with keys like ‘Line1’, ‘City’, ‘CountrySubDivisionCode’, ‘PostalCode’.
object
Details of taxes charged on the transaction as a whole. Provide as a dictionary with ‘TxnTaxCodeRef’ and/or ‘TaxLine’ keys. QuickBooks automatically calculates this based on tax codes if not provided.
object
Reference to the shipping method. Provide as a dictionary with ‘value’ key for the shipping method ID (e.g., {‘value’: ‘2’}).
boolean
Specifies whether customer is allowed to use IPN (Instant Payment Notification) to pay the invoice.
boolean
Specifies whether customer is allowed to use eInvoicing (online payment) to pay the invoice.
object
Reference to the asset account where payment deposits are recorded. Provide as a dictionary with ‘value’ key for the account ID (e.g., {‘value’: ‘35’}).
string
Method used to apply taxes. Valid values: ‘TaxExcluded’, ‘TaxInclusive’, ‘NotApplicable’. Default is ‘TaxExcluded’.
boolean
Permits customers to pay via electronic bank transfers (ACH) through eInvoicing.
boolean
If false or null, calculate sales tax first then apply discount. If true, apply discount first then calculate tax. US QuickBooks companies only.
boolean
Permits customers to pay via credit cards through eInvoicing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_ITEMCreate a new item in QuickBooks Online. Items represent the products or services that a company buys, sells, or resells. Use when adding new inventory items, services, or non-inventory products to the QuickBooks catalog.

Input Parameters

string
required
User-recognizable name for the item. This is the name displayed in lists and forms in QuickBooks.
string ("Service" | "Inventory" | "NonInventory" | "Category" | "Bundle")
required
Classification specifying the use of this item. Valid values: ‘Service’ (services offered for sale), ‘Inventory’ (products bought and sold with quantity tracking - requires QuickBooks Online Plus or Advanced), ‘NonInventory’ (products bought and sold without quantity tracking), ‘Category’ (used to group items together), ‘Bundle’ (combination of products/services sold together). Different types have different required fields.
boolean
Whether the item is active and available for use. Default is true.
boolean
Whether sales of this item are subject to sales tax. Default is false.
object
Reference to another entity.
number
Unit price of the item for sales. This is the default selling price per unit.
string
Description of the item that appears on sales forms such as invoices. This helps customers understand what they are purchasing.
number
Current quantity on hand for this inventory item. REQUIRED if TrackQtyOnHand is true. Must be a non-negative number.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version.
number
Cost to purchase this item from vendors. This is the default purchase cost per unit.
string
Description of the item for purchase forms. This is the description used when purchasing the item from vendors.
string
Date when inventory tracking begins for this item. Format: YYYY-MM-DD. REQUIRED if TrackQtyOnHand is true.
object
Reference to another entity.
boolean
Whether quantity on hand is tracked for this item. If true, you must provide QtyOnHand and InvStartDate. Applicable for Inventory items.
object
Reference to another entity.
object
Reference to another entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_JOURNAL_ENTRYTool to create a new journal entry in QuickBooks Online. Use when you need to make adjusting or correcting entries that directly affect account balances. Journal entries require at least two lines with total debits equaling total credits.

Input Parameters

array
required
List of journal entry lines. Each journal entry must have at least two lines, and the total debits must equal the total credits. Typically includes at least one debit line and one credit line with matching amounts.
string
Transaction date for the journal entry in YYYY-MM-DD format. If not provided, the current date is used.
string
Reference number for the journal entry. Maximum 21 characters.
boolean
Indicates if this is an adjustment journal entry. Set to true for adjusting entries.
object
Reference to an entity.
string
Private note about the journal entry. Maximum 4000 characters.
number
Exchange rate for multi-currency journal entries.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_PAYMENTCreates a payment record in QuickBooks Online. The Payment entity records payment from customers against single or multiple invoices and credit memos. Use this action when recording customer payments, whether full payment of an invoice or partial payment across multiple invoices.

Input Parameters

array
required
List of payment line items specifying which invoices or credit memos the payment is applied to. Each line item must contain Amount and LinkedTxn fields. Example: [{‘Amount’: 50.0, ‘LinkedTxn’: [{‘TxnId’: ‘11’, ‘TxnType’: ‘Invoice’}]}]
string
Date of the payment transaction in YYYY-MM-DD format (e.g., ‘2024-01-15’). If not specified, the current date is used.
number
required
Total amount of the payment. This should equal the sum of all Line item amounts. Must be a positive number (e.g., 50.0, 100.0).
string
required
ID of the customer making the payment. This is the unique identifier for the customer in QuickBooks (e.g., ‘3’, ‘58’). Use QUICKBOOKS_CREATE_CUSTOMER or QUICKBOOKS_READ_CUSTOMER to get valid customer IDs.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version.
string
Private note about the payment. Not visible to the customer. Maximum 4000 characters.
string
Name of the customer. Optional field that helps with readability but not required by the API.
number
Exchange rate for the transaction when using multi-currency. Applicable only if multi-currency is enabled. Optional field.
string
Reference number for the payment, such as a check number or transaction ID. Optional field.
boolean
Indicates whether the payment should be processed through QuickBooks Payments. Set to true to process the payment, false otherwise. Optional field.
string
ID of the accounts receivable account. Optional field. Use QuickBooks query API to get valid AR account IDs.
string
Currency code for multi-currency environments (e.g., ‘USD’, ‘CAD’, ‘EUR’). Required if the company file uses multi-currency. Optional otherwise.
object
Credit card payment details when payment method is credit card.
string
ID of the payment method used (e.g., ‘1’ for Cash, ‘2’ for Check). Optional field. Use QuickBooks query API to get valid payment method IDs.
string
ID of the asset account where this payment should be deposited. Optional field. If not provided, uses the default Undeposited Funds account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_PURCHASETool to create a new purchase transaction in QuickBooks Online. A purchase represents an expense such as a cash payment, check, or credit card purchase. Use when recording business expenses or making payments to vendors.

Input Parameters

array
required
List of line items for the purchase. At least one line item is required. Each line must have an Amount and DetailType with corresponding detail object.
string
Date of the transaction in YYYY-MM-DD format (e.g., ‘2024-08-23’). If not provided, uses the current date.
number
Total amount of the purchase including all line items. If not provided, QuickBooks will calculate it from the line items. Should match the sum of all line amounts.
string
Reference number for the purchase (e.g., check number). Maximum 21 characters.
object
Reference to an entity (vendor, customer, employee).
object
required
Reference to the account from which the payment is made (e.g., {‘value’: ‘19’} for a checking account or {‘value’: ‘42’} for a credit card account).
object
Reference to a currency.
string ("Cash" | "Check" | "CreditCard")
required
Payment method used for this purchase. Choose ‘Cash’, ‘Check’, or ‘CreditCard’.
string
Private note about the purchase, visible only to company users. Maximum 4000 characters.
number
Exchange rate for multi-currency transactions. Required if CurrencyRef is different from home currency.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). If not specified, uses the default API version from headers.
object
Reference to an account.
object
Reference to an entity (vendor, customer, employee).
string
Method used to apply tax on the transaction. Valid values: ‘TaxExcluded’, ‘TaxInclusive’, ‘NotApplicable’.
string
The location type of the transaction. Used for international tax calculations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_PURCHASE_ORDERCreate a new QuickBooks purchase order for a vendor to deliver goods or services.

Input Parameters

string
Free On Board shipping terms indicating point of transfer of ownership.
string
Memo or note about the purchase order visible on reports and to the vendor.
array
required
List of line items for the purchase order. Each line must have an ‘amount’ (number), ‘detail_type’ (‘ItemBasedExpenseLineDetail’ or ‘AccountBasedExpenseLineDetail’), and corresponding detail object. For item-based lines, include ‘item_based_expense_line_detail’ with an ‘item_ref’. For account-based lines, include ‘account_based_expense_line_detail’ with an ‘account_ref’.
string
Date when payment for the purchase order is due in YYYY-MM-DD format.
object
Email address structure.
string
Transaction date of the purchase order in YYYY-MM-DD format. Defaults to the current date if not provided.
object
Reference to another entity.
object
Physical address structure.
number
required
Total amount of the purchase order. Should equal the sum of all line amounts.
string
required
ID of the vendor for this purchase order. Use QUICKBOOKS_CREATE_VENDOR or QUICKBOOKS_READ_VENDOR to get valid vendor IDs.
string
Reference number for the purchase order. If not provided, QuickBooks will auto-generate it.
object
Physical address structure.
object
Reference to another entity.
array
Custom fields for the purchase order.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default API version.
string
Private note about the purchase order, not visible to the vendor.
object
Reference to another entity.
string
required
ID of the Accounts Payable account to use for this purchase order. This is typically the main AP account in your chart of accounts.
number
Currency exchange rate for multi-currency transactions.
string
Expected delivery date for products in YYYY-MM-DD format.
object
Reference to another entity.
object
Reference to another entity.
object
Transaction tax detail information including TxnTaxCodeRef and TaxLine.
object
Reference to another entity.
string
Method in which tax is applied. Valid values: ‘TaxExcluded’, ‘TaxInclusive’, ‘NotApplicable’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_REFUND_RECEIPTTool to create a new refund receipt in QuickBooks Online. Use when a customer receives a refund for returned goods or services.

Input Parameters

array
required
List of line items for the refund receipt. At least one line item is required. Each line must specify Amount, DetailType, and relevant detail information.
string
Transaction date in YYYY-MM-DD format. If not provided, the current date is used.
string
Reference number for the refund receipt. Maximum 21 characters.
object
Reference to the currency.
array
List of custom fields for the refund receipt.
object
required
Reference to the customer receiving the refund. Required.
string
Internal note about the refund receipt, not visible to customer.
number
Exchange rate for multi-currency transactions.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default API version.
string
Reference number for the payment (e.g., check number, transaction ID).
object
required
Reference to the asset account where the refund is deposited. Required for the refund receipt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_SALES_RECEIPTTool to create a new sales receipt in QuickBooks Online. Use when recording a sale where the customer pays immediately (cash, check, credit card).

Input Parameters

array
required
Array of line items for the sales receipt. At least one line item is required.
string
Transaction date in YYYY-MM-DD format. Defaults to current date if not provided.
object
Physical address structure.
object
Generic reference type for various entities.
object
Physical address structure.
string
Date when goods or services are scheduled for delivery in YYYY-MM-DD format.
object
Email address structure.
string
Reference number for the sales receipt (maximum 21 characters).
object
Reference to currency.
array
Array of custom fields for the sales receipt.
object
required
Reference to the customer receiving the sales receipt. Required field.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default API version.
string
Private note about the sales receipt, not visible to the customer.
string
Shipping tracking number provided by the shipping provider.
object
Email address structure.
object
Customer memo for the sales receipt.
number
Exchange rate for currency conversion.
object
Email address structure.
object
Generic reference type for various entities.
object
Generic reference type for various entities.
string
Reference number for the payment (e.g., check number, transaction ID).
object
Generic reference type for various entities.
object
Reference to the payment method (e.g., {‘value’: ‘1’}). Use to specify how the customer paid.
object
Reference to the deposit account.
string
Method in which tax is applied. Allowed values: TaxExcluded, TaxInclusive, NotApplicable.
boolean
Whether to apply tax after discount. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_TAX_AGENCYCreate a new tax agency in QuickBooks Online. Use when you need to set up a new tax authority or agency for tax reporting purposes.

Input Parameters

string
required
The name of the tax agency as displayed in QuickBooks. Must be unique.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_TAXSERVICE_TAXCODECreate a new tax code with associated tax rates using the TaxService endpoint. Use when you need to set up new tax codes for sales or purchase transactions with specific tax rates.

Input Parameters

string
required
The unique identifier for the tax code being created. Must be unique within the QuickBooks company.
array
required
List of tax rate details to associate with this tax code. At least one tax rate detail is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_TIME_ACTIVITYCreate a new time activity record in QuickBooks Online. TimeActivity tracks employee or vendor time worked on jobs or projects. Use when recording billable or non-billable hours for employees or vendors.

Input Parameters

integer
Number of hours worked. Alternative to using start_time and end_time. Use with minutes field to specify duration.
integer
Number of minutes worked (0-59). Use with hours field to specify duration as an alternative to start_time and end_time.
string ("Employee" | "Vendor")
required
Specifies the type of entity: ‘Employee’ for employee time tracking, or ‘Vendor’ for vendor/contractor time tracking.
boolean
Whether the time activity is taxable. Set to true if subject to sales tax.
string
End time of the time activity in ISO 8601 format with timezone (e.g., ‘2026-02-23T17:00:00+00:00’). Required unless using hours and minutes fields.
object
Reference to another entity.
string
Transaction date for the time activity in YYYY-MM-DD format (e.g., ‘2026-02-23’). If not provided, current date is used.
object
Reference to another entity.
string
Start time of the time activity in ISO 8601 format with timezone (e.g., ‘2026-02-23T09:00:00+00:00’). Required unless using hours and minutes fields.
object
Reference to another entity.
integer
Number of break hours to subtract from the time activity duration.
string
Description of work completed during this time activity.
number
Hourly billing rate for this time activity. If not provided, uses the default rate from the employee/vendor record.
object
Reference to another entity.
object
Reference to another entity.
integer
Number of break minutes (0-59) to subtract from the time activity duration.
object
Reference to another entity.
string ("Billable" | "NotBillable" | "HasBeenBilled")
Billable status of the time activity.
object
Reference to another entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_VENDORCreate a new vendor in QuickBooks with the given details.

Input Parameters

object
Phone number input for vendor creation.
string
GST Identification Number (applicable for Indian vendors).
string
Additional notes or comments about the vendor.
string
Title of the person (max 16 characters - keep it short like ‘Mr.’, ‘Dr.’, ‘CEO’). This tag supports i18n, all locales. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, Suffix, or FullyQualifiedName attributes are required during create.
boolean
Indicates whether the vendor is currently active. Set to False to make inactive.
object
Phone number input for vendor creation.
string
Suffix of the name. For example, Jr. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
number
Opening balance amount for this vendor. Use with open_balance_date.
string
Account number assigned to this vendor for tracking purposes.
object
Reference type input for entity references.
object
Website address input for vendor creation.
object
Physical address input for vendor creation.
number
Standard billing rate for the vendor (per hour or unit).
object
Physical address input for vendor creation.
string
Given name or first name of a person. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
object
Reference type input for entity references.
string
Family name or the last name of the person. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
string
Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create.
string
Country for tax purposes (e.g., ‘US’, ‘CA’, ‘IN’).
boolean
Indicates if Tax Deducted at Source (TDS) is enabled (India).
boolean
Indicates whether the vendor is eligible for 1099 tax reporting (US tax purposes).
string
The name of the company associated with the vendor. Useful when creating organizational vendors.
string
Primary contact person’s name at the vendor.
number
Maximum credit amount extended to the vendor.
object
Reference type input for entity references.
string
The name as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: Title, GivenName, MiddleName, FamilyName, and Suffix.
boolean
Canadian T4A tax form eligibility status.
object
Phone number input for vendor creation.
object
Reference type input for entity references.
boolean
Canadian T5018 tax form eligibility status.
string
Tax identification number for the vendor (EIN or SSN).
object
Phone number input for vendor creation.
string
Business registration number or tax identification number.
string
Alternate contact person’s name at the vendor.
string
Date of the opening balance in YYYY-MM-DD format.
object
Email address input for vendor creation.
integer
TDS entity type classification identifier (India).
string
The name of the vendor as it should be printed on checks. If not provided, uses DisplayName.
string
Tax reporting methodology (e.g., ‘Cash’, ‘Accrual’).
integer
TDS section type categorization identifier (India).
object
Reference type input for entity references.
string
GST registration type (applicable for Indian vendors, e.g., ‘Regular’, ‘Composition’).
string
Effective date for the tax identification number in YYYY-MM-DD format.
boolean
Whether to override the standard TDS threshold limits (India).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CREATE_VENDOR_CREDITTool to create a new vendor credit in QuickBooks Online. Use when recording a credit from a vendor that reduces what you owe.

Input Parameters

array
required
List of line items for the vendor credit. At least one line item is required. Each line must specify DetailType, Amount, and AccountBasedExpenseLineDetail.
string
Memo for the vendor credit that appears on reports.
string
Date of the transaction in YYYY-MM-DD format. Defaults to the current date if not provided.
string
Reference number for the vendor credit (e.g., credit memo number from vendor).
object
required
Reference to the vendor from whom the credit is received. Required field.
object
Reference to the currency. Format: {‘value’: ‘USD’}.
string
User-entered private note about the vendor credit.
object
Reference to the Accounts Payable account. Format: {‘value’: ‘account_id’}. If not specified, uses the default AP account.
number
Currency exchange rate for multi-currency transactions.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default version.
object
Reference to the department. Format: {‘value’: ‘department_id’}.
string
Method in which tax is applied. Valid values: TaxExcluded, TaxInclusive, NotApplicable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CUSTOMER_BALANCE_DETAILGenerate a customer balance detail report in QuickBooks, optionally filtered to one or more customer IDs.

Input Parameters

string ("All" | "Paid" | "Unpaid")
Status of the balance.
string
Column types to be shown in the report. Supported Values: bill_addr, create_by, create_date, cust_bill_email, cust_comp_name, cust_msg, cust_phone_other, cust_tel, cust_name, deliv_addr, doc_num*, due_date*, last_mod_by, last_mod_date, memo*, sale_sent_state, ship_addr, ship_date, ship_via, term_name, tracking_num, tx_date*, txn_type*. Additional columns with custom fields enabled: sales_cust1, sales_cust2, sales_cust3. Additional columns with location tracking enabled: dept_name*
string
Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. Supported Values: Name of custom field.
string
Filter by the shipping method as stored in Invoice.ShipMethodRef.Name.
string
The column type used in sorting report rows. Specify a column type as defined with the columns query parameter.
array
One or more comma separated term IDs. Filters report contents based on term or terms supplied.
string ("ascend" | "descend")
The sort order.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
string
Start date to use for the report, in the format YYYY-MM-DD.
string ("Report_Date" | "Current")
The date upon which aging is determined.
array
One or more comma separated customer IDs. Filters report contents to include information for specified customers.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_CUSTOMER_BALANCE_REPORTGenerate a customer balance report in QuickBooks showing outstanding balances for customers. Can filter by specific customers, date ranges, payment status, and accounting method. Returns a hierarchical report with customer names, IDs, and their current balance amounts.

Input Parameters

string
Specifies whether Quick Zoom URL information should be generated for rows in the report.
string ("All" | "Paid" | "Unpaid")
Filter by payment status. ‘All’ includes all balances, ‘Paid’ shows only paid invoices, ‘Unpaid’ shows only outstanding balances. If not specified, defaults to showing all.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
List of customer IDs to filter the report. If not provided, the report includes all customers. Each ID should be the Customer.Id value from the Customer object (e.g., [‘1’, ‘2’, ‘10’]).
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_DELETE_BANK_ACCOUNTDelete a bank account on file for a customer in QuickBooks Payments. When the API returns 204, the tool returns a success confirmation with the customer and bank account IDs.

Input Parameters

string
UUID for idempotency to prevent duplicate requests. If not provided, one will be generated automatically.
string
required
The customer ID for whom the bank account is being deleted (can be a test ID like ‘test-customer-id’)
string
required
The bank account ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_DELETE_ITEMDelete an item in QuickBooks Online by marking it as inactive (soft delete). Items cannot be permanently deleted if they have been used in transactions. Use this action when removing items from active catalogs while preserving historical transaction data. The item will be hidden from dropdowns but remain accessible in historical records. This action is irreversible through the API — the item can only be reactivated manually through the QuickBooks UI or by using an update action.

Input Parameters

string
required
Unique identifier of the item to delete. This is the Id field from the item object.
string
required
Version number of the entity for optimistic locking. This is the SyncToken field from the item object. Use QUICKBOOKS_GET_ITEM to retrieve the current SyncToken before deletion.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_EXECUTE_BATCH_OPERATIONExecute multiple QuickBooks operations in a single request. Operations are performed serially. Supports create, update, delete, and query operations on QuickBooks entities. Use this action to reduce network latency when performing multiple operations. Each operation is executed in order, and each response is correlated to its request via the bId field. Maximum 30 operations per batch. Ideal for bulk data operations or related entity updates.

Input Parameters

integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version from metadata.
array
required
List of batch item requests to execute. Each item can be a create, update, delete, or query operation. Operations are performed serially in the order provided. Maximum 30 items per batch request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_AGED_RECEIVABLES_REPORTGenerate an aged receivables report showing outstanding customer balances by age. Use when tracking overdue invoices and managing accounts receivable aging.

Input Parameters

string ("All" | "Paid" | "Unpaid")
Filters customers by payment status. Use ‘All’ for all customers, ‘Paid’ for customers with fully paid balances, or ‘Unpaid’ for customers with outstanding balances. Default is ‘Unpaid’.
string
Predefined date macro like ‘Today’, ‘This Month’, etc. Alternative to report_date for specifying the report date using a macro.
integer
Number of aging periods to display in the report. Must be between 1 and 10. Defaults to 4 if not specified. Each period shows receivables within that age range.
string
Date for the aged receivables report in YYYY-MM-DD format. Defaults to today if not provided. This is the as-of date for calculating aging.
string ("Report_Date" | "Current")
Method for calculating aging. ‘Report_Date’ calculates aging from the report date, ‘Current’ calculates aging from the current date. Defaults to ‘Report_Date’ if not specified.
integer
Number of days per aging period. Must be at least 1. Defaults to 30 days if not specified. For example, with 30 days you get periods like 0-30, 31-60, etc.
array
One or more comma-separated customer IDs to filter the report. Filters report contents to include information for specified customers only. Provide customer IDs as returned in the Customer.Id attribute.
string
API minor version number. Optional - defaults to x-minor-version header if not provided. Use this to access features from specific minor versions of the QuickBooks API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_ATTACHABLETool to read details of a specific attachable by ID in QuickBooks Online. Attachables represent file attachments linked to entities like invoices, customers, or bills.

Input Parameters

integer
API minor version to use for the request. If not provided, uses the version from metadata headers.
string
required
ID of the attachable (file attachment) to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_BALANCE_SHEET_REPORTGenerate a Balance Sheet report showing company assets, liabilities, and equity at a point in time. Use when you need to understand the financial position with what the company owns versus what it owes.

Input Parameters

string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_BANK_ACCOUNTTool to retrieve a specific bank account by ID from QuickBooks Payments API. Use when you need to get details about a specific payment method for a customer.

Input Parameters

string
required
The customer ID who owns the bank account
string
required
The unique identifier of the bank account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_BILLTool to fetch a QuickBooks bill by ID. Use when needing to retrieve bill details including vendor reference, line items, amounts, and payment status.

Input Parameters

string
required
ID of the bill to retrieve from QuickBooks
integer
API minor version to use for the request (e.g., 65, 70, 75). If not specified, uses the default from headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_BILL_PAYMENTTool to retrieve details of a specific bill payment by ID in QuickBooks Online. Use when you need to view information about an existing bill payment.

Input Parameters

integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default from headers.
string
required
ID of the bill payment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_CHANGED_ENTITIESTool to retrieve entities that changed since a specified timestamp using QuickBooks Change Data Capture (CDC) API. Use when you need to sync or refresh local data periodically by fetching only entities modified within the last 30 days. Returns full entity payloads (not just changed attributes) grouped by entity type with up to 1000 entities per response.

Input Parameters

string
required
Comma-separated list of entity types to query for changes. Valid entity types include: Account, Bill, BillPayment, Budget, Class, CreditMemo, Customer, Department, Deposit, Employee, Estimate, Invoice, Item, JournalEntry, Payment, PaymentMethod, Purchase, PurchaseOrder, RefundReceipt, SalesReceipt, TaxCode, TaxRate, Term, TimeActivity, Transfer, Vendor, VendorCredit. Example: ‘Customer,Invoice’ or ‘Bill,Payment,Vendor’.
string
required
ISO 8601 timestamp indicating the starting point for change tracking. Returns entities modified after this timestamp. Maximum lookback period is 30 days. Format: YYYY-MM-DDTHH:MM:SSZ (UTC timezone recommended). Example: ‘2026-02-16T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_COMPANY_INFORead company information from QuickBooks Online, including company name, addresses, and fiscal year settings.

Input Parameters

integer
API minor version to use for the request. If not provided, uses the version from metadata headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_CREDIT_MEMOFetch a QuickBooks credit memo by ID, including available metadata, customer information, line items, and remaining credit amount.

Input Parameters

integer
API minor version to use for the request
string
required
ID of the credit memo to read

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_CREDIT_MEMO_PDFTool to download a QuickBooks credit memo as a PDF file. Use when you need to retrieve the printable PDF version of a credit memo.

Input Parameters

string
API minor version to use for the request (e.g., ‘70’, ‘75’). If not specified, uses the default API version.
string
required
The ID of the credit memo to retrieve as PDF (e.g., ‘14’, ‘123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_DEPARTMENTRead details of a specific department by ID in QuickBooks Online. Use when you need to retrieve information about a department.

Input Parameters

string
required
The ID of the department to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_DEPOSITRead a specific QuickBooks Online deposit by ID, including available line items, amounts, and metadata.

Input Parameters

string
required
ID of the deposit to retrieve. Use QUICKBOOKS_QUERY_DEPOSIT to find deposit IDs.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). If not specified, uses the default API version from headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_ESTIMATETool to fetch a QuickBooks estimate by ID. Use when needing full estimate details including metadata, line items, and sync token.

Input Parameters

string
required
ID of the estimate to read from QuickBooks
integer
API minor version to use for the request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_ESTIMATE_PDFTool to download a QuickBooks estimate as a PDF file. Use when you need to retrieve the printable PDF version of an estimate.

Input Parameters

string
required
The ID of the estimate to retrieve as PDF (e.g., ‘19’, ‘123’).
string
API minor version to use for the request (e.g., ‘65’, ‘75’). If not specified, uses the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_EXCHANGE_RATETool to get exchange rate for a specific currency code and date in QuickBooks Online. Use when needing to retrieve the current or historical exchange rate between a foreign currency and the company’s home currency.

Input Parameters

string
required
The date for which to get the exchange rate, in YYYY-MM-DD format (e.g., 2024-01-15).
integer
API minor version to use for the request. If not provided, uses the version from metadata headers.
string
required
The source currency code for which to get the exchange rate (e.g., EUR, GBP, JPY).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_GENERAL_LEDGER_REPORTGenerate a General Ledger report showing all transactions with debits, credits, and running balances. Use when you need a detailed view of all accounting transactions posted to each account.

Input Parameters

string
Column types to show in the report. Comma-separated list of column names (e.g., ‘tx_date,txn_type,doc_num,name,memo,account,debit,credit,balance’).
string
The column type on which to base sorting (e.g., ‘tx_date’, ‘account’, ‘txn_type’). Default is ‘txn_type’ if not specified.
string
End date for the report period in YYYY-MM-DD format.
array
List of class IDs to filter the report. If not provided, the report includes all classes. Each ID should be the Class.Id value (e.g., [‘1’, ‘2’]).
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order for rows (ascending or descending). Default is ascending.
string
Start date for the report period in YYYY-MM-DD format.
array
List of vendor IDs to filter the report. If not provided, the report includes all vendors. Each ID should be the Vendor.Id value (e.g., [‘1’, ‘3’]).
array
List of account IDs to filter the report. If not provided, the report includes all accounts. Each ID should be the Account.Id value from the Account object (e.g., [‘1’, ‘35’, ‘82’]).
string
Account type from which to include transactions (e.g., ‘Bank’, ‘Expense’, ‘Income’).
array
List of customer IDs to filter the report. If not provided, the report includes all customers. Each ID should be the Customer.Id value (e.g., [‘1’, ‘5’]).
array
List of department IDs to filter the report. If not provided, the report includes all departments. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report (Cash or Accrual).
array
List of source account IDs to filter the report. Each ID should be the Account.Id value for the source account.
string
Source account type for transaction filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_INVENTORY_VALUATION_SUMMARYGenerate an Inventory Valuation Summary report showing inventory quantities and their current values. Use when you need to understand inventory asset values, track stock levels, or analyze inventory costs by item.

Input Parameters

string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_INVOICE_PDFTool to download a QuickBooks invoice as a PDF file. Use when you need to retrieve the printable PDF version of an invoice.

Input Parameters

string
required
The ID of the invoice to retrieve as PDF (e.g., ‘17’, ‘123’).
string
API minor version to use for the request (e.g., ‘70’, ‘75’). If not specified, uses the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_ITEMTool to retrieve a specific item by its ID from QuickBooks Online. Use when you need full details of a product or service item.

Input Parameters

string
required
Unique identifier of the item to retrieve from QuickBooks.
integer
QuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_JOURNAL_ENTRYTool to read details of a specific QuickBooks journal entry by ID. Use when you need complete journal entry information including transaction date, line items, posting types, and account references.

Input Parameters

integer
API minor version number (e.g., 75)
string
required
The ID of the journal entry to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PAYMENTTool to fetch details of a specific payment by ID in QuickBooks Online. Use when needing payment information including customer, amounts, and linked transactions.

Input Parameters

string
required
ID of the payment to retrieve
integer
API minor version to use for the request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PAYMENT_METHODRead details of a specific payment method by ID in QuickBooks Online. Use when you need to retrieve information about a payment method entity.

Input Parameters

string
required
ID of the payment method to be read

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PAYMENT_PDFTool to download a QuickBooks payment record as a PDF file. Use when you need to retrieve the printable PDF version of a payment.

Input Parameters

string
required
The ID of the payment record to retrieve as PDF (e.g., ‘18’, ‘123’).
string
API minor version to use for the request (e.g., ‘70’, ‘75’). If not specified, uses the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PREFERENCESTool to read company preferences that control application behavior in QuickBooks Online. Use when needing to retrieve accounting settings, sales form configurations, tax preferences, time tracking settings, or other company-wide preference data.

Input Parameters

integer
API minor version to use for the request. If not provided, uses the version from metadata headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PROFIT_AND_LOSS_DETAIL_REPORTGenerate a detailed Profit and Loss report showing company income and expenses with transaction-level details. Use when you need to analyze profitability with individual transaction details, customer/vendor breakdowns, and account-level activity.

Input Parameters

string
Report end date in YYYY-MM-DD format. If not provided, defaults to today’s date.
array
List of class IDs to filter the report. If not provided, the report includes all classes. Each ID should be the Class.Id value from the Class object (e.g., [‘1’, ‘3’]).
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Report start date in YYYY-MM-DD format. If not provided, defaults to the start of the current fiscal year.
array
List of vendor IDs to filter the report. If not provided, the report includes all vendors. Each ID should be the Vendor.Id value from the Vendor object (e.g., [‘1’, ‘5’, ‘20’]).
string
Start date to use for the report, in the format YYYY-MM-DD.
array
List of customer IDs to filter the report. If not provided, the report includes all customers. Each ID should be the Customer.Id value from the Customer object (e.g., [‘1’, ‘2’, ‘10’]).
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PROFIT_AND_LOSS_REPORTGenerate a Profit and Loss report showing company income and expenses over a period. Use when you need to analyze profitability, revenue, costs, and net income for a specific date range.

Input Parameters

string
Report end date in YYYY-MM-DD format. If not provided, defaults to today’s date.
array
List of class IDs to filter the report. If not provided, the report includes all classes. Each ID should be the Class.Id value from the Class object (e.g., [‘1’, ‘3’]).
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Report start date in YYYY-MM-DD format. If not provided, defaults to the start of the current fiscal year.
array
List of vendor IDs to filter the report. If not provided, the report includes all vendors. Each ID should be the Vendor.Id value from the Vendor object (e.g., [‘1’, ‘5’, ‘20’]).
string
Start date to use for the report, in the format YYYY-MM-DD.
array
List of customer IDs to filter the report. If not provided, the report includes all customers. Each ID should be the Customer.Id value from the Customer object (e.g., [‘1’, ‘2’, ‘10’]).
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PURCHASETool to fetch details of a specific purchase by ID in QuickBooks Online. Use when you need to retrieve complete purchase information including line items, payment details, and metadata.

Input Parameters

string
required
ID of the purchase to retrieve
integer
API minor version to use for the request. If not provided, uses the version from metadata headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PURCHASE_ORDERTool to fetch a QuickBooks purchase order by ID. Use when needing full purchase order details including line items, vendor information, and metadata.

Input Parameters

integer
API minor version to use for the request
string
required
ID of the purchase order to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_PURCHASE_ORDER_PDFTool to download a QuickBooks purchase order as a PDF file. Use when you need to retrieve the printable PDF version of a purchase order.

Input Parameters

string
API minor version to use for the request (e.g., ‘70’, ‘75’). If not specified, uses the default API version.
string
required
The ID of the purchase order to retrieve as PDF (e.g., ‘25’, ‘123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REFUND_RECEIPTTool to fetch a QuickBooks refund receipt by ID. Use when needing details of a specific refund issued to a customer.

Input Parameters

integer
API minor version to use for the request
string
required
ID of the refund receipt to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REFUND_RECEIPT_PDFTool to download a QuickBooks refund receipt as a PDF file. Use when you need to retrieve the printable PDF version of a refund receipt.

Input Parameters

string
API minor version to use for the request (e.g., ‘70’, ‘75’). If not specified, uses the default API version.
string
required
The ID of the refund receipt to retrieve as PDF (e.g., ‘22’, ‘123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_ACCOUNT_LISTRetrieve the AccountList report from QuickBooks showing a list of all accounts. This report displays all account details including name, type, and balance information.

Input Parameters

string
Comma-separated list of column names to include in the report. Valid column names: ‘account_name’, ‘account_type’, ‘detail_acc_type’, ‘account_desc’, ‘account_bal’. If not specified, all columns are included. Example: ‘account_name,account_type,account_bal’
string
The sort order for the accounts. Valid values: ‘ascend’ (ascending, A-Z) or ‘descend’ (descending, Z-A). If not specified, accounts are returned in their default order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_AGED_PAYABLE_DETAILGenerate an aged payable detail report showing aging detail for accounts payable. Use when you need to analyze outstanding vendor bills grouped by aging periods.

Input Parameters

string ("All" | "Paid" | "Unpaid")
Status of the payable balance.
string
Column types to be shown in the report. Supported Values: bill_addr, create_by, create_date, vend_bill_email, vend_comp_name, vend_phone_other, vend_tel, vend_name, doc_num*, due_date*, last_mod_by, last_mod_date, memo*, term_name, tx_date*, txn_type*. Additional columns with custom fields enabled: purch_vend1, purch_vend2, purch_vend3. Additional columns with location tracking enabled: dept_name*
string
The column type used in sorting report rows. Specify a column type as defined with the columns query parameter.
array
One or more comma separated term IDs. Filters report contents based on term or terms supplied.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range for the report. Examples: ‘Today’, ‘This Month’, ‘Last Month’, ‘This Fiscal Quarter’, etc.
string ("ascend" | "descend")
The sort order.
array
One or more comma separated vendor IDs. Filters report contents to include information for specified vendors.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
integer
Number of aging periods to display in the report. Each period represents a time bucket for aging calculations (e.g., 0-30 days, 31-60 days).
string
Start date to use for the report, in the format YYYY-MM-DD.
string ("Report_Date" | "Current")
The date upon which aging is determined.
integer
Number of days per aging period. Default is typically 30 days. For example, setting this to 30 creates buckets like 0-30, 31-60, 61-90 days.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range for filtering by due date. Examples: ‘Today’, ‘This Month’, ‘Last Month’, ‘This Fiscal Quarter’, etc.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report. Supported values: Cash, Accrual.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_AGED_PAYABLESRetrieve an Aged Payables aging summary report from QuickBooks showing outstanding vendor balances grouped by age. Shows amounts owed to vendors categorized by aging periods (e.g., current, 1-30 days, 31-60 days overdue).

Input Parameters

string ("All" | "Paid" | "Unpaid")
Filters vendors by payment status. Use ‘All’ for all vendors, ‘Paid’ for vendors with fully paid balances, or ‘Unpaid’ for vendors with outstanding balances. Default is ‘Unpaid’.
string
Predefined date macro like ‘Today’, ‘This Month’, etc. Alternative to report_date for specifying the report date using a macro.
array
Filters report contents to include information for specified vendors. Provide one or more comma-separated vendor IDs as returned in the Vendor.Id attribute.
integer
Number of aging periods to display in the report. Must be between 1 and 10. Defaults to 4 if not specified. Each period shows payables within that age range.
string
Date for the aged payables report in YYYY-MM-DD format. Defaults to today if not provided. This is the as-of date for calculating aging.
string ("Report_Date" | "Current")
Method for calculating aging. ‘Report_Date’ calculates aging from the report date, ‘Current’ calculates aging from the current date. Defaults to ‘Report_Date’ if not specified.
integer
Number of days per aging period. Must be at least 1. Defaults to 30 days if not specified. For example, with 30 days you get periods like 0-30, 31-60, etc.
string
API minor version number. Optional - defaults to x-minor-version header if not provided. Use this to access features from specific minor versions of the QuickBooks API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_AGED_RECEIVABLE_DETAILGenerate an aged receivable detail report showing aging detail for accounts receivable. Use when you need to analyze outstanding customer invoices grouped by aging periods.

Input Parameters

string ("All" | "Paid" | "Unpaid")
Status of the receivable balance.
string
Column types to be shown in the report. Supported Values: bill_addr, create_by, create_date, cust_bill_email, cust_comp_name, cust_msg, cust_phone_other, cust_tel, cust_name, deliv_addr, doc_num*, due_date*, last_mod_by, last_mod_date, memo*, sale_sent_state, ship_addr, ship_date, ship_via, term_name, tracking_num, tx_date*, txn_type*. Additional columns with custom fields enabled: sales_cust1, sales_cust2, sales_cust3. Additional columns with location tracking enabled: dept_name*
string
Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. Supported Values: Name of custom field.
string
Filter by the shipping method as stored in Invoice.ShipMethodRef.Name.
string
The column type used in sorting report rows. Specify a column type as defined with the columns query parameter.
array
One or more comma separated term IDs. Filters report contents based on term or terms supplied.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use report_date to specify an explicit report date.
string ("ascend" | "descend")
The sort order.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
integer
Number of aging periods to display in the report. Each period represents a time bucket for aging calculations (e.g., 0-30 days, 31-60 days).
string
Start date to use for the report, in the format YYYY-MM-DD.
string ("Report_Date" | "Current")
The date upon which aging is determined.
integer
Number of days per aging period. Default is typically 30 days. For example, setting this to 30 creates buckets like 0-30, 31-60, 61-90 days.
array
One or more comma separated customer IDs. Filters report contents to include information for specified customers.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range of due dates for receivables to include in the report; otherwise, use the start_duedate and end_duedate to cover an explicit report date range.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_CASH_FLOWGenerate a cash flow report in QuickBooks showing cash inflows and outflows categorized by operating, investing, and financing activities. Use when you need to analyze cash movement and liquidity over a specified period.

Input Parameters

string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_CLASS_SALESGenerate a ClassSales report in QuickBooks showing sales amounts grouped by class. Use when you need to analyze sales performance by class tracking categories.

Input Parameters

array
One or more comma separated class IDs to filter the report. If not provided, the report includes all classes. Each ID should be the Class.Id value from the Class object.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_CUSTOMER_INCOMEGenerate a customer income report in QuickBooks showing revenue by customer. Use when you need to analyze income generated from each customer over a specified period.

Input Parameters

string
Report end date in YYYY-MM-DD format. Use together with start_date to specify a custom date range.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Report start date in YYYY-MM-DD format. Use together with end_date to specify a custom date range.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
List of customer IDs to filter the report. If not provided, the report includes all customers. Each ID should be the Customer.Id value from the Customer object (e.g., [‘1’, ‘2’, ‘10’]).
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_CUSTOMER_SALESGenerate a customer sales report in QuickBooks showing sales transactions and totals for customers. Can filter by specific customers, date ranges, and accounting method. Returns a hierarchical report with customer names, IDs, and their sales amounts.

Input Parameters

string
Report end date in YYYY-MM-DD format. Use together with start_date to specify a custom date range.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Report start date in YYYY-MM-DD format. Use together with end_date to specify a custom date range.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
List of customer IDs to filter the report. If not provided, the report includes all customers. Each ID should be the Customer.Id value from the Customer object (e.g., [‘1’, ‘2’, ‘10’]).
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_DEPARTMENT_SALESGenerate a department sales report in QuickBooks showing sales data broken down by department. Use when you need to analyze sales performance across different departments within a date range. Note: Department tracking must be enabled in the QuickBooks company file for this report to return data.

Input Parameters

string
End date for the report period in YYYY-MM-DD format. Use this with start_date to specify a custom date range, or use date_macro for predefined ranges.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range for the report (e.g., ‘This Month’, ‘Last Quarter’). Use this as an alternative to specifying start_date and end_date explicitly.
string ("ascend" | "descend")
The sort order for the report results (ascend or descend).
string
Start date for the report period in YYYY-MM-DD format. Use this with end_date to specify a custom date range, or use date_macro for predefined ranges.
array
List of department IDs to filter the report. Filters report contents to include information for specified departments if configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report (Cash or Accrual).
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results (e.g., Total, Month, Quarter).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_ITEM_SALESGenerate an ItemSales report showing sales data for products and services. Use when you need to analyze sales performance by item including quantity sold, revenue, COGS, and gross margin.

Input Parameters

array
List of item IDs to filter the report. If not provided, the report includes all items. Each ID should be the Item.Id value from the Item object (e.g., [‘1’, ‘2’, ‘10’]).
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORTSRetrieve QuickBooks reports such as TransactionList, BalanceSheet, ProfitAndLoss, and others. Use when you need to access standardized financial or transaction reports with flexible filtering options.

Input Parameters

string
Vendor ID or comma-separated list of vendor IDs to filter the report. Only transactions related to these vendors will be included. Use Vendor.Id value from the Vendor object.
string
Filter for transaction cleared status. Options: ‘All’, ‘Cleared’, ‘Uncleared’, ‘Reconciled’. Note that ‘cleared’ can only be used as a filter parameter, not as a column in the result.
string
Comma-separated list of column types to include in the report. For example: ‘tx_date,txn_type,doc_num,name,memo,account,amount’. If not specified, the report uses default columns.
string
Column type to use for sorting report rows. Common values include ‘tx_date’, ‘txn_type’, ‘amount’, etc. Must be a column that exists in the report.
string
Customer ID or comma-separated list of customer IDs to filter the report. Only transactions related to these customers will be included. Use Customer.Id value from the Customer object.
string
Report end date in YYYY-MM-DD format. Used to filter transactions or data up to this date. If not provided, the report uses its default end date or date_macro setting.
string
Column type to use for grouping report rows. Common values include ‘Customer’, ‘Vendor’, ‘Account’, etc. Groups transactions by the specified entity type.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Report start date in YYYY-MM-DD format. Used to filter transactions or data from this date onwards. If not provided, the report uses its default start date or date_macro setting.
string
Start date to use for the report, in the format YYYY-MM-DD.
string
required
The name of the report to retrieve. For example: ‘TransactionList’, ‘BalanceSheet’, ‘ProfitAndLoss’, ‘CashFlow’, etc. This is the report type identifier used in the QuickBooks API endpoint.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_REPORT_TRIAL_BALANCEGenerate a Trial Balance report showing account debits, credits, and balances for a specified period. Use when you need to verify that total debits equal total credits across all accounts for accounting reconciliation.

Input Parameters

string
Report end date in YYYY-MM-DD format. If not provided, defaults to today’s date.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
string
Report start date in YYYY-MM-DD format. If not provided, defaults to the start of the current fiscal year.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_SALES_RECEIPTTool to fetch a QuickBooks sales receipt by ID. Use when needing full sales receipt details including customer info, line items, payment details, and metadata.

Input Parameters

integer
API minor version to use for the request
string
required
ID of the sales receipt to read from QuickBooks

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_SALESRECEIPT_PDFTool to download a QuickBooks sales receipt as a PDF file. Use when you need to retrieve the printable PDF version of a sales receipt.

Input Parameters

string
API minor version to use for the request (e.g., ‘70’, ‘75’). If not specified, uses the default API version.
string
required
The ID of the sales receipt to retrieve as PDF (e.g., ‘31’, ‘123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_TAX_RATETool to read details of a specific tax rate by ID in QuickBooks Online. Use when you need to retrieve information about a tax rate.

Input Parameters

string
required
The ID of the tax rate to retrieve.
integer
API minor version to use for the request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_TERMRead details of a specific payment term by ID in QuickBooks Online. Terms define payment conditions like Net 30 or Due on Receipt.

Input Parameters

string
required
The ID of the payment term to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_TIME_ACTIVITYRead a specific QuickBooks Online time activity by ID. The response can include employee or vendor references, hours worked, billing rate and associated customer.

Input Parameters

integer
Optional API minor version parameter to use for the request
string
required
The unique identifier of the time activity to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_TRANSACTION_LIST_REPORTGet the Transaction List report showing all transactions in the company. Use when you need a comprehensive view of all transactions with flexible filtering by date, customer, vendor, account, or other criteria.

Input Parameters

string
Filter for transaction cleared status. Options: ‘All’, ‘Cleared’, ‘Uncleared’, ‘Reconciled’. Note that ‘cleared’ can only be used as a filter parameter, not as a column in the result.
string
Comma-separated list of columns to include in the report. Supports both user-friendly names and QuickBooks API identifiers: date/tx_date (Date), transaction_type/txn_type (Transaction Type), number/num/doc_num (Number), name (Name), memo/description (Memo/Description), account/account_name (Account), amount/subt_nat_amount (Amount), net_amount (Net Amount), split (Split), balance (Balance), customer (Customer), vendor (Vendor), employee (Employee), product_service (Product/Service), quantity (Quantity), rate (Rate), class (Class), department/dept (Department), location (Location). If not specified, report uses default columns.
string
Column to sort report rows by. Supports both user-friendly names (date, transaction_type, amount, account, etc.) and QuickBooks API identifiers (tx_date, txn_type, subt_nat_amount, account_name, etc.). Must be a column that exists in the report.
string
Report end date in YYYY-MM-DD format. Used to filter transactions up to this date. If not provided, the report uses its default end date or date_macro setting.
string
Column type to use for grouping report rows. Common values include ‘Customer’, ‘Vendor’, ‘Account’, etc. Groups transactions by the specified entity type.
array
List of class IDs to filter the report. If not provided, the report includes all classes. Each ID should be the Class.Id value (e.g., [‘1’, ‘2’]).
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range for the report. Use if you want the report to cover a standard report date range; otherwise, use start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order for rows (ascending or descending). Default is ascending.
string
Report start date in YYYY-MM-DD format. Used to filter transactions from this date onwards. If not provided, the report uses its default start date or date_macro setting.
array
List of vendor IDs to filter the report. If not provided, the report includes all vendors. Each ID should be the Vendor.Id value from the Vendor object (e.g., [‘5’, ‘8’, ‘12’]).
array
List of account IDs to filter the report. If not provided, the report includes all accounts. Each ID should be the Account.Id value from the Account object (e.g., [‘1’, ‘35’, ‘82’]).
array
List of customer IDs to filter the report. If not provided, the report includes all customers. Each ID should be the Customer.Id value from the Customer object (e.g., [‘1’, ‘2’, ‘10’]).
array
List of department IDs to filter the report. If not provided, the report includes all departments. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report (Cash or Accrual).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_TRANSFERTool to fetch a QuickBooks transfer by ID. Use when needing to retrieve transfer details including from/to account references and transfer amount.

Input Parameters

string
required
ID of the transfer to retrieve from QuickBooks
integer
API minor version to use for the request (e.g., 65, 70, 75). If not specified, uses the default from headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_VENDOR_CREDITTool 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.

Input Parameters

integer
API minor version to use for the request (e.g., 65, 70, 75). If not specified, uses the default from headers.
string
required
ID of the vendor credit to retrieve from QuickBooks

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_GET_VENDOR_EXPENSES_REPORTRetrieve a vendor expenses report from QuickBooks showing expense transactions by vendor. This report displays the total expenses incurred for each vendor, providing a detailed view of vendor-related spending. Filter by specific vendors, date ranges, payment status, and customize with various grouping and sorting options.

Input Parameters

string
Specifies whether Quick Zoom URL information should be generated for rows in the report.
string ("All" | "Paid" | "Unpaid")
Filters vendors by payment status. Use ‘All’ for all vendors, ‘Paid’ for vendors with fully paid balances, or ‘Unpaid’ for vendors with outstanding balances.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
array
Filters report contents to include information for specified vendors. Supported Values: One or more comma separated vendor IDs as returned in the attribute, Vendor.Id, of the Vendor object response code.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_LIST_CARDSList payment cards on file for a customer in QuickBooks Payments. A 404 response is returned as an empty card list, so an empty list can also mean the customer was not found.

Input Parameters

string
required
The QuickBooks Payments V4IDPseudonym identifier for the customer. This is different from the QuickBooks Online customer ID - use the V4IDPseudonym field from the customer object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_LIST_DEPARTMENTSQuery Department entities in QuickBooks using SQL-like syntax. Use when you need to list departments or filter departments by criteria like active status, name patterns, or parent relationships. Supports WHERE clauses, pattern matching (LIKE with %), ORDERBY, and pagination.

Input Parameters

string
SQL-like query string to filter and retrieve Department entities ONLY. IMPORTANT: This tool queries the Department entity exclusively - do NOT use it to query other entities. For querying other entity types, use their respective query tools. Query syntax: SELECT [fields] FROM Department [WHERE conditions] [ORDERBY field] [STARTPOSITION n] [MAXRESULTS n] NOTE: QuickBooks API returns ALL fields with values regardless of SELECT clause - field projections are not supported. You can write ‘SELECT Id, Name’ but the API will return all available fields anyway. Commonly queryable Department fields: Id, Name, Active, FullyQualifiedName, SubDepartment, ParentRef, SyncToken. Supports: - WHERE clauses with operators (=, <, >, <=, >=, IN) - LIKE operator with % wildcard - Boolean operators (AND, OR) - ORDERBY for sorting - Pagination with MAXRESULTS (max 1000, default 100) and STARTPOSITION - Aggregate functions (COUNT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_LIST_INVOICESList invoices through the QuickBooks Query endpoint with pagination and selectable fields. By default, the query selects only the invoice ID, sync token, document number, total, balance, and transaction date.

Input Parameters

array
List of fields to select in the query. Defaults to [‘Id’,‘SyncToken’,‘DocNumber’,‘TotalAmt’,‘Balance’,‘TxnDate’].
integer
Maximum number of records to return; default 50, max 1000.
integer
Starting position for pagination within the result set. Default is 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_ACCOUNTQuery Account entities in QuickBooks using SQL-like syntax. IMPORTANT: Queries the Account entity ONLY (chart of accounts). For other entities (Purchase, Invoice, Bill, Payment, etc.), use their respective query actions. NOTE: API returns ALL fields with values regardless of SELECT clause (projections not supported). CRITICAL RESTRICTIONS: Parentheses and OR operator are NOT supported. Use IN operator for multiple values: WHERE AccountType IN (‘Bank’, ‘Credit Card’) Supports: WHERE clauses (=, <, >, LIKE, IN), AND operator, pattern matching (%), ORDER BY, pagination (MAXRESULTS up to 1000, STARTPOSITION), COUNT. Common fields: Id, Name, AccountType, AccountSubType, Classification, Active, FullyQualifiedName, CurrentBalance, AcctNum, Description, SubAccount. Examples: - SELECT * FROM Account WHERE AccountType = ‘Expense’ MAXRESULTS 100 - SELECT * FROM Account WHERE Active = true ORDER BY Name - SELECT * FROM Account WHERE AccountType IN (‘Bank’, ‘Credit Card’)

Input Parameters

string
required
SQL-like query string to filter and retrieve Account entities ONLY. Do NOT use for other entities (Purchase, Invoice, Bill, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Account [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE Active = true AND AccountType IN (‘Bank’, ‘Credit Card’) NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, Name, AccountType, AccountSubType, Classification, Active, FullyQualifiedName, CurrentBalance, AcctNum, Description, SubAccount. Supports: - WHERE with operators (=, <, >, <=, >=, IN) - LIKE with % wildcard - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’). Sortable fields: Name, Id. Non-sortable: AccountType, AccountSubType, Classification, and others. - MAXRESULTS (max 1000, default 100) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_ACCOUNTSQuery Account entities in QuickBooks using SQL-like syntax. Use this action when you need to retrieve multiple accounts from the chart of accounts with filtering, sorting, or pagination. IMPORTANT: Queries the Account entity ONLY (chart of accounts). For other entities (Purchase, Invoice, Bill, Payment, etc.), use their respective query actions. NOTE: API returns ALL fields with values regardless of SELECT clause (projections not supported). CRITICAL RESTRICTIONS: Parentheses and OR operator are NOT supported. Use IN operator for multiple values: WHERE AccountType IN (‘Bank’, ‘Credit Card’). Supports: WHERE clauses (=, <, >, LIKE, IN), AND operator, pattern matching (%), ORDER BY, pagination (MAXRESULTS up to 1000, STARTPOSITION), COUNT.

Input Parameters

string
required
SQL-like query string to filter and retrieve Account entities ONLY. Do NOT use for other entities (Purchase, Invoice, Bill, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Account [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE Active = true AND AccountType IN (‘Bank’, ‘Credit Card’) NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, Name, AccountType, AccountSubType, Classification, Active, FullyQualifiedName, CurrentBalance, AcctNum, Description, SubAccount. Supports: - WHERE with operators (=, <, >, <=, >=, IN) - LIKE with % wildcard - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’). Sortable fields: Name, Id. Non-sortable: AccountType, AccountSubType, Classification, and others. - MAXRESULTS (max 1000, default 100) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_ATTACHABLEQuery Attachable entities in QuickBooks using SQL-like syntax. Use when you need to retrieve multiple attachables or search for specific file attachments.

Input Parameters

string
SQL-like query string to filter and retrieve Attachable entities ONLY. IMPORTANT: This tool queries the Attachable entity exclusively - do NOT use it to query other entities like Purchase, Invoice, Bill, Payment, etc. For querying other entity types, use their respective query tools. Query syntax: SELECT [fields] FROM Attachable [WHERE conditions] [ORDERBY field] [STARTPOSITION n] [MAXRESULTS n] NOTE: QuickBooks API returns ALL fields with values regardless of SELECT clause - field projections are not supported. You can write ‘SELECT Id, FileName’ but the API will return all available fields anyway. Commonly queryable Attachable fields: Id, FileName, Note, Category, ContentType, Size, FileAccessUri, TempDownloadUri. Supports: - WHERE clauses with operators (=, <, >, <=, >=, IN) - LIKE operator with % wildcard - Boolean operators (AND, OR) - ORDERBY for sorting - Pagination with MAXRESULTS (max 1000, default 100) and STARTPOSITION - Aggregate functions (COUNT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_BILLSQuery Bill entities in QuickBooks using SQL-like syntax. Returns bills with vendor information, line items, amounts, due dates, and payment status. Use this action when you need to search or filter bills by criteria such as vendor, date range, balance, or total amount. IMPORTANT: Queries the Bill entity ONLY (vendor bills/payables). For other entities (Invoice, Payment, Account, etc.), use their respective query actions. NOTE: API returns ALL fields with values regardless of SELECT clause (projections not supported). CRITICAL RESTRICTIONS: Parentheses and OR operator are NOT supported. Use IN operator for multiple values: WHERE VendorRef IN (‘1’, ‘2’, ‘3’) Common queryable fields: Id, TxnDate, DueDate, VendorRef, TotalAmt, Balance, DocNumber. NON-QUERYABLE fields: PrivateNote, AccountRef, CurrencyRef, DepartmentRef, ClassRef.

Input Parameters

string
required
SQL-like query string to filter and retrieve Bill entities ONLY. Do NOT use for other entities (Invoice, Payment, Account, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Bill [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE TxnDate >= ‘2024-01-01’ AND VendorRef = ‘123’ NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, TxnDate, DueDate, VendorRef, TotalAmt, Balance, DocNumber, PaymentType. NON-QUERYABLE fields (will cause QueryValidationError): PrivateNote, AccountRef, CurrencyRef, DepartmentRef, ClassRef, Line[].ItemRef. Supports: - WHERE with operators (=, <, >, <=, >=, !=, IN) - LIKE with % wildcard - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’) - MAXRESULTS (max 1000, default 100) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_CUSTOMERSQuery Customer entities in QuickBooks using SQL-like syntax. Use this action when you need to find customers by name, email, balance, active status, or other criteria with pagination support. IMPORTANT: Queries the Customer entity ONLY. For other entities use their respective query actions. CRITICAL RESTRICTIONS: Parentheses and OR operator are NOT supported. Use IN for multiple values. Supports: WHERE (=, <, >, LIKE, IN), AND, pattern matching (%), ORDER BY, pagination (MAXRESULTS up to 1000), COUNT.

Input Parameters

string
required
SQL-like query string to filter and retrieve Customer entities ONLY. Do NOT use for other entities (Invoice, Bill, Payment, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Customer [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE Active = true AND DisplayName IN (‘Customer A’, ‘Customer B’) NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, DisplayName, CompanyName, FamilyName, GivenName, FullyQualifiedName, Active, Balance, PrimaryEmailAddr. Supports: - WHERE with operators (=, <, >, <=, >=, IN) - LIKE with % wildcard - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’). Sortable fields: DisplayName, FamilyName, GivenName, Id. - MAXRESULTS (max 1000, default 25) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_ENTITIESExecute SQL-like queries on QuickBooks Online entities. Supports all entity types (Customer, Invoice, Bill, Payment, Purchase, Account, etc.) with WHERE clauses, pattern matching, ordering, and pagination. IMPORTANT: Many fields are NOT queryable in WHERE clauses including PrivateNote, AccountRef, CurrencyRef, DepartmentRef, ClassRef, etc. Use queryable fields like Id, TxnDate, PaymentType, DisplayName instead. For non-queryable field filtering, query by date range and filter client-side. See parameter description for full list of queryable vs non-queryable fields. Use entity-specific query tools when available for typed responses.

Input Parameters

string
required
SQL-like query string to retrieve data from QuickBooks Online entities. Generic query tool supporting all entity types: Customer, Invoice, Bill, Payment, Purchase, Account, Vendor, Employee, Item, and more. Query syntax: SELECT [fields] FROM [EntityName] [WHERE conditions] [ORDERBY field] [STARTPOSITION n] [MAXRESULTS n] NOTE: QuickBooks API returns ALL fields regardless of SELECT clause - field projections are not supported. Supported operators: = < > <= >= != LIKE (% wildcard) IN AND ORDERBY MAXRESULTS (max 1000, default 100) STARTPOSITION COUNT. CRITICAL: OR operator is NOT supported for most QuickBooks entities (including Item, Account, and many others). If you attempt to use OR in a query, the API will return a QueryParserError. Use IN operator instead for matching multiple specific values (e.g., ‘WHERE Id IN (“1”, “2”, “3”)’ instead of ‘WHERE Id = “1” OR Id = “2”’). For pattern matching across multiple terms with LIKE (e.g., finding items containing ‘Larkspur’ in FullyQualifiedName OR Description), query without the WHERE clause or with a broader filter, then filter results client-side. CRITICAL QUERY FIELD RESTRICTIONS: Top-level entity references like CustomerRef, VendorRef are queryable on transactions (e.g., ‘SELECT * FROM Invoice WHERE CustomerRef = “123”’). NON-QUERYABLE fields: PrivateNote, AccountRef, CurrencyRef, DepartmentRef, ClassRef on any entity; nested references like Line[].ItemRef. Using these in WHERE causes QueryValidationError. WORKAROUND: Query by date range and filter results client-side, or use entity-specific GET actions. Purchase entity queryable fields: Id, TxnDate, PaymentType, DocNumber, TotalAmt, PrintStatus. NOT queryable: AccountRef, CurrencyRef, DepartmentRef, ClassRef, PrivateNote. These lists are common examples, not exhaustive. Consult the QuickBooks API documentation or test incrementally to discover all queryable fields. Reference fields are generally NOT queryable unless explicitly documented. IMPORTANT: Use entity-specific query tools when available (e.g., QueryAccount for Account entities) as they provide typed responses. This generic tool returns untyped data and should be used only when no specific query tool exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_ESTIMATESQuery Estimate entities in QuickBooks using SQL-like syntax. Returns estimates matching specified criteria such as status, customer, date range, or amount. Use this action when you need to search for, filter, or list QuickBooks estimates based on specific conditions. The query syntax supports WHERE clauses, pattern matching with LIKE, ordering, and pagination. IMPORTANT: Queries the Estimate entity ONLY. For other entities (Invoice, Bill, Payment, Account, etc.), use their respective query actions. NOTE: API returns ALL fields with values regardless of SELECT clause (field projections not supported). CRITICAL RESTRICTIONS: Parentheses and OR operator are NOT supported. Use IN operator for multiple values: WHERE CustomerRef IN (‘1’, ‘2’) Common queryable fields: Id, TxnDate, TotalAmt, CustomerRef, DocNumber, TxnStatus, ExpirationDate, EmailStatus, PrintStatus. NON-QUERYABLE fields: PrivateNote, DepartmentRef, ClassRef, CurrencyRef cause QueryValidationError.

Input Parameters

string
required
SQL-like query string to filter and retrieve Estimate entities ONLY. Do NOT use for other entities (Invoice, Bill, Payment, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Estimate [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE TxnStatus = ‘Pending’ AND CustomerRef IN (‘1’, ‘2’) NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, TxnDate, TotalAmt, CustomerRef (top-level reference on Estimate is queryable), DocNumber, TxnStatus, ExpirationDate, EmailStatus, PrintStatus. NON-QUERYABLE fields: PrivateNote, DepartmentRef, ClassRef, CurrencyRef, and most nested reference fields. Using these in WHERE causes QueryValidationError. Supports: - WHERE with operators (=, <, >, <=, >=, IN) - LIKE with % wildcard - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’) - MAXRESULTS (max 1000, default 100) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_INVOICESQuery QuickBooks invoices with custom SQL-like filters or customer, transaction-date and payment-status filters, with pagination. A custom query replaces the convenience filters; the overdue status filter checks only for a positive balance, so add a due-date condition to identify overdue invoices.

Input Parameters

string
SQL-like query string to filter invoices. If not provided, returns all invoices. Supports QuickBooks Query Language syntax: WHERE, ORDERBY, operators (=, <, >, <=, >=, !=, LIKE, IN, AND). Common queryable fields: Id, TxnDate, DueDate, DocNumber, TotalAmt, Balance, CustomerRef, PrintStatus, EmailStatus. IMPORTANT: OR operator is NOT supported. Use IN for multiple values. Non-queryable fields include: PrivateNote, AccountRef, CurrencyRef, DepartmentRef, ClassRef. Example: “WHERE TxnDate >= ‘2024-01-01’ AND TotalAmt > ‘1000’ ORDERBY TxnDate DESC”
string
Filter by invoice payment status. Common values: ‘Paid’ (Balance = 0), ‘Unpaid’ (Balance > 0), ‘Overdue’ (Balance > 0 AND DueDate < today). This is a convenience filter that will be translated to appropriate query conditions.
string
Filter invoices created on or before this date in YYYY-MM-DD format. Adds ‘TxnDate <= end_date’ to query.
string
Filter invoices created on or after this date in YYYY-MM-DD format. Adds ‘TxnDate >= start_date’ to query.
string
Filter invoices by customer ID. Convenience parameter that adds ‘WHERE CustomerRef = customer_id’ to the query.
integer
Maximum number of invoices to return. Default is 25, maximum is 1000.
integer
Starting position for pagination. Default is 1 (first record).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_ITEMSQuery Item entities in QuickBooks using SQL-like syntax. Use this action to search, filter, and retrieve products and services from the QuickBooks catalog. IMPORTANT: Queries Item entity ONLY. For other entities use their respective query actions. Parentheses and OR operator NOT supported - use IN instead. Reference fields NOT queryable - filter client-side if needed.

Input Parameters

string
required
SQL-like query string to filter and retrieve Item entities ONLY. Do NOT use for other entities (Customer, Invoice, Bill, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Item [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE Active = true AND Type IN (‘Service’, ‘Inventory’) NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, Name, Type, Active, Sku, Description, FullyQualifiedName, UnitPrice, PurchaseCost, QtyOnHand. NON-QUERYABLE fields: IncomeAccountRef, ExpenseAccountRef, AssetAccountRef, ParentRef, ClassRef. Using these in WHERE causes QueryValidationError. Supports: - WHERE with operators (=, <, >, <=, >=, IN) - LIKE with % wildcard - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’). Sortable fields: Name, Id. Non-sortable: Type and most other fields. - MAXRESULTS (max 1000, default 100) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_PAYMENTSQuery Payment entities in QuickBooks using SQL-like syntax. Use when searching, filtering, or listing payments by date, customer, amount, or other attributes. For a single payment by ID, use GetPayment instead.

Input Parameters

string
required
SQL-like query string to filter and retrieve Payment entities ONLY. Do NOT use for other entities (Invoice, Bill, Customer, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Payment [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE TxnDate >= ‘2024-01-01’ AND CustomerRef = ‘123’ NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, TxnDate, CustomerRef, PaymentMethodRef, PaymentRefNum. Supports: - WHERE with operators (=, <, >, <=, >=, IN) - LIKE with % wildcard for text fields - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’). Sortable fields: Id, TxnDate. - MAXRESULTS (max 1000, default 100) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_QUERY_VENDORSQuery Vendor entities in QuickBooks using SQL-like syntax. Returns vendors matching the specified criteria with full details. Use this action when you need to search, filter, or list vendors based on conditions such as active status, display name, balance, or 1099 eligibility. Supports pagination for large result sets. IMPORTANT: Queries the Vendor entity ONLY. For other entities use their respective query actions. Parentheses and OR operator are NOT supported - use IN operator instead.

Input Parameters

string
required
SQL-like query string to filter and retrieve Vendor entities ONLY. Do NOT use for other entities (Purchase, Invoice, Bill, etc.) - use their respective query tools. Query syntax: SELECT [fields] FROM Vendor [WHERE conditions] [ORDER BY field] [STARTPOSITION n] [MAXRESULTS n] CRITICAL SYNTAX RESTRICTIONS: - Parentheses for grouping are NOT supported - OR operator is NOT supported - use IN instead - Use: WHERE Active = true AND DisplayName LIKE ‘%Smith%’ NOTE: QuickBooks API returns ALL fields regardless of SELECT clause. Commonly queryable fields: Id, DisplayName, CompanyName, GivenName, FamilyName, Active, Balance, PrimaryEmailAddr, PrintOnCheckName, AcctNum, Vendor1099. Supports: - WHERE with operators (=, <, >, <=, >=, IN) - LIKE with % wildcard - AND only (no OR - use IN for multiple values) - ORDER BY for sorting (MUST be two words, not ‘ORDERBY’). Sortable fields: DisplayName, Id, CompanyName, Balance. - MAXRESULTS (max 1000, default 100) and STARTPOSITION - COUNT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_READ_ACCOUNTRead an account in QuickBooks with the given account ID.

Input Parameters

string
required
ID of the account to be read

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_READ_CLASSRead details of a specific class by ID in QuickBooks Online. Classes allow categorization of transactions.

Input Parameters

string
required
ID of the class to be read
integer
API minor version to use for the request. If not provided, uses the version from metadata headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_READ_CUSTOMERRead a customer in QuickBooks with the given customer ID.

Input Parameters

string
required
ID of the customer to be read Must be the QuickBooks-assigned numeric system ID, not a customer display name or free-text identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_READ_EMPLOYEERead an employee’s details in QuickBooks with the given employee ID.

Input Parameters

string
required
The ID of the employee to be read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_READ_INVOICETool to fetch a QuickBooks invoice by ID or the most recent if no ID provided. Use when needing full invoice details including metadata and sync token.

Input Parameters

string
ID of the invoice to read; if not provided, fetches the latest invoice
integer
API minor version to use for the request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_READ_VENDORRead a vendor in QuickBooks with the given vendor ID.

Input Parameters

string
required
ID of the vendor to be read

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_SEND_CREDIT_MEMOTool to send a credit memo to a specified email address. Use when you need to email a credit memo to a customer.

Input Parameters

string
Optional email address to send the credit memo to. If not provided, sends to the customer’s default email.
integer
QuickBooks API minor version number (e.g., 65, 70, 75). If not specified, uses the default version from headers.
string
required
The ID of the credit memo to send

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_ATTACHABLETool to update an existing attachable in QuickBooks Online. Use when you need to modify attachable properties like note text or entity references. Requires the attachable Id and current SyncToken for optimistic locking.

Input Parameters

string
required
The ID of the attachable to update.
string
Latitude coordinate where the file was created.
string
Tag string for the attachable.
string
Longitude coordinate where the file was created.
string
Note text for the attachable.
string
Category of the attachable (e.g., Image, Document, Sound, Receipt, Other, etc.).
string
Name of the place where the file was created.
string
required
The current SyncToken value for optimistic locking. Must match the latest value from QuickBooks.
array
Array of references to entities this attachable is linked to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_COMPANY_INFOTool to update company information in QuickBooks Online. Use when you need to update company details like name, address, or contact information. Requires Id and SyncToken from a previous read operation.

Input Parameters

string
required
Unique identifier for the company info object. Typically ‘1’ for the company record.
object
Email address structure.
string
Country where the company is registered (e.g., US, CA, UK).
object
Website address structure.
Company address structure for update requests.
Legal name of the company.
array
List of name-value pairs containing additional company attributes.
string
required
Version number for optimistic locking. Must match current value to prevent concurrent update conflicts.
object
required
Company address object. Required for updates and must include PostalCode.
string
Name of the company. Optional for partial updates.
object
Telephone number structure.
string
Date when the company started business, in YYYY-MM-DD format.
string
Comma-separated list of languages supported by the company.
string
Starting month of the company’s fiscal year (e.g., January, February).
object
Company address structure for update requests.
object
Email address structure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_DEPARTMENTTool to update an existing department in QuickBooks Online. Use when you need to modify department details. Requires the department Id and current SyncToken to prevent concurrent update conflicts.

Input Parameters

string
required
The unique identifier of the department to update. Required for update operations.
string
required
Updated name of the department. Maximum length is 100 characters.
boolean
Whether the department is active. Inactive departments may be hidden from most display purposes.
boolean
Set to true to perform a partial update (only specified fields are updated). Defaults to true for update operations.
object
Reference to the parent department if this is a sub-department. Contains ‘value’ (ID) and optionally ‘name’.
string
required
Version token for optimistic locking, obtained from a prior GET request. Prevents concurrent update conflicts.
boolean
Whether this department is a sub-department. If true, ParentRef should be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_FULL_INVOICETool to fully replace an Invoice. Use when you need to update all aspects of an existing invoice in a single operation.

Input Parameters

object
required
Full Invoice JSON payload to update; must include Id and SyncToken. Any writable field omitted will be cleared. Do not set sparse=true.
string
Optional idempotency key (<=50 chars) to prevent duplicate writes on retries.
integer
Optional QuickBooks API minorversion to access newer fields (e.g., 63).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_PAYMENT_METHODUpdate an existing QuickBooks Online payment method using its ID, current SyncToken, and name. The request is a full update; active defaults to true if omitted, and the type can also be supplied.

Input Parameters

string
required
Unique identifier of the payment method to update. Required for updates.
string
required
User-recognizable name for the payment method (e.g., ‘Business Check’, ‘Cash’, ‘Credit Card’). Maximum length is 31 characters.
string
Type of payment method. Valid values: ‘CREDIT_CARD’, ‘NON_CREDIT_CARD’. If not specified, defaults to ‘NON_CREDIT_CARD’.
boolean
Whether the payment method is active. Default is true.
string
required
Version number for optimistic locking. Must match the current version in QuickBooks to prevent conflicts. Required for updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_PREFERENCESUpdate company preferences in QuickBooks Online. Requires Id and SyncToken from a previous read. Use sparse=true for partial updates (only specified fields are changed) or sparse=false/omitted for full replacement.

Input Parameters

string
required
ID of the preferences object, typically ‘1’ for company preferences.
boolean
Set to true for sparse (partial) update, updating only provided fields. Set to false or omit for full update.
object
Tax preferences.
string
required
Version number for optimistic locking. Required to prevent concurrent update conflicts.
object
Other miscellaneous preferences.
object
Report preferences.
integer
QuickBooks API minor version to use (e.g., 65, 70, 75). Uses default if not specified.
object
Currency preferences.
object
Sales forms preferences.
object
Time tracking preferences.
object
Email message preferences for various transaction types.
object
Accounting information preferences.
object
Product and services preferences.
object
Vendor and purchases preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_SPARSE_INVOICEUpdate an existing QuickBooks invoice using its ID, SyncToken and supplied fields. The sparse flag defaults to true; keep it true to request a partial update without overwriting other data.

Input Parameters

object
required
Invoice object containing Id, SyncToken, sparse flag, and fields to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_TERMUpdate an existing QuickBooks Online payment term, including its name, status, type or payment conditions. Requires the term ID, current SyncToken, name and type; the request is a full update.

Input Parameters

string
required
Unique identifier of the payment term to update. Required for updates.
string
required
User-recognizable name for the payment term (e.g., ‘Net 30’, ‘Due on receipt’). Maximum length 31 characters.
string
required
Type of the sales term. Valid values: ‘STANDARD’ (if dueDays is not null) or ‘DATEDRIVEN’ (if dueDays is null).
boolean
Whether the payment term is active. Default is true.
integer
Number of days until payment is due. If specified, Type should be ‘STANDARD’. Use 0 for ‘Due on receipt’.
string
required
Version number for optimistic locking. Must match the current version in QuickBooks to prevent conflicts. Required for updates.
integer
Number of days within which payment must be made to receive the discount. Used with discount_percent for early payment discounts.
integer
Specific day of the month when payment is due. Used for DATEDRIVEN type terms. Valid range: 1-31.
number
Discount percentage available if paid within the discount days. Valid range: 0 to 100.
integer
Number of days in the month before the due date shifts to the next month. Used for DATEDRIVEN type terms.
integer
Specific day of the month when discount is available. Used for DATEDRIVEN type terms. Valid range: 1-31.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_UPDATE_TRANSFERTool to update an existing transfer in QuickBooks Online. Use when you need to modify a transfer between accounts. Requires the transfer Id and current SyncToken to prevent concurrent update conflicts.

Input Parameters

string
required
The unique identifier of the transfer to update. Required for update operations.
string
required
The monetary amount to transfer between accounts. Specified as a string (e.g., ‘35.00’).
string
The date of the transfer transaction in YYYY-MM-DD format. Defaults to current date if not specified.
string
required
Version token for optimistic locking, obtained from a prior GET request. Prevents concurrent update conflicts.
object
Reference to a currency for multi-currency transactions.
string
Internal note about the transfer that is not visible to customers.
string
Exchange rate for multi-currency transactions. Default is 1 for home currency. Only applicable when using non-home currency.
object
required
Reference to the destination account to which funds are transferred.
object
Reference to a department for location tracking.
object
required
Reference to the source account from which funds are transferred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_VENDOR_BALANCE_DETAILRetrieve a QuickBooks vendor balance detail report, optionally filtered to one or more vendor IDs.

Input Parameters

string ("All" | "Paid" | "Unpaid")
Filter by payment status. Use ‘All’ for all balances, ‘Paid’ for fully paid balances, or ‘Unpaid’ for outstanding balances.
string
Column types to be shown in the report. Supported Values: bill_addr, create_by, create_date, vend_bill_email, vend_comp_name, vend_msg, vend_phone_other, vend_tel, vend_name, deliv_addr, doc_num*, due_date*, last_mod_by, last_mod_date, memo*, vendor_sent_state, ship_addr, ship_date, term_name, tracking_num, tx_date*, txn_type*. Additional columns with custom fields enabled: purchase_vend1, purchase_vend2, purchase_vend3. Additional columns with location tracking enabled: dept_name*
string
The column type used in sorting report rows. Specify a column type as defined with the columns query parameter.
array
One or more comma separated term IDs. Filters report contents based on term or terms supplied.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
array
One or more comma separated vendor IDs. Filters report contents to include information for specified vendors.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
integer
Number of aging periods to display in the report. Each period represents a time bucket for aging calculations (e.g., 0-30 days, 31-60 days).
string
Start date to use for the report, in the format YYYY-MM-DD.
string ("Report_Date" | "Current")
Method for calculating age of payables. ‘Report_Date’ calculates age based on the report date, while ‘Current’ calculates age based on the current date.
integer
Number of days per aging period. Default is typically 30 days. For example, setting this to 30 creates buckets like 0-30, 31-60, 61-90 days.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range of due dates for balances to include in the report; otherwise, use the start_duedate and end_duedate to cover an explicit report date range.
string
The range of dates over which receivables are due, in the format YYYY-MM-DD. start_duedate must be less than end_duedate. If not specified, all data is returned.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUICKBOOKS_VENDOR_BALANCE_REPORTRetrieve a QuickBooks vendor balance report summarizing accounts payable by vendor. Filter by vendor, payment status, report date or date macro, and customize column summarization and sort order.

Input Parameters

string
Specifies whether Quick Zoom URL information should be generated for rows in the report.
string ("All" | "Paid" | "Unpaid")
Filters vendors by payment status. Use ‘All’ for all vendors, ‘Paid’ for vendors with fully paid balances, or ‘Unpaid’ for vendors with outstanding balances.
string ("Today" | "Yesterday" | "This Week" | "Last Week" | "This Week-to-date" | "Last Week-to-date" | "Next Week" | "Next 4 Weeks" | "This Month" | "Last Month" | "This Month-to-date" | "Last Month-to-date" | "Next Month" | "This Fiscal Quarter" | "Last Fiscal Quarter" | "This Fiscal Quarter-to-date" | "Last Fiscal Quarter-to-date" | "Next Fiscal Quarter" | "This Fiscal Year" | "Last Fiscal Year" | "This Fiscal Year-to-date" | "Last Fiscal Year-to-date" | "Next Fiscal Year")
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the start_date and end_date to cover an explicit report date range.
string ("ascend" | "descend")
The sort order.
array
Filters report contents to include information for specified vendors. Supported Values: One or more comma separated vendor IDs as returned in the attribute, Vendor.Id, of the Vendor object response code.
string
Start date to use for the report, in the format YYYY-MM-DD.
array
One or more comma separated department IDs. Filters report contents to include information for specified departments if so configured in the company file.
string ("Cash" | "Accrual")
The accounting method used in the report.
string ("Total" | "Month" | "Week" | "Days" | "Quarter" | "Year" | "Customers" | "Vendors" | "Classes" | "Departments" | "Employees" | "ProductsAndServices")
The criteria by which to group the report results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not