Entities

Fee

Configurable additional charge for products or payment methods

A Fee defines a configurable additional charge such as a deposit, recycling fee, environmental fee, or handling surcharge. The entity is the catalog definition; computed charges on quotes use the separate AppliedFee value type.

Available since v0.26.0 in @laioutr-core/canonical-types

Components

Base

FeeBase

base

Fee identity, display details, applicability, and custom fields.

Schema

code

stringrequired

Tenant-unique code identifying the fee, e.g. "recycling-electronics".

name

string

Display name of the fee.

description

string

Longer description of what the fee is for.

appliesTo

"product" | "payment-method"

What kind of thing the fee attaches to (Emporix itemType).

customFields

Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Charge

FeeCharge

charge

Percentage, absolute, or per-unit calculation details and tax settings.

Schema

type

"percent" | "absolute" | "absolute-per-unit"required

Calculation method. absolute-per-unit multiplies amount by the line quantity.

amount

Money { amount, currency }

rate

number

Rate as a fraction (e.g. 0.05 for 5%), for the percent type.

taxable

boolean

Whether the fee is itself taxable.

taxClass

string

Tax class/code the fee is taxed under, when taxable (Emporix taxCode).

Status

FeeStatus

status

Active state and optional validity window.

Schema

status

"active" | "inactive"required

validity

Timespan

A timespan between two dates.

Edit this pageorReport an issue

Approval Rule

Display-oriented B2B order-approval rule configuration

Stock Location

Warehouse, distribution center, or fulfillment location