List all service items

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}}").

Query Parameters

ids

string[]

Filter for specific service items by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

fullNames

string[]

Filter for specific service items by their full-name(s), case-insensitive. Like id, fullName is a unique identifier for a service item, formed by by combining the names of its 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".

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

limit

integer

default:

150

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Required range: 1 < x < 150

cursor

string

The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.

status

enum<string>

default:

active

Filter for service items that are active, inactive, or both.

Available options:

active,

all,

inactive

updatedAfter

string

Filter for service items updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

updatedBefore

string

Filter for service items updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

nameContains

string

Filter for service items whose name contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

nameStartsWith

string

Filter for service items whose name starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

nameEndsWith

string

Filter for service items whose name ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

nameFrom

string

Filter for service items whose name is alphabetically greater than or equal to this value.

nameTo

string

Filter for service items whose name is alphabetically less than or equal to this value.

classIds

string[]

Filter for service items of these classes. A class is a way end-users can categorize service items in QuickBooks.

Response

200 - application/json

data

object[]

required

The array of service items.

data.barcode

string | null

required

The service item's barcode.

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

data.createdAt

string

required

The date and time when this service item was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

data.customFields

object[]

required

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

data.externalId

string | null

required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.

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

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

data.isActive

boolean

required

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

data.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". Maximum length: 31 characters.

data.objectType

string

required

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

Allowed value: "qbd_service_item"

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

data.revisionNumber

string

required

The current 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.

data.salesAndPurchaseDetails

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.

data.salesAndPurchaseDetails.expenseAccount

object

required

The expense account used to track expenses from purchases of this item.

data.salesAndPurchaseDetails.incomeAccount

object

required

The income account used to track revenue from sales of this item.

data.salesAndPurchaseDetails.preferredVendor

object | null

required

The preferred vendor from whom this item is typically purchased.

data.salesAndPurchaseDetails.purchaseCost

string | null

required

The cost at which this item is purchased from vendors, represented as a decimal string.

data.salesAndPurchaseDetails.purchaseDescription

string | null

required

The description of this item that appears on purchase forms (e.g., checks, bills, item receipts) when it is ordered or bought from vendors.

data.salesAndPurchaseDetails.purchaseTaxCode

object | null

required

The tax code applied to purchases of this item. Applicable in regions where purchase taxes are used, such as Canada or the UK.

data.salesAndPurchaseDetails.salesDescription

string | null

required

The description of this item that appears on sales forms (e.g., invoices, sales receipts) when sold to customers.

data.salesAndPurchaseDetails.salesPrice

string | null

required

The price at which this item is sold to customers, represented as a decimal string.

data.salesOrPurchaseDetails

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.

data.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. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

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

data.unitOfMeasureSet

object | null

required

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

data.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). The time zone is the same as the user's time zone in QuickBooks.

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

nextCursor

string | null

required

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.

NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

objectType

string

required

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

Allowed value: "list"

remainingCount

number | null

required

The number of objects remaining to be fetched.

url

string

required

The endpoint URL where this list can be accessed.

QuickBooks Desktop API

Core Resources

Transactions

Items

Authorizations

Headers

Query Parameters

Response