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.
Input Fields: Input Fields
Output Fields: Output Fields

Create a customer

ID: post_create_customer
Operation: write
Entities: address, name, customer
Summary: This API endpoint allows the creation of a new customer in the QuickBooks system. The request must include a unique DisplayName or at least one of the following attributes: Title, GivenName, MiddleName, FamilyName, or Suffix. The request body can also include additional customer details such as email address, phone number, company name, and billing address. The response returns the newly created Customer object, including details like the customer's ID, display name, email address, and metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Employee

ID: post_create_employee
Operation: write
Entities: address, phone, employee
Summary: The 'Create an Employee' API allows you to create a new employee in the QuickBooks system. The API requires a POST request to the specified endpoint with the realm ID of the company. The request body should include details such as the given name, family name, social security number, primary address, and primary phone number of the employee. The primary address includes fields like country subdivision code, city, postal code, and address lines. The response returns the newly created employee object, including details like display name, primary phone, family name, social security number, primary address, and metadata such as creation and last updated time.
Input Fields: Input Fields
Output Fields: Output Fields

Create an estimate

ID: post_create_estimate
Operation: write
Entities: line item, estimate, customer
Summary: The 'Create an estimate' API allows users to create an estimate in QuickBooks. An estimate must include at least one line item and a reference to a customer. If shipping and billing addresses are not provided, the address from the referenced Customer object is used. The request body must include details such as total amount, billing email, customer memo, shipping and billing addresses, line items, customer reference, transaction tax details, and whether to apply tax after discount. The response includes the estimate details such as document number, transaction status, billing email, transaction date, total amount, customer reference, customer memo, shipping and billing addresses, line items, and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Inventory Adjustment

ID: post_create_inventory_adjustment
Operation: write
Entities: account, inventory adjustment, item
Summary: This API creates a new inventory adjustment in QuickBooks. It requires the AdjustAccountRef to specify which account is debited, and Line items to detail the inventory adjustment. The request can include optional fields such as DocNumber, PrivateNote, and TxnDate. The response returns the newly created inventory adjustment object, including details like DocNumber, TxnDate, and AdjustAccountRef.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Invoice

ID: post_create_invoice
Operation: write
Entities: line item, invoice, customer
Summary: The Create an Invoice API allows you to create an invoice in QuickBooks. The request requires a CustomerRef element and at least one Line item, which can be a SalesItemLine, GroupLine, or DescriptionOnlyLine. The CustomerRef must include a value, which is the ID of the customer. The Line item must include a DetailType and an Amount. The API returns the created invoice details, including transaction date, total amount, line items, due date, customer reference, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Create an item

ID: post_create_item
Operation: write
Entities: account, item, inventory
Summary: This API endpoint allows the creation of an item in QuickBooks. The request requires a unique item name and optionally includes details such as quantity on hand, income account reference, asset account reference, inventory start date, item type, and expense account reference. The response returns the newly created item object with details such as the item's fully qualified name, domain, ID, name, tracking status, unit price, purchase cost, quantity on hand, account references, taxability, activity status, sync token, inventory start date, type, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Journal Entry

ID: post_create_journal_entry
Operation: write
Entities: journal code, line item, journal entry
Summary: The Create a Journal Entry API allows you to create a journal entry in QuickBooks. A journal entry must have at least two line items: one for the debit side and one for the credit side. Each line item must have a JournalEntryLineDetail with a PostingType of either Debit or Credit, and an AccountRef specifying the account. The DetailType must be set to JournalEntryLineDetail. The Amount is required for each line item. Optionally, you can include a Description and an Id for updates. The API returns the created journal entry with details such as SyncToken, domain, TxnDate, Line items, and MetaData.
Input Fields: Input Fields
Output Fields: Output Fields

Create a journalcode

ID: post_create_journalcode
Operation: write
Entities: journal code, company
Summary: The 'Create a journalcode' API allows you to create a new journal code object in the QuickBooks system. The API requires a POST request to the endpoint with the realm ID of the company. The request body must include the 'Name' and 'Type' of the journal code. The 'Name' should be a string between 2 to 20 characters. The response returns the newly created journal code object, including details such as 'SyncToken', 'domain', 'Name', 'sparse', 'time', 'Active', 'MetaData', 'Type', 'Id', and 'Description'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a note attachment

ID: post_create_note_attachment
Operation: write
Entities: note, attachment, target object
Summary: This API endpoint allows you to attach a note to a specified object in QuickBooks. The request requires a note and optionally a file name for attachments. The AttachableRef element specifies the transaction object to which the note is linked. The response includes details of the attachable, such as its ID, synchronization token, and metadata. The API is useful for linking notes to invoices, bills, or other transaction objects in QuickBooks.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Payment Method

ID: post_create_payment_method
Operation: write
Entities: metadata, payment method, company
Summary: This API creates a new payment method for a company in QuickBooks. The request requires a 'Name' parameter in the body, which is a user recognizable name for the payment method with a maximum of 31 characters. The 'realmID' path parameter is required to specify the company. The API returns the newly created payment method object, including details such as SyncToken, domain, Name, sparse status, Active status, Type, Id, and MetaData with creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a project estimate

ID: post_create_project_estimate
Operation: write
Entities: project estimate, project, line item
Summary: The 'Create a project estimate' API allows US companies with Advanced SKU to create a project estimate in QuickBooks Online. The API requires a minor version of 73 and a reference to a project. The request body must include at least one line item with details such as Cost Amount and Home Cost Amount. The API accepts various optional parameters like BillEmail, CustomerMemo, ShipAddr, and more. The response includes details of the created estimate, including transaction date, currency reference, line items, and more. The API is designed to handle multicurrency transactions and provides detailed information about the estimate created.
Input Fields: Input Fields
Output Fields: Output Fields

Create a purchase order

ID: post_create_purchase_order
Operation: write
Entities: purchase order, line item, vendor
Summary: This API endpoint allows you to create a purchase order in QuickBooks. The request requires a JSON body with details such as the total amount, line items, accounts payable reference, vendor reference, and shipping information. Each line item must include details like the item reference, customer reference, quantity, tax code, billable status, and unit price. The response returns the created purchase order with details like document number, vendor reference, transaction date, total amount, and line items. It also includes metadata such as creation and last updated time.
Input Fields: Input Fields
Output Fields: Output Fields

Create a recurring transaction

ID: post_create_recurring_transaction
Operation: write
Entities: recurring transaction, invoice, schedule
Summary: This API creates a recurring transaction in QuickBooks. The request requires a RecurringTransaction object with at least one line describing an item and a DepositToAccountRef. The request body includes details such as invoice information, customer reference, recurring schedule information, and more. The response returns the created RecurringTransaction object with details like invoice ID, total amount, customer reference, and recurring schedule information. Note that TaxCode.CustomSalesTax cannot be used as TxnTaxCodeRef.
Input Fields: Input Fields
Output Fields: Output Fields

Create a refund receipt

ID: post_create_refund_receipt
Operation: write
Entities: refund receipt, account, line item
Summary: The 'Create a refund receipt' API allows users to create a RefundReceipt object in QuickBooks. The request requires a minimum of one line item and a DepositToAccountRef. The line item can be of type SalesItemLine or GroupLine. The DepositToAccountRef specifies the account from which the refund is made. The API supports multicurrency transactions if enabled for the company. The response includes details of the created RefundReceipt, such as document number, transaction date, total amount, and line items. The API does not support transactions using TaxCode.CustomSalesTax.
Input Fields: Input Fields
Output Fields: Output Fields

Create a SalesReceipt

ID: post_create_salesreceipt
Operation: write
Entities: sales receipt, line item, currency
Summary: The Create a SalesReceipt API allows you to create a sales receipt in QuickBooks. The request requires a minimum of one line item, which can be either a SalesItemLine or GroupLine. Each line item must include details such as Description, DetailType, and Amount. The API supports multicurrency transactions, requiring a CurrencyRef if multicurrency is enabled. The response returns a SalesReceipt object with details such as DocNumber, TotalAmt, and Line items, along with metadata like CreateTime and LastUpdatedTime.
Input Fields: Input Fields
Output Fields: Output Fields

Create a TaxAgency

ID: post_create_taxagency
Operation: write
Entities: tax agency
Summary: This API creates a new TaxAgency object in the QuickBooks system. The request must include the 'DisplayName' attribute in the body, which is the name of the agency and is required with a maximum of 100 characters. The API endpoint requires a 'realmID' path parameter to specify the company. The response returns the newly created TaxAgency object, including details such as 'SyncToken', 'domain', 'DisplayName', 'TaxTrackedOnSales', 'TaxTrackedOnPurchases', 'sparse', 'Id', and 'MetaData' with 'CreateTime' and 'LastUpdatedTime'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a taxservice

ID: post_create_taxservice
Operation: write
Entities: tax service, tax rate detail, tax code
Summary: This API endpoint allows the creation of a new taxservice object in QuickBooks. The request requires a TaxCode and a list of TaxRateDetails, each specifying details such as RateValue, TaxRateId, TaxAgencyId, TaxRateName, and TaxApplicableOn. The TaxCode is a string with a maximum of 100 characters. TaxRateDetails is an array where each item can specify a RateValue (percentage as a string), TaxRateId, TaxAgencyId, TaxRateName (maximum 10 characters), and TaxApplicableOn (either 'Sales' or 'Purchase'). The response returns the newly created taxservice object, including the TaxCodeId and details of the tax rates.
Input Fields: Input Fields
Output Fields: Output Fields

Create a TimeActivity Object

ID: post_create_timeactivity_object
Operation: write
Entities: vendor, time activity, employee
Summary: This API creates a TimeActivity object in QuickBooks. The request requires a JSON body with details such as the transaction date (TxnDate), start and end times (StartTime, EndTime), and references to the employee (EmployeeRef) and the type of time activity (NameOf). The response returns the created TimeActivity object with details like the transaction date, employee reference, start and end times, and metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Transfer

ID: post_create_transfer
Operation: write
Entities: account, transfer, transaction
Summary: This API creates a transfer in QuickBooks by specifying the amount, the account to transfer funds to, and the account to transfer funds from. The request requires the amount of the transaction and references to the asset accounts involved, identified by their IDs and optionally their names. The response includes details of the created transfer, such as the transaction date, amount, account references, and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create a vendor

ID: post_create_vendor
Operation: write
Entities: vendor, customer, employee
Summary: The 'Create a vendor' API allows you to create a new vendor in the QuickBooks system. The API requires either the 'DisplayName' attribute or at least one of 'Title', 'GivenName', 'MiddleName', 'FamilyName', or 'Suffix' attributes to be provided in the request body. The request body can include additional information such as email address, web address, phone numbers, company name, billing address, and tax identifier. The API returns the newly created vendor object, including details such as the vendor's display name, contact information, billing address, and metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Vendor Credit

ID: post_create_vendor_credit
Operation: write
Entities: vendor credit, vendor, line item
Summary: This API creates a Vendor Credit in QuickBooks. The request requires a VendorRef attribute and at least one Line with Line.Amount specified. The request body must include the total amount (TotalAmt), transaction date (TxnDate), line items (Line), accounts payable reference (APAccountRef), and vendor reference (VendorRef). The response returns the created Vendor Credit object with details such as SyncToken, domain, transaction date, total amount, accounts payable reference, line items, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a bill

ID: post_delete_a_bill
Operation: write
Entities: bill, transaction
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

Delete a billpayment

ID: post_delete_a_billpayment
Operation: write
Entities: account, bill payment, vendor
Summary: This API operation deletes a specified billpayment object in QuickBooks Online. The request requires the unique identifier 'Id' and the 'SyncToken' of the billpayment object in the request body. The 'Id' is a unique identifier for the billpayment, and the 'SyncToken' is used to ensure that the object is not modified by another application during the delete operation. The response returns the status of the billpayment as 'Deleted', along with the domain and ID of the deleted billpayment, and the time the operation was performed.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a budget

ID: post_delete_a_budget
Operation: write
Entities: reference, budget, budget detail
Summary: This API operation deletes a budget object specified in the request body. The request body must include at least the budget's Id and SyncToken. The Id is a unique identifier for the budget object, and the SyncToken is a version number used to ensure that only the latest version of the object is modified. Optional fields include EndDate, StartDate, BudgetEntryType, Name, BudgetDetail, BudgetType, Active, and MetaData. The response returns the time when the budget was deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a deposit

ID: post_delete_a_deposit
Operation: write
Entities: deposit, account, line item
Summary: This API operation deletes a Deposit object specified in the request body. The request body must include the full payload of the deposit as returned in a read response. The required fields in the request body are 'SyncToken', which is the version number of the object, and 'Id', which is the unique identifier for the deposit. Upon successful deletion, the API returns a response indicating the status of the deposit as 'Deleted', along with the domain and Id of the deposit, and a timestamp of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a purchase

ID: post_delete_a_purchase
Operation: write
Entities: purchase
Summary: This API operation deletes a Purchase object in QuickBooks Online. The request must include the Purchase.Id and Purchase.SyncToken in the request body. The SyncToken is a version number used to lock the object for use by one app at a time. The API endpoint is a POST request to the URL https://quickbooks.api.intuit.com/v3/company//purchase?operation=delete. The response returns the status of the purchase deletion, the domain, the purchase ID, and the time of deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a refund receipt

ID: post_delete_a_refund_receipt
Operation: write
Entities: refund receipt, transaction
Summary: This API operation deletes a RefundReceipt object specified in the request body. The request must include the RefundReceipt.Id and RefundReceipt.SyncToken. Before deleting, any linked transactions associated with the RefundReceipt must be unlinked. The API endpoint is a POST request to the URL https://quickbooks.api.intuit.com/v3/company//refundreceipt with a query parameter 'operation=delete'. The request body requires 'SyncToken' and 'Id' as mandatory fields. The response returns the status of the refund receipt as 'Deleted', along with the domain and ID of the refund receipt, and the time of deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a SalesReceipt

ID: post_delete_a_salesreceipt
Operation: write
Entities: sales receipt
Summary: This API deletes a SalesReceipt object in QuickBooks Online. The request requires the SalesReceipt's Id and SyncToken in the body to ensure the correct object is deleted. The SyncToken is used to lock the object for use by one app at a time, and it must be the latest version. The response confirms the deletion with the status, domain, and Id of the SalesReceipt, along with the timestamp of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an attachable

ID: post_delete_an_attachable
Operation: write
Entities: attachable, custom field, metadata
Summary: This API operation deletes an attachable object specified in the request body. The request body must include the full payload of the attachable as returned in a read response. The key parameters include 'SyncToken' which is required for update operations, 'Id' which is the unique identifier for the entity, and 'Note' which is related to the attachment. The response returns the status of the attachable object, confirming its deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an estimate

ID: post_delete_an_estimate
Operation: write
Entities: address, estimate, customer
Summary: This API operation deletes an estimate object specified in the request body. The request must include the Estimate.Id and Estimate.SyncToken in the body. The API endpoint is a POST request to the QuickBooks API with the operation set to delete. The response returns the status of the estimate as 'Deleted', along with the domain and ID of the estimate, and the time of deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a credit memo

ID: post_delete_credit_memo
Operation: write
Entities: credit memo, sync token
Summary: This API operation deletes a specified credit memo object in QuickBooks Online. The request requires a minimum of the CreditMemo.Id and CreditMemo.SyncToken in the request body. The SyncToken is used to ensure that only the latest version of the object is modified. The API returns a response indicating the status of the credit memo after deletion, along with a timestamp of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a CreditCardPayment

ID: post_delete_creditcardpayment
Operation: write
Entities: vendor, credit card payment, bank account
Summary: This API operation deletes a specified CreditCardPayment object in QuickBooks. The request requires the full payload of the CreditCardPayment object, including its unique Id, CreditCardAccountRef, Amount, BankAccountRef, and SyncToken. Optional fields include PrivateNote, VendorRef, TxnDate, Memo, PrintStatus, CheckNum, and MetaData. The response confirms the deletion with the status, domain, and Id of the deleted transaction, along with the timestamp of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Inventory Adjustment

ID: post_delete_inventory_adjustment
Operation: write
Entities: account, inventory adjustment, item
Summary: The 'Delete an Inventory Adjustment' API allows users to delete a specified inventory adjustment object in QuickBooks. The request must include the InventoryAdjustment.Id and InventoryAdjustment.SyncToken in the request body. The API endpoint is a POST request to the URL 'https://quickbooks.api.intuit.com/v3/company//inventoryadjustment?minorversion=&operation=delete'. The request body requires the 'SyncToken' and 'Id' of the inventory adjustment to be deleted. The response returns the status of the deletion, the domain, and the ID of the deleted inventory adjustment, along with the time of deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Invoice

ID: post_delete_invoice
Operation: write
Entities: invoice, transaction
Summary: This API operation deletes an invoice object specified in the request body. The request must include the Invoice.Id and Invoice.SyncToken in the body. Before deleting, any linked transactions associated with the invoice must be unlinked. The API endpoint is a POST request to the URL https://quickbooks.api.intuit.com/v3/company//invoice?operation=delete. The request body must contain the SyncToken and Id of the invoice. The response returns the status of the invoice as 'Deleted', along with the domain and Id of the invoice, and the time of deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a JournalEntry

ID: post_delete_journalentry
Operation: write
Entities: JournalEntry
Summary: This API deletes a JournalEntry object in QuickBooks Online. The request requires the JournalEntry's unique identifier (Id) and the SyncToken, which is a version number used to ensure that only the latest version of the object is modified. The API endpoint is a POST request to the specified URL with the operation set to 'delete'. The response confirms the deletion with the status 'Deleted' and includes the time of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a payment

ID: post_delete_payment
Operation: write
Entities: account, payment, customer
Summary: This API operation deletes a specified Payment object in QuickBooks Online. The request must include the Payment.Id and Payment.SyncToken in the request body. The API endpoint is a POST request to the URL https://quickbooks.api.intuit.com/v3/company//payment?operation=delete. The request body must contain the unique identifier (Id) and the version number (SyncToken) of the payment object to be deleted. The response returns the status of the deletion, the domain, and the Id of the deleted payment, along with the timestamp of the deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a purchase order

ID: post_delete_purchase_order
Operation: write
Entities: purchase order, transaction
Summary: This API operation deletes a specified purchase order object in QuickBooks Online. The request must include the purchase order's unique identifier (Id) and the SyncToken, which is used to ensure that the object is not modified by another application during the deletion process. The API endpoint requires the realm ID of the company and the operation query parameter set to 'delete'. Upon successful deletion, the response returns the status of the purchase order as 'Deleted', along with the domain and the time of deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a recurring transaction

ID: post_delete_recurring_transaction
Operation: write
Entities: recurring transaction, transaction, schedule
Summary: This API operation deletes a specified RecurringTransaction object. The request body must include at least the RecurringTransaction.Id and RefundReceipt.SyncToken. Before deletion, any linked transactions associated with the RecurringTransaction object must be unlinked. The API endpoint is a POST request to the QuickBooks API with the operation set to delete. The response confirms the deletion with the status 'Deleted' and includes the ID of the deleted transaction.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a TimeActivity Object

ID: post_delete_timeactivity_object
Operation: write
Entities: vendor, time activity, employee
Summary: This API operation deletes a specified TimeActivity object in QuickBooks Online. The request requires the unique identifier 'Id' and the 'SyncToken' of the TimeActivity object in the request body. The 'Id' is a unique identifier for the object, and the 'SyncToken' is a version number used to ensure that the object is not being modified by another application at the same time. The response returns the status of the deletion operation, the domain, and the unique identifier of the deleted TimeActivity object, along with a timestamp of when the deletion occurred.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Transfer

ID: post_delete_transfer
Operation: write
Entities: account, transfer, transaction
Summary: This API operation deletes a Transfer object specified in the request body. The request body must include the full payload of the transfer as returned in a read response. The required fields in the request body include SyncToken, domain, ToAccountRef, Amount, Id, and FromAccountRef. Optional fields include TxnDate, sparse, and account names. The response returns the status of the transfer deletion, the domain, and the unique identifier of the transfer, along with the time of deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a VendorCredit

ID: post_delete_vendorcredit
Operation: write
Entities: vendor credit, sync token, id
Summary: This API operation deletes a specified VendorCredit object in QuickBooks Online. The request must include the VendorCredit's Id and SyncToken in the request body. The SyncToken is used to ensure that only the latest version of the object is modified. The API returns a response indicating the status of the VendorCredit after deletion, along with a timestamp of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a bill

ID: post_full_update_a_bill
Operation: write
Entities: vendor, line item, bill
Summary: This API operation allows for the full update of an existing bill object in QuickBooks. It requires the inclusion of all writable fields in the request body, as any omitted fields will be set to NULL. The bill's unique identifier is specified in the request body. The API endpoint is a POST request to the URL https://quickbooks.api.intuit.com/v3/company//bill. The request body includes fields such as DocNumber, SyncToken, APAccountRef, VendorRef, TxnDate, TotalAmt, CurrencyRef, PrivateNote, SalesTermRef, DepartmentRef, DueDate, sparse, Line items, Balance, Id, and MetaData. The response returns the updated bill object with fields like DocNumber, SyncToken, domain, APAccountRef, VendorRef, TxnDate, TotalAmt, CurrencyRef, PrivateNote, SalesTermRef, DepartmentRef, DueDate, sparse, Line items, Balance, Id, and MetaData, along with the response time.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a billpayment

ID: post_full_update_a_billpayment
Operation: write
Entities: account, bill payment, vendor
Summary: This API is used to update any of the writable fields of an existing billpayment object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires a POST request to the specified endpoint with the realm ID in the path. The request body includes fields such as SyncToken, VendorRef, TxnDate, TotalAmt, PayType, and more. The response returns the updated billpayment object with fields like SyncToken, VendorRef, TxnDate, TotalAmt, and others, along with metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a budget

ID: post_full_update_a_budget
Operation: write
Entities: reference type, budget, budget detail
Summary: This API is used to fully update a budget in QuickBooks Online. It allows updating any writable fields of an existing budget object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the 'Id' and 'SyncToken' fields for concurrency control. Other fields such as 'EndDate', 'StartDate', 'BudgetEntryType', 'Name', 'BudgetType', 'Active', and 'BudgetDetail' can be optionally included. The 'BudgetDetail' field is an array containing details like 'Amount', 'AccountRef', 'CustomerRef', and 'BudgetDate'. The API returns the updated budget object in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a class

ID: post_full_update_a_class
Operation: write
Entities: reference, class, metadata
Summary: This API is used to update any of the writable fields of an existing class object in QuickBooks Online. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the 'Id', 'Name', and 'SyncToken' fields to be provided. Optionally, 'ParentRef', 'SubClass', 'Active', and 'MetaData' can also be included. The response returns the updated class object with its metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a customer

ID: post_full_update_a_customer
Operation: write
Entities: phone number, address, customer
Summary: This API operation allows for the full update of a customer in QuickBooks Online. It updates any writable fields of an existing Customer object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API also supports a query parameter to automatically update the AR account on historical transactions for this customer. The request body includes fields such as DisplayName, PrimaryEmailAddr, PreferredDeliveryMethod, and more. The response returns the updated Customer object with fields like domain, DisplayName, PrimaryEmailAddr, and more, along with metadata such as CreateTime and LastUpdatedTime.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a department

ID: post_full_update_a_department
Operation: write
Entities: parent, department, metadata
Summary: This API is used to update any of the writable fields of an existing Department object in QuickBooks Online. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the 'Id', 'Name', and 'SyncToken' fields to be provided in the request body. Optionally, 'ParentRef', 'Active', and 'MetaData' can also be included. The response returns the updated Department object with its metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a deposit

ID: post_full_update_a_deposit
Operation: write
Entities: deposit, account, line item
Summary: This API operation allows for the full update of a deposit object in QuickBooks. It requires the inclusion of all writable fields in the request body, as any omitted fields will be set to NULL. The request body must include the unique identifier (Id) of the deposit object to be updated, along with other required fields such as SyncToken, DepositToAccountRef, and Line items. The response returns the updated deposit object with details such as SyncToken, DepositToAccountRef, TxnDate, TotalAmt, and MetaData. This operation is essential for maintaining accurate and up-to-date deposit records in QuickBooks.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a payment

ID: post_full_update_a_payment
Operation: write
Entities: project, payment, customer
Summary: This API operation allows you to update any of the writable fields of an existing Payment object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires a SyncToken for concurrency control and supports various references such as PaymentMethodRef, ProjectRef, and CustomerRef. The response includes the updated Payment object with details such as SyncToken, domain, PaymentMethodRef, UnappliedAmt, TxnDate, TotalAmt, ProjectRef, PaymentRefNum, Line items, CustomerRef, Id, and MetaData.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a purchase

ID: post_full_update_a_purchase
Operation: write
Entities: account, line item, purchase
Summary: This API operation allows for the full update of a purchase object in QuickBooks. It requires the inclusion of all writable fields in the request body, as any omitted fields will be set to NULL. The request must specify the unique ID of the purchase object to be updated. The request body includes fields such as SyncToken, domain, PurchaseEx, TxnDate, TotalAmt, PrivateNote, PaymentType, Line items, AccountRef, CustomField, and MetaData. The response returns the updated purchase object with fields like SyncToken, domain, PurchaseEx, TxnDate, TotalAmt, PrivateNote, PaymentType, Line items, AccountRef, CustomField, Id, and MetaData, along with the time of the response.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a refund receipt

ID: post_full_update_a_refund_receipt
Operation: write
Entities: account, refund receipt, currency
Summary: This API operation allows you to update any writable fields of an existing RefundReceipt object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API endpoint is POST /v3/company//refundreceipt. The request body includes various fields such as TxnDate, domain, PrintStatus, TotalAmt, Line items, and more. The response returns the updated RefundReceipt object with details such as transaction date, total amount, line items, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a salesreceipt

ID: post_full_update_a_salesreceipt
Operation: write
Entities: sales receipt, line item, customer
Summary: This API is used to fully update a SalesReceipt object in QuickBooks. It allows updating any writable fields of an existing SalesReceipt. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires a POST request to the endpoint with the realmID of the QuickBooks company. The request body includes various fields such as TxnDate, domain, PrintStatus, PaymentRefNum, TotalAmt, Line items, ApplyTaxAfterDiscount, DocNumber, sparse, DepositToAccountRef, CustomerMemo, ProjectRef, Balance, CustomerRef, TxnTaxDetail, SyncToken, PaymentMethodRef, EmailStatus, BillAddr, MetaData, CustomField, and Id. The response returns the updated SalesReceipt object with details such as TxnDate, domain, PrintStatus, PaymentRefNum, TotalAmt, Line items, ApplyTaxAfterDiscount, DocNumber, sparse, DepositToAccountRef, CustomerMemo, ProjectRef, Balance, CustomerRef, TxnTaxDetail, SyncToken, PaymentMethodRef, EmailStatus, BillAddr, MetaData, CustomField, and Id, along with the time of the response.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a term

ID: post_full_update_a_term
Operation: write
Entities: term, payment
Summary: This API is used to update any of the writable fields of an existing Term object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the realm ID as a path parameter and the request body must include fields such as SyncToken, domain, Name, DiscountPercent, DiscountDays, Type, sparse, Active, DueDays, Id, and MetaData. The response returns the updated Term object along with the time of the response.
Input Fields: Input Fields
Output Fields: Output Fields

Full update an account

ID: post_full_update_an_account
Operation: write
Entities: account, currency, tax code
Summary: This API operation allows for the full update of an existing account object in QuickBooks Online. It requires the inclusion of all writable fields in the request body, as any omitted fields will be set to NULL. The request body must include the account's unique ID, name, and sync token, among other optional fields such as account number, currency reference, parent reference, description, and more. The response returns the updated account details, including its fully qualified name, classification, account type, and current balance, along with metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Full update an attachable

ID: post_full_update_an_attachable
Operation: write
Entities: reference type, attachable, custom field
Summary: This API operation allows you to update any of the writable fields of an existing attachable object in QuickBooks Online. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. Key fields include 'Id', 'SyncToken', 'FileName', 'Note', 'Category', 'ContentType', 'PlaceName', 'AttachableRef', 'CustomField', and 'MetaData'. The response returns the updated attachable object with its metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Full update an estimate

ID: post_full_update_an_estimate
Operation: write
Entities: address, estimate, customer
Summary: This API is used to fully update an existing estimate object in QuickBooks. It allows updating any writable fields of the estimate. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the 'Content-Type' header to be set to 'application/json'. The request body includes fields such as 'Id', 'SyncToken', 'CustomerRef', 'ProjectRef', 'BillEmail', 'TxnDate', 'ShipDate', 'ClassRef', 'PrintStatus', 'CustomField', 'SalesTermRef', 'TxnStatus', 'LinkedTxn', 'GlobalTaxCalculation', 'AcceptedDate', 'ExpirationDate', 'TransactionLocationType', 'DueDate', 'MetaData', 'DocNumber', 'PrivateNote', 'Line', 'CustomerMemo', 'EmailStatus', 'TxnTaxDetail', 'AcceptedBy', 'ExchangeRate', 'ShipAddr', and 'BillAddr'. The response includes the updated estimate object with fields such as 'TxnDate', 'domain', 'PrintStatus', 'TxnStatus', 'TotalAmt', 'Line', 'ApplyTaxAfterDiscount', 'DocNumber', 'sparse', 'CustomerMemo', 'ProjectRef', 'CustomerRef', 'TxnTaxDetail', 'SyncToken', 'LinkedTxn', 'CustomField', 'ShipAddr', 'EmailStatus', 'BillAddr', 'MetaData', 'BillEmail', and 'Id'.
Input Fields: Input Fields
Output Fields: Output Fields

Full update an invoice

ID: post_full_update_an_invoice
Operation: write
Entities: line item, invoice, customer
Summary: This API is used to fully update an existing invoice in QuickBooks. It allows updating any writable fields of an invoice object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires specifying the transaction date, domain, print status, total amount, line items, due date, document number, customer memo, project reference, balance, customer reference, tax details, sync token, shipping and billing addresses, metadata, and custom fields. The response returns the updated invoice object with all specified fields.
Input Fields: Input Fields
Output Fields: Output Fields

Full update an item

ID: post_full_update_an_item
Operation: write
Entities: account, vendor, item
Summary: This API operation allows for the full update of an existing item object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API supports query parameters to suppress updating the income or expense account on any existing transactions associated with this Item object. Updates on soft closed transactions will fail. The request body includes fields such as Id, Name, Type, SyncToken, and various account references. The response returns the updated item object with fields like FullyQualifiedName, domain, Id, Name, and more, along with the time the response was generated.
Input Fields: Input Fields
Output Fields: Output Fields

Full Update Company Info

ID: post_full_update_company_info
Operation: write
Entities: address, company info, metadata
Summary: This API is used to perform a full update on the company information in QuickBooks Online. It allows updating any writable fields of the companyinfo object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires a SyncToken for concurrency control. The response includes the updated company information and the time the response was generated.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a credit memo

ID: post_full_update_credit_memo
Operation: write
Entities: credit memo, line item, customer
Summary: This API is used to fully update a credit memo in QuickBooks. It allows updating any writable fields of an existing credit memo object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the realm ID as a path parameter and the content type as a header. The request body includes various fields such as TxnDate, domain, PrintStatus, TotalAmt, RemainingCredit, Line items, ApplyTaxAfterDiscount, DocNumber, sparse, CustomerMemo, ProjectRef, Balance, CustomerRef, TxnTaxDetail, SyncToken, CustomField, ShipAddr, EmailStatus, BillAddr, MetaData, BillEmail, and Id. The response returns the updated credit memo object with fields like TxnDate, domain, PrintStatus, TotalAmt, RemainingCredit, Line items, ApplyTaxAfterDiscount, DocNumber, sparse, CustomerMemo, ProjectRef, Balance, CustomerRef, TxnTaxDetail, SyncToken, CustomField, ShipAddr, EmailStatus, BillAddr, MetaData, BillEmail, and Id, along with the response time.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a creditcardpayment

ID: post_full_update_creditcardpayment
Operation: write
Entities: credit card account, credit card payment, bank account
Summary: This API is used to fully update an existing CreditCardPayment object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The main fields include TxnDate (date of transaction), Amount (total payment amount), BankAccountRef (reference to the bank account used for payment), CreditCardAccountRef (reference to the credit card account), PrivateNote (optional note about the transaction), Id (ID of the object to update), and SyncToken (sync token for the object). The response returns the updated CreditCardPayment transaction object with details such as SyncToken, domain, references to accounts, transaction date, currency, private note, amount, and metadata including creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Full update an employee

ID: post_full_update_employee
Operation: write
Entities: phone number, address, employee
Summary: This API operation allows for the full update of an existing employee object in QuickBooks. It requires the inclusion of all writable fields in the request body, as any omitted fields will be set to NULL. The request body must include the unique identifier 'Id' and 'SyncToken' for the object. The API supports updating various employee details such as DisplayName, PrimaryPhone, Address, and more. The response returns the updated Employee object with the latest SyncToken and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a journalentry

ID: post_full_update_journalentry
Operation: write
Entities: currency, journal entry, line
Summary: This API is used to fully update a JournalEntry object in QuickBooks. It allows updating any writable fields of an existing JournalEntry, including all lines. The request body must include all writable fields of the existing object, and any omitted fields are set to NULL. The ID of the object to update is specified in the request body. The API requires a SyncToken for concurrency control and supports multicurrency transactions. The response includes the updated JournalEntry object with details such as SyncToken, domain, transaction date, line items, and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Full update on a transfer

ID: post_full_update_on_a_transfer
Operation: write
Entities: account, transfer, transaction
Summary: This API is used to fully update an existing Transfer object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the realmID as a path parameter and the content type as a header. The request body includes fields such as SyncToken, domain, TxnDate, ToAccountRef, Amount, sparse, Id, FromAccountRef, and MetaData. The response returns the updated Transfer object with fields like SyncToken, domain, TxnDate, ToAccountRef, Amount, sparse, Id, FromAccountRef, MetaData, and the time the response was generated.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a payment method

ID: post_full_update_payment_method
Operation: write
Entities: sync token, payment method, metadata
Summary: This API allows you to update any of the writable fields of an existing payment method object in QuickBooks. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires the 'SyncToken' to ensure that only the latest version of the object is modified. The response returns the updated payment method object with its metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Full Update Preferences

ID: post_full_update_preferences
Operation: write
Entities: preference, product and service, email message
Summary: The Full Update Preferences API allows you to update any writable preference fields for a QuickBooks Online company. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL or reverted to a default value. The ID of the object to update is specified in the request body. The API endpoint is POST /v3/company//preferences, and it requires a Content-Type header of application/json. The request body includes fields such as Id, SyncToken, sparse, ProductAndServicesPrefs, and SalesFormsPrefs. The response includes updated preferences such as EmailMessagesPrefs, ProductAndServicesPrefs, domain, SyncToken, and ReportPrefs.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a purchase order

ID: post_full_update_purchase_order
Operation: write
Entities: account, purchase order, vendor
Summary: This API operation allows for the full update of a purchase order in QuickBooks. It requires the inclusion of all writable fields in the request body, as any omitted fields will be set to NULL. The request body must include the unique identifier of the purchase order to be updated. Key fields include APAccountRef, VendorRef, Line items, and various optional fields such as POEmail, ShipAddr, and CustomField. The response returns the updated purchase order details, including metadata such as creation and last updated times.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a timeactivity object

ID: post_full_update_timeactivity_object
Operation: write
Entities: vendor, time activity, employee
Summary: This API operation allows you to update any of the writable fields of an existing TimeActivity object in QuickBooks Online. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires a POST request to the endpoint with the realm ID of the QuickBooks company. The request body includes fields such as Id, NameOf, SyncToken, TxnDate, and others, which are either required or conditionally required based on the context. The response returns the updated TimeActivity object with fields like TxnDate, domain, NameOf, Description, and more, along with metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a vendor

ID: post_full_update_vendor
Operation: write
Entities: address, contact info, vendor
Summary: This API is used to fully update a vendor in QuickBooks Online. It allows updating any writable fields of an existing vendor object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API also supports a query parameter to automatically update the AP account on historical transactions for this vendor. The request includes various fields such as Id, SyncToken, PrimaryEmailAddr, Vendor1099, GivenName, DisplayName, BillAddr, and more. The response returns the updated vendor object with fields like PrimaryEmailAddr, Vendor1099, GivenName, DisplayName, BillAddr, SyncToken, and more, along with metadata about the creation and last update times.
Input Fields: Input Fields
Output Fields: Output Fields

Full update a vendorcredit

ID: post_full_update_vendorcredit
Operation: write
Entities: vendor credit, account, line item
Summary: This API allows for the full update of a vendorcredit object in QuickBooks. It updates any writable fields of an existing vendorcredit object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body. The API requires a POST request to the specified endpoint with the realm ID in the path. The request body includes details such as SyncToken, domain, VendorRef, TxnDate, TotalAmt, APAccountRef, sparse, Line items, and MetaData. The response returns the updated vendorcredit object with details such as SyncToken, domain, VendorRef, TxnDate, TotalAmt, APAccountRef, sparse, Line items, and MetaData, along with the response time.
Input Fields: Input Fields
Output Fields: Output Fields

Sample Object Request

ID: post_sample_object_request
Operation: write
Entities: query response, batch item response, batch item request
Summary: The Sample Object Request API allows batch operations on various resources within a company account in QuickBooks. The API endpoint is POST/v3/company//account, where is the company ID. The request body contains an array of BatchItemRequest objects, each with a unique identifier (bId) and optional attributes such as operation, optionsData, Query, and resourceName. The operation attribute specifies the action to be performed, such as create, update, or delete. The response includes an array of BatchItemResponse objects, each corresponding to a request, with details of the operation's success or failure. Errors are returned as Fault objects with specific error messages and codes.
Input Fields: Input Fields
Output Fields: Output Fields

Send a Payment

ID: post_send_a_payment
Operation: write
Entities: project, payment, customer
Summary: The 'Send a Payment' API allows users to send a payment to a specified email address. The API requires the realm ID and payment ID as path parameters, and the email address to send the payment to as a query parameter. The request must include the 'Content-Type' header set to 'application/octet-stream'. The response includes detailed information about the payment, such as the synchronization 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