PosOperationEnvelope - OpenFiskal API

{
  "id": "op_01HXYZ",
  "object": "<string>",
  "type": "sale",
  "state": "open",
  "register_id": "<string>",
  "location_id": "<string>",
  "organization_id": "<string>",
  "external_id": "<string>",
  "sequence_number": 123,
  "cashier": {
    "id": "<string>",
    "display_name": "Maria R."
  },
  "fiscal": {
    "regime": "<string>",
    "document_type": "Kassenbeleg",
    "transmission_status": "transmitted",
    "fiscal_unit_id": "fu_01HXYZ",
    "document_number": "2026-004822",
    "transmitted_at": "2023-11-07T05:31:56Z",
    "verification": {
      "url": "<string>",
      "qr_data": "<string>"
    },
    "tse_serial": "<string>",
    "client_id": "<string>",
    "signature_algorithm": "ecdsa-plain-SHA384",
    "time_format": "utcTime",
    "start_event": {
      "signed_at": "2023-11-07T05:31:56Z",
      "transaction_counter": 4821,
      "signature": "aSDinaTvuI8gbWludGxpZnk=",
      "process_type": "<string>",
      "process_data": "<string>"
    },
    "end_event": {
      "signed_at": "2023-11-07T05:31:56Z",
      "transaction_counter": 4821,
      "signature": "aSDinaTvuI8gbWludGxpZnk=",
      "process_type": "<string>",
      "process_data": "<string>"
    }
  },
  "fiscal_state": "pending",
  "references": {
    "original_operation_id": "<string>",
    "reason": "<string>"
  },
  "metadata": {},
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Shared fields present on every operation regardless of type.

string

Example:

"op_01HXYZ"

object

string

Allowed value: "operation"

type

enum<string>

Available options:

sale,

refund,

exchange,

void,

cash_movement,

deposit,

deposit_capture,

training

state

enum<string>

The POS lifecycle state of the operation. Transitions are one-directional and enforced server-side — invalid transitions return 409 Conflict.

open — operation in progress, mutations allowed
completed — POS finalized the operation (payment collected)
cancelled — POS cancelled before completion

Valid transitions

From	Event	To
`open`	`POST .../complete`	`completed`
`open`	`POST .../cancel`	`cancelled`

Available options:

open,

completed,

cancelled

register_id

string

location_id

string

organization_id

string

external_id

string | null

sequence_number

integer

Monotonically increasing, register-scoped sequence number

cashier

object

Show child attributes

fiscal

object

Jurisdiction-specific fiscal output attached to every operation. Discriminated by regime — each variant carries typed fields for its fiscal security device and signing protocol.

Option 1
Option 2
Option 3

Show child attributes

fiscal_state

enum<string>

The fiscalization state of the operation, tracked independently from the operation state.

pending — fiscalization not yet attempted or in progress
succeeded — fiscal device recorded the event, fiscal data available
failed — fiscalization failed (device unreachable, transmission error)

The POS should check fiscal.state before printing — only print fiscal data on the receipt when it is succeeded.

Available options:

pending,

succeeded,

failed

references

object

Links to related operations. The audit chain between operations lives here at the envelope level — not inside the type-specific data block — because any operation type can reference any other.

Show child attributes

metadata

object

started_at

string<date-time>

Timestamp of the fiscal start event

completed_at

string<date-time> | null

created_at

string<date-time>

Validate credentials against the government portal SaleOperation

⌘I

API

Schemas

Valid transitions