Update Price Book

PATCH /accounting/price-books/{id}

Group: Accounting › Price Books · Operation ID: updatePriceBook

Updates the price book with the given identifier. Only the fields in the request body change. Use the price book's id, not its priceBookNumber.

Everything omitted from the request body is left as it was. priceBookName, when sent, must stay unique within the tenant, compared case-insensitively. The price book's own current name is not a collision, and renaming onto a name another price book already has fails with DUPLICATE_NAME, which names that other price book. isStandard and priceBookNumber cannot be changed through this endpoint. An unknown id fails with NOT_FOUND. The response contains only the id, so read the updated record with GET accounting/price-books/:id.

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`.
`Idempotency-Key`	header	string	no	An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored.
`id`	path	string	yes	The unique identifier for the price book to update.

Request body

Required, application/json: updatePriceBookInput.

Field	Type	Required	Description
`priceBookName`	string	no	A new display name. Omit to leave it unchanged. It must stay unique within the tenant, compared case-insensitively. The price book's own current name is not a collision.
`active`	boolean	no	A new active flag. Omit to leave it unchanged.
`description`	string	no	A new description. Omit to leave it unchanged.
`dataSource`	string	no	A new data source. Omit to leave it unchanged.

Example:

{
  "priceBookName": "<priceBookName>",
  "active": true,
  "description": "<description>",
  "dataSource": "<dataSource>"
}

Response

200 Success

Under data (updatePriceBookOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the updated price book.

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`DUPLICATE_NAME`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, DUPLICATE_NAME
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error