YQueue DocsDevelopers

Schema

Aggregate

The standardised representation of an aggregation of discounts, surcharges or taxes.

  • Foundation

Overview

object · 3 properties · 0 required

Properties

name

string

The name of the aggregated model.

Example GST
Min length 1
Max length 255

value

reference

The value of the aggregated model.

References Money.

tax_exempt

boolean

Indicates if the aggregated model is exempt from tax calculations.

Used by

Raw YAML
Download source
title: Aggregate
type: object
description: 'The standardised representation of an aggregation of discounts, surcharges or taxes.'
properties:
  name:
    type: string
    minLength: 1
    maxLength: 255
    description: The name of the aggregated model.
    example: GST
  value:
    $ref: ./Money.yaml
    description: The value of the aggregated model.
  tax_exempt:
    type: boolean
    description: Indicates if the aggregated model is exempt from tax calculations.
x-tags:
  - Foundation

Search documentation

Search across this documentation site.