Skip to main content
POST
JavaScript

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 End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the service item to update.

Maximum string length: 36
Example:

"80000001-1234567890"

Body

application/json
​
revisionNumber
string
required

The current QuickBooks-assigned revision number of the service item 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"

​
name
string

The case-insensitive name of this service item. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two service items could both have the name "Web-Design", but they could have unique fullName values, such as "Consulting:Web-Design" and "Contracting:Web-Design".

Maximum length: 31 characters.

Maximum string length: 31
Example:

"Web-Design"

​
barcode
object

The service item's barcode.

​
isActive
boolean

Indicates whether this service item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
classId
string

The service item's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

Maximum string length: 36
Example:

"80000001-1234567890"

​
parentId
string

The parent service item one level above this one in the hierarchy. For example, if this service item has a fullName of "Consulting:Web-Design", its parent has a fullName of "Consulting". If this service item is at the top level, this field will be null.

Maximum string length: 36
Example:

"80000001-1234567890"

​
unitOfMeasureSetId
string

The unit-of-measure set associated with this service item, which consists of a base unit and related units.

IMPORTANT: Right after QuickBooks Desktop launches, it can briefly report an alternate id for a unit-of-measure set, so match on fullName when joining to the unit-of-measure sets list.

Maximum string length: 36
Example:

"80000001-1234567890"

​
forceUnitOfMeasureChange
boolean

Indicates whether to allow changing the service item's unit-of-measure set (using the unitOfMeasureSetId field) when the base unit of the new unit-of-measure set does not match that of the currently assigned set. Without setting this field to true in this scenario, the request will fail with an error; hence, this field is equivalent to accepting the warning prompt in the QuickBooks UI.

NOTE: Changing the base unit requires you to update the item's quantities-on-hand and cost to reflect the new unit; otherwise, these values will be inaccurate. Alternatively, consider creating a new item with the desired unit-of-measure set and deactivating the old item.

Example:

false

​
salesTaxCodeId
string

The default sales-tax code for this service item, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

Maximum string length: 36
Example:

"80000001-1234567890"

​
salesOrPurchaseDetails
object

Details for service items that are exclusively sold or exclusively purchased, but not both. This typically applies to non-inventory items (like a purchased office supply that isn't resold) or service items (like consulting services that are sold but not purchased).

IMPORTANT: You cannot specify both salesOrPurchaseDetails and salesAndPurchaseDetails when modifying a service item because an item cannot have both configurations.

​
salesAndPurchaseDetails
object

Details for service items that are both purchased and sold, such as reimbursable expenses or inventory items that are bought from vendors and sold to customers.

IMPORTANT: You cannot specify both salesAndPurchaseDetails and salesOrPurchaseDetails when modifying a service item because an item cannot have both configurations.

Response

200 - application/json

Returns the updated service item.

​
id
string
required

The unique identifier assigned by QuickBooks to this service item. This ID is unique across all service items but not across different QuickBooks object types.

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_service_item"
Example:

"qbd_service_item"

​
createdAt
string
required

The date and time when this service item 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.000Z"

​
updatedAt
string
required

The date and time when this service item 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.000Z"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this service item 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"

​
name
string
required

The case-insensitive name of this service item. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two service items could both have the name "Web-Design", but they could have unique fullName values, such as "Consulting:Web-Design" and "Contracting:Web-Design".

Example:

"Web-Design"

​
fullName
string
required

The case-insensitive fully-qualified unique name of this service item, formed by combining the names of its hierarchical parent objects with its own name, separated by colons. For example, if a service item is under "Consulting" and has the name "Web-Design", its fullName would be "Consulting:Web-Design".

NOTE: Unlike name, fullName is guaranteed to be unique across all service item objects. However, fullName can still be arbitrarily changed by the QuickBooks user when they modify the underlying name field.

Example:

"Consulting:Web-Design"

​
barcode
string | null
required

The service item's barcode.

Example:

"012345678905"

​
isActive
boolean
required

Indicates whether this service item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
class
object | null
required

The service item's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

Example:
​
parent
object | null
required

The parent service item one level above this one in the hierarchy. For example, if this service item has a fullName of "Consulting:Web-Design", its parent has a fullName of "Consulting". If this service item is at the top level, this field will be null.

Example:
​
sublevel
number
required

The depth level of this service item in the hierarchy. A top-level service item has a sublevel of 0; each subsequent sublevel increases this number by 1. For example, a service item with a fullName of "Consulting:Web-Design" would have a sublevel of 1.

Example:

1

​
unitOfMeasureSet
object | null
required

The unit-of-measure set associated with this service item, which consists of a base unit and related units.

IMPORTANT: Right after QuickBooks Desktop launches, it can briefly report an alternate id for a unit-of-measure set, so match on fullName when joining to the unit-of-measure sets list.

Example:
​
salesTaxCode
object | null
required

The default sales-tax code for this service item, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

Example:
​
salesOrPurchaseDetails
The Sales-or-Purchase Details object · object | null
required

Details for service items that are exclusively sold or exclusively purchased, but not both. This typically applies to non-inventory items (like a purchased office supply that isn't resold) or service items (like consulting services that are sold but not purchased).

IMPORTANT: A service item will have either salesAndPurchaseDetails or salesOrPurchaseDetails, but never both because an item cannot have both configurations.

​
salesAndPurchaseDetails
The Sales-and-Purchase Details object · object | null
required

Details for service items that are both purchased and sold, such as reimbursable expenses or inventory items that are bought from vendors and sold to customers.

IMPORTANT: A service item will have either salesAndPurchaseDetails or salesOrPurchaseDetails, but never both because an item cannot have both configurations.

​
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"

​
customFields
The Custom Field object · object[]
required

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