Price Books

GET /accounting/price-books

Group: Accounting › Price Books · Operation ID: priceBooks

Returns a list of price books. To match on name or price book number, use POST accounting/price-books/search.

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
active — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isStandard — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
dataSource — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
createdDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, priceBookName, isStandard, active, dataSource, createdDate, lastModifiedDate
Selectable: id, priceBookName, priceBookNumber, description, active, isStandard, dataSource, createdDate, lastModifiedDate

200 Success

Under data, an array of priceBooksRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the price book.
`priceBookName`	string	no	The display name of the price book, unique within the tenant and compared case-insensitively.
`priceBookNumber`	string or null	no	The price book number, for example 'PB-000123'. Absent until a number range assigns one.
`description`	string or null	no	A free-form description of the price book. Absent when none is set.
`active`	boolean or null	no	Whether the price book is active and usable in transactions.
`isStandard`	boolean or null	no	Whether this is the standard (default) price book. Only one price book is the standard at a time. It cannot be set through this API.
`dataSource`	string or null	no	The source system that provided the price book data. Absent when none is set.
`createdDate`	string (date-time) or null	no	The date and time the price book was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time) or null	no	The date and time the price book record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.