Retrieve a service item

Retrieves a service item by ID.

IMPORTANT: If you need to fetch multiple specific service items 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/service-items/{id}

Path parameters

idstring required

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

Example:80000001-1234567890

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

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.

Response

Returns the specified service item.

idstring 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.

objectType'qbd_service_item' required

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

createdAtstring 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.

updatedAtstring 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.

revisionNumberstring 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.

namestring 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".

fullNamestring 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.

barcodestring nullable required

The service item's barcode.

isActiveboolean required

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

sublevelnumber 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.

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": "80000001-1234567890",
  "objectType": "qbd_service_item",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Web-Design",
  "fullName": "Consulting:Web-Design",
  "barcode": "012345678905",
  "isActive": true,
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Professional-Services"
  },
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "Consulting"
  },
  "sublevel": 1,
  "unitOfMeasureSet": {
    "id": "80000001-1234567890",
    "fullName": "Weight Units"
  },
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "salesOrPurchaseDetails": {
    "description": "Hourly Consulting Service",
    "price": "19.99",
    "pricePercentage": "10.5",
    "postingAccount": {
      "id": "80000001-1234567890",
      "fullName": "Income:Consulting Services"
    }
  },
  "salesAndPurchaseDetails": {
    "salesDescription": "High-quality steel bolts suitable for construction",
    "salesPrice": "19.99",
    "incomeAccount": {
      "id": "80000001-1234567890",
      "fullName": "Income:Product Sales"
    },
    "purchaseDescription": "Bulk purchase of steel bolts for inventory",
    "purchaseCost": "15.75",
    "purchaseTaxCode": {
      "id": "80000001-1234567890",
      "fullName": "GST"
    },
    "expenseAccount": {
      "id": "80000001-1234567890",
      "fullName": "Expenses:Cost of Goods Sold"
    },
    "preferredVendor": {
      "id": "80000001-1234567890",
      "fullName": "Acme Supplies Ltd."
    }
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Changes

Changed in 5 of the 46 revisions of this API.41132

May 2, 20261de07095c4b71See the full diff
- ●
  for the path request parameter id, the maxLength was set to 36
  request-parameter-max-length-set
Apr 20, 202610d4e9ebd1df148See the full diff
- ▲
  response property barcode list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property externalId list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the class response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the parent response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the salesTaxCode response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the unitOfMeasureSet response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property class/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property class/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property unitOfMeasureSet/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property unitOfMeasureSet/id from the response with the 200 status
  response-required-property-removed
- ○
  added qbd_sales_and_purchase_details subschema #2 to the salesAndPurchaseDetails response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added qbd_sales_or_purchase_details subschema #2 to the salesOrPurchaseDetails response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the class response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the parent response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the salesTaxCode response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the unitOfMeasureSet response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  removed qbd_sales_and_purchase_details subschema #2 from the salesAndPurchaseDetails response property oneOf list for the response status 200
  response-property-one-of-removed
- ○
  removed qbd_sales_or_purchase_details subschema #2 from the salesOrPurchaseDetails response property oneOf list for the response status 200
  response-property-one-of-removed
Apr 20, 20268e0b7df2044d1216See the full diff
- ▲
  the response property barcode became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property class became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property externalId became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property parent became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property salesTaxCode became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property unitOfMeasureSet became nullable for the status 200
  response-property-became-nullable
- ▲
  added qbd_sales_and_purchase_details subschema #2 to the salesAndPurchaseDetails response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  added qbd_sales_or_purchase_details subschema #2 to the salesOrPurchaseDetails response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  the class response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the parent response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the salesTaxCode response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the unitOfMeasureSet response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ○
  removed qbd_sales_and_purchase_details subschema #2 from the salesAndPurchaseDetails response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed qbd_sales_or_purchase_details subschema #2 from the salesOrPurchaseDetails response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the class response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the parent response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the salesTaxCode response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the unitOfMeasureSet response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  response property barcode list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property externalId list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  added the required property class/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property class/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property parent/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property parent/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property salesTaxCode/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property salesTaxCode/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property unitOfMeasureSet/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property unitOfMeasureSet/id to the response with the 200 status
  response-required-property-added
Apr 20, 20265f832f695675148See the full diff
- ▲
  response property barcode list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property externalId list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the class response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the parent response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the salesTaxCode response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the unitOfMeasureSet response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property class/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property class/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property unitOfMeasureSet/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property unitOfMeasureSet/id from the response with the 200 status
  response-required-property-removed
- ○
  added qbd_sales_and_purchase_details subschema #2 to the salesAndPurchaseDetails response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added qbd_sales_or_purchase_details subschema #2 to the salesOrPurchaseDetails response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the class response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the parent response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the salesTaxCode response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the unitOfMeasureSet response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  removed qbd_sales_and_purchase_details subschema #2 from the salesAndPurchaseDetails response property oneOf list for the response status 200
  response-property-one-of-removed
- ○
  removed qbd_sales_or_purchase_details subschema #2 from the salesOrPurchaseDetails response property oneOf list for the response status 200
  response-property-one-of-removed
Apr 2, 20262e591208a8751See the full diff
- ▲
  the response property salesAndPurchaseDetails/oneOf[subschema #1: The Sales-and-Purchase Details object]/incomeAccount became nullable for the status 200
  response-property-became-nullable

Full history