Retrieve a build assembly

Changed on May 2, 2026

Retrieves a build assembly by ID.

IMPORTANT: If you need to fetch multiple specific build assemblies by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

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

Request

Base URL
https://api.conductor.is/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/conductor-is/apis/conductor-api/docs/quickbooks-desktop/build-assemblies/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

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

Example:123ABC-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified 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"
    }
  ]
}

Changes

May 2, 20261de07095c4b7 Revision changes
- warning
  for the path request parameter id, the maxLength was set to 36
Apr 20, 202610d4e9ebd1df Revision changes
- breaking
  response property expirationDate list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property externalId list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property inventoryAssemblyItem/fullName list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property inventoryAssemblyItem/id list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property isPending list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property lines/items/description list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property lines/items/expirationDate list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property lines/items/lotNumber list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property lines/items/quantityNeeded list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property lines/items/quantityOnHand list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property lines/items/serialNumber list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property lotNumber list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property memo list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property refNumber list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property serialNumber list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  the response's property type changed from object null to no type for status
- breaking
  the response's property type changed from object null to no type for status
- breaking
  the // response's property type changed from object null to no type for status
- breaking
  the // response's property type changed from object null to no type for status
- breaking
  the // response's property type changed from object null to no type for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- info
  added subschema #1 subschema #2 to the response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the // response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the // response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the // response property anyOf list for the response status

Operation history (4 revisions)