Skip to main content
POST
Void operation

Authorizations

Authorization
string
header
required

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

Headers

X-OpenFiskal-Merchant
string
required

Merchant identifier returned by the merchants resource.

If-Match
string
required

Latest operation ETag returned by OpenFiskal. Replace it after every successful mutation.

Idempotency-Key
string
required

Unique key per endpoint, merchant, and tenant. Retained for at least 24 hours.

Path Parameters

operationId
string
required

Body

application/json
reason
enum<string>
required

Reason for voiding the operation

Available options:
void_before_completion,
customer_abandoned_checkout,
operator_cancelled,
payment_failed
Example:

"customer_abandoned_checkout"

Response

Operation voided

id
string
required
merchant_id
string
required
source
enum<string>
required
Available options:
POS,
ONLINE
status
enum<string>
required
Available options:
open,
completed,
voided
currency
string
required

ISO 4217 currency code.

Example:

"EUR"

resource_version
number
required

Current server-issued version for the operation, starting at 1. Returned as ETag header.

created_at
string<date-time>
required
updated_at
string<date-time>
required
pretax_amount
string
required
tax_amount
string
required
tip_amount
string
required
total_amount
string
required
line_items
object[]
required
payments
object[]
required
type
enum<string>
required
Available options:
sale
Example:

"sale"

cart_level_discounts
object[]
required

Cart-level (order-level) discounts applied across the SALE. Empty array when none. Surfaced separately from line items so consumers do not need to back-derive from totals.

location_id
string | null

Only set for source: POS.

register_id
string | null

Only set for source: POS.

session_id
string | null

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.

external_id
string | null

Merchant or POS identifier for the upstream order.

fiscal_information
FiscalInformationKassenSichV · object

The Fiskaly signature attached to this Operation, when one exists. Null until the operation has been signed.

completed_at
string<date-time> | null
voided_at
string<date-time> | null
void_reason
string | null
note
string | null

Merchant free-text note for the goods-movement event.