QuBe Sync: QuickBooks Desktop API for developers
Server Details
Build QuickBooks Desktop integrations: validated API requests and workflows, answers by webhook.
- Status
- Healthy
- Uptime
- 100.0% over the last 24 hours
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-06-18
- URL
- ChatGPT
- –
- Claude
- –
TDQS
Score is being calculated.
Available Tools
268 toolscreate_accountCreate accountRead-onlyIdempotentInspect
This message allows you to perform the same activities as a user does in the QB New Account form, which can be accessed in QB by selecting Lists->Chart of Accounts->Accounts->New. If you want the account to be a subaccount to an existing account, similar to using the SubAccount checkbox and selection list drop down in the New Account form, you use the parent_ref aggregate. Notice that the parent_ref can take either the parent account’s list_id or full_name.
The account_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), account_type (required), desc, is_active, +12 more. Returns: url, body, qbxml, method, +2 more
create_alertCreate alertRead-onlyIdempotentInspect
Builds a v2 alert.create request.
The alert_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: desc (required), owner_id (required), alert_tag (required), help_text (required), +9 more. Returns: url, body, qbxml, method, +2 more
create_ar_refund_credit_cardCreate AR refund credit cardRead-onlyIdempotentInspect
Adds a credit card refund transaction that is linked to one or more QuickBooks credit memo transactions. You can link the credit card refund to one or more of those credit transactions.
The ar_refund_credit_card_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: customer_ref (required), refund_applied_to_txn_add (required), memo, address, +12 more. Returns: url, body, qbxml, method, +2 more
create_billCreate billRead-onlyIdempotentInspect
Adds a bill: money the business owes a vendor, entered in accounts payable. vendor_ref is required. Expenses go in expense_line_add and items received in item_line_add. To bill a whole open purchase order, link it with link_to_txn_id.
The bill_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: vendor_ref (required), memo, due_date, txn_date, +16 more. Returns: url, body, qbxml, method, +2 more
create_billing_rateCreate billing rateRead-onlyIdempotentInspect
Adds a billing rate to the billing rate level list. After a billing rate is created, it can be assigned to an employee or vendor (VendorAdd/Mod, EmployeeAdd/Mod) via the BillingRateRef element in the appropriate request. Then, once the billing rate is assigned to an employee or vendor, if you use that employee or vendor in a time transaction (TimeTrackingAdd), then the billing rate will override the rate specified by the service item used in the time transaction.
The billing_rate_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), request_id, include_qbxml, fixed_billing_rate, +2 more. Returns: url, body, qbxml, method, +2 more
create_bill_payment_checkCreate bill payment checkRead-onlyIdempotentInspect
A BillPaymentCheckAdd request must include either payment_amount, set_credit, or discount_amount (or more than one of these). If none of these three is included, the SDK will return an error.
The bill_payment_check_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: bank_account_ref (required), payee_entity_ref (required), applied_to_txn_add (required), memo, +10 more. Returns: url, body, qbxml, method, +2 more
create_bill_payment_credit_cardCreate bill payment credit cardRead-onlyIdempotentInspect
A BillPaymentCreditCardAdd request must include either payment_amount, set_credit, or discount_amount (or more than one of these). If none of these three is included, the SDK will return an error.
The bill_payment_credit_card_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: payee_entity_ref (required), applied_to_txn_add (required), credit_card_account_ref (required), memo, +9 more. Returns: url, body, qbxml, method, +2 more
create_build_assemblyCreate build assemblyRead-onlyIdempotentInspect
Adds a build assembly transaction to QuickBooks, where the specified quantity of the specified inventory assembly item is built. If there are insufficient quantities of items required for the build, you can have the build marked as a pending build by using setting mark_pending_if_required to True. (If you don’t and theren’t enough quantities on hand for the build, this request will fail.) If successful, this request results in the decrementing of the quantities on hand amounts of each item used in the build, and the incrementing of the on hand quantities of the built assembly item.
The build_assembly_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: quantity_to_build (required), item_inventory_assembly_ref (required), memo, txn_date, +11 more. Returns: url, body, qbxml, method, +2 more
create_chargeCreate chargeRead-onlyIdempotentInspect
Adds a customer charge. A Charge contains information about a statement charge. (A CreditCardCharge object, on the other hand, refers to a credit card charge incurred by the QuickBooks user.)
The charge_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: customer_ref (required), desc, rate, amount, +18 more. Returns: url, body, qbxml, method, +2 more
create_checkCreate checkRead-onlyIdempotentInspect
The amount of a check is the total of the amounts assigned to expense lines and item lines. You can write a check for:
The check_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: account_ref (required), memo, address, txn_date, +15 more. Returns: url, body, qbxml, method, +2 more
create_classCreate classRead-onlyIdempotentInspect
Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
The class_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, parent_ref, request_id, +2 more. Returns: url, body, qbxml, method, +2 more
create_credit_card_chargeCreate credit card chargeRead-onlyIdempotentInspect
A credit card charge is a general charge incurred when a QuickBooks user makes a purchase using a credit card. Credit card charges for purchases can be tracked as expenses (in expense accounts) or as items.
The credit_card_charge_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: account_ref (required), memo, txn_date, def_macro, +12 more. Returns: url, body, qbxml, method, +2 more
create_credit_card_creditCreate credit card creditRead-onlyIdempotentInspect
If a QuickBooks user returns merchandise and receives credit, the credit is entered in QuickBooks and assigned to the appropriate expense account. Typically, the assigned expense account reflects the same account, customer, and class that were assigned when the merchandise was first purchased. (The original purchase would be described by a CreditCardCharge message.)
The credit_card_credit_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: account_ref (required), memo, txn_date, def_macro, +12 more. Returns: url, body, qbxml, method, +2 more
create_credit_memoCreate credit memoRead-onlyIdempotentInspect
Adds a credit memo: an amount the business owes a customer, for returned goods, an overpayment or a prepayment. It lowers the customer's balance, but isn't set against an invoice until a payment or the invoice applies it. customer_ref is required, and lines go in credit_memo_line_add. What a vendor owes the business is a vendor credit, not a credit memo.
The credit_memo_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: customer_ref (required), fob, memo, other, +31 more. Returns: url, body, qbxml, method, +2 more
create_currencyCreate currencyRead-onlyIdempotentInspect
Creates a user defined currency with the specified name and currency code, both of which will show up in the QuickBooks UI.
The currency_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), currency_code (required), is_active, request_id, +3 more. Returns: url, body, qbxml, method, +2 more
create_customerCreate customerRead-onlyIdempotentInspect
Adds a customer, or a job under one: set parent_ref to the customer and the job's full_name becomes Parent:Job. name is required. QuickBooks keeps customers, vendors, employees and other names in one name space, so a name any of them already uses fails with 3100 name_in_use. The ensure workflow template adds the customer only if it isn't there yet, and on a clash finds out what holds the name and asks.
The customer_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), cc, fax, email, +53 more. Returns: url, body, qbxml, method, +2 more
create_customer_msgCreate customer msgRead-onlyIdempotentInspect
Builds a v2 customer_msg.create request.
The customer_msg_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, request_id, include_qbxml, +1 more. Returns: url, body, qbxml, method, +2 more
create_customer_typeCreate customer typeRead-onlyIdempotentInspect
Builds a v2 customer_type.create request.
The customer_type_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, parent_ref, request_id, +2 more. Returns: url, body, qbxml, method, +2 more
create_data_extCreate data extRead-onlyIdempotentInspect
Writes data to one data extension. This request can only be invoked if a data extension definition has already been defined for the target object type. That is, before you can perform the DataExtAdd on a particular customer, say John Henry, the data extension must already be defined for the Customer object. Notice that a data extension definition can be defined in either of two ways: via DataExtDefAdd as already described, or via the QuickBooks UI by the user specifying a custom field. Only custom fields can be defined through the UI, not private data extensions.
The data_ext_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: owner_id (required), data_ext_name (required), data_ext_value (required), txn_id, +7 more. Returns: url, body, qbxml, method, +2 more
create_data_ext_defCreate data ext defRead-onlyIdempotentInspect
This request adds a data extension definition to the specified object type (e.g. Customer) so that extension data can be written to a particular object of that type (e.g., this customer, John Smith. A data extension definition must be created before data can be written to the data extension.
The data_ext_def_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: owner_id (required), data_ext_name (required), data_ext_type (required), request_id, +6 more. Returns: url, body, qbxml, method, +2 more
create_date_driven_termsCreate date driven termsRead-onlyIdempotentInspect
Date-driven terms show the day of the month by which payment is due and can include a discount for early payment. For example, the following date-driven term means that payment is due on the 30th of the month, with a 1% discount if payment is made by the 10th:
The date_driven_terms_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), day_of_month_due (required), is_active, request_id, +5 more. Returns: url, body, qbxml, method, +2 more
create_depositCreate depositRead-onlyIdempotentInspect
After you receive payments from customers (see ReceivePayment), you can use the DepositAdd request to either deposit each payment directly into a QuickBooks bank account or you can group payments together. You can also choose the method you prefer for depositing payments.
The deposit_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: deposit_to_account_ref (required), memo, txn_date, def_macro, +8 more. Returns: url, body, qbxml, method, +2 more
create_employeeCreate employeeRead-onlyIdempotentInspect
Adds an employee with personal data about the employee as well as certain payroll-related data.
The employee_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: fax, ssn, name, email, +47 more. Returns: url, body, qbxml, method, +2 more
create_estimateCreate estimateRead-onlyIdempotentInspect
Adds an estimate: a quote or bid for a sale proposed to a customer. An estimate doesn't post to any account. customer_ref is required, and lines go in estimate_line_add. QuickBooks users can turn an accepted estimate into an invoice, but the API can't link an invoice to an estimate.
The estimate_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: customer_ref (required), fob, memo, other, +24 more. Returns: url, body, qbxml, method, +2 more
create_inventory_adjustmentCreate inventory adjustmentRead-onlyIdempotentInspect
If the following conditions aren’t met, you will receive an error if you try to add an inventory adjustment through the SDK:
The inventory_adjustment_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: account_ref (required), inventory_adjustment_line_add (required), memo, txn_date, +9 more. Returns: url, body, qbxml, method, +2 more
create_inventory_siteCreate inventory siteRead-onlyIdempotentInspect
Builds a v2 inventory_site.create request.
The inventory_site_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), fax, email, phone, +8 more. Returns: url, body, qbxml, method, +2 more
create_invoiceCreate invoiceRead-onlyIdempotentInspect
Adds an invoice: what a customer owes for a sale they didn't pay in full when it was made (a sale paid in full is a sales receipt). customer_ref is required. Each line in invoice_line_add names an item_ref and two of quantity, rate and amount; QuickBooks works out the third. An inventory item on an invoice lowers stock and posts its cost of goods sold. To invoice a sales order, link it with link_to_txn_id. The add_transaction workflow template finds the customer and items first and creates any that are missing.
The invoice_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: customer_ref (required), fob, memo, other, +34 more. Returns: url, body, qbxml, method, +2 more
create_item_discountCreate item discountRead-onlyIdempotentInspect
Adds a discount item. A discount item is a percentage or a fixed amount that will be subtracted from a total or subtotal. Items should be subtotaled (using an ItemSubtotal item) before a discount item is applied to them, because a discount only acts on the line that is directly above it.
The item_discount_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, class_ref, is_active, +10 more. Returns: url, body, qbxml, method, +2 more
create_item_fixed_assetCreate item fixed assetRead-onlyIdempotentInspect
Adds a fixed-asset item. Fixed-asset items represent assets that will benefit a business for longer than one year. The purchase price of these fixed assets is typically expensed over a period of years, rather than in the year the purchase was made.
The item_fixed_asset_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), acquired_as (required), purchase_date (required), purchase_desc (required), +21 more. Returns: url, body, qbxml, method, +2 more
create_item_groupCreate item groupRead-onlyIdempotentInspect
Adds an item group. ItemGroup objects represent items that are grouped together for fast entry, and an ItemGroupRef aggregate refers to one of these item groups. In a request, if an ItemGroupRef aggregate includes both full_name and list_id, full_name will be ignored. You can use an ItemGroupQuery request to get information about all the item groups that are set up in the QuickBooks file.
The item_group_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, is_active, item_desc, +7 more. Returns: url, body, qbxml, method, +2 more
create_item_inventoryCreate item inventoryRead-onlyIdempotentInspect
Adds an inventory item: merchandise the business buys, stocks and resells. name is required; give it the accounts it posts to, income_account_ref, cogs_account_ref and asset_account_ref. For stock already on hand that no purchase will record, set quantity_on_hand and total_value; otherwise leave them at zero and add a bill, which raises both. QuickBooks values stock at its average cost.
The item_inventory_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), max, bar_code, class_ref, +23 more. Returns: url, body, qbxml, method, +2 more
create_item_inventory_assemblyCreate item inventory assemblyRead-onlyIdempotentInspect
Adds an inventory assembly item, which is an item that is assembled or manufactured from other inventory items. The items and/or assemblies that make up the assembly are called components. For Premier, an assembly can have a maximum of 100 components. For Enterprise, the maximum is 500 components.
The item_inventory_assembly_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), max, bar_code, class_ref, +24 more. Returns: url, body, qbxml, method, +2 more
create_item_non_inventoryCreate item non inventoryRead-onlyIdempotentInspect
Adds a non-inventory item: something the business buys but doesn't stock, such as office supplies, or materials bought for one job and billed to the customer. Send sales_or_purchase for an item it only sells or only buys, or sales_and_purchase for one it does both with.
The item_non_inventory_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, class_ref, is_active, +11 more. Returns: url, body, qbxml, method, +2 more
create_item_other_chargeCreate item other chargeRead-onlyIdempotentInspect
Adds an other charge item: a charge that isn't a service or a product, such as delivery, setup fees or service charges. Send sales_or_purchase for a charge the business only sells or only buys, or sales_and_purchase for one it does both with.
The item_other_charge_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, class_ref, is_active, +9 more. Returns: url, body, qbxml, method, +2 more
create_item_paymentCreate item paymentRead-onlyIdempotentInspect
For an ItemPaymentAdd request, you can “set” the “Group with undeposited funds” radio button in QuickBooks either by not specifying deposit_to_account_ref at all, or by specifying the special UndepositedFunds account for the deposit_to_account_ref.
The item_payment_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, class_ref, is_active, +7 more. Returns: url, body, qbxml, method, +2 more
create_item_receiptCreate item receiptRead-onlyIdempotentInspect
Adds an item receipt transaction, which is a transaction entered in QuickBooks when a shipment is received from a vendor. If you use PurchaseOrders to order from the vendor, you can link the item receipt to purchase order to receive the items against the purchase orders to automatically update (and eventually close) the purchase orders. This linking also saves you having to re-create line items as they are pulled in automatically from the purchase order. You can do this linking only in the item receipt add, not in the mod.
The item_receipt_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: vendor_ref (required), memo, txn_date, def_macro, +13 more. Returns: url, body, qbxml, method, +2 more
create_item_sales_taxCreate item sales taxRead-onlyIdempotentInspect
Adds a sales-tax item, which is an item used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. (Compare with the ItemSalesTaxGroupAdd message.) An ItemSalesTaxRef aggregate refers to an item on this list. In a request, if an ItemSalesTaxRef aggregate includes both full_name and list_id, full_name will be ignored.
The item_sales_tax_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, tax_rate, class_ref, +8 more. Returns: url, body, qbxml, method, +2 more
create_item_sales_tax_groupCreate item sales tax groupRead-onlyIdempotentInspect
Adds a sales-tax group item, which is an item used for calculating two or more sales taxes grouped together and applied to the same sale. For example, local and state taxes could be tracked separately but applied to a sale as one tax. (Compare with the ItemSalesTaxAdd message.)
The item_sales_tax_group_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), item_sales_tax_ref (required), bar_code, is_active, +5 more. Returns: url, body, qbxml, method, +2 more
create_item_serviceCreate item serviceRead-onlyIdempotentInspect
Adds a service item: work the business sells or buys, such as labor, consulting hours or fees. Send sales_or_purchase for a service it only sells or only buys (one price, one account), or sales_and_purchase for one it does both with (an income and an expense account).
The item_service_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, class_ref, is_active, +10 more. Returns: url, body, qbxml, method, +2 more
create_item_subtotalCreate item subtotalRead-onlyIdempotentInspect
Adds a subtotal item. On a sales form, a subtotal item will add up the amounts of the item lines above it, up to the previous subtotal.
The item_subtotal_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), bar_code, is_active, item_desc, +4 more. Returns: url, body, qbxml, method, +2 more
create_job_typeCreate job typeRead-onlyIdempotentInspect
Adds a job type. A job type can be used to separate jobs into any categories that are meaningful to the business. A JobTypeRef aggregate refers to a job type on the JobType list. In a request, if a JobTypeRef aggregate includes both full_name and list_id, full_name will be ignored.
The job_type_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, parent_ref, request_id, +2 more. Returns: url, body, qbxml, method, +2 more
create_journal_entryCreate journal entryRead-onlyIdempotentInspect
In versions 1.0 and 1.1, all debit lines in a JournalEntryAdd request had to appear first, followed by all credit lines. But in versions 2.0 and above, the debit and credit lines can be intermingled. A credit line can legally come first in thejournal entry add.
The journal_entry_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: memo, txn_date, def_macro, ref_number, +11 more. Returns: url, body, qbxml, method, +2 more
create_leadCreate leadRead-onlyIdempotentInspect
Builds a v2 lead.create request.
The lead_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: full_name (required), status, locations, main_phone, +6 more. Returns: url, body, qbxml, method, +2 more
create_list_displayCreate list displayRead-onlyIdempotentInspect
A ListDisplayAdd request opens a form within the QuickBooks UI for adding a list element.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: list_display_add_type (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
create_other_nameCreate other nameRead-onlyIdempotentInspect
Adds an other name. In QuickBooks, the “other names” list contains any names that don’t appear on customer, vendor, or employee lists.
The other_name_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), fax, email, notes, +16 more. Returns: url, body, qbxml, method, +2 more
create_payment_methodCreate payment methodRead-onlyIdempotentInspect
Adds a payment method, which is the way a customer pays for goods or services, for example, cash, check, or Master Card. A PaymentMethodRef aggregate refers to an item on the PaymentMethod list. In a request, if a PaymentMethodRef aggregate includes both FullName and list_id, FullName will be ignored.
The payment_method_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, request_id, include_qbxml, +2 more. Returns: url, body, qbxml, method, +2 more
create_payroll_item_additionCreate payroll item additionRead-onlyIdempotentInspect
Builds a v2 payroll_item_addition.create request.
The payroll_item_addition_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), expense_account_ref (required), rate, limit, +12 more. Returns: url, body, qbxml, method, +2 more
create_payroll_item_company_contributionCreate payroll item company contributionRead-onlyIdempotentInspect
Builds a v2 payroll_item_company_contribution.create request.
The payroll_item_company_contribution_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), expense_account_ref (required), payment_template_ref (required), liability_account_ref (required), +17 m… Returns: url, body, qbxml, method, +2 more
create_payroll_item_deductionCreate payroll item deductionRead-onlyIdempotentInspect
Builds a v2 payroll_item_deduction.create request.
The payroll_item_deduction_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), payment_template_ref (required), liability_account_ref (required), rate, +15 more. Returns: url, body, qbxml, method, +2 more
create_payroll_item_direct_depositCreate payroll item direct depositRead-onlyIdempotentInspect
Builds a v2 payroll_item_direct_deposit.create request.
The payroll_item_direct_deposit_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), liability_account_ref (required), is_active, request_id, +3 more. Returns: url, body, qbxml, method, +2 more
create_payroll_item_taxCreate payroll item taxRead-onlyIdempotentInspect
Builds a v2 payroll_item_tax.create request.
The payroll_item_tax_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), payment_template_ref (required), liability_account_ref (required), payroll_item_detail_type_value (requi… Returns: url, body, qbxml, method, +2 more
create_payroll_item_wageCreate payroll item wageRead-onlyIdempotentInspect
Adds a payroll wage item. Each payroll wage item describes and names a payment scheme, for example, Regular Pay or Overtime Pay. A PayrollItemWageRef aggregate refers to one of these wage items. In a request, if a PayrollItemWageRef aggregate includes both full_name and list_id, full_name will be ignored.
The payroll_item_wage_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), wage_type (required), expense_account_ref (required), is_active, +3 more. Returns: url, body, qbxml, method, +2 more
create_payroll_item_workers_compensationCreate payroll item workers compensationRead-onlyIdempotentInspect
Builds a v2 payroll_item_workers_compensation.create request.
The payroll_item_workers_compensation_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), expense_account_ref (required), payment_template_ref (required), liability_account_ref (required), +9 mo… Returns: url, body, qbxml, method, +2 more
create_payroll_liability_adjustmentCreate payroll liability adjustmentRead-onlyIdempotentInspect
Builds a v2 payroll_liability_adjustment.create request.
The payroll_liability_adjustment_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: is_affecting_accounts (required), payroll_liability_adjustment_line_add (required), memo, txn_date, +10 more. Returns: url, body, qbxml, method, +2 more
create_payroll_prior_paymentCreate payroll prior paymentRead-onlyIdempotentInspect
Builds a v2 payroll_prior_payment.create request.
The payroll_prior_payment_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: is_affecting_accounts (required), payroll_prior_payment_line_add (required), memo, txn_date, +7 more. Returns: url, body, qbxml, method, +2 more
create_payroll_year_to_date_adjustmentCreate payroll year to date adjustmentRead-onlyIdempotentInspect
Builds a v2 payroll_year_to_date_adjustment.create request.
The payroll_year_to_date_adjustment_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: employee_ref (required), is_affecting_accounts (required), payroll_year_to_date_adjustment_line_add (required), memo, +12… Returns: url, body, qbxml, method, +2 more
create_price_levelCreate price levelRead-onlyIdempotentInspect
Adds a price level. You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.)
The price_level_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, request_id, currency_ref, +4 more. Returns: url, body, qbxml, method, +2 more
create_purchase_orderCreate purchase orderRead-onlyIdempotentInspect
Adds a purchase order, which is an order submitted to a vendor. You can use ItemReceiptAdd to receive items against a purchase order as items arrive from the vendor. A purchase order is a non-posting transaction, so it doesn’t affect a company’s balance sheet or income statement.
The purchase_order_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: fob, memo, other1, other2, +26 more. Returns: url, body, qbxml, method, +2 more
create_sales_orderCreate sales orderRead-onlyIdempotentInspect
Adds a sales order: goods a customer has ordered, often on back order, to be invoiced when they ship. A sales order doesn't post to any account. customer_ref is required, and lines go in sales_order_line_add. Sales orders need QuickBooks Premier or above. An invoice made from a sales order needs a sales tax item, so set item_sales_tax_ref if the company charges sales tax.
The sales_order_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: customer_ref (required), fob, memo, other, +27 more. Returns: url, body, qbxml, method, +2 more
create_sales_receiptCreate sales receiptRead-onlyIdempotentInspect
Adds a sales receipt: a sale paid in full when it was made, by cash, check or card. If the customer pays later, add an invoice instead and record the payment when it arrives. The money goes to deposit_to_account_ref. customer_ref is optional. Card details sent in credit_card_txn_info come back in the answer only if the app may see sensitive data.
The sales_receipt_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: fob, memo, other, due_date, +32 more. Returns: url, body, qbxml, method, +2 more
create_sales_repCreate sales repRead-onlyIdempotentInspect
Adds a sales rep. The sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A SalesRepRef refers to a person on the SalesRep list. In a request, if a SalesRepRef aggregate includes both full_name and list_id, full_name will be ignored.
The sales_rep_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: initial (required), sales_rep_entity_ref (required), is_active, request_id, +2 more. Returns: url, body, qbxml, method, +2 more
create_sales_tax_codeCreate sales tax codeRead-onlyIdempotentInspect
Adds a sales tax code. Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:
The sales_tax_code_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_taxable (required), desc, is_active, +5 more. Returns: url, body, qbxml, method, +2 more
create_sales_tax_payment_checkCreate sales tax payment checkRead-onlyIdempotentInspect
Builds a v2 sales_tax_payment_check.create request.
The sales_tax_payment_check_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: txn_date (required), bank_account_ref (required), payee_entity_ref (required), sales_tax_payment_check_line_add (required… Returns: url, body, qbxml, method, +2 more
create_ship_methodCreate ship methodRead-onlyIdempotentInspect
Adds a shipping method, for example, standard mail or overnight delivery. A ShipMethodRef aggregate refers to an item on the ShipMethod list. In a request, if a ShipMethodRef aggregate includes both FullName and list_id, FullName will be ignored.
The ship_method_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, request_id, include_qbxml, +1 more. Returns: url, body, qbxml, method, +2 more
create_special_accountCreate special accountRead-onlyIdempotentInspect
Adds a special account of the specified type to QuickBooks. A special account is an account normally created automatically as needed within the QuickBooks UI, or in the SDK via the SpecialAccountAdd request. Notice that default names for each account type are used, so there is no provision for a name field here.
The special_account_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: special_account_type (required), request_id, currency_ref, include_qbxml, +1 more. Returns: url, body, qbxml, method, +2 more
create_special_itemCreate special itemRead-onlyIdempotentInspect
Adds special items to QuickBooks that can’t be added via the other Item*Add requests.
The special_item_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: special_item_type (required), bar_code, request_id, external_guid, +2 more. Returns: url, body, qbxml, method, +2 more
create_standard_termsCreate standard termsRead-onlyIdempotentInspect
Adds a standard term. Standard terms show the number of days within which payment is due and can include a discount for early payment. For example, the following standard term means that payment is due in 30 days, with a 1% discount if payment is made within 10 days:
The standard_terms_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, request_id, discount_pct, +4 more. Returns: url, body, qbxml, method, +2 more
create_time_trackingCreate time trackingRead-onlyIdempotentInspect
This request adds a time tracking transaction to QuickBooks, mirroring the time-tracking feature available in the QuickBooks UI. The time tracking feature allows a QuickBooks user to base payroll or invoices on time worked. You can add time-tracking information to any vendor, employee, or person on the Other Names list in QuickBooks.
The time_tracking_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: duration (required), entity_ref (required), rate, notes, +11 more. Returns: url, body, qbxml, method, +2 more
create_to_doCreate to doRead-onlyIdempotentInspect
A “to do”list is used in QuickBooks to keep track of tasks. Notice the Notes field: when you do a query on the ToDo list (ToDoQuery), you can use the supplied name filters to search these Notes and filter by them.
The to_do_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: notes (required), type, is_done, lead_ref, +10 more. Returns: url, body, qbxml, method, +2 more
create_transferCreate transferRead-onlyIdempotentInspect
Builds a v2 transfer.create request.
The transfer_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: memo, amount, txn_date, class_ref, +6 more. Returns: url, body, qbxml, method, +2 more
create_transfer_inventoryCreate transfer inventoryRead-onlyIdempotentInspect
Builds a v2 transfer_inventory.create request.
The transfer_inventory_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: to_inventory_site_ref (required), from_inventory_site_ref (required), memo, txn_date, +7 more. Returns: url, body, qbxml, method, +2 more
create_txn_displayCreate txn displayRead-onlyIdempotentInspect
A TxnDisplayAdd request opens a form within the QuickBooks UI for adding a transaction. You may optionally supply an entity reference to “prefill” certain forms.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: txn_display_add_type (required), entity_ref, request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
create_unit_of_measure_setCreate unit of measure setRead-onlyIdempotentInspect
Requires the company to be enabled for unit of measure (UOM), either a single unit of measure per item, or multiple units of measure. However, in order to support both single or multiple units per item of measure enablement, you must prefix all UOM set names with “By the”, for example, “By the Barrel”. Otherwise, the UOM set won’t show up in the QuickBooks UI in single UOM per item mode.
The unit_of_measure_set_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), base_unit (required), unit_of_measure_type (required), is_active, +5 more. Returns: url, body, qbxml, method, +2 more
create_vehicleCreate vehicleRead-onlyIdempotentInspect
Adds a vehicle to the vehicle list for use in VehicleMileage transactions. Each vehicle name must be unique.
The vehicle_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), desc, is_active, request_id, +2 more. Returns: url, body, qbxml, method, +2 more
create_vehicle_mileageCreate vehicle mileageRead-onlyIdempotentInspect
Adds a VehicleMileage transaction involving the specified vehicle for the specified total miles or optionally for the QuickBooks calculated total miles if you supply the odometer start and end.
The vehicle_mileage_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: vehicle_ref (required), notes, item_ref, class_ref, +11 more. Returns: url, body, qbxml, method, +2 more
create_vendorCreate vendorRead-onlyIdempotentInspect
Adds a vendor: a person or company the business buys from, including its banks and tax agencies. name is required. QuickBooks keeps vendors, customers, employees and other names in one name space, so a name any of them already uses fails with 3100 name_in_use.
The vendor_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), cc, fax, email, +48 more. Returns: url, body, qbxml, method, +2 more
create_vendor_creditCreate vendor creditRead-onlyIdempotentInspect
Adds a vendor credit. A vendor credit is also known as a “bill credit”. That is, it is a credit that a vendor owes you because you overpaid your bill, returned merchandise, or for some other reason. The VendorCredit is referenced in a BilPayment transaction, inside the SetCredit aggregate. A VendorCredit shouldn’t be confused with a Credit Memo, which is something you owe your customer and which is referenced in a ReceivePayment request.
The vendor_credit_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: vendor_ref (required), memo, txn_date, def_macro, +12 more. Returns: url, body, qbxml, method, +2 more
create_vendor_typeCreate vendor typeRead-onlyIdempotentInspect
Adds a vendor type. A vendor type allows business owners to categorize vendors in ways that are meaningful for their businesses. For example, a vendor type might indicate which industry a vendor represents, or which part of the country a vendor is in.
The vendor_type_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), is_active, parent_ref, request_id, +2 more. Returns: url, body, qbxml, method, +2 more
create_workers_comp_codeCreate workers comp codeRead-onlyIdempotentInspect
Adds a workers’ compensation code with one or more rate entries (each rate entry has an effective date and a rate). You can assign effective dates in the past, present or future. However, only one future date will be used. If a future date exists and you write a new one (using the Mod request) then the most recently written code wins; if you have multiple future dates in the Add request, the last one wins.
The workers_comp_code_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: name (required), rate_entry (required), desc, is_active, +3 more. Returns: url, body, qbxml, method, +2 more
delete_alertDelete alertRead-onlyIdempotentInspect
Builds a v2 alert.delete request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3160 cannot_delete, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: owner_id (required), alert_tag (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
delete_data_event_recovery_infoDelete data event recovery infoRead-onlyIdempotentInspect
Deletes the data event recovery information for the given subscriber. An application would send a DataEventRecoveryInfoDel request after having recovered its data events. For details about the event-notification feature, see the chapter called “Event Notification” in the QB SDK Programmer’s Guide (PDF, 9.6 MB).
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3160 cannot_delete, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: subscriber_id (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
delete_data_extDelete data extRead-onlyIdempotentInspect
This request deletes the data from the specified existing custom field or private extension. If you want to clear the data extension value (to make the custom field or private extension blank), you must use data_ext_del. The DataExtMod request can’t be used to clear the field.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3160 cannot_delete, 3161 closing_date_delete, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: data_ext_del (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
delete_data_ext_defDelete data ext defRead-onlyIdempotentInspect
Deletes the private data extension definition specified by owner_id and data_ext_name. This delete will be successful only for private data extensions.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3160 cannot_delete, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: owner_id (required), data_ext_name (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
delete_listDelete listRead-onlyIdempotentInspect
You can only delete a list item from a QuickBooks company file if the file is open in single-user mode. If the file is open in multiuser mode, your application will receive an error. (This restriction doesn’t apply to deleting or voiding transaction objects.)
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3160 cannot_delete, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), list_del_type (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
delete_txnDelete txnRead-onlyIdempotentInspect
Deleting a transaction removes it completely and irreversibly. (Using a TxnVoid request to void a transaction, on the other hand, sets its amount to zero but keeps a record of it in QuickBooks.)
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3160 cannot_delete, 3161 closing_date_delete, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), txn_del_type (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
execute_list_mergeExecute list mergeRead-onlyIdempotentInspect
This request merges one list object into another list object of the same type. Currently you can merge customers/jobs, or vendors, or accounts. The consequence of the merge is that only the merge-to object remains. The merge-from object goes away and all transactions that reference that merge-from object now reference only the merge-to object.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: merge_to (required), merge_from (required), list_merge_type (required), request_id, +2 more. Returns: url, body, qbxml, method, +2 more
execute_qb_command_execExecute QB command execRead-onlyIdempotentInspect
Builds a v2 qb_command_exec.execute request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: qb_command (required), argument, request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
execute_txn_voidExecute txn voidRead-onlyIdempotentInspect
Voids a transaction: QuickBooks keeps it, with its amounts and its lines' quantities at zero and "VOID: " in front of its memo, while deleting one removes it completely. A voided invoice keeps its number and reads back as paid. An invoice that payments paid can be voided too: each payment stays, and what it had applied to the invoice becomes its unused payment, to apply elsewhere or refund (observed on QuickBooks Enterprise 24.0, 2026-10-10).
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id (required), txn_void_type (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
find_accountsFind accountsRead-onlyIdempotentInspect
Finds accounts in the chart of accounts, all of them or those of one account_type, each with its parent account. It returns an account's own details, not its transactions. When the company shows account numbers, a full_name made of digits can match the account with that number rather than that name.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, owner_id, full_name, meta_data, +11 more. Returns: url, qbxml, query, method, +2 more
find_account_tax_line_infosFind account tax line infosRead-onlyIdempotentInspect
Used to determine which tax line values are available for the tax_line_id value for AccountMod and AccountAdd requests that use the tax_line_id field to map the account to a federal tax line.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml. Returns: url, qbxml, query, method, +2 more
find_aging_reportsFind aging reportsRead-onlyIdempotentInspect
An aging report tracks outstanding invoices (in accounts receivable accounts) and unpaid bills (in accounts payable accounts). Notice that you could use a collections report instead of the aging query, if that better suited your needs.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: aging_report_type (required), request_id, include_qbxml, report_period, +14 more. Returns: url, qbxml, query, method, +2 more
find_alertsFind alertsRead-onlyIdempotentInspect
Builds a v2 alert.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: owner_id (required), meta_data, request_id, include_qbxml. Returns: url, qbxml, query, method, +2 more
find_ar_refund_credit_cardsFind AR refund credit cardsRead-onlyIdempotentInspect
Retrieves the specified credit card refund transaction or transactions.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_bar_codesFind bar codesRead-onlyIdempotentInspect
Builds a v2 bar_code.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: iterator, meta_data, request_id, include_qbxml, +1 more. Returns: url, qbxml, query, method, +2 more
find_billing_ratesFind billing ratesRead-onlyIdempotentInspect
Returns all billing rates, or billing rates filtered by modified date, or filtered by billing rate name, or filtered by the service item referenced in the billing rate.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, item_ref, full_name, meta_data, +8 more. Returns: url, qbxml, query, method, +2 more
find_bill_payment_checksFind bill payment checksRead-onlyIdempotentInspect
Provides functionality found in the Find/Advanced Find window to find bill payments paid by check. The Find/Advanced Find windows can be reached by clicking the Find button on the main QuickBooks menubar, by selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that you can use the meta_data attribute inside the query tag if you want only a count of the bill payments that will be returned from the query.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_bill_payment_credit_cardsFind bill payment credit cardsRead-onlyIdempotentInspect
Provides functionality found in the Find/Advanced Find window to find bill payments that were paid by credit card. The Find/Advanced Find windows can be reached by clicking the Find button on the main QuickBooks menubar, by selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that you can use the meta_data attribute inside the query tag if you want only a count of the bill payments that will be returned from the query.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_billsFind billsRead-onlyIdempotentInspect
Provides functionality found in the Find/Advanced Find window to find bills that are to be paid by check. The Find/Advanced Find windows can be reached by clicking the Find button on the main QuickBooks menubar, by selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that you can use the meta_data attribute inside the query tag if you want only a count of the bills that will be returned from the query.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +16 more. Returns: url, qbxml, query, method, +2 more
find_bill_to_paysFind bill to paysRead-onlyIdempotentInspect
The BillToPayQuery request returns information about open bills and credits. You can use this information in subsequent BillPaymentCheck and BillPaymentCreditCard requests.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: payee_entity_ref (required), due_date, meta_data, request_id, +4 more. Returns: url, qbxml, query, method, +2 more
find_budget_summary_reportsFind budget summary reportsRead-onlyIdempotentInspect
Generates budget reports similar to the budget report functionality that is available within the QuickBooks UI. (From the main QB menubar select Reports->Budgets & Forecasts.) Note: the graphing functionality, forecasts, and memorized reports that available through the UI aren’t supported by the SDK. Notice that if you simply use the default instead of specifying the Fiscal Year, the report_period defaults to “year to date.” You can’t change the default to “This Fiscal Year.”
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: fiscal_year (required), budget_summary_report_type (required), request_id, include_qbxml, +7 more. Returns: url, qbxml, query, method, +2 more
find_build_assembliesFind build assembliesRead-onlyIdempotentInspect
Filters BuildAssembly transactions by the specified filter criteria.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +13 more. Returns: url, qbxml, query, method, +2 more
find_chargesFind chargesRead-onlyIdempotentInspect
A ChargeQuery request returns information about statement charges.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_checksFind checksRead-onlyIdempotentInspect
Returns certain types of checks based on the supplied query criteria. Note that BillPaymentChecks, payroll checks, and liability checks aren’t returned.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +15 more. Returns: url, qbxml, query, method, +2 more
find_classesFind classesRead-onlyIdempotentInspect
Queries for existing classes.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_companiesFind companiesRead-onlyIdempotentInspect
A CompanyQueryRq request message returns detailed information about a QuickBooks company file, such as the company’s address and legal name, certain preferences that are set, and any services that the company is subscribed to, such as payroll, QuickBooks Merchant Services, and so forth. Company information can’t be added or modified through the SDK, only through the QuickBooks user interface. Note: If you include an explicit end tag in a CompanyQueryRq request, you will receive an error if there is any space between the opening tag and the end tag.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: owner_id, request_id, include_qbxml, include_ret_element. Returns: url, qbxml, query, method, +2 more
find_company_activitiesFind company activitiesBRead-onlyIdempotentInspect
A CompanyActivityQueryRq request message returns last_restore_time (the time when the company file was last restored from a back up), and last_condense_time (the time the company file was last condensed). It returns the default date of 1970-01-01 (UTC) for these elements if a restore or condense hasn’t happened for this company file. (For example, 1970-01-01 will be represented as 1969-12-31T16:00:00-08:00 in a time zone that is eight hours behind UTC.)
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml, include_ret_element. Returns: url, qbxml, query, method, +2 more
find_credit_card_chargesFind credit card chargesARead-onlyIdempotentInspect
Queries for the specified credit card charge or charges.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_credit_card_creditsFind credit card creditsBRead-onlyIdempotentInspect
Queries for the specified credit or set of credits.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_credit_memosFind credit memosARead-onlyIdempotentInspect
Finds credit memos: exact ones by txn_id or ref_number, or a filtered set by customer (entity_filter), date or account. Lines come back only with include_line_items, and the invoices each credit was applied to (not the payments that applied it) only with include_linked_txns. Set iterator to page through many results.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +15 more. Returns: url, qbxml, query, method, +2 more
find_currenciesFind currenciesARead-onlyIdempotentInspect
Returns the list of built-in and user-defined currency objects that match the filters used in the request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_custom_detail_reportsFind custom detail reportsARead-onlyIdempotentInspect
A Custom Transaction Detail report gives you complete control over the content of the report. It doesn’t have any default values and consists entirely of customized data. You must specify all the include columns for the transactions you want returned in the report.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: include_column (required), summarize_rows_by (required), custom_detail_report_type (required), request_id, +16 more. Returns: url, qbxml, query, method, +2 more
find_customer_msgsFind customer msgsBRead-onlyIdempotentInspect
Queries for the specified customer message or set of messages.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_customersFind customersARead-onlyIdempotentInspect
Finds customers and jobs: exact ones by list_id or full_name, or a filtered set by name, active_status and modified date. Without active_status only active customers come back. Set iterator to page through a long list: each page arrives at your webhook_url under one request id.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: include, list_id, iterator, owner_id, +11 more. Returns: url, qbxml, query, method, +2 more
find_customer_typesFind customer typesBRead-onlyIdempotentInspect
Queries for the specified customer type or set of types.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_custom_summary_reportsFind custom summary reportsBRead-onlyIdempotentInspect
A custom summary report gives you complete control over the content of the report. It doesn’t have any default values and consists entirely of customized data.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: summarize_rows_by (required), summarize_columns_by (required), custom_summary_report_type (required), request_id, +18 mor… Returns: url, qbxml, query, method, +2 more
find_data_event_recovery_infosFind data event recovery infosARead-onlyIdempotentInspect
You can use the DataEventRecoveryInfoQuery request to find out whether data event recovery information exists for the given subscriber. If it does, then data events have been lost and need to be recovered. (Note that there will be no data event recovery information to return if TrackLostEvents was “tleNone” in the subscriber’s DataEventSubscriptionAdd request.)
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: subscriber_id (required), request_id, include_qbxml. Returns: url, qbxml, query, method, +2 more
find_data_ext_defsFind data ext defsARead-onlyIdempotentInspect
Finds the definitions of custom fields and private data extensions. Pass owner_id (0 for custom fields, your GUID for private extensions). Without it QuickBooks answers status 1 "did not find a matching object" even when definitions exist, so an empty answer there doesn't prove a field is missing (observed on QuickBooks Enterprise 24.0, 2026-10-03).
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: owner_id, meta_data, request_id, include_qbxml, +2 more. Returns: url, qbxml, query, method, +2 more
find_date_driven_termsFind date driven termsBRead-onlyIdempotentInspect
Queries for the specified date-driven terms or set of terms.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_depositsFind depositsARead-onlyIdempotentInspect
This request searches for deposits that match the supplied filters.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +10 more. Returns: url, qbxml, query, method, +2 more
find_employee_defaultsFind employee defaultsBRead-onlyIdempotentInspect
Builds a v2 employee_default.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml, include_ret_element. Returns: url, qbxml, query, method, +2 more
find_employeesFind employeesBRead-onlyIdempotentInspect
Returns employee data. Notice that prior to qbXML spec 4.0, an EmployeeQueryRq would return a permissions error if the currently logged in QuickBooks user didn’t have “Payroll and Employees” permission. This would occur even if you only needed data that wasn’t restricted.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, owner_id, full_name, meta_data, +9 more. Returns: url, qbxml, query, method, +2 more
find_entitiesFind entitiesARead-onlyIdempotentInspect
Queries for the specified entity or entities. A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, full_name, meta_data, +9 more. Returns: url, qbxml, query, method, +2 more
find_estimatesFind estimatesBRead-onlyIdempotentInspect
Queries for the specified estimate or set of estimates.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +15 more. Returns: url, qbxml, query, method, +2 more
find_form1099_category_account_mappingsFind form1099 category account mappingsARead-onlyIdempotentInspect
Returns one Ret object that contains a list of all of the account mappings currently in effect for Form 1099-NEC and Form 1099-MISC. You can optionally supply a Box number (representing the corresponding text box in the 1099 forms) if you only want the mappings for a particular box in the form. Using SDK version 15 or older won’t yield correct category account mappings in the response.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: form_type, request_id, include_qbxml, mapping_category. Returns: url, qbxml, query, method, +2 more
find_general_detail_reportsFind general detail reportsARead-onlyIdempotentInspect
You use this report query to get any of the supported QuickBooks detail reports, which you specify in the general_detail_report_type. You can optionally display the report within QB by setting display_report to True.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: general_detail_report_type (required), request_id, report_basis, include_qbxml, +16 more. Returns: url, qbxml, query, method, +2 more
find_general_summary_reportsFind general summary reportsBRead-onlyIdempotentInspect
The General Summary Reports category is the largest category for summary reports. In addition to common customizations, the reports within this category can be customized by the number of columns that are returned and by period comparisons for the data in the report.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: general_summary_report_type (required), request_id, return_rows, report_basis, +17 more. Returns: url, qbxml, query, method, +2 more
find_hostsFind hostsCRead-onlyIdempotentInspect
A HostQueryRq request message returns information about the exact QuickBooks product and version with which you are communicating. Note: If you include an explicit end tag in a HostQueryRq request, you will receive an error if there is any space between the opening tag and the end tag. The following table shows valid and invalid ways of constructing this request:
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml, include_ret_element, include_list_meta_data. Returns: url, qbxml, query, method, +2 more
find_inventory_adjustmentsFind inventory adjustmentsBRead-onlyIdempotentInspect
You can’t query an inventory adjustment while the inventory adjustment form is open in the QuickBooks user interface.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_inventory_sitesFind inventory sitesBRead-onlyIdempotentInspect
Builds a v2 inventory_site.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +7 more. Returns: url, qbxml, query, method, +2 more
find_invoicesFind invoicesARead-onlyIdempotentInspect
Finds invoices: exact ones by txn_id or ref_number, or a filtered set by customer (entity_filter), date, account or paid_status. Lines come back only with include_line_items, and the payments and credits applied to each invoice only with include_linked_txns. An invoice's applied_amount comes back negative (-80.00 for one paid 80.00), so balance_remaining is its total plus applied_amount (observed on QuickBooks Enterprise 24.0). Set iterator to page through many results.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +16 more. Returns: url, qbxml, query, method, +2 more
find_item_assemblies_can_buildsFind item assemblies can buildsBRead-onlyIdempotentInspect
A query that is used to determine the current number of the specified assembly that can be built from the components on hand.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_date (required), item_inventory_assembly_ref (required), request_id, include_qbxml. Returns: url, qbxml, query, method, +2 more
find_item_discountsFind item discountsARead-onlyIdempotentInspect
Queries for the specified discount item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_fixed_assetsFind item fixed assetsARead-onlyIdempotentInspect
Queries for the specifed fixed-asset item or set of fixed asset items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_groupsFind item groupsBRead-onlyIdempotentInspect
An ItemGroupQuery request will return information about all the item groups that are set up in the QuickBooks file.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +10 more. Returns: url, qbxml, query, method, +2 more
find_item_inventoriesFind item inventoriesBRead-onlyIdempotentInspect
Queries for the specified inventory item or set of items. Notice that certain modifications to the item can be caused by other transactions, such as ItemReceipts where the item’s on hand quantity is increased. Modifications through these transactions don’t result in changing the time_modified stamp (only the Mod operation will do that), but those changes will be detected when you use the from_modified_date/to_modified_date filters in your query.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_inventory_assembliesFind item inventory assembliesARead-onlyIdempotentInspect
Queries for the specified inventory assembly item or set of assembly items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_non_inventoriesFind item non inventoriesARead-onlyIdempotentInspect
Queries for the specified non inventory item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_other_chargesFind item other chargesARead-onlyIdempotentInspect
Queries for the specified other charge item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_paymentsFind item paymentsBRead-onlyIdempotentInspect
Queries for the specified item payment or set of payments.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_receiptsFind item receiptsBRead-onlyIdempotentInspect
An item receipt transaction is entered in QuickBooks when a shipment is received from a vendor.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +15 more. Returns: url, qbxml, query, method, +2 more
find_itemsFind itemsARead-onlyIdempotentInspect
Finds items of every type in one query: service, inventory, non-inventory, other charge, discount, group and the rest. Filter by list_id, full_name or name. For an inventory item's current quantity on hand, query inventory items instead: this query doesn't reflect what other transactions did to it.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +10 more. Returns: url, qbxml, query, method, +2 more
find_item_sales_taxesFind item sales taxesBRead-onlyIdempotentInspect
Queries for the specified sales tax item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_sales_tax_groupsFind item sales tax groupsBRead-onlyIdempotentInspect
Queries for the specified sales tax group item or set of group items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +10 more. Returns: url, qbxml, query, method, +2 more
find_item_servicesFind item servicesBRead-onlyIdempotentInspect
Queries for the specified service item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +11 more. Returns: url, qbxml, query, method, +2 more
find_item_sitesFind item sitesARead-onlyIdempotentInspect
Builds a v2 item_sites.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, meta_data, request_id, +6 more. Returns: url, qbxml, query, method, +2 more
find_item_subtotalsFind item subtotalsBRead-onlyIdempotentInspect
Queries for the specified subtotal item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +10 more. Returns: url, qbxml, query, method, +2 more
find_job_reportsFind job reportsARead-onlyIdempotentInspect
The Job Reports category includes both summary and transaction detail reports. They can be customized only by date range, by column summarization, and by common filters. Some job reports require a customer:job reference in order to work
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: job_report_type (required), request_id, include_qbxml, report_period, +13 more. Returns: url, qbxml, query, method, +2 more
find_job_typesFind job typesARead-onlyIdempotentInspect
Queries for the specified job type or set of job types.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_journal_entriesFind journal entriesCRead-onlyIdempotentInspect
In traditional accounting, transactions are entered into the general journal and categorized exclusively by account. In QuickBooks, most transactions can be categorized either by account or by type (invoice, check, and so on). For a few activities in QuickBooks, you must use the general journal directly, for example for recording depreciation.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_leadsFind leadsBRead-onlyIdempotentInspect
Builds a v2 lead.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: name, list_id, iterator, meta_data, +8 more. Returns: url, qbxml, query, method, +2 more
find_list_deletedsFind list deletedsBRead-onlyIdempotentInspect
A ListDeletedQuery will return all list elements deleted within the last 90 days, grouped according to object type.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_del_type (required), meta_data, request_id, include_qbxml, +2 more. Returns: url, qbxml, query, method, +2 more
find_other_namesFind other namesBRead-onlyIdempotentInspect
Queries for the specified other name or set of other names.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, owner_id, full_name, meta_data, +9 more. Returns: url, qbxml, query, method, +2 more
find_paychecksFind paychecksARead-onlyIdempotentInspect
Builds a v2 paycheck.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, meta_data, ref_number, request_id, +12 more. Returns: url, qbxml, query, method, +2 more
find_payment_methodsFind payment methodsBRead-onlyIdempotentInspect
Queries for the specified payment method or set of payment methods.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +9 more. Returns: url, qbxml, query, method, +2 more
find_payroll_detail_reportsFind payroll detail reportsBRead-onlyIdempotentInspect
Returns information from any of five QuickBooks payroll reports:
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: payroll_detail_report_type (required), request_id, include_qbxml, report_period, +14 more. Returns: url, qbxml, query, method, +2 more
find_payroll_item_non_wagesFind payroll item non wagesBRead-onlyIdempotentInspect
Queries for the specified non-wage payroll item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_payroll_itemsFind payroll itemsARead-onlyIdempotentInspect
Builds a v2 payroll_item.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_payroll_item_wagesFind payroll item wagesBRead-onlyIdempotentInspect
Queries for the specified payroll wage item or set of items.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_payroll_last_periodsFind payroll last periodsBRead-onlyIdempotentInspect
Builds a v2 payroll_last_period.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml. Returns: url, qbxml, query, method, +2 more
find_payroll_liability_adjustmentsFind payroll liability adjustmentsBRead-onlyIdempotentInspect
Builds a v2 payroll_liability_adjustment.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, meta_data, ref_number, request_id, +12 more. Returns: url, qbxml, query, method, +2 more
find_payroll_liability_checksFind payroll liability checksBRead-onlyIdempotentInspect
Builds a v2 payroll_liability_check.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, meta_data, ref_number, request_id, +12 more. Returns: url, qbxml, query, method, +2 more
find_payroll_prior_paymentsFind payroll prior paymentsARead-onlyIdempotentInspect
Builds a v2 payroll_prior_payment.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, meta_data, ref_number, request_id, +12 more. Returns: url, qbxml, query, method, +2 more
find_payroll_summary_reportsFind payroll summary reportsBRead-onlyIdempotentInspect
This report returns information from any of three QuickBooks payroll reports:
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: payroll_summary_report_type (required), request_id, return_rows, include_qbxml, +15 more. Returns: url, qbxml, query, method, +2 more
find_payroll_year_to_date_adjustmentsFind payroll year to date adjustmentsBRead-onlyIdempotentInspect
Builds a v2 payroll_year_to_date_adjustment.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, meta_data, ref_number, request_id, +12 more. Returns: url, qbxml, query, method, +2 more
find_preferencesFind preferencesCRead-onlyIdempotentInspect
A PreferencesQueryRq request message returns information about many of the preferences that the QuickBooks user has set in the company file. Preferences can’t be modified through the SDK, only through the QuickBooks user interface. Note: If you include an explicit end tag in a PreferencesQueryRq request, you will receive an error if there is any space between the opening tag and the end tag. The following table shows valid and invalid ways of constructing this request:
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml, include_ret_element. Returns: url, qbxml, query, method, +2 more
find_price_levelsFind price levelsBRead-onlyIdempotentInspect
Queries for the specified price level or set of price levels.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, item_ref, full_name, meta_data, +10 more. Returns: url, qbxml, query, method, +2 more
find_purchase_ordersFind purchase ordersBRead-onlyIdempotentInspect
Queries for the specified purchase order or set of orders.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +15 more. Returns: url, qbxml, query, method, +2 more
find_receive_paymentsFind receive paymentsARead-onlyIdempotentInspect
Finds received payments: exact ones by txn_id or ref_number, or a filtered set by customer (entity_filter), date or account. What each payment paid (its applied_to_txn_ret) comes back only with include_line_items, though a payment has no lines: without it, a payment applied to invoices answers none. Each applied_to_txn_ret's balance_remaining and txn_date are the invoice's as it is now, not when the payment was made (both observed on QuickBooks Enterprise 24.0, 2026-10-10). Set iterator to page through many results.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_receive_payment_to_depositsFind receive payment to depositsARead-onlyIdempotentInspect
This query returns information about payments that have been received and are ready to deposit. You can use any returned txn_id and txn_line_id elements as PaymentTxnID and PaymentTxnLineID elements in subsequent DespositAdd requests. Note: If you include an explicit end tag in a ReceivePaymentToDepositQuery request, you will receive an error if there is any space between the opening tag and the end tag. The following table shows valid and invalid ways of constructing this request:
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: meta_data, request_id, include_qbxml, include_ret_element. Returns: url, qbxml, query, method, +2 more
find_sales_ordersFind sales ordersBRead-onlyIdempotentInspect
Queries for the specified sales order or set of sales orders.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_sales_receiptsFind sales receiptsBRead-onlyIdempotentInspect
Queries for the specified sales receipt or set of receipts.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_sales_repsFind sales repsBRead-onlyIdempotentInspect
Queries for the specified sales rep or set of reps.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_sales_tax_codesFind sales tax codesARead-onlyIdempotentInspect
Queries for the specified sales tax code or set of codes.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_sales_tax_payablesFind sales tax payablesARead-onlyIdempotentInspect
Builds a v2 sales_tax_payable.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: meta_data, as_of_date, request_id, include_qbxml, +1 more. Returns: url, qbxml, query, method, +2 more
find_sales_tax_payment_checksFind sales tax payment checksARead-onlyIdempotentInspect
Queries for payments that have been made for sales tax owed (for example, to a state sales tax authority).
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +14 more. Returns: url, qbxml, query, method, +2 more
find_sales_tax_return_linesFind sales tax return linesBRead-onlyIdempotentInspect
Builds a v2 sales_tax_return_line.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: tax_agency_vendor_ref (required), meta_data, request_id, include_qbxml. Returns: url, qbxml, query, method, +2 more
find_sales_tax_returnsFind sales tax returnsBRead-onlyIdempotentInspect
Builds a v2 sales_tax_return.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: meta_data, request_id, include_qbxml. Returns: url, qbxml, query, method, +2 more
find_ship_methodsFind ship methodsBRead-onlyIdempotentInspect
Queries for the specified shipping method or set of methods.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_standard_termsFind standard termsARead-onlyIdempotentInspect
Queries for the specified standard term or set of terms.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_templatesFind templatesBRead-onlyIdempotentInspect
A template query returns the names of all templates that have been defined in QuickBooks. Templates are mainly used for specifying how to print certain transactions. The following transactions can have templates defined for them: credit memo, estimate, invoice, purchase order, sales order, sales receipt, receipt payment and bill payment customization.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: meta_data, request_id, include_qbxml, include_ret_element. Returns: url, qbxml, query, method, +2 more
find_termsFind termsBRead-onlyIdempotentInspect
Queries for the terms or set of terms. Refers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.) If a TermsRef aggregate includes both full_name and list_id, full_name will be ignored.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_time_reportsFind time reportsBRead-onlyIdempotentInspect
The Time Reports category includes summary and detail reports related by time. Summarized columns can be customized in these reports.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: time_report_type (required), request_id, return_rows, include_qbxml, +11 more. Returns: url, qbxml, query, method, +2 more
find_time_trackingsFind time trackingsBRead-onlyIdempotentInspect
The time-tracking transactions that are returned in this query include time tracking information that was entered into QuickBooks manually or gathered using the QuickBooks “Timer” or “Stopwatch.”
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, meta_data, request_id, +6 more. Returns: url, qbxml, query, method, +2 more
find_to_dosFind to dosBRead-onlyIdempotentInspect
A “to do”list is used in QuickBooks to keep track of tasks. Notice that the various Name filters refer to the Notes field in the ToDoQuery. So, by using these filters, you are searching the Notes.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, meta_data, request_id, done_status, +8 more. Returns: url, qbxml, query, method, +2 more
find_transactionsFind transactionsARead-onlyIdempotentInspect
TransactionQuery is a generic transaction query that provides functionality (e.g. filters) similar to the Advanced Find window in the QuickBooks UI. It allows you to search for transactions across different transaction types. In contrast to the other transaction-specific queries, the TransactionQuery only returns data common to all transactions, such as txn_id, type, dates, accountRef, and so on. This query does return condensed transactions.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, meta_data, ref_number, +18 more. Returns: url, qbxml, query, method, +2 more
find_transfer_inventoriesFind transfer inventoriesARead-onlyIdempotentInspect
Builds a v2 transfer_inventory.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, meta_data, ref_number, +13 more. Returns: url, qbxml, query, method, +2 more
find_transfersFind transfersARead-onlyIdempotentInspect
Builds a v2 transfer.query request.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, meta_data, request_id, +5 more. Returns: url, qbxml, query, method, +2 more
find_txn_deletedsFind txn deletedsARead-onlyIdempotentInspect
Lists the transactions deleted in the last 90 days, of the types txn_del_type names and no others: a deleted payment isn't listed when txn_del_type names only invoice and sales_order (observed on QuickBooks Enterprise 24.0, 2026-10-10), so name every type your app keeps. Each comes back with its type, id, reference number and when it was created and deleted, grouped by type in the order you named them; deleted_date_range_filter narrows it to a window.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_del_type (required), meta_data, request_id, include_qbxml, +2 more. Returns: url, qbxml, query, method, +2 more
find_unit_of_measure_setsFind unit of measure setsBRead-onlyIdempotentInspect
Queries for the UOM sets specified in the filters used.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_vehicle_mileagesFind vehicle mileagesARead-onlyIdempotentInspect
VehicleQuery is a transaction query that returns vehicle mileage transaction data for all vehicle mileage transactions that match the provided filter criteria. You can query by transaction ID, or by transaction date, or by date modified.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, meta_data, request_id, +5 more. Returns: url, qbxml, query, method, +2 more
find_vehiclesFind vehiclesARead-onlyIdempotentInspect
VehicleQuery is a list query that returns vehicle data for all vehicles that match the provided filter criteria. You can query by vehicle list ID, or its name, or by name comparision or by a range of name comparisons (name filters).
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_vendor_creditsFind vendor creditsBRead-onlyIdempotentInspect
Queries for the specified vendor credit or set of credits.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: txn_id, iterator, owner_id, meta_data, +15 more. Returns: url, qbxml, query, method, +2 more
find_vendorsFind vendorsARead-onlyIdempotentInspect
Queries for the specified vendor or set of vendors.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, iterator, owner_id, full_name, +13 more. Returns: url, qbxml, query, method, +2 more
find_vendor_typesFind vendor typesBRead-onlyIdempotentInspect
Queries for the specified vendor type or set of types.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +8 more. Returns: url, qbxml, query, method, +2 more
find_workers_comp_codesFind workers comp codesARead-onlyIdempotentInspect
Requires the company to be subscribed to Intuit Payroll service. Queries for the workers’ compensation codes specified in the query filter; you can filter by name, modified date, and effective date.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Inputs: list_id, full_name, meta_data, request_id, +10 more. Returns: url, qbxml, query, method, +2 more
get_integration_checklistGet integration checklistRead-onlyIdempotentInspect
Returns QuBe Sync's integration checklist as Markdown: the 53 rules an app integrating with QuBe Sync has to get right (verifying webhook signatures on the raw body, answering 2xx within 5 seconds and working in a job, a new run reference saved before the start, revisions and delivery ids, never answering a run's question for the user, QuickBooks ids keyed by their connection and list, lost answers, webhooks not polling...). Each has an id, a severity, when it applies, why, what to check in the code, what wrong and right look like, and its docs. Read it before writing or reviewing an integration's webhook handler, run starts or stored QuickBooks ids. Pass area for one area's rules. To audit a whole codebase, a coding agent can follow the audit skill at https://qubesync.com/skills/qube-sync-audit/SKILL.md, which has every rule.
Inputs: area.
get_workflow_authoring_guideGet workflow authoring guideRead-onlyIdempotentInspect
Returns the QuBeSync workflow authoring guide: the rules for writing a workflow chart (a JSON statechart that runs qbXML requests against QuickBooks Desktop), the chart JSON Schema, and a canonical example. Load this before writing or editing a chart, then check your chart with validate_workflow_chart.
Inputs: no named parameters.
get_workflow_templateGet workflow templateRead-onlyIdempotentInspect
Returns one shipped workflow chart template by key (see list_workflow_templates), with the child workflows it calls, every question it can ask (each prompt.id, with its options) and every way it can end, and the API calls that install and run it. Its whole usage contract, with example webhooks and answers, is GET /api/v2/workflow-templates/{key}/usage.md (or /usage for JSON), readable before anything is installed. Unmodified, install it with POST /api/v2/workflow-templates/{key}/install (body {"publish": true}), which installs its child workflows too ("replace": true re-installs over the ones the app already has); adapted (check with validate_workflow_chart), install it with PUT /api/v2/workflows/{key} (publish: true), each child first. Then run it with POST /api/v2/connections/{connection_id}/workflow-runs with an input matching the chart's declared inputs, on a realtime or simulated connection: a standard one answers 422 with errors.code realtime_required and nothing stored, so the same call starts the run once the connection is upgraded. An installed workflow is a copy: when the template changes later, GET /api/v2/workflows/{key} says so in template.status (update_available), and installing it again with "replace": true takes the new version.
Inputs: key (required).
list_workflow_templatesList workflow templatesRead-onlyIdempotentInspect
Lists the workflow chart templates QuBeSync ships (key, name, description): complete, tested charts for the common multi-step jobs. These match names -- ranked against the connection's name index (ACME, Inc. finds Acme Inc) -- and ask your app about near matches: resolve (any list record by kind and name -- a customer, a job, a vendor, an item, an account -- or the ListID it stored), ensure (resolve, then create what is missing, asking when the name is held elsewhere in its name space), upsert (resolve, then update, or create, asking as ensure does when the name is held elsewhere), push_records (many upserts) and add_transaction (any transaction add, once every customer, item, class or account it names exists: it finds each and asks every question first, then creates what is missing by a rule per kind). The rest: resolve_transaction (a transaction by id, number or GUID); record a payment (asking when it's more than the invoice owes, or the invoice isn't there); void a transaction; read the company's profile (company, preferences, host); pull every record, or those changed and deleted since a date, paged to your app (pull_changes, stream_query). A workflow runs server-side against a connection, settles requests QuickBooks never answered, asks before overwriting a record someone else changed, and can pause for a decision from your app. Workflows run on realtime and simulated connections only (a standard one answers 422 realtime_required). Install one as-is, child workflows included, with POST /api/v2/workflow-templates/{key}/install (body {"publish": true}; add "replace": true to re-install over workflows the app already has); fetch it with get_workflow_template to read or adapt it first.
Inputs: no named parameters.
match_recordsMatch recordsRead-onlyIdempotentInspect
Finds the record in a customer's QuickBooks company file that a name means, even written differently -- QuickBooks itself only matches a name exactly, or by 'contains' on one list. Checks the arguments and returns the v2 request to send (POST /api/v2/connections/{connection_id}/matches); it never touches a connection. Matching needs a realtime or simulated connection: a standard one answers 422 matching_requires_realtime (switching a sandbox connection to realtime is free). The first match on a connection starts building its name index and answers 409 name_index_building until it's ready, a few Web Connector sessions later; POST /api/v2/connections/{connection_id}/name-index with a webhook_url to start it ahead and be sent name_index.ready. The answer's match is a tier: exact (the full name, as QuickBooks compares names: use record), strong (exactly one record is the same once punctuation, accents, company suffixes such as Inc/LLC, spacing or word order are set aside, has the same number in its name (Subway #1234 for Subway Store 1234), has the account number sent, or shares the email, phone or postal code: likely, so confirm record before using it), candidates (up to 10 ranked records with a score and reasons: ask which, if any) or none. Numbers in names must agree: Subway #1235 is never offered for Subway #1234. When candidates_total is more than a person can choose from (a file of numbered locations), ask for what tells them apart -- the number, city, postal_code or account_number -- and match again with it. exact_only: true answers exact or none; min_score moves the candidate threshold for one call. Match a record once: when it's confirmed, store its list_id and refer to it by that (customer_ref: {list_id}); match again only when a stored list_id stops working.
Inputs: kind (required), name (required), fields, parent, +2 more. Returns: url, body, answer, method
record_paymentRecord paymentARead-onlyIdempotentInspect
Records a customer's payment. Set customer_ref, total_amount and either is_auto_apply (true: to an invoice of that exact amount, else the oldest; false: to none) or applied_to_txn_add: each invoice's txn_id and amount, at most what it owes (more fails with 3210 invalid_value); the rest is unused_payment. A line can also apply a credit memo (set_credit); a total_amount of 0 that only does that creates no payment and answers just each invoice's txn_id and txn_type. Without ref_number a payment gets no number; without deposit_to_account_ref it goes to Undeposited Funds.
The receive_payment_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Inputs: customer_ref (required), memo, txn_date, def_macro, +13 more. Returns: url, body, qbxml, method, +2 more
report_confusionReport confusionInspect
Send feedback to the QuBe Sync team about something in this server, its guides, or the v2 API that confused you, so we can fix it. Use it when a tool description or guide was unclear or contradicted what actually happened, an error didn't say how to fix it, you had to guess a parameter, endpoint, or behavior, or you couldn't find a way to do what your user needed. Make one call per problem, after you've got past it or given up, and put what the answer turned out to be in answer. Not for praise, and not for bugs in your user's own app. The QuBe Sync team stores and reads these reports: never include API keys, webhook secrets, your user's code, or QuickBooks data such as customer names and amounts -- describe the problem in terms of our tools and docs.
Inputs: kind (required), details (required), outcome (required), summary (required), +3 more. Returns: id, stored
update_accountUpdate accountARead-onlyIdempotentInspect
Modifies an Account.
The account_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), desc, name, +13 more. Returns: url, body, qbxml, method, +2 more
update_billUpdate billBRead-onlyIdempotentInspect
BillMod allows you to edit an existing Bill, similar to editing a Bill in the Enter Bills form in the QuickBooks UI.
The bill_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, due_date, +17 more. Returns: url, body, qbxml, method, +2 more
update_bill_payment_checkUpdate bill payment checkCRead-onlyIdempotentInspect
Generally, this is what you can do with BillPaymentCheckMod:
The bill_payment_check_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, amount, +9 more. Returns: url, body, qbxml, method, +2 more
update_build_assemblyUpdate build assemblyCRead-onlyIdempotentInspect
Modifies an existing build assembly transaction in the QuickBooks company.
The build_assembly_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +11 more. Returns: url, body, qbxml, method, +2 more
update_chargeUpdate chargeCRead-onlyIdempotentInspect
Some fields in a ChargeMod request can’t be cleared. If any of the following fields is included in a charge modify request, it must contain a value:
The charge_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), desc, rate, +19 more. Returns: url, body, qbxml, method, +2 more
update_checkUpdate checkARead-onlyIdempotentInspect
Modifies an existing Check. Notice that you can’t use this to modify BillPaymentChecks.
The check_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, address, +17 more. Returns: url, body, qbxml, method, +2 more
update_classUpdate classCRead-onlyIdempotentInspect
Modifies the specified class.
The class_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, is_active, +4 more. Returns: url, body, qbxml, method, +2 more
update_cleared_statusUpdate cleared statusBRead-onlyIdempotentInspect
Changes the cleared status of a transaction.
The cleared_status_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), cleared_status (required), request_id, txn_line_id, +1 more. Returns: url, body, qbxml, method, +2 more
update_credit_card_chargeUpdate credit card chargeBRead-onlyIdempotentInspect
The Credit Card charge mod request allows you to modify an existing credit card charge transaction using the SDK. You can modify most of the fields that can be modified in the QuickBooks UI. That is, this request can be used to modify Purchased from, date, credit card and modify lines from the item table and the expense table.
The credit_card_charge_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +14 more. Returns: url, body, qbxml, method, +2 more
update_credit_card_creditUpdate credit card creditBRead-onlyIdempotentInspect
The Credit Card credit mod request allows you to modify an existing credit card credit transaction using the SDK. You can modify most of the fields that can be modified in the QuickBooks UI. That is, this request can be used to modify Purchased from, date, credit card and modify lines from the item table and the expense table.
The credit_card_credit_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +14 more. Returns: url, body, qbxml, method, +2 more
update_credit_memoUpdate credit memoCRead-onlyIdempotentInspect
Some fields in a CreditMemoMod request can’t be cleared. If any of the following fields is included in a credit-memo modify request, it must contain a value:
The credit_memo_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), fob, memo, +28 more. Returns: url, body, qbxml, method, +2 more
update_currencyUpdate currencyBRead-onlyIdempotentInspect
This request is used primarily for changing the is_active status of the built-in QuickBooks currencies. However, it can also be used to modify anything in user-defined currencies. When used on a built-in currency, this request can’t modify name or currency code, neither of which can be modified in the UI either.
The currency_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, is_active, +5 more. Returns: url, body, qbxml, method, +2 more
update_customerUpdate customerBRead-onlyIdempotentInspect
Changes a customer or job. Send its list_id, the edit_sequence QuickBooks last returned for it, and only the fields to change; the rest keep their values. If the customer changed since you read it, QuickBooks answers 3200 stale_edit_sequence with the customer as it stands in error.current: re-apply your change and retry with its edit_sequence.
The customer_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), cc, fax, +52 more. Returns: url, body, qbxml, method, +2 more
update_data_extUpdate data extARead-onlyIdempotentInspect
Sets the value of a custom field (owner_id 0) or private extension (your GUID) on a list object or transaction. The object needn't have a value yet: on QuickBooks Enterprise 24.0 (2026-10-10) this set a custom field's first value on a new sales order, so you don't need data_ext.create first. The definition must reach the object's type: a custom field defined on Customer also reaches credit memos, estimates, invoices, sales orders and sales receipts. It can't clear a value; delete the value instead.
The data_ext_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: owner_id (required), data_ext_name (required), data_ext_value (required), txn_id, +7 more. Returns: url, body, qbxml, method, +2 more
update_data_ext_defUpdate data ext defBRead-onlyIdempotentInspect
Modifies an existing data extension definition. Notice that this Mod doesn’t allow you to change the type originally assigned to the data extension def, but it allows you to change just about everything else, such as its name and the objects it is assigned to.
The data_ext_def_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: owner_id (required), data_ext_name (required), request_id, include_qbxml, +7 more. Returns: url, body, qbxml, method, +2 more
update_depositUpdate depositBRead-onlyIdempotentInspect
Modifies an existing deposit.
The deposit_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +8 more. Returns: url, body, qbxml, method, +2 more
update_employeeUpdate employeeCRead-onlyIdempotentInspect
Modifies and existing employee.
The employee_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), fax, name, +46 more. Returns: url, body, qbxml, method, +2 more
update_employee_defaultUpdate employee defaultCRead-onlyIdempotentInspect
Builds a v2 employee_default.update request.
The employee_default_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml, include_ret_element, employee_default_payroll_info_mod. Returns: url, body, qbxml, method, +2 more
update_estimateUpdate estimateCRead-onlyIdempotentInspect
Some fields in an EstimateMod request can’t be cleared. If any of the following fields is included in an estimate modify request, it must contain a value:
The estimate_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), fob, memo, +25 more. Returns: url, body, qbxml, method, +2 more
update_form1099_category_account_mappingUpdate form1099 category account mappingBRead-onlyIdempotentInspect
This request is used to specify how the QuickBooks company file tracks payments subject to 1099-MISC and 1099-NEC. You can use it to specify one or more accounts for each of the 1099 categories.
The form1099_category_account_mapping_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: request_id, include_qbxml, is_filing1099_misc, category_account_mapping_mod. Returns: url, body, qbxml, method, +2 more
update_inventory_adjustmentUpdate inventory adjustmentBRead-onlyIdempotentInspect
Builds a v2 inventory_adjustment.update request.
The inventory_adjustment_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +9 more. Returns: url, body, qbxml, method, +2 more
update_inventory_siteUpdate inventory siteBRead-onlyIdempotentInspect
Builds a v2 inventory_site.update request.
The inventory_site_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), fax, name, +10 more. Returns: url, body, qbxml, method, +2 more
update_invoiceUpdate invoiceARead-onlyIdempotentInspect
Changes an invoice. Send its txn_id and the edit_sequence QuickBooks last returned for it. To change a line, send it in invoice_line_mod with its txn_line_id; to add a line, send txn_line_id -1. Some fields can't be cleared: if you send customer_ref, txn_date, due_date, or a line's item_ref, quantity, rate or amount, it must have a value.
The invoice_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), fob, memo, +29 more. Returns: url, body, qbxml, method, +2 more
update_item_discountUpdate item discountCRead-onlyIdempotentInspect
Modifies a discount item. Starting with qbXML spec 7.0, you can modify the account ref, using the account_ref aggregate and the apply_account_ref_to_existing_txns boolean. You need to use the apply_account_ref_to_existing_txns boolean because the QuickBooks UI displays a prompt asking whether the change should apply to existing transactions or not. Specifying True for the boolean basically dismisses this with a “Yes” answer, allowing your changes to be made and changes any existing transactions that use the item with that account_ref.
The item_discount_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +12 more. Returns: url, body, qbxml, method, +2 more
update_item_fixed_assetUpdate item fixed assetCRead-onlyIdempotentInspect
Modifies a fixed asset item. Fixed-asset items represent assets that will benefit a business for longer than one year. The purchase price of these fixed assets is typically expensed over a period of years, rather than in the year the purchase was made.
The item_fixed_asset_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, notes, +22 more. Returns: url, body, qbxml, method, +2 more
update_item_groupUpdate item groupBRead-onlyIdempotentInspect
Modifies an item group.
The item_group_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +10 more. Returns: url, body, qbxml, method, +2 more
update_item_inventoryUpdate item inventoryCRead-onlyIdempotentInspect
Modifies an inventory item. Starting with qbXML spec 7.0, you can modify the income account ref, using the income_account_ref aggregate and the apply_income_account_ref_to_existing_txns boolean. You need to use the apply_income_account_ref_to_existing_txns boolean because the QuickBooks UI displays a prompt asking whether the change should apply to existing transactions or not. Specifying True for the boolean basically dismisses this with a “Yes” answer, allowing your changes to be made and changes any existing transactions that use the item with that AccountRef.
The item_inventory_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), max, name, +24 more. Returns: url, body, qbxml, method, +2 more
update_item_inventory_assemblyUpdate item inventory assemblyBRead-onlyIdempotentInspect
Modifies an inventory assembly item. If you are adding components to the assembly, remember that the component items and/or assemblies that make up the assembly are limited in number. For Premier, an assembly can have a maximum of 100 components. For Enterprise, the maximum is 500 components.
The item_inventory_assembly_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), max, name, +25 more. Returns: url, body, qbxml, method, +2 more
update_item_non_inventoryUpdate item non inventoryCRead-onlyIdempotentInspect
Modifies a non inventory item. About sales_or_purchase_mod versus sales_and_purchase_mod in an ItemNonInventoryMod request:
The item_non_inventory_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +13 more. Returns: url, body, qbxml, method, +2 more
update_item_other_chargeUpdate item other chargeCRead-onlyIdempotentInspect
About sales_or_purchase_mod versus sales_and_purchase_mod in an ItemOtherChargeMod request:
The item_other_charge_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +10 more. Returns: url, body, qbxml, method, +2 more
update_item_paymentUpdate item paymentBRead-onlyIdempotentInspect
For an ItemPaymentMod request, you can “set” the “Group with undeposited funds” radio button in QuickBooks by either attempting to clear the deposit_to_account_ref, or by specifying the account whose SpecialAccountType is UndepositedFunds for the deposit_to_account_ref.
The item_payment_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +8 more. Returns: url, body, qbxml, method, +2 more
update_item_receiptUpdate item receiptCRead-onlyIdempotentInspect
Modifies an existing item receipt.
The item_receipt_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +14 more. Returns: url, body, qbxml, method, +2 more
update_item_sales_taxUpdate item sales taxCRead-onlyIdempotentInspect
Modifies an existing sales tax item.
The item_sales_tax_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +9 more. Returns: url, body, qbxml, method, +2 more
update_item_sales_tax_groupUpdate item sales tax groupCRead-onlyIdempotentInspect
Modifies an existing sales-tax group item.
The item_sales_tax_group_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +6 more. Returns: url, body, qbxml, method, +2 more
update_item_serviceUpdate item serviceCRead-onlyIdempotentInspect
About sales_or_purchase_mod versus sales_and_purchase_mod in an ItemServiceMod request:
The item_service_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +12 more. Returns: url, body, qbxml, method, +2 more
update_item_subtotalUpdate item subtotalCRead-onlyIdempotentInspect
Modifies an existing subtotal item.
The item_subtotal_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, bar_code, +5 more. Returns: url, body, qbxml, method, +2 more
update_journal_entryUpdate journal entryCRead-onlyIdempotentInspect
Modifies a journal entry. If the transaction is a home currency adjustment, QuickBooks will ignore the is_amounts_entered_in_home_currency, currency_ref, and exchange_rate elements.
The journal_entry_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), txn_date, ref_number, +8 more. Returns: url, body, qbxml, method, +2 more
update_leadUpdate leadBRead-onlyIdempotentInspect
Builds a v2 lead.update request.
The lead_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), full_name (required), edit_sequence (required), status, +8 more. Returns: url, body, qbxml, method, +2 more
update_list_displayUpdate list displayARead-onlyIdempotentInspect
A ListDisplayMod request opens a QuickBooks list element within the QuickBooks UI for modification.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), list_display_mod_type (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
update_other_nameUpdate other nameBRead-onlyIdempotentInspect
Modifies an existing other name.
The other_name_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), fax, name, +17 more. Returns: url, body, qbxml, method, +2 more
update_payroll_item_additionUpdate payroll item additionBRead-onlyIdempotentInspect
Builds a v2 payroll_item_addition.update request.
The payroll_item_addition_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, rate, +14 more. Returns: url, body, qbxml, method, +2 more
update_payroll_item_company_contributionUpdate payroll item company contributionBRead-onlyIdempotentInspect
Builds a v2 payroll_item_company_contribution.update request.
The payroll_item_company_contribution_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, rate, +19 more. Returns: url, body, qbxml, method, +2 more
update_payroll_item_deductionUpdate payroll item deductionBRead-onlyIdempotentInspect
Builds a v2 payroll_item_deduction.update request.
The payroll_item_deduction_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, rate, +17 more. Returns: url, body, qbxml, method, +2 more
update_payroll_item_direct_depositUpdate payroll item direct depositBRead-onlyIdempotentInspect
Builds a v2 payroll_item_direct_deposit.update request.
The payroll_item_direct_deposit_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, is_active, +5 more. Returns: url, body, qbxml, method, +2 more
update_payroll_item_taxUpdate payroll item taxBRead-onlyIdempotentInspect
Builds a v2 payroll_item_tax.update request.
The payroll_item_tax_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, rate, +16 more. Returns: url, body, qbxml, method, +2 more
update_payroll_item_wageUpdate payroll item wageBRead-onlyIdempotentInspect
Builds a v2 payroll_item_wage.update request.
The payroll_item_wage_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, rate, +8 more. Returns: url, body, qbxml, method, +2 more
update_payroll_item_workers_compensationUpdate payroll item workers compensationBRead-onlyIdempotentInspect
Builds a v2 payroll_item_workers_compensation.update request.
The payroll_item_workers_compensation_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, is_active, +11 more. Returns: url, body, qbxml, method, +2 more
update_preferencesUpdate preferencesARead-onlyIdempotentInspect
Builds a v2 preferences.update request.
The preferences_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: accounting_preferences_mod (required), request_id, include_qbxml, include_ret_element. Returns: url, body, qbxml, method, +2 more
update_price_levelUpdate price levelBRead-onlyIdempotentInspect
Modifies a price level. The currency_ref should only be used with “per item” price levels.
The price_level_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), name, is_active, +6 more. Returns: url, body, qbxml, method, +2 more
update_purchase_orderUpdate purchase orderCRead-onlyIdempotentInspect
Some fields in a PurchaseOrderMod request can’t be cleared. If any of the following fields is included in a purchase order modify request, it must contain a value:
The purchase_order_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), fob, memo, +27 more. Returns: url, body, qbxml, method, +2 more
update_receive_paymentUpdate receive paymentBRead-onlyIdempotentInspect
Modifies a receive payment transaction. If you save QBMS credit card data in your ReceivePayments, this Mod request allows you to capture a previously authorized credit card charge. The way this works is that the ReceivePaymentAdd would contain the QBMS credit_card_txn_info aggregate with the credit_card_txn_type set to “Authorization,” which causes QB to internally mark the transaction as pending.
The receive_payment_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +12 more. Returns: url, body, qbxml, method, +2 more
update_sales_orderUpdate sales orderCRead-onlyIdempotentInspect
Some fields in a SalesOrderMod request can’t be cleared. If any of the following fields is included in a sales-order modify request, it must contain a value:
The sales_order_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), fob, memo, +27 more. Returns: url, body, qbxml, method, +2 more
update_sales_receiptUpdate sales receiptCRead-onlyIdempotentInspect
Modifies an existing Sales receipt.
The sales_receipt_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), fob, memo, +28 more. Returns: url, body, qbxml, method, +2 more
update_sales_repUpdate sales repCRead-onlyIdempotentInspect
Modifies a sales rep record.
The sales_rep_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), initial, is_active, +4 more. Returns: url, body, qbxml, method, +2 more
update_sales_tax_codeUpdate sales tax codeBRead-onlyIdempotentInspect
This modifies the specified sales tax code, subject to a few limitations. You can’t use it to change a tax code’s is_taxable property after the code has been used in any transaction. For the default QuickBooks taxable (Tax) and exempt (Non) tax codes, you can’t use this request to change the is_taxable property at all, even before any transactions.
The sales_tax_code_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), desc, name, +7 more. Returns: url, body, qbxml, method, +2 more
update_sales_tax_payment_checkUpdate sales tax payment checkBRead-onlyIdempotentInspect
Builds a v2 sales_tax_payment_check.update request.
The sales_tax_payment_check_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, address, +7 more. Returns: url, body, qbxml, method, +2 more
update_time_trackingUpdate time trackingARead-onlyIdempotentInspect
Modifies a time tracking transaction. This allows you to modify time entry and mark time entered as billed.
The time_tracking_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), duration (required), entity_ref (required), edit_sequence (required), +11 more. Returns: url, body, qbxml, method, +2 more
update_to_doUpdate to doARead-onlyIdempotentInspect
Builds a v2 to_do.update request.
The to_do_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), type, notes, +12 more. Returns: url, body, qbxml, method, +2 more
update_transferUpdate transferARead-onlyIdempotentInspect
Builds a v2 transfer.update request.
The transfer_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, amount, +7 more. Returns: url, body, qbxml, method, +2 more
update_transfer_inventoryUpdate transfer inventoryBRead-onlyIdempotentInspect
Builds a v2 transfer_inventory.update request.
The transfer_inventory_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +7 more. Returns: url, body, qbxml, method, +2 more
update_txn_displayUpdate txn displayARead-onlyIdempotentInspect
A TxnDisplayMod request opens a QuickBooks transaction within the QuickBooks UI for modification.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), txn_display_mod_type (required), request_id, include_qbxml. Returns: url, body, qbxml, method, +2 more
update_vehicleUpdate vehicleCRead-onlyIdempotentInspect
Modifies a vehicle already in the vehicle list. Any modification, including changing the name, will cause corresponding changes in existing VehicleMileage transactions and in reports.
The vehicle_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), desc, name, +4 more. Returns: url, body, qbxml, method, +2 more
update_vendorUpdate vendorCRead-onlyIdempotentInspect
Modifies a vendor.
The vendor_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), cc, fax, +47 more. Returns: url, body, qbxml, method, +2 more
update_vendor_creditUpdate vendor creditBRead-onlyIdempotentInspect
Modifies a vendor credit. Be careful! If you modify ANY line item, you must fully re-construct the line item table as you want it because if you edit even a single line item, any line item that is NOT in the vendor credit mod will be omitted. For full details, see the QB SDK Programmer’s Guide (PDF, 9.6 MB) chapter on modifying and deleting transactions and list objects.
The vendor_credit_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: txn_id (required), edit_sequence (required), memo, txn_date, +14 more. Returns: url, body, qbxml, method, +2 more
update_workers_comp_codeUpdate workers comp codeCRead-onlyIdempotentInspect
Requires the company to be subscribed to Intuit Payroll service. Modifies an existing workers’ compensation code. Notice that if a future date exists and you write a new one (using the Mod request) then the most recently written code wins.
The workers_comp_code_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Inputs: list_id (required), edit_sequence (required), desc, name, +5 more. Returns: url, body, qbxml, method, +2 more
validate_workflow_chartValidate workflow chartRead-onlyIdempotentInspect
Validates a workflow chart without saving or running it -- the same structural validation and lint as POST /api/v2/workflows/validate, minus the checks that need a specific app. Returns {valid, errors, warnings, workflows_to_create}. errors block saving/publishing and must be fixed; warnings are likely mistakes worth reviewing. Each issue has a path into the chart document (e.g. states.create.on.success.0.target) and a message. A workflow state calling a child workflow not listed in known_workflows is reported as a warning, and its key is listed in workflows_to_create: that workflow must exist and be published in the app before this chart can be published.
Inputs: chart (required), known_workflows. Returns: valid, errors, warnings, workflows_to_create
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
Related MCP Connectors
The best QuickBooks Desktop MCP server on the planet: every operation on every record type
Connect QuickBooks Online to AI agents with secure read or write access across multiple companies.
Read QuickBooks Desktop data; after your yes, create sales orders and approve PO dates and payments
QuickBooks MCP Pack — query customers, invoices, and accounts via QuickBooks Online API.
Related MCP Servers
- AlicenseNot gradedqualityBmaintenanceExposes six tools that let MCP clients such as Claude, ChatGPT, Cursor and VS Code discover, validate and execute any of 240 qbXML operations against a QuickBooks Desktop company file, explain QuickBooks error codes, and check bridge status, plus a matching HTTP endpoint for sending qbXML from your own code. It runs beside QuickBooks on the Windows machine and can be reached locally, over the office network, or via a managed relay.MIT
- AlicenseNot gradedqualityDmaintenanceEnables QuickBooks Online integration for financial management with CRUD operations, reporting, real-time updates, and automation.16 npm3MIT
- AlicenseNot gradedqualityCmaintenanceProvides complete coverage of the QuickBooks Online Accounting API v3, enabling queries, financial reports, sales and expense management, and write operations with deployment-controlled access.MIT
- AlicenseNot gradedqualityDmaintenanceProvides 55 tools for managing QuickBooks entities like customers, invoices, and bills via any MCP-compatible client, built on Cloudflare Workers with OAuth 2.0 authentication.11Apache 2.0
Glama MCP Gateway
Add one secure layer between your agents and this server.