Schema
Custom Surcharge (Order)
Represents a custom surcharge supplied and managed by POS.
Overview
Properties
uuid
string
Required
The unique identifier.
Format
uuid
name
string
Required
The name of the custom surcharge.
Example
Special Handling
Min length
1
Max length
255
calculation
reference
Required
The calculation used by POS for the custom surcharge.
References Calculation.
line_item_uuid
string | null
The UUID of the associated order line item, if any.
Format
uuid
Nullable
Yes
Used by
Raw YAML
Download source
title: Custom Surcharge (Order)
type: object
x-tags:
- Orders
description: Represents a custom surcharge supplied and managed by POS.
required:
- uuid
- name
- calculation
properties:
uuid:
type: string
format: uuid
description: The unique identifier.
name:
type: string
minLength: 1
maxLength: 255
example: Special Handling
description: The name of the custom surcharge.
calculation:
$ref: ./Calculation.yaml
description: The calculation used by POS for the custom surcharge.
line_item_uuid:
type:
- string
- 'null'
format: uuid
description: The UUID of the associated order line item, if any.