Sign in

v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Update a build assembly

Updates an existing build assembly.

post/quickbooks-desktop/build-assemblies/{id}

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the build assembly to update.

Example:123ABC-1234567890

The QuickBooks-assigned unique identifier of the build assembly to update.

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Request body

revisionNumberstring required

The current QuickBooks-assigned revision number of the build assembly object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

inventorySiteIdstring

The site location where inventory for the item associated with this build assembly is stored.

inventorySiteLocationIdstring

The specific location (e.g., bin or shelf) within the inventory site where the item associated with this build assembly is stored.

serialNumberstring

The serial number of the item associated with this build assembly. This is used for tracking individual units of serialized inventory items.

lotNumberstring

The lot number of the item associated with this build assembly. Used for tracking groups of inventory items that are purchased or manufactured together.

expirationDatestring date

The expiration date for the serial number or lot number of the item associated with this build assembly, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.

transactionDatestring date

The date of this build assembly, in ISO 8601 format (YYYY-MM-DD).

refNumberstring

The case-sensitive user-defined reference number for this build assembly, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

Maximum length: 11 characters.

memostring

A memo or note for this build assembly.

quantityToBuildnumber

The number of build assembly to be built. The transaction will fail if the number specified here exceeds the number of on-hand components.

markPendingIfRequiredboolean

When true, the build assembly will be marked pending if there are insufficient quantities to complete the build assembly.

removePendingboolean

When true, changes this build assembly's status from pending to non-pending, which effectively performs the build transaction. The operation will fail if there are insufficient component quantities on hand to complete the build.

Example request

{
  "revisionNumber": "1721172183",
  "inventorySiteId": "80000001-1234567890",
  "inventorySiteLocationId": "80000001-1234567890",
  "serialNumber": "SN1234567890",
  "lotNumber": "LOT2023-001",
  "expirationDate": "2025-12-31",
  "transactionDate": "2024-10-01",
  "refNumber": "BUILD-1234",
  "memo": "Assembled 25 units of Model ABC-123 Office Chair",
  "quantityToBuild": 7,
  "markPendingIfRequired": true,
  "removePending": true
}

Response

Returns the updated build assembly.

idstring required

The unique identifier assigned by QuickBooks to this build assembly. This ID is unique across all transaction types.

objectType'qbd_build_assembly' required

The type of object. This value is always "qbd_build_assembly".

createdAtstring required

The date and time when this build assembly was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this build assembly was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this build assembly object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

serialNumberstring nullable required

The serial number of the item associated with this build assembly. This is used for tracking individual units of serialized inventory items.

lotNumberstring nullable required

The lot number of the item associated with this build assembly. Used for tracking groups of inventory items that are purchased or manufactured together.

expirationDatestring date nullable required

The expiration date for the serial number or lot number of the item associated with this build assembly, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.

transactionDatestring date required

The date of this build assembly, in ISO 8601 format (YYYY-MM-DD).

refNumberstring nullable required

The case-sensitive user-defined reference number for this build assembly, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

memostring nullable required

A memo or note for this build assembly.

isPendingboolean nullable required

Indicates whether this build assembly has not been completed.

quantityToBuildnumber required

The number of build assembly to be built. The transaction will fail if the number specified here exceeds the number of on-hand components.

quantityCanBuildnumber required

The number of this build assembly that can be built from the parts on hand.

quantityOnHandnumber required

The number of units of this build assembly currently in inventory.

quantityOnSalesOrdernumber required

The number of units of this build assembly that have been sold (as recorded in sales orders) but not yet fulfilled or delivered to customers.

externalIdstring nullable required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_build_assembly",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "inventoryAssemblyItem": {
    "id": "80000001-1234567890",
    "fullName": "Inventory Assembly Item"
  },
  "inventorySite": {
    "id": "80000001-1234567890",
    "fullName": "Main Warehouse"
  },
  "inventorySiteLocation": {
    "id": "80000001-1234567890",
    "fullName": "Aisle 3, Shelf B"
  },
  "serialNumber": "SN1234567890",
  "lotNumber": "LOT2023-001",
  "expirationDate": "2025-12-31",
  "transactionDate": "2024-10-01",
  "refNumber": "BUILD-1234",
  "memo": "Assembled 25 units of Model ABC-123 Office Chair",
  "quantityToBuild": 7,
  "quantityCanBuild": 5,
  "quantityOnHand": 150,
  "quantityOnSalesOrder": 10,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "lines": [
    {
      "item": {
        "id": "80000001-1234567890",
        "fullName": "Widget A"
      },
      "inventorySite": {
        "id": "80000001-1234567890",
        "fullName": "Main Warehouse"
      },
      "inventorySiteLocation": {
        "id": "80000001-1234567890",
        "fullName": "Aisle 3, Shelf B"
      },
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "expirationDate": "2025-12-31",
      "description": "Wood screws, 2-inch, stainless steel",
      "quantityOnHand": 150,
      "quantityNeeded": 3
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}