Search QuickBooks items | Distru Documentation

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
limit	integer	No	Default: `10`
cursor	string	No	nextCursor of the previous call; keep the other arguments unchanged.
ids	string[]	No	QuickBooks item IDs.
search	string	No	Case-insensitive substring or fuzzy word match on name. Ranks substring matches first, then by similarity, replacing sortBy.
usage	enum `SALESPURCHASES`	No	SALES: items with an income account; PURCHASES: items with an expense account. An item can be both.
includeHidden	boolean	No	Include hidden items, which cannot be assigned to products.
sortBy	object	No	Default UPDATED_AT DESC. Ignored while search is set.
sortBy.direction	enum `ASCDESC`	Yes
sortBy.field	enum `INSERTED_ATNAMEUPDATED_AT`	Yes

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
hasMore	boolean	Always
nextCursor	string	Can be absent
totalCount	integer	Can be absent
items	object[]	Always
items[].id	string	Always
items[].name	string	Always
items[].description	string	Can be null
items[].qbItemId	string	Can be null
items[].qbItemType	string	Can be null
items[].default	boolean	Always
items[].hidden	boolean	Always
items[].qbIncomeAccount	object	Can be null
items[].qbIncomeAccount.id	string	Always
items[].qbIncomeAccount.name	string	Always
items[].qbIncomeAccount.active	boolean	Always
items[].qbIncomeAccount.isDeleted	boolean	Always
items[].qbExpenseAccount	object	Can be null
items[].qbExpenseAccount.id	string	Always
items[].qbExpenseAccount.name	string	Always
items[].qbExpenseAccount.active	boolean	Always
items[].qbExpenseAccount.isDeleted	boolean	Always
items[].qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null

What the AI reads

Searches Distru's QuickBooks items, without deleted ones: the QBO products and services that product, charge and credit lines sync to QuickBooks through, with the accounts they post to. For a product's own items use distru-search-products or distru-get-product; for QuickBooks' own chart of accounts use distru-search-qb-accounts. default = one of the company's two fallback items (sales, purchases): a line whose product has no item of its own syncs through it. qbIncomeAccount / qbExpenseAccount null = the item is not used in sales / purchases, or its account is missing from Distru's copy of the chart of accounts. qbItemId null = not created in QuickBooks yet. qbSyncStatus null = the company is not integrated with QuickBooks; NOT_SYNCED = never pushed.