Starts a new operation. The body is a discriminated union on type: goods movement (sale / return / exchange) or session lifecycle (session_open / session_cash_adjustment / session_close).
Documentation Index
Fetch the complete documentation index at: https://dev.openfiskal.com/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Merchant identifier returned by the merchants resource.
Unique key per endpoint, merchant, and tenant. Retained for at least 24 hours.
Discriminated request body. The type field selects the variant.
POS, ONLINE "POS"
ISO 4217 currency code
"USD"
Total before taxes
"9.00"
Total tax amount
"0.95"
Tip amount
"0.00"
Total amount (pretax + tax + tip)
"9.95"
sale "sale"
Required for POS, must be null for ONLINE.
"reg_abc123"
Merchant or POS identifier for the upstream order.
"order-12345"
For returns/exchanges: the OpenFiskal operation ID of the original sale. Exactly one of related_operation_id or external_related_operation must be set.
"op_abc123"
For returns/exchanges of sales that were never ingested into OpenFiskal (typically during platform migration). Exactly one of related_operation_id or external_related_operation must be set.
"Customer requested extra napkins"
Operation created
POS, ONLINE open, completed, voided ISO 4217 currency code.
"EUR"
Current server-issued version for the operation, starting at 1. Returned as ETag header.
sale "sale"
Only set for source: POS.
Only set for source: POS.
The RegisterSession this Operation is bound to. Set on every POS Operation; null for ONLINE goods-movement (no register, hence no session). On session-event variants this is the session being opened, adjusted, or closed; on goods-movement variants it is the session the operation was rung up during.
Merchant or POS identifier for the upstream order.
The Fiskaly signature attached to this Operation, when one exists. Null until the operation has been signed.
Merchant free-text note for the goods-movement event.