about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/Unit.md
blob: 5822859f8e09bd2b7ce139e6f1ec809d7cd7da2d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<!--
rocie - An enterprise grocery management system

Copyright (C) 2026 Benedikt Peetz <benedikt.peetz@b-peetz.de>
SPDX-License-Identifier: GPL-3.0-or-later

This file is part of Rocie.

You should have received a copy of the License along with this program.
If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.
-->

# Unit

## Properties

| Name                   | Type                                            | Description                                                                                                                                                                | Notes      |
| ---------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **description**        | Option\<**String**>                             | Description of this unit.                                                                                                                                                  | [optional] |
| **full_name_plural**   | **String**                                      | The plural version of this unit's name. Is used by a value of two and more. (We do not support Slovenian dual numerus versions) E.g.: Kilogram -> Kilograms gram -> meters |
| **full_name_singular** | **String**                                      | The singular version of this unit's name. E.g.: Kilogram Gram                                                                                                              |
| **id**                 | [**models::UnitId**](UnitId.md)                 | Unique id for this unit.                                                                                                                                                   |
| **short_name**         | **String**                                      | Short name or abbreviation of this unit. E.g.: kg for Kilogram g for gram m for meter                                                                                      |
| **unit_property**      | [**models::UnitPropertyId**](UnitPropertyId.md) | Which property is described by this unit. E.g.: kg -> Mass L -> Volume m/s -> Speed and so forth                                                                           |

[[Back to Model list]](../README.md#documentation-for-models)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to README]](../README.md)