Skip to main content
POST
Open cash register

Authorizations

X-API-Key
string
header
required

Integration API Key (Integrations → New Integration).

Headers

Idempotency-Key
string

Optional. Unique key per operation (max. 100 characters, valid for 24 h per integration). A retry with the same key and the same body returns the original response (header Idempotent-Replayed: true) without repeating the operation; with a different body, or while the first is still in progress, it returns 409.

Maximum string length: 100

Body

application/json
branch_id
string<uuid>
required
user_id
string<uuid>
required

Cashier: FileXpress user with access to the branch.

opening_amount
number
required
Required range: x >= 0
point_of_sale_id
string<uuid>

Point of sale. Required if the branch has more than one active.

notes
string
Maximum string length: 500

Response

Open cash register

status
boolean
required
Example:

true

data
object
required