POST
Create a cash register
Company space For: Manager · Permission: cash_registers.create Conditions
  • The name must be unique among the company’s registers.
  • Cashiers are required: at least one agent account or user profile id, each belonging to the same company and organization.
  • Cashiers ids must be 27-character strings without duplicates.
What else happens
  • Creates a ledger account for the register (credit normal balance, in the company currency).
  • Creates a cash account named after the register and stores its id as cash_account_id.
  • Creates a cash register payment method labelled cash, with no money account.
  • Creates a cashier for each listed agent account or user profile, and a seller record for each (active only if is_seller is true).
Part of Set up cash registers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, is_seller, auto_print_invoice, linear_pos, is_locked, session_status, cash_account_id, last_closed_at, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: cashiers.

Body

application/json
name
string
required

Name of the register, up to 250 characters, unique among the company's registers. Required on creation; optional on update.

Maximum string length: 250
cashiers
object
required

Cashiers to assign. Required on creation, with at least one id; prohibited on update.

is_seller
boolean

Whether cashiers of this register are also sellers. Defaults to false on creation; unchanged when omitted on update.

auto_print_invoice
boolean

Whether the invoice is printed automatically after a sale. Defaults to false on creation.

linear_pos
boolean

Whether the register uses the linear point-of-sale layout. Defaults to false on creation.

Response

Resource (only with response=resource).

id

Identifier of the cash register (27-character KSUID).

name

Name of the register, unique within the company.

is_seller
boolean

True when the cashiers of this register are also sellers who can be credited with sales.

auto_print_invoice
boolean

True when the point of sale prints the invoice automatically after a sale.

linear_pos
boolean

True when the register uses the linear point-of-sale layout; it is copied to the register's seller records.

is_locked
boolean

True when the register is locked and cannot be opened or edited.

session_status

Whether a register session is running: open or closed.

cash_account_id

Identifier of the cash account created for this register.

last_closed_at

Closing time of the most recently opened register session of this register (ISO 8601); null when no register session was ever opened or while that session is still open. Omitted when the register session was not loaded (for example in the public available list).

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).

cashiers
array

Cashiers assigned to this register, as summaries with their id.