Get Price Book

GET /accounting/price-books/{id}

Group: Accounting › Price Books · Operation ID: getPriceBook

Returns the price book with the given identifier. Use the price book's id, not its priceBookNumber.

Open in the interactive reference

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 path string yes The unique identifier for the price book to return.

Response

200 Success

Under data (getPriceBookOutput):

Field Type Required Description
id string yes The unique identifier for the price book.
priceBookName string yes The display name of the price book, unique within the tenant and compared case-insensitively.
priceBookNumber string no The price book number, for example 'PB-000123'. Absent until a number range assigns one.
description string no A free-form description of the price book. Absent when none is set.
active boolean no Whether the price book is active and usable in transactions.
isStandard boolean 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 no The source system that provided the price book data. Absent when none is set.
createdDate string (date-time) no The date and time the price book was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) yes The date and time the price book record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses