Create a price book

Operation ID: createPriceBook

Group: Accounting › Price Books

Open in the interactive reference

POST /accounting/price-books

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Creates a price book. A price book created here always has isStandard set to false. Your tenant has exactly one standard price book, set up by seed data. This endpoint can't make another price book the standard.

You don't send priceBookNumber. The number comes from a number range.

The response contains only the new price book's id. Read the record with GET accounting/price-books/:id.

Parameters

Name In Type Required Description
Api-Version header string · 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.

Request body

Required, application/json: createPriceBookInput.

Field Type Required Description
priceBookName string yes The display name of the price book. Required, and must be unique within the tenant, compared case-insensitively.
active boolean no Whether the price book is active and usable in transactions. Omit to use the default.
description string no A free-form description of the price book.
dataSource string no The source system that provided the price book data. 
{
  "priceBookName": "<priceBookName>",
  "active": true,
  "description": "<description>",
  "dataSource": "<dataSource>"
}

Response

200 Success

Under data (createPriceBookOutput):

Field Type Required Description
id string yes The unique identifier for the created price book. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "diagnostics": [
    {
      "code": "PRICE_BOOK_CREATED",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    }
  ]
}

Response headers

Errors

Code Status
DUPLICATE_NAME 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Advisories

Warnings and information a successful response can carry under diagnostics:

Statuses