Quickbooks API Integration Vol.1

These are the list of integration use cases supported by Knit for Quickbooks API as part of the ACCOUNTING category

Query Company Information

ID: atoms_quickbooks/get_companies_info.json
Operation: read
Entities:
Summary: The Query Company Information API allows users to retrieve detailed information about a company using a SQL-like query. The API requires the realm ID of the company as a path parameter and the query statement as a query parameter. The response includes comprehensive details about the company such as legal address, company name, supported languages, fiscal year start month, and metadata. The API returns the company information in a structured JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Department

ID: create_a_department
Operation: write
Entities: subdepartment, reference, department
Summary: This API is used to create a new department in the system. The request body must include the 'Name' of the department, which is a required field with a maximum of 100 characters. If the department is a sub-department, the 'ParentRef' object must be provided, which includes a required 'value' field for the ID of the parent department and an optional 'name' field. The API returns the newly created Department object, including details such as 'FullyQualifiedName', 'domain', 'Name', 'SyncToken', 'SubDepartment', 'sparse', 'Active', 'Id', and 'MetaData' with 'CreateTime'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a bill

ID: create_accounts_payable_invoice
Operation: write
Entities:
Summary: The 'Create a bill' API allows you to create a bill in QuickBooks by specifying the necessary details such as vendor reference and line items. The request body must include the 'VendorRef' and 'Line' objects, where 'VendorRef' contains the vendor ID and optionally the vendor name, and 'Line' contains details about each line item including 'DetailType', 'Amount', and 'AccountBasedExpenseLineDetail'. The response returns the created bill details including the bill ID, total amount, vendor reference, and line items with their respective details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a bill

ID: delete_accounts_payable_invoice
Operation: write
Entities:
Summary: This API operation deletes a specified bill object in QuickBooks Online. The request body must include the 'Id' and 'SyncToken' of the bill. The 'SyncToken' is used to ensure that only the latest version of the object is modified. Before deleting, any linked transactions must be unlinked. The response returns the status of the bill as 'Deleted', along with the domain and unique identifier of the bill, and a timestamp of the deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Read all taxclassifications

ID: get_all_taxclassifications
Operation: read
Entities: tax classification, noninventory, inventory
Summary: The 'Read all taxclassifications' API retrieves the details of all TaxClassification objects that have been previously created in a QuickBooks company. The API requires an OAuth 2.0 token for authorization and the realmID of the company as a path parameter. It returns a list of TaxClassification records, each containing details such as applicable types, code, description, level, parent reference, ID, and name.
Input Fields: Input Fields
Output Fields: Output Fields

Read a CompanyCurrency

ID: get_companycurrency_details
Operation: read
Entities: time, company currency, metadata
Summary: The 'Read a CompanyCurrency' API retrieves the details of a CompanyCurrency object that has been previously created. It requires the realmID and companycurrencyId as path parameters to identify the specific CompanyCurrency object. The request must include an Authorization header with a valid OAuth 2.0 token. The response returns the details of the CompanyCurrency object, including its sync token, domain, currency code, name, active status, ID, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Get a credit memo as PDF

ID: get_credit_memo_as_pdf
Operation: read
Entities: credit memo, company setting
Summary: This API retrieves a credit memo as a PDF file from QuickBooks. The request requires the realm ID of the company and the credit memo ID as path parameters. The response returns the credit memo formatted as a PDF file, adhering to the custom form styles set in the company settings. The content type for both the request and response is application/pdf.
Input Fields: Input Fields
Output Fields: Output Fields

Read a CreditCardPayment

ID: get_creditcardpayment_details
Operation: read
Entities: credit card payment, bank account, currency
Summary: The 'Read a CreditCardPayment' API retrieves the details of a CreditCardPayment object that has been previously created in QuickBooks. The API requires the realmID of the QuickBooks company and the creditcardpaymentId of the CreditCardPayment object as path parameters. The request must include an Authorization header with a valid OAuth 2.0 token. The response includes details such as the transaction date, amount, currency, and associated account references, along with metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Customer Balance Report

ID: get_customer_balance_report
Operation: read
Entities: report, customer, department
Summary: The 'Query a Customer Balance Report' API allows users to retrieve a report detailing customer balances. Users can customize the report by specifying various query parameters such as customer IDs, accounting method, date range, payment status, and more. The API returns a detailed report object that includes headers with report metadata, rows with customer balance data, and columns defining the data types. The report can be filtered and sorted based on the provided query parameters to meet specific reporting needs.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Customer Income Report

ID: get_customer_income_report
Operation: read
Entities: report, vendor, customer
Summary: The 'Query a Customer Income Report' API allows users to retrieve a detailed report of customer income for a specified company. The API endpoint requires the realmID as a path parameter and supports various optional query parameters to customize the report, such as customer IDs, accounting method, date range, and more. The response includes a detailed report object with headers, rows, and columns, providing insights into customer income, expenses, and net income. The report can be filtered and sorted based on different criteria, making it a versatile tool for financial analysis.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Customertype

ID: get_customertype_details
Operation: read
Entities: customertype, time, metadata
Summary: The 'Read a Customertype' API retrieves the details of a Customertype object from QuickBooks. It requires the realmID of the QuickBooks company and the ID of the Customertype object as path parameters. The request must include an OAuth 2.0 token for authorization and specify the media type as 'application/json'. The response includes the details of the Customertype object, such as its SyncToken, domain, name, active status, ID, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Download an attachment

ID: get_download_attachment
Operation: read
Entities: attachment, url, file
Summary: The 'Download an attachment' API retrieves a temporary download URL for a specified attachment ID (attachableId) from a read response. The URL is used by the application to download the file in a separate step. The URL is valid for 15 minutes, after which a new URL must be obtained. The API requires the realmID of the company and the attachableId of the attachment as path parameters. The request must include a 'Content-Type' header set to 'text/plain'. The response returns a temporary download URL in the body, which can be used to download the attachment.
Input Fields: Input Fields
Output Fields: Output Fields

Get an estimate as PDF

ID: get_estimate_as_pdf
Operation: read
Entities: estimate, company
Summary: The 'Get an estimate as PDF' API retrieves a specified estimate from QuickBooks Online and returns it as a PDF file. The PDF is formatted according to the custom form styles set in the company settings. The API requires the 'realmID' and 'estimateId' as path parameters to identify the company and the specific estimate. The request must include a 'Content-Type' header set to 'application/pdf'. The response will include a 'Content-Type' header indicating the content type as 'application/pdf' and the body will contain the PDF content of the estimate.
Input Fields: Input Fields
Output Fields: Output Fields

Get an exchangerate for an individual currency code

ID: get_exchangerate_for_individual_currency_code
Operation: read
Entities: effective date, currency code, exchange rate
Summary: This API retrieves the exchange rate for a specified currency code as of a given date. The request requires the 'realmID' as a path parameter and 'sourcecurrencycode' as a query parameter. The 'asofdate' query parameter is optional and defaults to today's date if not provided. The response includes the exchange rate details such as the source and target currency codes, the rate, and metadata including the last updated time.
Input Fields: Input Fields
Output Fields: Output Fields

Query Exchangerate Objects

ID: get_exchangerate_objects
Operation: read
Entities: exchangerate, currency, query
Summary: The Query Exchangerate Objects API allows users to query exchange rate objects from QuickBooks. The API requires a realm ID as a path parameter and a SQL-like query as a query parameter. The query can filter exchange rates based on source currency codes and dates. The response includes the queried exchange rates with details such as sync token, as-of date, source and target currency codes, rate, and metadata including the last updated time. The response also provides the start position, maximum results, and total count of the query results.
Input Fields: Input Fields
Output Fields: Output Fields

Read an Inventory Adjustment

ID: get_inventory_adjustment
Operation: read
Entities: account, inventory adjustment, item
Summary: The 'Read an Inventory Adjustment' API retrieves the details of a previously created inventory adjustment object. It requires the company ID and the inventory adjustment ID as path parameters. The API supports an optional query parameter for specifying the minor version. The response includes the full details of the inventory adjustment, such as document number, transaction date, adjustment account reference, line items, and metadata. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get an invoice as PDF

ID: get_invoice_as_pdf
Operation: read
Entities: invoice, company
Summary: The 'Get an invoice as PDF' API retrieves a specified invoice in PDF format from QuickBooks. The request requires the realmID and invoiceId as path parameters to identify the company and the specific invoice. The request header must include 'Content-Type: application/pdf'. The response returns the invoice formatted as a PDF file, adhering to the custom form styles set in the company settings. The response header will also indicate 'Content-Type: application/pdf'.
Input Fields: Input Fields
Output Fields: Output Fields

Get a list of changed entities

ID: get_list_of_changed_entities
Operation: read
Entities: Customer, Estimate
Summary: The 'Get a list of changed entities' API retrieves a list of entities that have changed since a specified date-time. The API requires the realmID of the company, a comma-separated list of entity names, and a date-time stamp within 30 days of today as query parameters. The response includes the changed entities with their IDs, status, domain, and metadata such as the last updated time. The API is accessed via a GET request to the QuickBooks API endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Get a payment as PDF

ID: get_payment_as_pdf
Operation: read
Entities: company setting, PDF file, payment
Summary: The 'Get a payment as PDF' API retrieves a specified payment as a PDF file. The request requires the 'realmID' and 'paymentId' as path parameters to identify the company and the specific payment. The request header must include 'Content-Type: application/pdf'. The response returns the payment in PDF format, adhering to custom form styles set in the company settings. The response header will also indicate 'Content-Type: application/pdf'.
Input Fields: Input Fields
Output Fields: Output Fields

Get a purchase order as PDF

ID: get_purchase_order_as_pdf
Operation: read
Entities: company setting, PDF file, purchase order
Summary: The 'Get a purchase order as PDF' API retrieves a specified purchase order from QuickBooks Online and returns it as a PDF file. The request requires the 'realmID' and 'purchaseorderId' as path parameters to identify the company and the specific purchase order. The request header must include 'Content-Type: application/pdf'. The response includes the PDF file content of the purchase order, formatted according to the company's custom form styles.
Input Fields: Input Fields
Output Fields: Output Fields

Query a bill

ID: get_query_a_bill
Operation: read
Entities: account, vendor, bill
Summary: The 'Query a bill' API allows users to execute a SQL-like query to retrieve bill information from a specified company realm in QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that contains the SQL-like statement. The request must include a 'Content-Type' header set to 'application/text'. The response includes a 'QueryResponse' object with details about the bills, such as 'startPosition', 'totalCount', and an array of 'Bill' objects. Each 'Bill' object contains information like 'SyncToken', 'VendorRef', 'TxnDate', 'TotalAmt', 'APAccountRef', 'Id', 'Line' items, 'Balance', 'DueDate', and 'MetaData'. The response also includes a 'time' field indicating when the response was generated.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Bill Payment

ID: get_query_a_bill_payment
Operation: read
Entities: vendor, bill payment, line
Summary: The 'Query a Bill Payment' API allows users to execute a SQL-like query to retrieve bill payment details from QuickBooks. The API requires the 'realmID' as a path parameter and a 'query' string as a query parameter. The request must include the 'Content-Type' header set to 'application/text'. The response includes detailed information about each bill payment, such as document number, vendor reference, transaction date, total amount, payment type, and metadata. The response also provides pagination details like start position, maximum results, and total count.
Input Fields: Input Fields
Output Fields: Output Fields

Query a budget

ID: get_query_a_budget
Operation: read
Entities: account, budget, budget detail
Summary: The 'Query a budget' API allows users to execute a SQL-like query to retrieve budget information from a specified company realm in QuickBooks. The API requires the 'realmID' as a path parameter and a 'query' string as a query parameter. The request must include the 'Content-Type' header set to 'application/text'. The response includes detailed budget information such as start and end dates, budget entry type, budget details, and metadata. The response is structured in a 'QueryResponse' object containing the budget details and the time the response was generated.
Input Fields: Input Fields
Output Fields: Output Fields

Query a bundle

ID: get_query_a_bundle
Operation: read
Entities: item group detail, query, item
Summary: The 'Query a bundle' API allows users to execute SQL-like queries on the QuickBooks database to retrieve information about items, specifically those of type 'Group'. The API requires the realm ID of the company and a query statement as input. The response includes details about the items that match the query, such as SKU, name, type, and other attributes. The API is accessed via a GET request to the specified endpoint, with the query parameters included in the URL.
Input Fields: Input Fields
Output Fields: Output Fields

Query a category

ID: get_query_a_category
Operation: read
Entities: item, category, company
Summary: The 'Query a category' API allows users to execute a SQL-like query to retrieve categories from a company's QuickBooks data. The API endpoint requires the realmID of the company and a query string as query parameters. The response includes a list of items that match the query, each with details such as name, type, ID, and metadata. The API checks if categories are enabled for the company using the CompanyInfo.NameValue.Name.ItemCategoriesFeature flag.
Input Fields: Input Fields
Output Fields: Output Fields

Query a class

ID: get_query_a_class
Operation: read
Entities: class, query, metadata
Summary: The 'Query a class' API allows users to execute a SQL-like query to retrieve class information from a specified company in QuickBooks. The API requires the realm ID of the company and a query statement as input. The response includes details about the classes such as their fully qualified name, domain, name, sync token, subclass status, active status, ID, and metadata including creation and last updated times. The API returns the results in a structured format, including the total count of results and the maximum number of results returned.
Input Fields: Input Fields
Output Fields: Output Fields

Query a company currency

ID: get_query_a_company_currency
Operation: read
Entities: query response, company currency, metadata
Summary: The 'Query a company currency' API allows users to query company currency information using a SQL-like query statement. The API endpoint is a GET request to the URL 'https://quickbooks.api.intuit.com/v3/company//query?query='. The request requires a 'Content-Type' header set to 'text/plain' and a 'realmID' path parameter to specify the company. The 'query' query parameter is required to define the SQL-like query statement. The response includes a 'QueryResponse' object with details about the company currencies, including their code, name, active status, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Credit Card Payment

ID: get_query_a_credit_card_payment
Operation: read
Entities: credit card payment, meta data, query response
Summary: This API allows querying of credit card payments in QuickBooks. The request is made to the endpoint with the realm ID of the company and a SQL-like query string. The response includes details of the credit card payment transactions such as transaction date, amount, currency, and associated account references. The response also includes metadata about the creation and last update times of the transactions.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Credit Memo

ID: get_query_a_credit_memo
Operation: read
Entities: credit memo, project, customer
Summary: This API allows querying of credit memos in a QuickBooks company realm using a SQL-like query. The request is made to the endpoint with the company realm ID and the query as a query parameter. The response includes details of the credit memos such as transaction date, total amount, customer reference, and line items. The response is structured with a QueryResponse object containing the list of credit memos and metadata about the query execution.
Input Fields: Input Fields
Output Fields: Output Fields

Query a customer

ID: get_query_a_customer
Operation: read
Entities: address, query response, customer
Summary: The 'Query a customer' API allows users to execute SQL-like queries to retrieve customer information from QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that contains the SQL-like statement. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object with a list of customers matching the query, each containing detailed information such as domain, family name, display name, email address, phone number, and more. The response also includes metadata about the query execution time.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Customer Type

ID: get_query_a_customertype
Operation: read
Entities: customer type, query response, metadata
Summary: This API allows querying customer types in QuickBooks using a SQL-like query. The request requires the realm ID of the company and a query string as query parameters. The response includes details about customer types such as their name, ID, active status, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a department

ID: get_query_a_department
Operation: read
Entities: query, department, company
Summary: The 'Query a department' API allows users to execute a SQL-like query to retrieve information about departments within a specified company realm in QuickBooks. The request requires a 'realmID' path parameter to identify the company and a 'selectStatement' query parameter to specify the query. The response includes details about the department such as its fully qualified name, domain, name, sync token, and whether it is a sub-department.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Deposit

ID: get_query_a_deposit
Operation: read
Entities: deposit, account, transaction
Summary: The 'Query a Deposit' API allows users to execute SQL-like queries to retrieve deposit information from a specified company realm in QuickBooks. The API requires the 'realmID' as a path parameter and a 'query' string as a query parameter. The request must include the 'Content-Type' header set to 'application/text'. The response includes a 'QueryResponse' object containing details about the deposits, such as 'SyncToken', 'domain', 'DepositToAccountRef', 'TxnDate', 'TotalAmt', 'Line', 'Id', and 'MetaData'. Known issue: Queries with filters may return incorrect data.
Input Fields: Input Fields
Output Fields: Output Fields

Query a General Ledger Report

ID: get_query_a_general_ledger_report
Operation: read
Entities: report, account, customer
Summary: The 'Query a General Ledger Report' API allows users to retrieve a detailed general ledger report for a specified company. The API supports various query parameters to customize the report, including filtering by customer, account, accounting method, source account, date range, and more. Users can specify the columns to be included in the report and the sorting order. The response includes detailed report data, including headers, rows, and columns, with options for multicurrency and non-tracking settings. The API returns the report in JSON format, providing a comprehensive view of the company's financial transactions within the specified parameters.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Journal Entry

ID: get_query_a_journal_entry
Operation: read
Entities: account, journal entry, line
Summary: This API allows querying of journal entries in a QuickBooks company file. The request is made to the endpoint with a specified realmID and a SQL-like query string as a query parameter. The content type of the request must be 'application/text'. The response includes details about the journal entries such as SyncToken, domain, transaction date, private note, lines with details like posting type, account reference, amount, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Journal Report

ID: get_query_a_journal_report
Operation: read
Entities: journal code, report, company
Summary: The 'Query a Journal Report' API allows users to retrieve a journal report from QuickBooks. The API endpoint is a GET request to the URL 'https://quickbooks.api.intuit.com/v3/company//reports/JournalReport'. Users can customize the report by specifying query parameters such as 'end_date', 'date_macro', 'sort_by', 'sort_order', 'start_date', and 'columns'. The response includes a report object with details such as the report name, date range, currency, and a list of rows containing column data. The columns can include transaction date, type, document number, account name, debit and credit amounts, among others. The API returns the report in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Query a journalcode

ID: get_query_a_journalcode
Operation: read
Entities: journal code, query response, metadata
Summary: The 'Query a journalcode' API allows users to execute a SQL-like query to retrieve journal code information from a specified company in QuickBooks. The API requires the realm ID of the company as a path parameter and the query string as a query parameter. The request must include a 'Content-Type' header set to 'text/plain'. The response includes details about each journal code such as SyncToken, domain, Name, sparse status, Active status, MetaData with CreateTime and LastUpdatedTime, Type, Id, and Description. The response also provides the start position, maximum results, and total count of the query results, along with the time the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query a payment

ID: get_query_a_payment
Operation: read
Entities: payment, invoice, customer
Summary: The 'Query a payment' API allows users to execute SQL-like queries to retrieve payment information from QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that contains the SQL-like statement. The request must include a 'Content-Type' header set to 'application/text'. The response includes a 'QueryResponse' object with details about the payments, such as 'SyncToken', 'domain', 'DepositToAccountRef', 'UnappliedAmt', 'TxnDate', 'TotalAmt', 'ProjectRef', 'ProcessPayment', 'sparse', 'Line', 'CustomerRef', 'Id', and 'MetaData'. The response also includes the 'maxResults' and the 'time' of the query execution.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Payment Method

ID: get_query_a_payment_method
Operation: read
Entities: payment method, query response, metadata
Summary: This API allows querying of payment methods in a QuickBooks company. The request is made to the endpoint '/v3/company//query' with a required query parameter 'query' that specifies the SQL-like query to execute. The 'realmID' is a required path parameter that identifies the company. The request must include a 'Content-Type' header set to 'application/text'. The response includes a 'QueryResponse' object with details about the payment methods, such as their names, types, and metadata, as well as the time the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Profit and Loss Report

ID: get_query_a_profit_and_loss_report
Operation: read
Entities: report, vendor, customer
Summary: This API endpoint allows you to query a Profit and Loss report for a specified company realm. You can customize the report by using various query parameters such as customer ID, accounting method, date range, and more. The report can be filtered and sorted based on different criteria like classes, items, departments, and vendors. The response includes detailed report data with sections for income, expenses, gross profit, and net income, along with metadata about the report generation.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Purchase

ID: get_query_a_purchase
Operation: read
Entities: account, purchase, vendor
Summary: The 'Query a Purchase' API allows users to execute a SQL-like query to retrieve purchase records from QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that contains the SQL-like statement. The request must include a 'Content-Type' header set to 'application/text'. The response includes a 'QueryResponse' object with details of the purchases, such as 'SyncToken', 'domain', 'PurchaseEx', 'Credit', 'TotalAmt', 'PrivateNote', 'PaymentType', 'TxnDate', 'Line', 'AccountRef', 'Id', and 'MetaData'. The response also includes the 'time' the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Purchase Order

ID: get_query_a_purchase_order
Operation: read
Entities: purchase order, vendor, item
Summary: This API allows querying of purchase orders in QuickBooks using a SQL-like query language. The request is made to the endpoint '/v3/company//query' with the 'query' parameter specifying the SQL-like query. The 'realmID' is a required path parameter representing the company realm ID. The 'query' parameter is required and should contain the SQL-like query string. The request must include the 'Content-Type' header set to 'application/text'. The response includes details of the purchase orders matching the query, such as document number, vendor reference, transaction date, total amount, and more. The response also includes metadata like creation and last updated time.
Input Fields: Input Fields
Output Fields: Output Fields

Query a recurring transaction

ID: get_query_a_recurring_transaction
Operation: read
Entities: recurring transaction, invoice, bill
Summary: The 'Query a recurring transaction' API allows users to retrieve recurring transactions from a specified company realm in QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that contains the SQL-like statement to select recurring transactions. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object with details of the recurring transactions such as invoices and bills, including their amounts, currency, customer references, and recurring schedule information. The response also includes metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a refund receipt

ID: get_query_a_refund_receipt
Operation: read
Entities: refund receipt, payment method, customer
Summary: The 'Query a refund receipt' API allows users to execute a SQL-like query to retrieve refund receipt details from QuickBooks. The API requires the company realm ID as a path parameter and a query string as a query parameter. The query string should be a SQL-like statement to select data from the RefundReceipt table. The response includes detailed information about the refund receipt, such as document number, balance, payment method, billing address, transaction date, total amount, customer reference, and more. The API returns the results in a structured JSON format, including metadata and query response details.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Reimburse Charge

ID: get_query_a_reimburse_charge
Operation: read
Entities: reimburse charge, invoice, customer
Summary: The 'Query a Reimburse Charge' API allows users to execute a SQL-like query to retrieve reimburse charge details from a specified company realm in QuickBooks. The API requires the 'realmID' as a path parameter and a 'query' as a query parameter. The request must include a 'Content-Type' header set to 'text/plain'. The response includes detailed information about the reimburse charges, such as transaction date, currency, linked transactions, amount, line details, customer reference, and metadata. The response also provides pagination details like start position, maximum results, and total count.
Input Fields: Input Fields
Output Fields: Output Fields

Query a report

ID: get_query_a_report
Operation: read
Entities: vendor, customer, report
Summary: The 'Query a report' API allows users to retrieve a report of aged payables from QuickBooks. The API endpoint is a GET request to the URL 'https://quickbooks.api.intuit.com/v3/company//reports/AgedPayables'. Users can customize the report by specifying various query parameters such as 'customer', 'qzurl', 'vendor', 'date_macro', 'department', 'report_date', 'sort_order', and 'aging_method'. The response includes a detailed report object with headers, rows, and columns, providing information about vendors and their payable amounts over different aging periods.
Input Fields: Input Fields
Output Fields: Output Fields

Query a SalesReceipt

ID: get_query_a_salesreceipt
Operation: read
Entities: sales receipt, line, customer memo
Summary: The 'Query a SalesReceipt' API allows users to execute a SQL-like query to retrieve sales receipt details from QuickBooks. The API requires a 'realmID' as a path parameter and a 'query' as a query parameter. The request must include a 'Content-Type' header set to 'application/text'. The response includes detailed information about the sales receipt, such as transaction date, total amount, line items, customer reference, and more. The response is structured in a 'QueryResponse' object containing an array of 'SalesReceipt' objects with various properties like 'TxnDate', 'TotalAmt', 'CustomerRef', etc.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Tax Agency

ID: get_query_a_tax_agency
Operation: read
Entities: tax agency
Summary: The 'Query a Tax Agency' API allows users to execute a SQL-like query to retrieve information about tax agencies associated with a specific company realm. The request requires the 'realmID' as a path parameter and a 'query' string as a query parameter. The response includes details such as the start position, total count, and maximum results of the query, along with an array of tax agency objects containing information like display name, tax tracking status, and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Tax Summary Report

ID: get_query_a_tax_summary_report
Operation: read
Entities: tax agency, accounting method, report
Summary: This API endpoint allows you to query a tax summary report for a specific company identified by the realmID. The report can be customized using various query parameters such as agency_id (required), accounting_method, start_date, end_date, date_macro, and sort_order. The response includes a detailed report object with headers and rows containing tax summary data. The report can be generated for a specific date range or a predefined date range using date_macro.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Taxcode

ID: get_query_a_taxcode
Operation: read
Entities: tax group, tax code, metadata
Summary: The 'Query a Taxcode' API allows users to query tax codes from a specified company using a SQL-like query statement. The API requires the realm ID of the company as a path parameter and the query statement as a query parameter. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object containing the starting position, total count, and a list of tax codes with details such as tax group status, name, taxable status, description, ID, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a taxrate

ID: get_query_a_taxrate
Operation: read
Entities: agency, tax rate, metadata
Summary: The 'Query a taxrate' API allows users to execute a SQL-like query to retrieve tax rate information from a specified company realm in QuickBooks. The API requires a 'query' string as a query parameter. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object containing details such as 'startPosition', 'totalCount', and an array of 'TaxRate' objects, each with properties like 'RateValue', 'AgencyRef', 'Name', 'Active', and 'MetaData'. The response also includes a 'time' field indicating when the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Term

ID: get_query_a_term
Operation: read
Entities: term, query response, meta data
Summary: The 'Query a Term' API allows users to execute a SQL-like query to retrieve term details from a specified company in QuickBooks. The API requires the realm ID of the company as a path parameter and the query string as a query parameter. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object containing the list of terms with details such as SyncToken, domain, Name, DiscountPercent, DiscountDays, Type, sparse, Active, DueDays, Id, and MetaData. The response also includes the time the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Vendor

ID: get_query_a_vendor
Operation: read
Entities: vendor, query response, metadata
Summary: The 'Query a Vendor' API allows users to execute SQL-like queries against vendor data in QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that contains the SQL-like statement. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object with details about the vendors matching the query, including their display names, balances, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Vendor Credit

ID: get_query_a_vendor_credit
Operation: read
Entities: vendor credit, account, project
Summary: The 'Query a Vendor Credit' API allows users to execute a SQL-like query to retrieve vendor credit information from QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query?query='. The request requires a 'Content-Type' header set to 'application/text' and a 'realmID' path parameter to specify the company realm. The 'query' parameter is used to pass the SQL-like query string. The response includes a 'QueryResponse' object containing details such as 'startPosition', 'totalCount', and an array of 'VendorCredit' objects with detailed information about each vendor credit, including 'SyncToken', 'VendorRef', 'TxnDate', 'TotalAmt', 'APAccountRef', 'Line' items, and 'MetaData'. The response also includes the 'time' the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query an account

ID: get_query_an_account
Operation: read
Entities: account, query response, metadata
Summary: The 'Query an account' API allows users to execute a SQL-like query on the accounts of a specified company identified by the realmID. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that contains the SQL-like statement. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object containing the list of accounts that match the query, along with metadata such as creation and last updated times, account type, balance, and more. The response also includes the time the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query an Attachable

ID: get_query_an_attachable
Operation: read
Entities: purchase, attachment, attachable
Summary: This API allows you to query attachable IDs for all attachments linked to a specific object type and ID. You need to specify the object type and its ID in the query parameters. The request is made to the QuickBooks API endpoint with the realm ID of the company. The response includes the attachable IDs, their sparse status, and the time the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query an Employee

ID: get_query_an_employee
Operation: read
Entities: employee
Summary: The 'Query an Employee' API allows users to execute SQL-like queries to retrieve employee information from a QuickBooks company. The request requires a realm ID as a path parameter and a query string as a query parameter. The response includes detailed employee information such as display name, middle name, family name, and metadata about the employee's record. The API returns the results of the query along with the time the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query an estimate

ID: get_query_an_estimate
Operation: read
Entities: estimate, line, customer memo
Summary: The 'Query an estimate' API allows users to execute SQL-like queries to retrieve estimates from a specified company realm in QuickBooks. The API endpoint requires a 'realmID' as a path parameter and a 'query' as a query parameter. The request must include a 'Content-Type' header set to 'application/text'. The response includes a 'QueryResponse' object containing details of the estimates such as transaction date, status, total amount, line items, customer information, and more. The response also includes metadata about the creation and last update times of the estimates.
Input Fields: Input Fields
Output Fields: Output Fields

Query an Invoice

ID: get_query_an_invoice
Operation: read
Entities: invoice, customer, item
Summary: The 'Query an Invoice' API allows users to execute a SQL-like query to retrieve invoice details from QuickBooks. The API endpoint is a GET request to 'https://quickbooks.api.intuit.com/v3/company//query' with a required query parameter 'query' that specifies the SQL-like query to be executed. The request must include a 'Content-Type' header set to 'application/text'. The response includes detailed information about the invoice, such as transaction date, total amount, line items, customer reference, and more. The response is structured with a 'QueryResponse' object containing the query results and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Query an item

ID: get_query_an_item
Operation: read
Entities: account, query, item
Summary: The 'Query an item' API allows users to execute a SQL-like query to retrieve items from a QuickBooks company. The API requires the realm ID of the company as a path parameter and a query string as a query parameter. The request must include a 'Content-Type' header set to 'text/plain'. The response includes a 'QueryResponse' object containing the list of items that match the query, along with metadata such as creation and last updated times, item details like name, type, and price, and other attributes. The response also includes the time the query was executed.
Input Fields: Input Fields
Output Fields: Output Fields

Query Company Information

ID: get_query_company_information
Operation: read
Entities: address, company info, contact info
Summary: The Query Company Information API allows users to retrieve detailed information about a company using a SQL-like query. The API requires the realm ID of the company as a path parameter and the query statement as a query parameter. The response includes comprehensive details about the company such as legal address, company name, supported languages, fiscal year start month, and metadata. The API returns the company information in a structured JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Customer Balance Report

ID: get_query_customer_balance_report
Operation: read
Entities: report, customer, department
Summary: This API endpoint allows users to query a customer balance report from QuickBooks. The report can be customized using various query parameters such as customer ID, shipping method, terms, due dates, custom fields, sorting options, and more. The response includes detailed information about the customer balance, including the report name, options used, currency, and a breakdown of rows and columns with customer and financial data.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Customer Sales Report

ID: get_query_customer_sales_report
Operation: read
Entities: report, customer, item
Summary: The 'Query a Customer Sales Report' API allows users to retrieve a detailed sales report for specified customers within a company. Users can customize the report by specifying various query parameters such as customer IDs, accounting method, date range, and more. The API returns a structured report object containing headers, rows, and columns with detailed sales data. The report can be filtered and sorted based on different criteria, providing flexibility in how the data is presented.
Input Fields: Input Fields
Output Fields: Output Fields

Query Preferences

ID: get_query_preferences
Operation: read
Entities: preference, message, custom field
Summary: The Query Preferences API allows users to retrieve the preferences of a company in QuickBooks. The API endpoint is a GET request to the URL 'https://quickbooks.api.intuit.com/v3/company//query?query='. The request requires a 'Content-Type' header set to 'text/plain' and a 'realmID' path parameter to specify the company. The query parameter 'query' is required and should contain an SQL-like statement to select preferences. The response includes detailed preferences such as email message preferences, product and services preferences, accounting information preferences, sales forms preferences, vendor and purchases preferences, tax preferences, and other preferences. The response also includes metadata about the preferences and the time of the response.
Input Fields: Input Fields
Output Fields: Output Fields

Query Tax Payment

ID: get_query_tax_payment
Operation: read
Entities: tax payment, payment account, query response
Summary: The Query Tax Payment API allows users to execute SQL-like queries to retrieve tax payment records from a specified company realm in QuickBooks. The API requires the realmID as a path parameter and a query statement as a query parameter. The response includes details of tax payments such as refund status, payment amount, payment date, and metadata about the record. The API returns a JSON object containing the query response with tax payment details and the execution time.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Transfer

ID: get_query_transfer
Operation: read
Entities: account, transfer, metadata
Summary: The 'Query a Transfer' API allows users to execute a SQL-like query to retrieve transfer records from a specified company realm in QuickBooks. The API requires the 'realmID' as a path parameter and a 'query' string as a query parameter. The request must include the 'Content-Type' header set to 'application/text'. The response includes a 'QueryResponse' object containing details of the transfers such as 'SyncToken', 'TxnDate', 'ToAccountRef', 'Amount', 'Id', 'FromAccountRef', and 'MetaData'. The response also provides the 'startPosition', 'maxResults', and 'totalCount' of the query results, along with the execution 'time'.
Input Fields: Input Fields
Output Fields: Output Fields

Read a bill

ID: get_read_a_bill
Operation: read
Entities: account, vendor, bill
Summary: The 'Read a bill' API retrieves the details of a previously created bill in QuickBooks. It requires the 'realmID' and 'billId' as path parameters to identify the specific bill. The request must include the 'Content-Type' header set to 'application/json'. The response includes detailed information about the bill, such as the sync token, domain, accounts payable account reference, vendor reference, transaction date, total amount, currency reference, linked transactions, sales term reference, due date, line items, balance, and metadata including creation and last updated times. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Billpayment

ID: get_read_a_billpayment
Operation: read
Entities: bill payment, vendor, bank account
Summary: The 'Read a Billpayment' API retrieves the details of a previously created billpayment in QuickBooks. It requires the 'realmID' and 'billpaymentId' as path parameters to identify the specific billpayment. The request must include the 'Content-Type' header set to 'application/text'. The response includes detailed information about the billpayment, such as the vendor reference, transaction date, total amount, payment type, and metadata including creation and last updated times. The response is structured with a 'BillPayment' object containing all relevant details.
Input Fields: Input Fields
Output Fields: Output Fields

Read a budget

ID: get_read_a_budget
Operation: read
Entities: account reference, budget, budget detail
Summary: The 'Read a budget' API retrieves the details of a budget that has been previously created in QuickBooks. The API requires the 'realmID' and 'budgetId' as path parameters to identify the specific budget to retrieve. The request must include the 'Content-Type' header set to 'application/text'. The response includes detailed information about the budget, such as its start and end dates, name, type, and a list of budget details with amounts and account references. The response also includes metadata about the creation and last update times of the budget.
Input Fields: Input Fields
Output Fields: Output Fields

Read a bundle

ID: get_read_a_bundle
Operation: read
Entities: item group detail, item group line, item
Summary: The 'Read a bundle' API retrieves the details of an item bundle object that has been previously created in QuickBooks. The API requires the realmID and itemId as path parameters to identify the specific company and item bundle. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the desired response format. The response includes detailed information about the item bundle, such as its SKU, name, type, purchase cost, and item group details, along with metadata about its creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a category

ID: get_read_a_category
Operation: read
Entities: item, category, company
Summary: The 'Read a category' API retrieves the details of a previously created item object. It is available only for companies that have enabled the Categories feature. The API requires the realmID and itemId as path parameters, and optionally accepts a minorversion query parameter. The response includes the full details of the category item, such as its name, type, ID, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a class

ID: get_read_a_class
Operation: read
Entities: metadata, class, company
Summary: The 'Read a class' API retrieves the details of a class object that has been previously created in QuickBooks. The API requires the realmID and classId as path parameters to identify the specific class to retrieve. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type. The response includes details about the class such as its fully qualified name, domain, name, sync token, subclass status, sparsity, active status, ID, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a credit memo

ID: get_read_a_credit_memo
Operation: read
Entities: credit memo, customer, item
Summary: The 'Read a credit memo' API retrieves the details of a previously created credit memo in QuickBooks. The request requires the 'realmID' and 'creditmemoId' as path parameters to identify the company and the specific credit memo. The response includes detailed information about the credit memo, such as transaction date, total amount, line items, customer reference, and more. The API returns a JSON object containing the credit memo details and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Read a customer

ID: get_read_a_customer
Operation: read
Entities: phone number, email address, customer
Summary: The 'Read a customer' API retrieves the details of a Customer object that has been previously created in the QuickBooks system. The API requires the realmID and customerId as path parameters to identify the specific customer. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type. The response returns a Customer object containing details such as the primary email address, name, company name, phone number, billing address, balance, and metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Department

ID: get_read_a_department
Operation: read
Entities: department, company
Summary: The 'Read a Department' API retrieves the details of a Department object that has been previously created in QuickBooks. The API requires the 'realmID' and 'departmentId' as path parameters to identify the company and department respectively. The request must include an 'Authorization' header with a bearer token and a 'Content-Type' header set to 'application/json'. The response returns the Department object with details such as its fully qualified name, domain, name, sync token, sub-department status, active status, ID, and metadata including creation time.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Deposit

ID: get_read_a_deposit
Operation: read
Entities: deposit, account, transaction
Summary: The 'Read a Deposit' API retrieves the details of a previously created Deposit object. It requires the realmID and depositId as path parameters to identify the specific deposit. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type. The response includes detailed information about the deposit, such as the SyncToken, domain, DepositToAccountRef, transaction date, total amount, line items, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Journalcode

ID: get_read_a_journalcode
Operation: read
Entities: journalcode, metadata
Summary: The 'Read a Journalcode' API retrieves the details of a journalcode object that has been previously created in the QuickBooks system. The request requires the realmID and journalcodeId as path parameters, and an OAuth 2.0 token for authentication in the headers. The response returns the journalcode object, including details such as SyncToken, domain, Name, sparse, time, Active status, MetaData, Type, Id, and Description.
Input Fields: Input Fields
Output Fields: Output Fields

Read a JournalEntry

ID: get_read_a_journalentry
Operation: read
Entities: account, journal entry, line
Summary: The 'Read a JournalEntry' API retrieves the details of a previously created JournalEntry in QuickBooks. It requires the realmID and journalentryId as path parameters to identify the specific JournalEntry. The request must include an Authorization header with a valid OAuth 2.0 token. The response includes detailed information about the JournalEntry, such as transaction date, line items with descriptions, posting types, account references, and entity details. The response also contains metadata about the creation and last update times of the JournalEntry.
Input Fields: Input Fields
Output Fields: Output Fields

Read a payment

ID: get_read_a_payment
Operation: read
Entities: account, payment, invoice
Summary: The 'Read a payment' API retrieves the details of a Payment object that has been previously created in QuickBooks. The API requires the realmID and paymentId as path parameters to identify the company and the specific payment to retrieve. The request must include the 'Content-Type' header set to 'application/json'. The response includes detailed information about the payment, such as the sync token, domain, deposit account reference, unapplied amount, transaction date, total amount, project reference, process payment status, line items, customer reference, payment ID, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Payment Method

ID: get_read_a_payment_method
Operation: read
Entities: metadata, payment method, company
Summary: The 'Read a Payment Method' API retrieves the details of a payment method object that has been previously created in QuickBooks. The API requires the realmID and paymentmethodId as path parameters to identify the company and the specific payment method. The request must include an Authorization header with a valid OAuth 2.0 token. The response returns the payment method object, including details such as the name, type, and metadata of the payment method.
Input Fields: Input Fields
Output Fields: Output Fields

Read a purchase

ID: get_read_a_purchase
Operation: read
Entities: account, project, purchase
Summary: The 'Read a purchase' API retrieves the details of a Purchase object that has been previously created in QuickBooks. The API requires the realmID and purchaseId as path parameters to identify the specific purchase to retrieve. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type as application/json. The response includes detailed information about the purchase, such as the transaction date, total amount, payment type, line items, account references, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a purchase order

ID: get_read_a_purchase_order
Operation: read
Entities: purchase order, vendor, item
Summary: The 'Read a purchase order' API retrieves the details of a previously created purchase order in QuickBooks. It requires the realm ID of the QuickBooks company and the purchase order ID as path parameters. The request must include an OAuth 2.0 token for authorization and specify the media type as 'application/json' in the headers. The response includes detailed information about the purchase order, such as document number, transaction date, total amount, vendor reference, line items, and metadata. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Read a refund receipt

ID: get_read_a_refund_receipt
Operation: read
Entities: refund receipt, customer, item
Summary: The 'Read a refund receipt' API retrieves the details of a previously created RefundReceipt. It requires the realmID and refundreceiptId as path parameters to identify the specific refund receipt. The request must include the 'Content-Type' header set to 'application/json'. The API returns a detailed RefundReceipt object, which includes information such as document number, sync token, balance, payment method, billing and shipping addresses, transaction date, total amount, customer reference, and more. The response also includes metadata about the creation and last update times of the refund receipt.
Input Fields: Input Fields
Output Fields: Output Fields

Read a reimburse charge

ID: get_read_a_reimburse_charge
Operation: read
Entities: reimburse line detail, reimburse charge, customer
Summary: The 'Read a reimburse charge' API retrieves the details of a ReimburseCharge object from QuickBooks. It requires the realmID and taxrateId as path parameters to identify the specific company and reimburse charge object. The request must include an OAuth 2.0 token in the Authorization header and specify 'application/json' in the Accept header. The response includes detailed information about the ReimburseCharge object, such as transaction date, currency, linked transactions, amount, customer reference, and metadata about creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a TaxAgency

ID: get_read_a_taxagency
Operation: read
Entities: tax agency, metadata
Summary: The 'Read a TaxAgency' API retrieves the details of a TaxAgency object that has been previously created in QuickBooks. The API requires the realmID and taxagencyId as path parameters to identify the specific TaxAgency. The request must include an Authorization header with a valid OAuth 2.0 token. The response returns the TaxAgency object, including details such as SyncToken, domain, DisplayName, tax tracking information, and metadata about creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a TaxCode

ID: get_read_a_taxcode
Operation: read
Entities: tax rate detail, tax code, metadata
Summary: The 'Read a TaxCode' API retrieves the details of a TaxCode object that has been previously created in QuickBooks. The API requires the realmID and taxcodeId as path parameters to identify the company and the specific TaxCode to retrieve. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type. The response returns the TaxCode object, including details such as its name, description, tax rates, and metadata about its creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Read a TaxRate

ID: get_read_a_taxrate
Operation: read
Entities: tax rate, agency ref, metadata
Summary: The 'Read a TaxRate' API retrieves the details of a TaxRate object from QuickBooks. It requires the realmID and taxrateId as path parameters to identify the company and the specific TaxRate object. The API returns a TaxRate object containing details such as RateValue, AgencyRef, domain, Name, SyncToken, SpecialTaxType, DisplayType, sparse, Active status, MetaData, Id, and Description. The response also includes a timestamp indicating when the response was generated.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Term

ID: get_read_a_term
Operation: read
Entities: term, metadata
Summary: The 'Read a Term' API retrieves the details of a Term object that has been previously created in QuickBooks. The API requires the realmID of the QuickBooks company and the termId of the Term object to be retrieved as path parameters. The request must include an Authorization header with a valid OAuth 2.0 token. The response returns the Term object, including details such as SyncToken, domain, Name, DiscountPercent, DiscountDays, Type, sparse, Active, DueDays, Id, and MetaData with CreateTime and LastUpdatedTime.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Transfer

ID: get_read_a_transfer
Operation: read
Entities: account, transfer, metadata
Summary: The 'Read a Transfer' API retrieves the details of a Transfer object that has been previously created in QuickBooks. It requires the realmID and transferId as path parameters to identify the specific transfer. The request must include an OAuth 2.0 token in the Authorization header and specify the content type as application/json. The response includes details of the transfer such as the transaction date, amount, source and destination accounts, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a vendor

ID: get_read_a_vendor
Operation: read
Entities: address, phone, vendor
Summary: The 'Read a vendor' API retrieves the details of a Vendor object that has been previously created in QuickBooks. The API requires the realmID and vendorId as path parameters to identify the specific vendor. The request must include an OAuth 2.0 token in the Authorization header for authentication. The response includes detailed information about the vendor, such as their email address, phone number, billing address, company name, and metadata about the creation and last update times. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Read an account

ID: get_read_an_account
Operation: read
Entities: account, balance, metadata
Summary: The 'Read an account' API retrieves the details of an Account object that has been previously created in QuickBooks. It requires the realmID and accountId as path parameters to identify the specific account. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type. The response returns the Account object, including details such as the fully qualified name, domain, name, classification, account subtype, current balance, metadata, account type, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Read an attachable

ID: get_read_an_attachable
Operation: read
Entities: attachable
Summary: The 'Read an attachable' API retrieves the details of an attachable item that has been previously created in QuickBooks. The API requires the realmID and attachableId as path parameters to identify the specific attachable item. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the desired response format. The response includes details of the attachable item such as its SyncToken, domain, references, note, ID, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read an employee

ID: get_read_an_employee
Operation: read
Entities: address, phone, employee
Summary: The 'Read an employee' API retrieves the details of an Employee object that has been previously created in QuickBooks. The API requires the realmID and employeeId as path parameters to identify the company and the specific employee. The request must include an Authorization header with a valid OAuth 2.0 token. The response returns the Employee object, including details such as the employee's display name, phone number, address, and metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Read an estimate

ID: get_read_an_estimate
Operation: read
Entities: project, estimate, customer
Summary: The 'Read an estimate' API retrieves the details of an estimate that has been previously created in QuickBooks. The API requires the realmID and estimateId as path parameters to identify the specific estimate. The request must include an Authorization header with an OAuth 2.0 token. The response includes detailed information about the estimate, such as document number, transaction status, billing and shipping addresses, line items, total amount, and metadata. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Read an invoice

ID: get_read_an_invoice
Operation: read
Entities: invoice, customer, item
Summary: The 'Read an invoice' API retrieves the details of a previously created invoice from QuickBooks. It requires the realmID and invoiceId as path parameters to identify the specific invoice. The request must include an Accept header specifying the media type. The response includes detailed information about the invoice, such as transaction date, total amount, line items, customer details, tax details, and more. The response is returned in JSON format, providing a comprehensive view of the invoice's attributes and associated metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Read an item

ID: get_read_an_item
Operation: read
Entities: account, metadata, item
Summary: The 'Read an item' API retrieves the details of an item object that has been previously created in QuickBooks. The API requires the realmID and itemId as path parameters to identify the company and the specific item to retrieve. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type. The response returns the item object with details such as its name, type, purchase cost, quantity on hand, and associated account references, along with metadata like creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Read companyinfo

ID: get_read_companyinfo
Operation: read
Entities: company info, company address, name value
Summary: The 'Read companyinfo' API retrieves the details of the CompanyInfo object for a specified company realm. The API requires an OAuth 2.0 token for authorization and accepts an optional 'Accept' header to specify the desired response format. The request URL includes the 'realmID' path parameter, which identifies the company realm. The response includes detailed information about the company, such as its legal address, company name, supported languages, fiscal year start month, and various metadata. The response is returned in JSON format, containing the 'CompanyInfo' object with all relevant company details.
Input Fields: Input Fields
Output Fields: Output Fields

Read entitlements

ID: get_read_entitlements
Operation: read
Entities: entitlement, threshold, company
Summary: The 'Read entitlements' API retrieves the entitlements details for a specified company identified by the realmID. It requires an OAuth token for authorization and returns details such as the plan name, maximum and current users, and a list of entitlements with their status. The response also includes threshold information for various limits like classes, accounts, and users.
Input Fields: Input Fields
Output Fields: Output Fields

Read Preferences

ID: get_read_preferences
Operation: read
Entities: message, preference, company
Summary: The Read Preferences API retrieves the Preferences details for a specified company in QuickBooks. It requires the realmID as a path parameter to identify the company. The API uses OAuth 2.0 for authentication, requiring an Authorization header with a bearer token. The response includes a comprehensive Preferences object detailing various settings such as EmailMessagesPrefs, ProductAndServicesPrefs, ReportPrefs, AccountingInfoPrefs, SalesFormsPrefs, VendorAndPurchasesPrefs, TaxPrefs, OtherPrefs, TimeTrackingPrefs, and CurrencyPrefs. Each section contains specific configurations like email messages, product and service preferences, accounting information, sales form settings, vendor and purchase preferences, tax settings, and more. The response also includes metadata about the creation and last update times of the preferences.
Input Fields: Input Fields
Output Fields: Output Fields

Read Tax Payment

ID: get_read_tax_payment
Operation: read
Entities: tax payment, refund, tax return
Summary: The Read Tax Payment API retrieves the tax payment or refund details made against a filed tax return for a specified QuickBooks company. The API requires the realmID of the company and the taxPaymentId of the specific tax payment as path parameters. The request must include an OAuth 2.0 token for authentication in the headers. The response returns a TaxPayment object containing details such as the refund status, payment amount, payment date, and metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Read a recurring transaction

ID: get_recurring_transaction_details
Operation: read
Entities: recurring transaction, vendor, bill
Summary: The 'Read a recurring transaction' API retrieves the details of a RecurringTransaction object from QuickBooks. It requires the realmID and recurringtransactionId as path parameters to identify the specific transaction. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the desired response format. The API returns a detailed RecurringTransaction object, including information such as the bill's sync token, domain, recurring info, currency, total amount, vendor reference, line items, balance, and metadata. The response is provided in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get a refund receipt as PDF

ID: get_refund_receipt_as_pdf
Operation: read
Entities: company setting, PDF file, refund receipt
Summary: This API retrieves a refund receipt as a PDF file from QuickBooks. The request requires the realmID and refundreceiptId as path parameters. The response returns the refund receipt formatted as a PDF file, adhering to the custom form styles set in the company settings. The Content-Type header must be set to application/pdf for both the request and response.
Input Fields: Input Fields
Output Fields: Output Fields

Get a salesreceipt as PDF

ID: get_salesreceipt_as_pdf
Operation: read
Entities: sales receipt, company setting
Summary: The 'Get a salesreceipt as PDF' API retrieves a sales receipt in PDF format for a specified company and sales receipt ID. The request requires the 'realmID' and 'salesreceiptId' as path parameters, and the 'Content-Type' header must be set to 'application/pdf'. The response returns the sales receipt as a PDF file, formatted according to the company's custom form styles.
Input Fields: Input Fields
Output Fields: Output Fields

Read a SalesReceipt

ID: get_salesreceipt_details
Operation: read
Entities: sales receipt, customer, item
Summary: The 'Read a SalesReceipt' API retrieves the details of a SalesReceipt object that has been previously created in QuickBooks. The API requires the realmID and salesreceiptId as path parameters to identify the specific sales receipt. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the desired response format. The response includes detailed information about the sales receipt, such as transaction date, total amount, line items, customer reference, and more. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Read a TaxClassification by ID

ID: get_taxclassification_by_id
Operation: read
Entities: Parent Reference, Company, Tax Classification
Summary: This API retrieves the details of a TaxClassification object by its ID. It requires the realmID and taxClassificationId as path parameters. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type as application/json. The response returns a TaxClassification object containing details such as applicable items, code, description, level, parent reference, ID, and name.
Input Fields: Input Fields
Output Fields: Output Fields

Read a TaxClassification by Parent ID

ID: get_taxclassification_by_parent_id
Operation: read
Entities: tax classification, query response, parent
Summary: This API retrieves the details of a TaxClassification object by its parent ID. It requires the realm ID and parent ID as path parameters. The request must include an Authorization header with a valid OAuth 2.0 token and an Accept header specifying the media type. The response includes a list of TaxClassification objects, each with details such as applicable items, code, description, level, parent reference, ID, and name.
Input Fields: Input Fields
Output Fields: Output Fields

Read TaxClassifications by Level

ID: get_taxclassifications_by_level
Operation: read
Entities: level, parent reference, tax classification
Summary: The 'Read TaxClassifications by Level' API retrieves the details of TaxClassification objects that have been previously created by a specified level. The request requires the realmID as a path parameter and the level as a query parameter. The response includes a list of TaxClassification objects, each with details such as applicable items, code, description, level, parent reference, ID, and name.
Input Fields: Input Fields
Output Fields: Output Fields

Read a TimeActivity Object

ID: get_timeactivity_object
Operation: read
Entities: time activity, customer, employee
Summary: The 'Read a TimeActivity Object' API retrieves the details of a previously created TimeActivity object in QuickBooks. The request requires the realmID of the QuickBooks company and the timeactivityId of the specific TimeActivity object. The API returns a detailed response including transaction date, description, item reference, hours, billable status, hourly rate, employee reference, customer reference, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Get Tracking Categories

ID: get_tracking_categories
Operation: read
Entities:
Summary: The 'Get Tracking Categories' API allows users to execute a SQL-like query to retrieve class information from a specified company in QuickBooks. The API requires the realm ID of the company and a query statement as input. The response includes details about the classes such as their fully qualified name, domain, name, sync token, subclass status, active status, ID, and metadata including creation and last updated times. The API returns the results in a structured format, including the total count of results and the maximum number of results returned.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Trial Balance Report

ID: get_trial_balance_report
Operation: read
Entities: report, option, parameter
Summary: This API endpoint allows users to query a trial balance report for a specified company identified by realmID. The report can be customized using various query parameters such as accounting_method, end_date, date_macro, sort_order, summarize_column_by, and start_date. The response includes detailed report data with headers, rows, and columns, providing a comprehensive view of the trial balance for the specified period and criteria.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Vendor Balance Detail Report

ID: get_vendor_balance_detail_report
Operation: read
Entities: term, vendor, report
Summary: This API endpoint allows users to query a Vendor Balance Detail Report from QuickBooks. The report can be customized using various query parameters such as 'term', 'end_duedate', 'accounting_method', 'date_macro', 'start_duedate', 'duedate_macro', 'sort_by', 'report_date', 'sort_order', 'appaid', 'department', 'vendor', and 'columns'. The response includes detailed information about the vendor balance, including report headers, rows, and columns. The API supports both single and multicurrency settings, and the response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Vendor Balance Report

ID: get_vendor_balance_report
Operation: read
Entities: report, vendor, department
Summary: The 'Query a Vendor Balance Report' API allows users to retrieve a detailed report of vendor balances for a specified company. Users can customize the report by using various query parameters such as 'qzurl' for Quick Zoom URL information, 'accounting_method' for the accounting method, 'date_macro' for predefined date ranges, 'appaid' for balance status, 'report_date' for the start date, 'sort_order' for sorting, 'summarize_column_by' for grouping criteria, 'department' for filtering by department, and 'vendor' for filtering by vendor. The API returns a report object containing detailed information about vendor balances, including columns for vendor names and total amounts, as well as a summary section with grand totals.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Vendor Expenses Report

ID: get_vendor_expenses_report
Operation: read
Entities: report, vendor, customer
Summary: The 'Query a Vendor Expenses Report' API allows users to retrieve a detailed report of expenses by vendor for a specified company. Users can customize the report by using various query parameters such as 'customer', 'vendor', 'end_date', 'date_macro', 'class', 'sort_order', 'summarize_column_by', 'department', 'accounting_method', and 'start_date'. The API returns a report object that includes details such as the report name, options, date range, currency, and summarized columns. The report data is organized into rows and columns, with each row containing vendor information and corresponding expense totals.
Input Fields: Input Fields
Output Fields: Output Fields

Read a VendorCredit

ID: get_vendorcredit_details
Operation: read
Entities: vendor credit, account, vendor
Summary: The 'Read a VendorCredit' API retrieves the details of a VendorCredit object that has been previously created in QuickBooks. The API requires the realmID and vendorcreditId as path parameters to identify the specific VendorCredit to retrieve. The request must include an OAuth 2.0 token for authentication in the headers. The response includes detailed information about the VendorCredit, such as the vendor reference, transaction date, total amount, accounts payable account reference, line items with details, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Query a Journal Entry

ID: list_journal_entries
Operation: read
Entities:
Summary: This API allows querying of journal entries in a QuickBooks company file. The request is made to the endpoint with a specified realmID and a SQL-like query string as a query parameter. The content type of the request must be 'application/text'. The response includes details about the journal entries such as SyncToken, domain, transaction date, private note, lines with details like posting type, account reference, amount, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a bill

ID: post_create_a_bill
Operation: write
Entities: vendor, line item, bill
Summary: The 'Create a bill' API allows you to create a bill in QuickBooks by specifying the necessary details such as vendor reference and line items. The request body must include the 'VendorRef' and 'Line' objects, where 'VendorRef' contains the vendor ID and optionally the vendor name, and 'Line' contains details about each line item including 'DetailType', 'Amount', and 'AccountBasedExpenseLineDetail'. The response returns the created bill details including the bill ID, total amount, vendor reference, and line items with their respective details.
Input Fields: Input Fields
Output Fields: Output Fields

Create a class

ID: post_create_a_class
Operation: write
Entities: class, parent reference, metadata
Summary: This API endpoint allows the creation of a new class in QuickBooks. The request requires a user recognizable name for the class, and optionally, a reference to a parent class if the new class is a subclass. The response returns the newly created class object, including its fully qualified name, domain, name, sync token, subclass status, active status, ID, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a CompanyCurrency

ID: post_create_a_companycurrency
Operation: write
Entities: company currency
Summary: This API creates a new CompanyCurrency object in the QuickBooks system. The request requires a path parameter 'realmID' to specify the company and a request body with a 'Code' attribute, which is a three-letter ISO 4217 currency code (e.g., USD, GBP). The response returns the newly created CompanyCurrency object, including details such as the currency code, name, active status, and metadata about creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a deposit

ID: post_create_a_deposit
Operation: write
Entities: deposit, account, line
Summary: The 'Create a deposit' API allows users to create a deposit in QuickBooks. The request must include at least one line representing a deposit, which can be either a direct deposit or a linked deposit. The request body requires details such as the line items, deposit account reference, and optionally, currency details if multicurrency is enabled. The response returns the details of the created deposit, including the deposit ID, transaction date, total amount, and metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a payment

ID: post_create_a_payment
Operation: write
Entities: project, payment, customer
Summary: The 'Create a payment' API allows you to create a Payment object in QuickBooks. The request requires a JSON body with the total amount of the transaction and a reference to a customer or job. Optionally, you can include references to a project and currency. The response returns the created Payment object with details such as the sync token, domain, deposit account reference, unapplied amount, transaction date, total amount, project reference, process payment status, line items, customer reference, payment ID, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a purchase

ID: post_create_a_purchase
Operation: write
Entities: account, line item, purchase
Summary: This API endpoint allows you to create a purchase in QuickBooks. The request requires specifying a payment type (Cash, Check, or CreditCard) and an account reference. The account reference must be valid and active, and it must specify a bank account for Check or a credit card account for CreditCard. The request body must include line items, each with a detail type set to AccountBasedExpenseLineDetail, an amount, and account-based expense line details. The response returns the purchase details, including the total amount, payment type, transaction date, and line items with their respective details.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Term

ID: post_create_a_term
Operation: write
Entities: term, payment
Summary: The 'Create a Term' API allows users to create a new term in the QuickBooks system. The API requires a POST request to the specified endpoint with a JSON body containing the term details. The 'Name' attribute is mandatory, while either 'DayOfMonthDue' or 'DueDays' must be provided. The response returns the newly created term object, including its ID, name, due days, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Account

ID: post_create_account
Operation: write
Entities: classification, account, tax code
Summary: The 'Create an Account' API allows users to create a new account in QuickBooks. The request requires a JSON body with at least the 'Name' attribute, which must be unique and cannot contain double quotes or colons. The 'AcctNum' is conditionally required for France locales and must not contain colons. The 'TaxCodeRef' is also conditionally required for France locales. The 'AccountType' or 'AccountSubType' must be specified to classify the account. The API returns the newly created Account object with details such as 'FullyQualifiedName', 'Classification', 'AccountType', and 'CurrentBalance'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Bill Payment

ID: post_create_bill_payment
Operation: write
Entities: vendor, currency, transaction
Summary: This API endpoint allows you to create a bill payment in QuickBooks. The request requires a JSON body with details such as the vendor reference, total amount, payment type, and line items. The payment type can be either 'Check' or 'CreditCard'. If the payment type is 'Check', a bank account reference is required. The response includes details of the created bill payment, including the vendor reference, transaction date, total amount, payment type, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a budget

ID: post_create_budget
Operation: write
Entities: reference type, budget, budget detail
Summary: The 'Create a budget' API allows users to create a budget in QuickBooks Online. The API requires a POST request to the specified endpoint with a JSON body containing the budget details. The request body must include the start and end dates of the budget, and optionally, the budget entry type, name, budget type, and budget details. Each budget detail can include an amount, account reference, customer reference, and budget date. The response returns the created budget details, including metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a category

ID: post_create_category
Operation: write
Entities: category, parent, sub-category
Summary: The 'Create a category' API allows users to create a new category in QuickBooks. The request requires a JSON body with the category's name, type, and optionally, whether it is a sub-category and its parent reference. The API endpoint is invoked with a minor version of 4 to ensure the type is set to 'Category'. The response returns the newly created category object, including its unique ID, name, type, and metadata such as creation and last updated times. This API is only available for companies that have enabled categories.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Credit Card Payment

ID: post_create_credit_card_payment
Operation: write
Entities: credit card account, credit card payment, bank account
Summary: This API endpoint allows you to create a Credit Card Payment in QuickBooks. The request requires a transaction date, amount, and references to both a bank account and a credit card account. Optionally, a private note can be included. The response returns the details of the created credit card payment, including transaction ID, amount, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Credit Memo

ID: post_create_credit_memo
Operation: write
Entities: credit memo, reference, line item
Summary: The 'Create a Credit Memo' API allows users to create a credit memo in QuickBooks for a specified company. The API requires a POST request to the endpoint with the company realm ID. The request body must include at least one line item with details such as the detail type, amount, and item reference. Additionally, a customer reference is required. The API returns a credit memo object containing details such as document number, balance, billing and shipping addresses, transaction date, total amount, and line items. Optional fields include project reference, currency reference, and various line item details like discount amount, tax code reference, and service date.