Skip to main content

Interface: Surcharge

Defined in: type/Surcharge.ts:8

Additional fee or charge applied to products or orders

  • Surcharges represent extra costs such as handling fees, special processing charges, or additional services that are applied to pricing calculations. They can be configured as flat fees or percentage-based charges with specific tax treatments and validity periods.

Properties​

changedBy?​

optional changedBy?: number

Defined in: type/Surcharge.ts:42

Identifier of the user who last modified the surcharge. References the user account responsible for the most recent changes to this surcharge record.

createdBy?​

optional createdBy?: number

Defined in: type/Surcharge.ts:39

Identifier of the user who created the surcharge. References the user account responsible for creating this surcharge record.

dateChanged​

dateChanged: string

Defined in: type/Surcharge.ts:48

Timestamp when the surcharge was last modified. Automatically updated whenever the surcharge record is changed in the system.

dateCreated​

dateCreated: string

Defined in: type/Surcharge.ts:45

Timestamp when the surcharge was created. Automatically set when the surcharge record is first created in the system.

description?​

optional description?: LocalizedString[]

Defined in: type/Surcharge.ts:15

Detailed descriptions of the surcharge in different languages. Provides additional context about the surcharge purpose and application across multiple languages for internationalization support.

enabled​

enabled: boolean

Defined in: type/Surcharge.ts:30

Activation status of the surcharge. When true, the surcharge is active and will be applied to pricing calculations. When false, it is disabled.

id​

id: string

Defined in: type/Surcharge.ts:10

Unique identifier for the surcharge

name​

name: LocalizedString[]

Defined in: type/Surcharge.ts:12

A descriptive name for the surcharge

taxCode​

taxCode: TaxCode

Defined in: type/Surcharge.ts:24

Tax classification code that determines applicable tax rates and regulations. Specifies the tax treatment for the surcharge (H for high rate, L for low rate, N for no tax).

taxZone​

taxZone: string

Defined in: type/Surcharge.ts:27

Geographic tax zone identifier for regional tax calculations. Two-character code representing the tax jurisdiction for compliance and rate determination.

type​

type: SurchargeType

Defined in: type/Surcharge.ts:18

Classification of surcharge calculation method. Determines how the surcharge value is applied to pricing calculations (flat fee or percentage-based).

validFrom?​

optional validFrom?: string

Defined in: type/Surcharge.ts:33

Start date and time for surcharge validity period. Surcharge will only be applied to orders after this timestamp. If not set, surcharge is immediately active.

validTo?​

optional validTo?: string

Defined in: type/Surcharge.ts:36

End date and time for surcharge validity period. Surcharge will not be applied to orders after this timestamp. If not set, surcharge remains active indefinitely.

value​

value: number

Defined in: type/Surcharge.ts:21

Numeric value for surcharge calculation. For flat fees: amount in currency units. For percentages: percentage value (e.g., 15.5 for 15.5%).