Create build assembly
create_build_assemblyAdds 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
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"item_inventory_assembly_ref": "<item_inventory_assembly_ref>",
"quantity_to_build": "<quantity_to_build>"
},
"name": "create_build_assembly"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| memo | No | Additional information. | |
| txn_date | No | The date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type. | |
| def_macro | No | `def_macro` lets you assign a reusable name to a returned `txn_id` or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK 2.0+. | |
| lot_number | No | The lot number of the asset. Choose at most one of: `serial_number`, or `lot_number`. | |
| ref_number | No | `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. | |
| request_id | No | Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`. | |
| external_guid | No | Allows for the attachment of a user defined GUID value. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| serial_number | No | The serial number of the asset. Choose at most one of: `serial_number`, or `lot_number`. | |
| quantity_to_build | Yes | Specifies the number of assemblies to be built. The transaction will fail if the number specified here exceeds the number of on-hand components. | |
| inventory_site_ref | No | Site where inventory is located. | |
| include_ret_element | No | ||
| mark_pending_if_required | No | Allows the build assembly to be marked pending if there are insufficient quantities to complete the build assembly. | |
| inventory_site_location_ref | No | Location within the Inventory Site | |
| item_inventory_assembly_ref | Yes | An inventory assembly item is one that is assembled or manufactured from inventory items. The items and/or assemblies that make up the assembly are called components. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |