POST
/
quickbooks-desktop
/
build-assemblies
/
{id}
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

const buildAssembly = await conductor.qbd.buildAssemblies.update('123ABC-1234567890', {
  revisionNumber: '1721172183',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(buildAssembly.id);
{
  "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",
  "isPending": false,
  "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

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

Example:

"123ABC-1234567890"

Body

application/json
​
revisionNumber
string
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.

Example:

"1721172183"

​
inventorySiteId
string

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

Example:

"80000001-1234567890"

​
inventorySiteLocationId
string

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

Example:

"80000001-1234567890"

​
serialNumber
string

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

Example:

"SN1234567890"

​
lotNumber
string

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

Example:

"LOT2023-001"

​
expirationDate
string<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.

Example:

"2025-12-31"

​
transactionDate
string<date>

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

Example:

"2024-10-01"

​
refNumber
string

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.

Example:

"BUILD-1234"

​
memo
string

A memo or note for this build assembly.

Example:

"Assembled 25 units of Model ABC-123 Office Chair"

​
quantityToBuild
number

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

Example:

7

​
markPendingIfRequired
boolean

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

Example:

true

​
removePending
boolean

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:

true

Response

200 - application/json

Returns the updated build assembly.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_build_assembly"
Example:

"qbd_build_assembly"

​
createdAt
string
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.

Example:

"2025-01-01T12:34:56+00:00"

​
updatedAt
string
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.

Example:

"2025-02-01T12:34:56+00:00"

​
revisionNumber
string
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.

Example:

"1721172183"

​
inventoryAssemblyItem
object
required

The inventory assembly item associated with this build assembly. An inventory assembly item is assembled or manufactured from other inventory items, and the items and/or assemblies that make up the assembly are called components.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Inventory Assembly Item"
}
​
inventorySite
object | null
required

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

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Main Warehouse"
}
​
inventorySiteLocation
object | null
required

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

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Aisle 3, Shelf B"
}
​
serialNumber
string | null
required

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

Example:

"SN1234567890"

​
lotNumber
string | null
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.

Example:

"LOT2023-001"

​
expirationDate
string<date> | null
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.

Example:

"2025-12-31"

​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

​
refNumber
string | null
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.

Example:

"BUILD-1234"

​
memo
string | null
required

A memo or note for this build assembly.

Example:

"Assembled 25 units of Model ABC-123 Office Chair"

​
isPending
boolean | null
required

Indicates whether this build assembly has not been completed.

Example:

false

​
quantityToBuild
number
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.

Example:

7

​
quantityCanBuild
number
required

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

Example:

5

​
quantityOnHand
number
required

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

Example:

150

​
quantityOnSalesOrder
number
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.

Example:

10

​
externalId
string | null
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:

"12345678-abcd-1234-abcd-1234567890ab"

​
lines
The Component Item Line object · object[]
required

The component item lines in this build assembly.

​
customFields
The Custom Field object · object[]
required

The custom fields for the build assembly object, added as user-defined data extensions, not included in the standard QuickBooks object.