Nomenclature models

Models of the nomenclature management endpoints.

Generated by python -m codegen from the iikoCloud OpenAPI specification. Do not edit by hand.

AllergenGroup

Bases: IikoModel

AllergenGroup.

code class-attribute instance-attribute

code: str | None = None

Code of the directory entry

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

AllergenGroupFilter

Bases: IikoModel

AllergenGroupFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

AllergenGroupListRequest

Bases: IikoModel

AllergenGroupListRequest.

filters class-attribute instance-attribute

filters: list[AllergenGroupFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

AllergenGroupListResponse

Bases: IikoModel

AllergenGroupListResponse.

items class-attribute instance-attribute

items: list[AllergenGroup] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

AmountUnit

Bases: IikoModel

AmountUnit.

code class-attribute instance-attribute

code: str | None = None

Code of the directory entry

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

AmountUnitFilter

Bases: IikoModel

AmountUnitFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

AmountUnitListRequest

Bases: IikoModel

AmountUnitListRequest.

filters class-attribute instance-attribute

filters: list[AmountUnitFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

AmountUnitListResponse

Bases: IikoModel

AmountUnitListResponse.

items class-attribute instance-attribute

items: list[AmountUnit] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

AssembledRequest

Bases: IikoModel

AssembledRequest.

date_from class-attribute instance-attribute

date_from: str | None = None

Date to retrieve the assembly chart for (YYYY-MM-DD)

organization_id class-attribute instance-attribute

organization_id: str | None = None

UUID of the organization (department) to build the assembly chart in the context of. Optional

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product to retrieve the assembly chart for

AssemblyChartCommonResponse

Bases: IikoModel

AssemblyChartCommonResponse.

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

AssemblyChartItem

Bases: IikoModel

AssemblyChartItem.

id class-attribute instance-attribute

id: str | None = None

UUID of the ingredient line

package_count class-attribute instance-attribute

package_count: Decimal | None = None

Package count

package_type_id class-attribute instance-attribute

package_type_id: str | None = None

UUID of the package type

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the ingredient product

product_size_id class-attribute instance-attribute

product_size_id: str | None = None

UUID of the product size this line applies to. null — applies to all sizes

quantity_in class-attribute instance-attribute

quantity_in: Decimal | None = None

Gross quantity (brutto)

quantity_in1 class-attribute instance-attribute

quantity_in1: Decimal | None = None

Additional gross quantity #1

quantity_in2 class-attribute instance-attribute

quantity_in2: Decimal | None = None

Additional gross quantity #2

quantity_in3 class-attribute instance-attribute

quantity_in3: Decimal | None = None

Additional gross quantity #3

quantity_middle class-attribute instance-attribute

quantity_middle: Decimal | None = None

Semi-processed quantity (netto)

quantity_out class-attribute instance-attribute

quantity_out: Decimal | None = None

Finished quantity (yield)

quantity_out1 class-attribute instance-attribute

quantity_out1: Decimal | None = None

Additional yield quantity #1

quantity_out2 class-attribute instance-attribute

quantity_out2: Decimal | None = None

Additional yield quantity #2

quantity_out3 class-attribute instance-attribute

quantity_out3: Decimal | None = None

Additional yield quantity #3

sort_weight class-attribute instance-attribute

sort_weight: int | None = None

Display order weight

store_specification class-attribute instance-attribute

store_specification: StoreSpecification | None = None

Organization (structural unit) applicability filter for the ingredient line

AssemblyChartItemResponse

Bases: IikoModel

AssemblyChartItemResponse.

id class-attribute instance-attribute

id: str | None = None

UUID of the ingredient line

package_count class-attribute instance-attribute

package_count: Decimal | None = None

Package count

package_type_id class-attribute instance-attribute

package_type_id: str | None = None

UUID of the package type

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the ingredient product

product_size_id class-attribute instance-attribute

product_size_id: str | None = None

UUID of the product size this line applies to. null — applies to all sizes

quantity_in class-attribute instance-attribute

quantity_in: Decimal | None = None

Gross quantity (brutto)

quantity_in1 class-attribute instance-attribute

quantity_in1: Decimal | None = None

Additional gross quantity #1

quantity_in2 class-attribute instance-attribute

quantity_in2: Decimal | None = None

Additional gross quantity #2

quantity_in3 class-attribute instance-attribute

quantity_in3: Decimal | None = None

Additional gross quantity #3

quantity_middle class-attribute instance-attribute

quantity_middle: Decimal | None = None

Semi-processed quantity (netto)

quantity_out class-attribute instance-attribute

quantity_out: Decimal | None = None

Finished quantity (yield)

quantity_out1 class-attribute instance-attribute

quantity_out1: Decimal | None = None

Additional yield quantity #1

quantity_out2 class-attribute instance-attribute

quantity_out2: Decimal | None = None

Additional yield quantity #2

quantity_out3 class-attribute instance-attribute

quantity_out3: Decimal | None = None

Additional yield quantity #3

sort_weight class-attribute instance-attribute

sort_weight: Decimal | None = None

Display order weight

store_specification class-attribute instance-attribute

store_specification: StoreSpecification | None = None

Department applicability filter for the ingredient line

AssemblyChartListRequest

Bases: IikoModel

AssemblyChartListRequest.

date_from class-attribute instance-attribute

date_from: str | None = None

Start of the sample period (YYYY-MM-DD). Required when productId is not set, or when knownRevision is set

date_to class-attribute instance-attribute

date_to: str | None = None

End of the sample period (YYYY-MM-DD). Optional

include_deleted_products class-attribute instance-attribute

include_deleted_products: bool | None = None

Whether to include assembly charts of deleted products. Defaults to true

include_prepared_charts class-attribute instance-attribute

include_prepared_charts: bool | None = None

Whether to include the breakdown to store items (preparedCharts) in the response. Defaults to false

known_revision class-attribute instance-attribute

known_revision: int | None = None

Known revision for incremental synchronization (getAllUpdate). Cannot be combined with productId

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product to retrieve assembly charts for

AssemblyChartListResponse

Bases: IikoModel

AssemblyChartListResponse.

deleted_assembly_chart_ids class-attribute instance-attribute

deleted_assembly_chart_ids: list[str] | None = None

UUIDs of assembly charts deleted since the last synchronization (relevant with knownRevision)

deleted_prepared_chart_ids class-attribute instance-attribute

deleted_prepared_chart_ids: list[str] | None = None

UUIDs of prepared charts deleted since the last synchronization (relevant with knownRevision)

items class-attribute instance-attribute

items: list[AssemblyChartResponse] | None = None

Ingredient lines of the assembly chart

known_revision class-attribute instance-attribute

known_revision: int | None = None

Known revision for incremental synchronization (getAllUpdate). Cannot be combined with productId

prepared_charts class-attribute instance-attribute

prepared_charts: list[PreparedChartDto] | None = None

Breakdown of assembly charts to store items (populated when includePreparedCharts: true)

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of assembly charts of the product

AssemblyChartResponse

Bases: IikoModel

AssemblyChartResponse.

appearance class-attribute instance-attribute

appearance: str | None = None

Presentation and serving requirements (up to 2000 characters)

assembled_quantity class-attribute instance-attribute

assembled_quantity: Decimal | None = None

Assembled quantity (bookmark rate). Must be greater than 0

date_from class-attribute instance-attribute

date_from: str | None = None

Start date of the validity period (YYYY-MM-DD)

date_to class-attribute instance-attribute

date_to: str | None = None

End date of the validity period (YYYY-MM-DD)

description class-attribute instance-attribute

description: str | None = None

Free-text description field (up to 2000 characters)

direct_writeoff_store_specification class-attribute instance-attribute

direct_writeoff_store_specification: (
    StoreSpecification | None
) = None

Organization (structural unit) filter for DIRECT write-off strategy. null — applies to all organizations

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

items class-attribute instance-attribute

items: list[AssemblyChartItemResponse] | None = None

Ingredient lines of the assembly chart

organoleptic class-attribute instance-attribute

organoleptic: str | None = None

Organoleptic quality indicators (up to 2000 characters)

output_comment class-attribute instance-attribute

output_comment: str | None = None

Output comment / yield note (up to 2000 characters)

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product this assembly chart belongs to

product_size_assembly_strategy class-attribute instance-attribute

product_size_assembly_strategy: str | None = None

Size strategy: COMMON (one chart for all sizes) or SPECIFIC (per-size ingredients)

technology_description class-attribute instance-attribute

technology_description: str | None = None

Preparation technology description (up to 2000 characters)

writeoff_strategy class-attribute instance-attribute

writeoff_strategy: str | None = None

Write-off strategy: ASSEMBLE (write off ingredients) or DIRECT (write off the product itself)

ChartTreeNodeDto

Bases: IikoModel

ChartTreeNodeDto.

assembled_quantity class-attribute instance-attribute

assembled_quantity: Decimal | None = None

Assembled quantity (bookmark rate). Must be greater than 0

has_chart class-attribute instance-attribute

has_chart: bool | None = None

true — the product has its own assembly chart for the given date (items contains its composition); false — the product is an elementary store item

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

items class-attribute instance-attribute

items: list[ChartTreeNodeDto] | None = None

Child nodes of the tree — ingredients of the assembly chart, each recursively expanded with its own composition (if it has an assembly chart)

package_count class-attribute instance-attribute

package_count: Decimal | None = None

Package count

package_type_id class-attribute instance-attribute

package_type_id: str | None = None

UUID of the package type

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product this assembly chart belongs to

product_size_assembly_strategy class-attribute instance-attribute

product_size_assembly_strategy: str | None = None

Size strategy: COMMON (one chart for all sizes) or SPECIFIC (per-size ingredients)

quantity_in class-attribute instance-attribute

quantity_in: Decimal | None = None

Gross quantity (brutto)

quantity_middle class-attribute instance-attribute

quantity_middle: Decimal | None = None

Semi-processed quantity (netto)

quantity_out class-attribute instance-attribute

quantity_out: Decimal | None = None

Finished quantity (yield)

writeoff_strategy class-attribute instance-attribute

writeoff_strategy: str | None = None

Write-off strategy: ASSEMBLE (write off ingredients) or DIRECT (write off the product itself)

Container

Bases: IikoModel

Container.

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

ContainerFilter

Bases: IikoModel

ContainerFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

ContainerListRequest

Bases: IikoModel

ContainerListRequest.

filters class-attribute instance-attribute

filters: list[ContainerFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

ContainerListResponse

Bases: IikoModel

ContainerListResponse.

items class-attribute instance-attribute

items: list[Container] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

CreateRequest

Bases: IikoModel

CreateRequest.

appearance class-attribute instance-attribute

appearance: str | None = None

Presentation and serving requirements (up to 2000 characters)

assembled_quantity class-attribute instance-attribute

assembled_quantity: Decimal | None = None

Assembled quantity (bookmark rate). Must be greater than 0

date_from class-attribute instance-attribute

date_from: str | None = None

Start date of the validity period (YYYY-MM-DD)

date_to instance-attribute

date_to: str

End date of the validity period (YYYY-MM-DD)

description class-attribute instance-attribute

description: str | None = None

Free-text description field (up to 2000 characters)

direct_writeoff_store_specification class-attribute instance-attribute

direct_writeoff_store_specification: (
    StoreSpecification | None
) = None

Organization (structural unit) filter for DIRECT write-off strategy. null — applies to all organizations

franchise_master_id class-attribute instance-attribute

franchise_master_id: str | None = None

Franchise master UUID. null — not a franchise object

franchise_original_id class-attribute instance-attribute

franchise_original_id: str | None = None

Franchise original UUID. null — not a franchise object

franchise_unique_id class-attribute instance-attribute

franchise_unique_id: str | None = None

Franchise unique UUID. Required when franchiseMasterId is set

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

items class-attribute instance-attribute

items: list[AssemblyChartItem] | None = None

Ingredient lines of the assembly chart

organoleptic class-attribute instance-attribute

organoleptic: str | None = None

Organoleptic quality indicators (up to 2000 characters)

output_comment class-attribute instance-attribute

output_comment: str | None = None

Output comment / yield note (up to 2000 characters)

picture class-attribute instance-attribute

picture: str | None = None

UUID of the technology image. null — no image

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product this assembly chart belongs to

product_size_assembly_strategy class-attribute instance-attribute

product_size_assembly_strategy: str | None = None

Size strategy: COMMON (one chart for all sizes) or SPECIFIC (per-size ingredients)

technology_description class-attribute instance-attribute

technology_description: str | None = None

Preparation technology description (up to 2000 characters)

version_compatibility class-attribute instance-attribute

version_compatibility: str | None = None

Version compatibility tag. Only V_7_0 is currently accepted

writeoff_strategy class-attribute instance-attribute

writeoff_strategy: str | None = None

Write-off strategy: ASSEMBLE (write off ingredients) or DIRECT (write off the product itself)

CustomCategory

Bases: IikoModel

CustomCategory.

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

CustomCategoryFilter

Bases: IikoModel

CustomCategoryFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

CustomCategoryListRequest

Bases: IikoModel

CustomCategoryListRequest.

filters class-attribute instance-attribute

filters: list[CustomCategoryFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

CustomCategoryListResponse

Bases: IikoModel

CustomCategoryListResponse.

items class-attribute instance-attribute

items: list[CustomCategory] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

DeleteRequest

Bases: IikoModel

DeleteRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

GetRequest

Bases: IikoModel

GetRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

MenuSection

Bases: IikoModel

MenuSection.

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

MenuSectionFilter

Bases: IikoModel

MenuSectionFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

MenuSectionListRequest

Bases: IikoModel

MenuSectionListRequest.

filters class-attribute instance-attribute

filters: list[MenuSectionFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

MenuSectionListResponse

Bases: IikoModel

MenuSectionListResponse.

items class-attribute instance-attribute

items: list[MenuSection] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

ModifierSchema

Bases: IikoModel

ModifierSchema.

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

ModifierSchemaFilter

Bases: IikoModel

ModifierSchemaFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

ModifierSchemaListRequest

Bases: IikoModel

ModifierSchemaListRequest.

filters class-attribute instance-attribute

filters: list[ModifierSchemaFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

ModifierSchemaListResponse

Bases: IikoModel

ModifierSchemaListResponse.

items class-attribute instance-attribute

items: list[ModifierSchema] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

NomenclatureCategoryCreateRequest

Bases: IikoModel

NomenclatureCategoryCreateRequest.

name class-attribute instance-attribute

name: str | None = None

Name of the product category

NomenclatureCategoryDeleteRequest

Bases: IikoModel

NomenclatureCategoryDeleteRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the category to delete

NomenclatureCategoryListRequest

Bases: IikoModel

NomenclatureCategoryListRequest.

ids class-attribute instance-attribute

ids: list[str] | None = None

UUIDs of categories to filter by

include_deleted class-attribute instance-attribute

include_deleted: bool | None = None

Include deleted categories in the response. Default false

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. limit <= 0 - no limit, all records are returned

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

NomenclatureCategoryListResponse

Bases: IikoModel

NomenclatureCategoryListResponse.

items class-attribute instance-attribute

items: list[NomenclatureCategoryResponse] | None = None

List of product categories

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. limit <= 0 - no limit, all records are returned

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of product categories matching the request

NomenclatureCategoryResponse

Bases: IikoModel

NomenclatureCategoryResponse.

id class-attribute instance-attribute

id: str | None = None

UUID of the product category

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the category is soft-deleted

name class-attribute instance-attribute

name: str | None = None

Name of the product category

NomenclatureCategoryRestoreRequest

Bases: IikoModel

NomenclatureCategoryRestoreRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the category to restore

NomenclatureCategoryUpdateRequest

Bases: IikoModel

NomenclatureCategoryUpdateRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the category to update

name class-attribute instance-attribute

name: str | None = None

Name of the product category

NomenclatureCategoryWriteResponse

Bases: IikoModel

NomenclatureCategoryWriteResponse.

id class-attribute instance-attribute

id: str | None = None

UUID of the category

NomenclatureGroupCreateRequest

Bases: IikoModel

NomenclatureGroupCreateRequest.

accounting_category_id class-attribute instance-attribute

accounting_category_id: str | None = None

UUID of the accounting category (as configured in the accounting settings)

category_id class-attribute instance-attribute

category_id: str | None = None

UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category

code instance-attribute

code: str

Group code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a group

color class-attribute instance-attribute

color: NomenclatureGroupRGBColor | None = None

Background button colour for POS

custom_categories class-attribute instance-attribute

custom_categories: (
    list[NomenclatureGroupCustomCategory] | None
) = None

Custom nomenclature categories. Empty array or null - no categories set

default_course class-attribute instance-attribute

default_course: int | None = None

Default serving course. null - not set; 0 - VIP course; otherwise - course number

default_maximum_store_balance_level class-attribute instance-attribute

default_maximum_store_balance_level: Decimal | None = None

Default maximum stock level

default_minimum_store_balance_level class-attribute instance-attribute

default_minimum_store_balance_level: Decimal | None = None

Default minimum stock level

description class-attribute instance-attribute

description: str | None = None

Group description

font_color class-attribute instance-attribute

font_color: NomenclatureGroupRGBColor | None = None

Font colour on the button for POS

front_image_id class-attribute instance-attribute

front_image_id: str | None = None

UUID of the image for POS

group_article class-attribute instance-attribute

group_article: str | None = None

Group article. If null or not provided, the field remains empty

group_id class-attribute instance-attribute

group_id: str | None = None

UUID of the group to create. If not specified, the UUID will be generated automatically.

include_in_report class-attribute instance-attribute

include_in_report: bool | None = None

Include in the price list print form

is_fixed_price class-attribute instance-attribute

is_fixed_price: bool | None = None

Price is set explicitly and does not depend on markup

markup_settings class-attribute instance-attribute

markup_settings: (
    list[NomenclatureGroupMarkupSetting] | None
) = None

Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used

maximum_store_balance_levels class-attribute instance-attribute

maximum_store_balance_levels: (
    list[NomenclatureGroupStoreBalanceLevel] | None
) = None

Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used

minimum_store_balance_levels class-attribute instance-attribute

minimum_store_balance_levels: (
    list[NomenclatureGroupStoreBalanceLevel] | None
) = None

Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used

name instance-attribute

name: str

Group name

parent_id class-attribute instance-attribute

parent_id: str | None = None

UUID of the parent group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the group belongs to the root level

position class-attribute instance-attribute

position: int | None = None

Menu position. 0 - sort by Code+Name; otherwise - sort by this value

price_markup_percent class-attribute instance-attribute

price_markup_percent: Decimal | None = None

Fixed markup (%). Stored with up to 9 decimal places

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

UUID of the tax category used for the group (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section

visibility_filter class-attribute instance-attribute

visibility_filter: (
    NomenclatureGroupOrganizationFilter | None
) = None

Organization (structural unit) visibility filter. null - the group is visible in all organisations. Applies only to root groups

NomenclatureGroupCreateResponse

Bases: IikoModel

NomenclatureGroupCreateResponse.

group_id class-attribute instance-attribute

group_id: str | None = None

UUID of the created group

message class-attribute instance-attribute

message: str | None = None

Message confirming successful creation

NomenclatureGroupCustomCategory

Bases: IikoModel

NomenclatureGroupCustomCategory.

category_list_id class-attribute instance-attribute

category_list_id: str | None = None

UUID of the custom category list (CustomCategoryList)

category_value_id class-attribute instance-attribute

category_value_id: str | None = None

UUID of the value from that list (CustomCategoryValue). Must belong to the specified categoryList

NomenclatureGroupDeleteRequest

Bases: IikoModel

NomenclatureGroupDeleteRequest.

group_ids instance-attribute

group_ids: list[str]

List of nomenclature group UUIDs for recursive deletion

NomenclatureGroupDeleteResponse

Bases: IikoModel

NomenclatureGroupDeleteResponse.

message class-attribute instance-attribute

message: str | None = None

Message confirming successful deletion

NomenclatureGroupFilter

Bases: IikoModel

NomenclatureGroupFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

NomenclatureGroupListRequest

Bases: IikoModel

NomenclatureGroupListRequest.

filters instance-attribute

filters: list[NomenclatureGroupFilter]

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit instance-attribute

limit: int

Maximum number of records in the response. Allowed values: 1 to 1000

offset instance-attribute

offset: int

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

NomenclatureGroupListResponse

Bases: IikoModel

NomenclatureGroupListResponse.

groups class-attribute instance-attribute

groups: list[NomenclatureGroupResponse] | None = None

List of nomenclature groups

NomenclatureGroupMarkupSetting

Bases: IikoModel

NomenclatureGroupMarkupSetting.

markup_percent class-attribute instance-attribute

markup_percent: Decimal | None = None

Markup percentage. Stored with up to 9 decimal places

organization_id instance-attribute

organization_id: str

UUID of the organization (structural unit)

NomenclatureGroupOrganizationFilter

Bases: IikoModel

NomenclatureGroupOrganizationFilter.

is_excluding class-attribute instance-attribute

is_excluding: bool | None = None

Filter mode: false - the group is visible only in the listed organizations; true - visible everywhere except the listed organizations

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

UUIDs of the organizations (structural units) to which the visibility filter applies

NomenclatureGroupRGBColor

Bases: IikoModel

NomenclatureGroupRGBColor.

blue class-attribute instance-attribute

blue: int | None = None

Blue channel: 0–255

green class-attribute instance-attribute

green: int | None = None

Green channel: 0–255

red class-attribute instance-attribute

red: int | None = None

Red channel: 0–255

NomenclatureGroupResponse

Bases: IikoModel

NomenclatureGroupResponse.

accounting_category_id class-attribute instance-attribute

accounting_category_id: str | None = None

UUID of the accounting category (as configured in the accounting settings)

category_id class-attribute instance-attribute

category_id: str | None = None

UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category

code class-attribute instance-attribute

code: str | None = None

Group code: 0–8 digits

color class-attribute instance-attribute

color: NomenclatureGroupRGBColor | None = None

Background button colour for POS

created_at class-attribute instance-attribute

created_at: str | None = None

Object creation date. ISO 8601

created_by_user_id class-attribute instance-attribute

created_by_user_id: str | None = None

UUID of the user who created the object

custom_categories class-attribute instance-attribute

custom_categories: (
    list[NomenclatureGroupCustomCategory] | None
) = None

Custom nomenclature categories. Empty array or null - no categories set

default_course class-attribute instance-attribute

default_course: int | None = None

Default serving course. null - not set; 0 - VIP course; otherwise - course number

default_maximum_store_balance_level class-attribute instance-attribute

default_maximum_store_balance_level: Decimal | None = None

Default maximum stock level

default_minimum_store_balance_level class-attribute instance-attribute

default_minimum_store_balance_level: Decimal | None = None

Default minimum stock level

deleted_at class-attribute instance-attribute

deleted_at: str | None = None

Deletion date. null - for non-deleted objects and for those deleted before v4.3.2. ISO 8601

description class-attribute instance-attribute

description: str | None = None

Group description

font_color class-attribute instance-attribute

font_color: NomenclatureGroupRGBColor | None = None

Font colour on the button for POS

franchise_master_id class-attribute instance-attribute

franchise_master_id: str | None = None

UUID of the parent entity in the Franchise master nomenclature from which this one was last updated

franchise_unique_id class-attribute instance-attribute

franchise_unique_id: str | None = None

Globally unique UUID of the entity within Franchise

front_image_id class-attribute instance-attribute

front_image_id: str | None = None

UUID of the image for POS

group_article class-attribute instance-attribute

group_article: str | None = None

Group article. If null or not provided, the field remains empty

group_id class-attribute instance-attribute

group_id: str | None = None

UUID of the nomenclature group

include_in_report class-attribute instance-attribute

include_in_report: bool | None = None

Include in the price list print form

is_chain_root class-attribute instance-attribute

is_chain_root: bool | None = None

Whether the group is the root of a chain. Read-only

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deletion flag

is_fixed_price class-attribute instance-attribute

is_fixed_price: bool | None = None

Price is set explicitly and does not depend on markup

last_modify_node_id class-attribute instance-attribute

last_modify_node_id: str | None = None

UUID of the node (ServerNode) of the last change. null - last edit was on the current server

markup_settings class-attribute instance-attribute

markup_settings: (
    list[NomenclatureGroupMarkupSetting] | None
) = None

Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used

maximum_store_balance_levels class-attribute instance-attribute

maximum_store_balance_levels: (
    list[NomenclatureGroupStoreBalanceLevel] | None
) = None

Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used

minimum_store_balance_levels class-attribute instance-attribute

minimum_store_balance_levels: (
    list[NomenclatureGroupStoreBalanceLevel] | None
) = None

Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used

modified_at class-attribute instance-attribute

modified_at: str | None = None

Date of the last modification. ISO 8601

modified_by_user_id class-attribute instance-attribute

modified_by_user_id: str | None = None

UUID of the last user who modified the object

name class-attribute instance-attribute

name: str | None = None

Group name

parent_id class-attribute instance-attribute

parent_id: str | None = None

UUID of the parent group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the group belongs to the root level

position class-attribute instance-attribute

position: int | None = None

Menu position. 0 - sort by Code+Name; otherwise - sort by this value

price_markup_percent class-attribute instance-attribute

price_markup_percent: Decimal | None = None

Fixed markup (%). Stored with up to 9 decimal places

revision class-attribute instance-attribute

revision: int | None = None

Revision number of the last modification

system class-attribute instance-attribute

system: bool | None = None

System object. System objects cannot be edited by users

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

UUID of the tax category used for the group (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section

visibility_filter class-attribute instance-attribute

visibility_filter: (
    NomenclatureGroupOrganizationFilter | None
) = None

Organization (structural unit) visibility filter. null - the group is visible in all organisations. Applies only to root groups

NomenclatureGroupStoreBalanceLevel

Bases: IikoModel

NomenclatureGroupStoreBalanceLevel.

store_id instance-attribute

store_id: str

UUID of the warehouse

value class-attribute instance-attribute

value: Decimal | None = None

Stock level value. null when valueAssigned = false

value_assigned class-attribute instance-attribute

value_assigned: bool | None = None

true - value is set explicitly and taken from this array; false - taken from defaultMinimum/MaximumStoreBalanceLevel

NomenclatureGroupUndeleteRequest

Bases: IikoModel

NomenclatureGroupUndeleteRequest.

group_ids instance-attribute

group_ids: list[str]

List of nomenclature group UUIDs to restore

recursively class-attribute instance-attribute

recursively: bool | None = None

true - recursively restore all child groups and their products; false - restore only the specified top-level groups

NomenclatureGroupUndeleteResponse

Bases: IikoModel

NomenclatureGroupUndeleteResponse.

message class-attribute instance-attribute

message: str | None = None

Message confirming successful restoration

NomenclatureGroupUpdateRequest

Bases: IikoModel

NomenclatureGroupUpdateRequest.

accounting_category_id class-attribute instance-attribute

accounting_category_id: str | None = None

UUID of the accounting category (as configured in the accounting settings)

category_id class-attribute instance-attribute

category_id: str | None = None

UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category

code instance-attribute

code: str

Group code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a group

color class-attribute instance-attribute

color: NomenclatureGroupRGBColor | None = None

Background button colour for POS

custom_categories class-attribute instance-attribute

custom_categories: (
    list[NomenclatureGroupCustomCategory] | None
) = None

Custom nomenclature categories. Empty array or null - no categories set

default_course class-attribute instance-attribute

default_course: int | None = None

Default serving course. null - not set; 0 - VIP course; otherwise - course number

default_maximum_store_balance_level class-attribute instance-attribute

default_maximum_store_balance_level: Decimal | None = None

Default maximum stock level

default_minimum_store_balance_level class-attribute instance-attribute

default_minimum_store_balance_level: Decimal | None = None

Default minimum stock level

description class-attribute instance-attribute

description: str | None = None

Group description

font_color class-attribute instance-attribute

font_color: NomenclatureGroupRGBColor | None = None

Font colour on the button for POS

front_image_id class-attribute instance-attribute

front_image_id: str | None = None

UUID of the image for POS

group_article class-attribute instance-attribute

group_article: str | None = None

Group article. If null or not provided, the field remains empty

group_id instance-attribute

group_id: str

UUID of the group to update

include_in_report class-attribute instance-attribute

include_in_report: bool | None = None

Include in the price list print form

is_fixed_price class-attribute instance-attribute

is_fixed_price: bool | None = None

Price is set explicitly and does not depend on markup

markup_settings class-attribute instance-attribute

markup_settings: (
    list[NomenclatureGroupMarkupSetting] | None
) = None

Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used

maximum_store_balance_levels class-attribute instance-attribute

maximum_store_balance_levels: (
    list[NomenclatureGroupStoreBalanceLevel] | None
) = None

Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used

minimum_store_balance_levels class-attribute instance-attribute

minimum_store_balance_levels: (
    list[NomenclatureGroupStoreBalanceLevel] | None
) = None

Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used

name instance-attribute

name: str

Group name

parent_id class-attribute instance-attribute

parent_id: str | None = None

UUID of the parent group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the group belongs to the root level

price_markup_percent class-attribute instance-attribute

price_markup_percent: Decimal | None = None

Fixed markup (%). Stored with up to 9 decimal places

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

UUID of the tax category used for the group (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section

visibility_filter class-attribute instance-attribute

visibility_filter: (
    NomenclatureGroupOrganizationFilter | None
) = None

Organization (structural unit) visibility filter. null - the group is visible in all organisations. Applies only to root groups

NomenclatureGroupUpdateResponse

Bases: IikoModel

NomenclatureGroupUpdateResponse.

group_id class-attribute instance-attribute

group_id: str | None = None

UUID of the updated group

message class-attribute instance-attribute

message: str | None = None

Message confirming successful update

NomenclatureProductBarcode

Bases: IikoModel

NomenclatureProductBarcode.

barcode instance-attribute

barcode: str

Barcode value

container_id class-attribute instance-attribute

container_id: str | None = None

Container ID represents a specific type of packaging or container for an item (e.g., a barrel, box, or bottle). Specify the container using its ID. Leave this field blank or pass null to automatically use the default container.

type instance-attribute

type: str

Barcode type. Required. Allowed values: NTIN, GTIN, UNKNOWN

NomenclatureProductChildModifier

Bases: IikoModel

NomenclatureProductChildModifier.

child_modifiers class-attribute instance-attribute

child_modifiers: (
    list[NomenclatureProductChildModifier] | None
) = None

Child modifiers of the next nesting level

child_modifiers_have_min_max_restrictions class-attribute instance-attribute

child_modifiers_have_min_max_restrictions: bool | None = (
    None
)

Child modifiers have their own min/max amount restrictions

default_amount class-attribute instance-attribute

default_amount: int | None = None

Default modifier amount

free_of_charge_amount class-attribute instance-attribute

free_of_charge_amount: int | None = None

Free-of-charge modifier amount

hide_if_default_amount class-attribute instance-attribute

hide_if_default_amount: bool | None = None

Hide the modifier when the default amount is selected

maximum_amount class-attribute instance-attribute

maximum_amount: int | None = None

Maximum modifier amount. null - no limit

minimum_amount class-attribute instance-attribute

minimum_amount: int | None = None

Minimum modifier amount. null - no limit

modifier_id class-attribute instance-attribute

modifier_id: str | None = None

UUID of the modifier

required class-attribute instance-attribute

required: bool | None = None

Required modifier

splittable class-attribute instance-attribute

splittable: bool | None = None

The modifier can be split between dish portions

NomenclatureProductContainer

Bases: IikoModel

NomenclatureProductContainer.

container_id class-attribute instance-attribute

container_id: str | None = None

UUID of the container/packaging. The list of values can be retrieved via the "Get a list of containers" method in the "Directories" category

container_weight class-attribute instance-attribute

container_weight: Decimal | None = None

Container weight without the product

franchise_master_id class-attribute instance-attribute

franchise_master_id: str | None = None

UUID of the parent container in the Franchise master nomenclature

franchise_unique_id class-attribute instance-attribute

franchise_unique_id: str | None = None

Globally unique UUID of the container within Franchise

full_container_weight class-attribute instance-attribute

full_container_weight: Decimal | None = None

Full container weight with the product

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Container deletion flag

line_number class-attribute instance-attribute

line_number: str | None = None

Container number (line number of the container within the product)

max_container_weight class-attribute instance-attribute

max_container_weight: Decimal | None = None

Maximum container weight

min_container_weight class-attribute instance-attribute

min_container_weight: Decimal | None = None

Minimum container weight

name class-attribute instance-attribute

name: str | None = None

Container name

quantity class-attribute instance-attribute

quantity: Decimal | None = None

Amount of product in the container

use_in_front class-attribute instance-attribute

use_in_front: bool | None = None

Use the container in POS

NomenclatureProductCreateRequest

Bases: IikoModel

NomenclatureProductCreateRequest.

accounting_category_id class-attribute instance-attribute

accounting_category_id: str | None = None

UUID of the accounting category (as configured in the accounting settings)

alcohol_class class-attribute instance-attribute

alcohol_class: str | None = None

Alcohol product class

allergen_group_ids class-attribute instance-attribute

allergen_group_ids: list[str] | None = None

UUIDs of allergen groups. The list of values can be retrieved via the "Get a list of allergen groups" method in the "Directories" category

amount_independent_of_parent_amount class-attribute instance-attribute

amount_independent_of_parent_amount: bool | None = None

The amount does not depend on the parent dish's amount

amount_unit_id instance-attribute

amount_unit_id: str

UUID of the product's unit of measure (mainUnit). The list of values can be retrieved via the "Get a list of amount units" method in the "Directories" category

barcodes class-attribute instance-attribute

barcodes: list[NomenclatureProductBarcode] | None = None

Product barcodes

can_buy_from_cashdesk class-attribute instance-attribute

can_buy_from_cashdesk: bool | None = None

Can be sold directly from the cash desk

can_change_amount_cooked_dish class-attribute instance-attribute

can_change_amount_cooked_dish: bool | None = None

The amount of the cooked dish can be changed

can_set_open_price class-attribute instance-attribute

can_set_open_price: bool | None = None

An open price can be set manually

category_id class-attribute instance-attribute

category_id: str | None = None

UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category

cheque_printable class-attribute instance-attribute

cheque_printable: bool | None = None

Print on the cheque

code instance-attribute

code: str

Product code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a product

cold_loss_percent class-attribute instance-attribute

cold_loss_percent: Decimal | None = None

Weight loss percentage during cold processing

color class-attribute instance-attribute

color: NomenclatureProductRGBColor | None = None

Background button colour for POS

containers class-attribute instance-attribute

containers: list[NomenclatureProductContainer] | None = None

Product containers/packagings

cook_with_main_dish class-attribute instance-attribute

cook_with_main_dish: bool | None = None

Cook together with the main dish

cooking_time_normal class-attribute instance-attribute

cooking_time_normal: int | None = None

Cooking time in normal mode, minutes

cooking_time_peak class-attribute instance-attribute

cooking_time_peak: int | None = None

Cooking time in peak mode, minutes

cooking_type class-attribute instance-attribute

cooking_type: str | None = None

Cooking method

custom_categories class-attribute instance-attribute

custom_categories: (
    list[NomenclatureProductCustomCategory] | None
) = None

Custom nomenclature categories. Empty array or null - no categories set

default_container_id class-attribute instance-attribute

default_container_id: str | None = None

UUID of the default container. The list of values can be retrieved via the "Get a list of containers" method in the "Directories" category

default_course class-attribute instance-attribute

default_course: int | None = None

Default serving course. null - not set; 0 - VIP course; otherwise - course number

default_included_in_menu class-attribute instance-attribute

default_included_in_menu: bool | None = None

Include the product in the menu by default

default_maximum_store_balance_level class-attribute instance-attribute

default_maximum_store_balance_level: Decimal | None = None

Default maximum stock level

default_minimum_store_balance_level class-attribute instance-attribute

default_minimum_store_balance_level: Decimal | None = None

Default minimum stock level

default_sale_price class-attribute instance-attribute

default_sale_price: Decimal | None = None

Default sale price

description class-attribute instance-attribute

description: str | None = None

Product description

description_english class-attribute instance-attribute

description_english: str | None = None

Product description in English

disabled_product_size_ids class-attribute instance-attribute

disabled_product_size_ids: list[str] | None = None

UUIDs of the dish sizes disabled for this product. The list of values can be retrieved via the "Get a list of product sizes" method in the "Directories" category

egais_alc_code class-attribute instance-attribute

egais_alc_code: str | None = None

EGAIS product type code

estimated_purchase_price class-attribute instance-attribute

estimated_purchase_price: Decimal | None = None

Estimated purchase price

excluded_section_ids class-attribute instance-attribute

excluded_section_ids: list[str] | None = None

UUIDs of the menu sections the product is excluded from. The list of values can be retrieved via the "Get a list of menu sections" method in the "Directories" category

expiration_date class-attribute instance-attribute

expiration_date: int | None = None

Shelf life, days

font_color class-attribute instance-attribute

font_color: NomenclatureProductRGBColor | None = None

Font colour on the button for POS

front_image_id class-attribute instance-attribute

front_image_id: str | None = None

UUID of the image for POS

full_name class-attribute instance-attribute

full_name: str | None = None

Full product name

full_name_english class-attribute instance-attribute

full_name_english: str | None = None

Full product name in English

gtin class-attribute instance-attribute

gtin: str | None = None

Global Trade Item Number (GTIN)

hot_loss_percent class-attribute instance-attribute

hot_loss_percent: Decimal | None = None

Weight loss percentage during hot processing

images class-attribute instance-attribute

images: list[NomenclatureProductImage] | None = None

Product quality certificates

invoice_supplier_id class-attribute instance-attribute

invoice_supplier_id: str | None = None

UUID of the default supplier (counterparty) for incoming invoices of this product. The list of values can be retrieved via the "Get counteragents list" method in the "Counteragents" category in "Inventory" section

is_calculate_unit_weight class-attribute instance-attribute

is_calculate_unit_weight: bool | None = None

Calculate unit weight automatically

is_dish_of_day class-attribute instance-attribute

is_dish_of_day: bool | None = None

Dish of the day

is_fixed_price class-attribute instance-attribute

is_fixed_price: bool | None = None

Price is set explicitly and does not depend on markup

is_flyer_program class-attribute instance-attribute

is_flyer_program: bool | None = None

Participates in the flyer programme

is_not_in_store_movement class-attribute instance-attribute

is_not_in_store_movement: bool | None = None

Not included in warehouse stock movement

is_nutrition_value_auto_calculated class-attribute instance-attribute

is_nutrition_value_auto_calculated: bool | None = None

Nutrition value is calculated automatically

is_percentage_of_alcohol_applicable class-attribute instance-attribute

is_percentage_of_alcohol_applicable: bool | None = None

Alcohol content is applicable to this product

is_time_pay_product class-attribute instance-attribute

is_time_pay_product: bool | None = None

Time-pay service product (time-based billing)

item_category_id class-attribute instance-attribute

item_category_id: str | None = None

Item category (for fiscalisation/accounting) of the product. The list of values can be retrieved via the "Get a list of fiscal categories" method in the "Directories" category in "Finance" section

markup_settings class-attribute instance-attribute

markup_settings: (
    list[NomenclatureProductMarkupSetting] | None
) = None

Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used

maximum_store_balance_levels class-attribute instance-attribute

maximum_store_balance_levels: (
    list[NomenclatureProductStoreBalanceLevel] | None
) = None

Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used

minimum_store_balance_levels class-attribute instance-attribute

minimum_store_balance_levels: (
    list[NomenclatureProductStoreBalanceLevel] | None
) = None

Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used

minimum_time_pay_product_duration_minutes class-attribute instance-attribute

minimum_time_pay_product_duration_minutes: int | None = None

Minimum duration of the time-pay service, minutes

modifier_schema_id class-attribute instance-attribute

modifier_schema_id: str | None = None

UUID of the modifier schema. The list of values can be retrieved via the "Get a list of modifier schemas" method in the "Directories" category

modifier_schema_redefinitions class-attribute instance-attribute

modifier_schema_redefinitions: (
    list[NomenclatureProductModifierSchemaRedefinition]
    | None
) = None

Modifier schema value redefinitions for this product

modifiers class-attribute instance-attribute

modifiers: list[NomenclatureProductModifier] | None = None

Top-level dish modifiers

name instance-attribute

name: str

Product name

name_english class-attribute instance-attribute

name_english: str | None = None

Product name in English

name_kitchen class-attribute instance-attribute

name_kitchen: str | None = None

Name for the kitchen screen/printer

nutrition_values class-attribute instance-attribute

nutrition_values: (
    list[NomenclatureProductNutritionValue] | None
) = None

Nutrition values by organization (structural unit) and dish size

outer_economic_activity_nomenclature_code class-attribute instance-attribute

outer_economic_activity_nomenclature_code: str | None = None

Foreign economic activity commodity nomenclature code (TN VED)

parent_group_id class-attribute instance-attribute

parent_group_id: str | None = None

UUID of the parent nomenclature group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the product belongs to the root level

percentage_of_alcohol class-attribute instance-attribute

percentage_of_alcohol: Decimal | None = None

Alcohol content, %

place_type_id class-attribute instance-attribute

place_type_id: str | None = None

Place of preparation/sale type. The list of values can be retrieved via the "Get a list of preparation place types" method in the "Directories" category

position class-attribute instance-attribute

position: int | None = None

Menu position. 0 - sort by Code+Name; otherwise - sort by this value

precheque_printable class-attribute instance-attribute

precheque_printable: bool | None = None

Print on the pre-cheque

price_markup_percent class-attribute instance-attribute

price_markup_percent: Decimal | None = None

Fixed markup (%). Stored with up to 9 decimal places

print_on_add class-attribute instance-attribute

print_on_add: bool | None = None

Print when added to the order

producer_ids class-attribute instance-attribute

producer_ids: list[str] | None = None

UUIDs of the product's manufacturers. The list of values can be retrieved via the "Get a list of producers" method in the "Directories" category

product_article class-attribute instance-attribute

product_article: str | None = None

Product article (num). If null or not provided, it will be assigned automatically by the API server

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product to create. If not specified, the UUID will be generated automatically.

product_scale_id class-attribute instance-attribute

product_scale_id: str | None = None

UUID of the dish size scale. The list of values can be retrieved via the "Get a list of product size scales" method in the "Size scales" category

product_size_factors class-attribute instance-attribute

product_size_factors: (
    NomenclatureProductSizeFactors | None
) = None

Write-off factor table by dish size

product_tag_ids class-attribute instance-attribute

product_tag_ids: list[str] | None = None

UUIDs of product tags. The list of values can be retrieved via the "Get a list of product tags" method in the "Directories" category

product_type_for_cooking class-attribute instance-attribute

product_type_for_cooking: str | None = None

Product type for kitchen preparation

rate_schedule class-attribute instance-attribute

rate_schedule: NomenclatureProductRateSchedule | None = None

Time-pay service rate schedule

relative_rate_schedule class-attribute instance-attribute

relative_rate_schedule: bool | None = None

The rate schedule is relative (anchored to the start of the service rather than the time of day)

source_nature class-attribute instance-attribute

source_nature: str | None = None

Raw material nature

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

UUID of the tax category used for the product (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section

time_pay_product_duration_step_minutes class-attribute instance-attribute

time_pay_product_duration_step_minutes: int | None = None

Billing step of the time-pay service, minutes

transfer_type class-attribute instance-attribute

transfer_type: str | None = None

Item transfer type

type instance-attribute

type: str

Product type: GOODS (goods/ingredients), DISH (dishes), PREPARED (semi-prepared items), SERVICE (services), MODIFIER (modifiers), OUTER, RATE, PETROL

unit_capacity class-attribute instance-attribute

unit_capacity: Decimal | None = None

Volume of a product unit

unit_weight class-attribute instance-attribute

unit_weight: Decimal | None = None

Weight of a product unit

use_balance_for_inventory class-attribute instance-attribute

use_balance_for_inventory: bool | None = None

Use stock balance during inventory

use_balance_for_sell class-attribute instance-attribute

use_balance_for_sell: bool | None = None

Use stock balance when selling

use_default_cooking_time class-attribute instance-attribute

use_default_cooking_time: bool | None = None

Use the default cooking time

use_range_for_invoices class-attribute instance-attribute

use_range_for_invoices: bool | None = None

Use a price range in invoices

uz_fiscal_code class-attribute instance-attribute

uz_fiscal_code: str | None = None

Fiscal code of the product for Uzbekistan

NomenclatureProductCreateResponse

Bases: IikoModel

NomenclatureProductCreateResponse.

message class-attribute instance-attribute

message: str | None = None

Message confirming successful creation

product_article class-attribute instance-attribute

product_article: str | None = None

Article of the created product

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the created product

NomenclatureProductCustomCategory

Bases: IikoModel

NomenclatureProductCustomCategory.

category_list_id class-attribute instance-attribute

category_list_id: str | None = None

UUID of the custom category list (CustomCategoryList). The list of values can be retrieved via the "Get a list of custom categories" method in the "Directories" category

category_value_id class-attribute instance-attribute

category_value_id: str | None = None

UUID of the value from that list (CustomCategoryValue). Must belong to the specified categoryList. The list of values can be retrieved via the "Get a list of custom categories" method in the "Directories" category

NomenclatureProductDayTime

Bases: IikoModel

NomenclatureProductDayTime.

minutes class-attribute instance-attribute

minutes: int | None = None

Time in minutes from the start of the day (0–1439)

NomenclatureProductDeleteRequest

Bases: IikoModel

NomenclatureProductDeleteRequest.

product_ids instance-attribute

product_ids: list[str]

List of nomenclature product UUIDs to delete

NomenclatureProductDeleteResponse

Bases: IikoModel

NomenclatureProductDeleteResponse.

message class-attribute instance-attribute

message: str | None = None

Message confirming successful deletion

NomenclatureProductFilter

Bases: IikoModel

NomenclatureProductFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

NomenclatureProductImage

Bases: IikoModel

NomenclatureProductImage.

end_at class-attribute instance-attribute

end_at: str | None = None

Certificate expiry date. ISO 8601

image_id class-attribute instance-attribute

image_id: str | None = None

Quality certificate image

start_at class-attribute instance-attribute

start_at: str | None = None

Certificate start date. ISO 8601

type class-attribute instance-attribute

type: str | None = None

Certificate type

NomenclatureProductListRequest

Bases: IikoModel

NomenclatureProductListRequest.

filters class-attribute instance-attribute

filters: list[NomenclatureProductFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

NomenclatureProductListResponse

Bases: IikoModel

NomenclatureProductListResponse.

items class-attribute instance-attribute

items: list[NomenclatureProductResponse] | None = None

List of nomenclature items on the current page

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of nomenclature items matching the filters

NomenclatureProductMarkupSetting

Bases: IikoModel

NomenclatureProductMarkupSetting.

markup_percent class-attribute instance-attribute

markup_percent: Decimal | None = None

Markup percentage. Stored with up to 9 decimal places

organization_id instance-attribute

organization_id: str

UUID of the organization (structural unit)

NomenclatureProductModifier

Bases: IikoModel

NomenclatureProductModifier.

child_modifiers class-attribute instance-attribute

child_modifiers: (
    list[NomenclatureProductChildModifier] | None
) = None

Child modifiers

child_modifiers_have_min_max_restrictions class-attribute instance-attribute

child_modifiers_have_min_max_restrictions: bool | None = (
    None
)

Child modifiers have their own min/max amount restrictions

default_amount class-attribute instance-attribute

default_amount: int | None = None

Default modifier amount

free_of_charge_amount class-attribute instance-attribute

free_of_charge_amount: int | None = None

Free-of-charge modifier amount

hide_if_default_amount class-attribute instance-attribute

hide_if_default_amount: bool | None = None

Hide the modifier when the default amount is selected

maximum_amount class-attribute instance-attribute

maximum_amount: int | None = None

Maximum modifier amount

minimum_amount class-attribute instance-attribute

minimum_amount: int | None = None

Minimum modifier amount

modifier_id class-attribute instance-attribute

modifier_id: str | None = None

UUID of the modifier

required class-attribute instance-attribute

required: bool | None = None

Required modifier

splittable class-attribute instance-attribute

splittable: bool | None = None

The modifier can be split between dish portions

NomenclatureProductModifierSchemaRedefinition

Bases: IikoModel

NomenclatureProductModifierSchemaRedefinition.

child_modifiers class-attribute instance-attribute

child_modifiers: (
    list[NomenclatureProductChildModifier] | None
) = None

Redefined child modifiers

default_amount class-attribute instance-attribute

default_amount: int | None = None

Redefined default amount

free_of_charge_amount class-attribute instance-attribute

free_of_charge_amount: int | None = None

Redefined free-of-charge amount

maximum_amount class-attribute instance-attribute

maximum_amount: int | None = None

Redefined maximum amount. null - no limit

minimum_amount class-attribute instance-attribute

minimum_amount: int | None = None

Redefined minimum amount. null - no limit

modifier_id class-attribute instance-attribute

modifier_id: str | None = None

UUID of the modifier whose schema parameters are redefined

NomenclatureProductNutritionValue

Bases: IikoModel

NomenclatureProductNutritionValue.

carbohydrate_amount class-attribute instance-attribute

carbohydrate_amount: Decimal | None = None

Carbohydrate content, g.

energy_amount class-attribute instance-attribute

energy_amount: Decimal | None = None

Energy value, kcal

fat_amount class-attribute instance-attribute

fat_amount: Decimal | None = None

Fat content, g.

nutrition_components class-attribute instance-attribute

nutrition_components: dict[str, Decimal] | None = None

Components of nutritional value

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

UUIDs of the organizations (structural units) the nutrition value is set for

product_size_id class-attribute instance-attribute

product_size_id: str | None = None

UUID of the dish size. null - for a dish without a size scale. The list of values can be retrieved via the "Get a list of product sizes" method in the "Directories" category

protein_amount class-attribute instance-attribute

protein_amount: Decimal | None = None

Protein content, g.

NomenclatureProductRGBColor

Bases: IikoModel

NomenclatureProductRGBColor.

blue class-attribute instance-attribute

blue: int | None = None

Blue channel: 0–255

green class-attribute instance-attribute

green: int | None = None

Green channel: 0–255

red class-attribute instance-attribute

red: int | None = None

Red channel: 0–255

NomenclatureProductRate

Bases: IikoModel

NomenclatureProductRate.

intervals class-attribute instance-attribute

intervals: list[NomenclatureProductRateInterval] | None = (
    None
)

Time intervals the rate is active

service_rate class-attribute instance-attribute

service_rate: str | None = None

Rate charge per unit of time

NomenclatureProductRateInterval

Bases: IikoModel

NomenclatureProductRateInterval.

begin class-attribute instance-attribute

begin: NomenclatureProductDayTime | None = None

Start of the rate's active interval

day_of_week class-attribute instance-attribute

day_of_week: str | None = None

Day of the week the rate is active

end class-attribute instance-attribute

end: NomenclatureProductDayTime | None = None

End of the rate's active interval

NomenclatureProductRateSchedule

Bases: IikoModel

NomenclatureProductRateSchedule.

rates class-attribute instance-attribute

rates: list[NomenclatureProductRate] | None = None

List of time-pay service rates

NomenclatureProductResponse

Bases: IikoModel

NomenclatureProductResponse.

accounting_category_id class-attribute instance-attribute

accounting_category_id: str | None = None

UUID of the accounting category (as configured in the accounting settings)

alcohol_class class-attribute instance-attribute

alcohol_class: str | None = None

Alcohol product class

allergen_group_ids class-attribute instance-attribute

allergen_group_ids: list[str] | None = None

UUIDs of allergen groups. The list of values can be retrieved via the "Get a list of allergen groups" method in the "Directories" category

amount_independent_of_parent_amount class-attribute instance-attribute

amount_independent_of_parent_amount: bool | None = None

The amount does not depend on the parent dish's amount

amount_unit_id class-attribute instance-attribute

amount_unit_id: str | None = None

UUID of the product's unit of measure (mainUnit). The list of values can be retrieved via the "Get a list of amount units" method in the "Directories" category

assembly_chart_modified_at class-attribute instance-attribute

assembly_chart_modified_at: str | None = None

Date the assembly chart (dish build) was last modified. ISO 8601

barcodes class-attribute instance-attribute

barcodes: list[NomenclatureProductBarcode] | None = None

Product barcodes

can_buy_from_cashdesk class-attribute instance-attribute

can_buy_from_cashdesk: bool | None = None

Can be sold directly from the cash desk

can_change_amount_cooked_dish class-attribute instance-attribute

can_change_amount_cooked_dish: bool | None = None

The amount of the cooked dish can be changed

can_set_open_price class-attribute instance-attribute

can_set_open_price: bool | None = None

An open price can be set manually

category_id class-attribute instance-attribute

category_id: str | None = None

UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category

cheque_printable class-attribute instance-attribute

cheque_printable: bool | None = None

Print on the cheque

code class-attribute instance-attribute

code: str | None = None

Product code: 0–8 digits

cold_loss_percent class-attribute instance-attribute

cold_loss_percent: Decimal | None = None

Weight loss percentage during cold processing

color class-attribute instance-attribute

color: NomenclatureProductRGBColor | None = None

Background button colour for POS

containers class-attribute instance-attribute

containers: list[NomenclatureProductContainer] | None = None

Product containers/packagings

cook_with_main_dish class-attribute instance-attribute

cook_with_main_dish: bool | None = None

Cook together with the main dish

cooking_time_normal class-attribute instance-attribute

cooking_time_normal: int | None = None

Cooking time in normal mode, minutes

cooking_time_peak class-attribute instance-attribute

cooking_time_peak: int | None = None

Cooking time in peak mode, minutes

cooking_type class-attribute instance-attribute

cooking_type: str | None = None

Cooking method

created_at class-attribute instance-attribute

created_at: str | None = None

Object creation date. ISO 8601

created_by_user_id class-attribute instance-attribute

created_by_user_id: str | None = None

UUID of the user who created the object

custom_categories class-attribute instance-attribute

custom_categories: (
    list[NomenclatureProductCustomCategory] | None
) = None

Custom nomenclature categories. Empty array or null - no categories set

default_container_id class-attribute instance-attribute

default_container_id: str | None = None

UUID of the default container. The list of values can be retrieved via the "Get a list of containers" method in the "Directories" category

default_course class-attribute instance-attribute

default_course: int | None = None

Default serving course. null - not set; 0 - VIP course; otherwise - course number

default_included_in_menu class-attribute instance-attribute

default_included_in_menu: bool | None = None

Include the product in the menu by default

default_maximum_store_balance_level class-attribute instance-attribute

default_maximum_store_balance_level: Decimal | None = None

Default maximum stock level

default_minimum_store_balance_level class-attribute instance-attribute

default_minimum_store_balance_level: Decimal | None = None

Default minimum stock level

default_sale_price class-attribute instance-attribute

default_sale_price: Decimal | None = None

Default sale price

deleted_at class-attribute instance-attribute

deleted_at: str | None = None

Deletion date. null - for non-deleted objects and for those deleted before v4.3.2. ISO 8601

description class-attribute instance-attribute

description: str | None = None

Product description

description_english class-attribute instance-attribute

description_english: str | None = None

Product description in English

disabled_fields class-attribute instance-attribute

disabled_fields: list[str] | None = None

List of fields locked for editing (e.g. by the Franchise master nomenclature)

disabled_product_size_ids class-attribute instance-attribute

disabled_product_size_ids: list[str] | None = None

UUIDs of the dish sizes disabled for this product. The list of values can be retrieved via the "Get a list of product sizes" method in the "Directories" category

egais_alc_code class-attribute instance-attribute

egais_alc_code: str | None = None

EGAIS product type code

estimated_purchase_price class-attribute instance-attribute

estimated_purchase_price: Decimal | None = None

Estimated purchase price

excluded_section_ids class-attribute instance-attribute

excluded_section_ids: list[str] | None = None

UUIDs of the menu sections the product is excluded from. The list of values can be retrieved via the "Get a list of menu sections" method in the "Directories" category

expiration_date class-attribute instance-attribute

expiration_date: int | None = None

Shelf life, days

font_color class-attribute instance-attribute

font_color: NomenclatureProductRGBColor | None = None

Font colour on the button for POS

franchise_master_id class-attribute instance-attribute

franchise_master_id: str | None = None

UUID of the parent entity in the Franchise master nomenclature from which this one was last updated

franchise_unique_id class-attribute instance-attribute

franchise_unique_id: str | None = None

Globally unique UUID of the entity within Franchise

front_image_id class-attribute instance-attribute

front_image_id: str | None = None

UUID of the image for POS

full_name class-attribute instance-attribute

full_name: str | None = None

Full product name

full_name_english class-attribute instance-attribute

full_name_english: str | None = None

Full product name in English

gtin class-attribute instance-attribute

gtin: str | None = None

Global Trade Item Number (GTIN)

hot_loss_percent class-attribute instance-attribute

hot_loss_percent: Decimal | None = None

Weight loss percentage during hot processing

images class-attribute instance-attribute

images: list[NomenclatureProductImage] | None = None

Product quality certificates

invoice_supplier_id class-attribute instance-attribute

invoice_supplier_id: str | None = None

UUID of the default supplier (counterparty) for incoming invoices of this product. The list of values can be retrieved via the "Get counteragents list" method in the "Counteragents" category in "Inventory" section

is_calculate_unit_weight class-attribute instance-attribute

is_calculate_unit_weight: bool | None = None

Calculate unit weight automatically

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deletion flag

is_dish_of_day class-attribute instance-attribute

is_dish_of_day: bool | None = None

Dish of the day

is_fixed_price class-attribute instance-attribute

is_fixed_price: bool | None = None

Price is set explicitly and does not depend on markup

is_flyer_program class-attribute instance-attribute

is_flyer_program: bool | None = None

Participates in the flyer programme

is_not_in_store_movement class-attribute instance-attribute

is_not_in_store_movement: bool | None = None

Not included in warehouse stock movement

is_nutrition_value_auto_calculated class-attribute instance-attribute

is_nutrition_value_auto_calculated: bool | None = None

Nutrition value is calculated automatically

is_percentage_of_alcohol_applicable class-attribute instance-attribute

is_percentage_of_alcohol_applicable: bool | None = None

Alcohol content is applicable to this product

is_time_pay_product class-attribute instance-attribute

is_time_pay_product: bool | None = None

Time-pay service product (time-based billing)

item_category_id class-attribute instance-attribute

item_category_id: str | None = None

Item category (for fiscalisation/accounting) of the product. The list of values can be retrieved via the "Get a list of fiscal categories" method in the "Directories" category in "Finance" section

last_modify_node_id class-attribute instance-attribute

last_modify_node_id: str | None = None

UUID of the node (ServerNode) of the last change. null - last edit was on the current server

markup_settings class-attribute instance-attribute

markup_settings: (
    list[NomenclatureProductMarkupSetting] | None
) = None

Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used

maximum_store_balance_levels class-attribute instance-attribute

maximum_store_balance_levels: (
    list[NomenclatureProductStoreBalanceLevel] | None
) = None

Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used

minimum_store_balance_levels class-attribute instance-attribute

minimum_store_balance_levels: (
    list[NomenclatureProductStoreBalanceLevel] | None
) = None

Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used

minimum_time_pay_product_duration_minutes class-attribute instance-attribute

minimum_time_pay_product_duration_minutes: int | None = None

Minimum duration of the time-pay service, minutes

modified_at class-attribute instance-attribute

modified_at: str | None = None

Date of the last modification. ISO 8601

modified_by_user_id class-attribute instance-attribute

modified_by_user_id: str | None = None

UUID of the last user who modified the object

modifier_schema_id class-attribute instance-attribute

modifier_schema_id: str | None = None

UUID of the modifier schema. The list of values can be retrieved via the "Get a list of modifier schemas" method in the "Directories" category

modifier_schema_redefinitions class-attribute instance-attribute

modifier_schema_redefinitions: (
    list[NomenclatureProductModifierSchemaRedefinition]
    | None
) = None

Modifier schema value redefinitions for this product

modifiers class-attribute instance-attribute

modifiers: list[NomenclatureProductModifier] | None = None

Top-level dish modifiers

name class-attribute instance-attribute

name: str | None = None

Product name

name_english class-attribute instance-attribute

name_english: str | None = None

Product name in English

name_kitchen class-attribute instance-attribute

name_kitchen: str | None = None

Name for the kitchen screen/printer

nutrition_values class-attribute instance-attribute

nutrition_values: (
    list[NomenclatureProductNutritionValue] | None
) = None

Nutrition values by organization (structural unit) and dish size

outer_economic_activity_nomenclature_code class-attribute instance-attribute

outer_economic_activity_nomenclature_code: str | None = None

Foreign economic activity commodity nomenclature code (TN VED)

parent_group_id class-attribute instance-attribute

parent_group_id: str | None = None

UUID of the parent nomenclature group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the product belongs to the root level

percentage_of_alcohol class-attribute instance-attribute

percentage_of_alcohol: Decimal | None = None

Alcohol content, %

place_type_id class-attribute instance-attribute

place_type_id: str | None = None

Place of preparation/sale type. The list of values can be retrieved via the "Get a list of preparation place types" method in the "Directories" category

position class-attribute instance-attribute

position: int | None = None

Menu position. 0 - sort by Code+Name; otherwise - sort by this value

precheque_printable class-attribute instance-attribute

precheque_printable: bool | None = None

Print on the pre-cheque

price_markup_percent class-attribute instance-attribute

price_markup_percent: Decimal | None = None

Fixed markup (%). Stored with up to 9 decimal places

print_on_add class-attribute instance-attribute

print_on_add: bool | None = None

Print when added to the order

producer_ids class-attribute instance-attribute

producer_ids: list[str] | None = None

UUIDs of the product's manufacturers. The list of values can be retrieved via the "Get a list of producers" method in the "Directories" category

product_article class-attribute instance-attribute

product_article: str | None = None

Product article (num). If null or not provided, it will be assigned automatically by the API server

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the nomenclature product

product_scale_id class-attribute instance-attribute

product_scale_id: str | None = None

UUID of the dish size scale. The list of values can be retrieved via the "Get a list of product size scales" method in the "Size scales" category

product_size_factors class-attribute instance-attribute

product_size_factors: (
    NomenclatureProductSizeFactors | None
) = None

Write-off factor table by dish size

product_tag_ids class-attribute instance-attribute

product_tag_ids: list[str] | None = None

UUIDs of product tags. The list of values can be retrieved via the "Get a list of product tags" method in the "Directories" category

product_type_for_cooking class-attribute instance-attribute

product_type_for_cooking: str | None = None

Product type for kitchen preparation

rate_schedule class-attribute instance-attribute

rate_schedule: NomenclatureProductRateSchedule | None = None

Time-pay service rate schedule

relative_rate_schedule class-attribute instance-attribute

relative_rate_schedule: bool | None = None

The rate schedule is relative (anchored to the start of the service rather than the time of day)

revision class-attribute instance-attribute

revision: int | None = None

Revision number of the last modification

source_nature class-attribute instance-attribute

source_nature: str | None = None

Raw material nature

system class-attribute instance-attribute

system: bool | None = None

System object. System objects cannot be edited by users

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

UUID of the tax category used for the product (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section

time_pay_product_duration_step_minutes class-attribute instance-attribute

time_pay_product_duration_step_minutes: int | None = None

Billing step of the time-pay service, minutes

transfer_type class-attribute instance-attribute

transfer_type: str | None = None

Item transfer type

type class-attribute instance-attribute

type: str | None = None

Product type: GOODS (goods/ingredients), DISH (dishes), PREPARED (semi-prepared items), SERVICE (services), MODIFIER (modifiers), OUTER, RATE, PETROL

unit_capacity class-attribute instance-attribute

unit_capacity: Decimal | None = None

Volume of a product unit

unit_weight class-attribute instance-attribute

unit_weight: Decimal | None = None

Weight of a product unit

use_balance_for_inventory class-attribute instance-attribute

use_balance_for_inventory: bool | None = None

Use stock balance during inventory

use_balance_for_sell class-attribute instance-attribute

use_balance_for_sell: bool | None = None

Use stock balance when selling

use_default_cooking_time class-attribute instance-attribute

use_default_cooking_time: bool | None = None

Use the default cooking time

use_range_for_invoices class-attribute instance-attribute

use_range_for_invoices: bool | None = None

Use a price range in invoices

uz_fiscal_code class-attribute instance-attribute

uz_fiscal_code: str | None = None

Fiscal code of the product for Uzbekistan

NomenclatureProductSizeFactors

Bases: IikoModel

NomenclatureProductSizeFactors.

factors class-attribute instance-attribute

factors: dict[str, dict[str, str]] | None = None

Write-off factor table: key - dish size UUID, value - a map of quantity range lower bound to write-off factor

NomenclatureProductStoreBalanceLevel

Bases: IikoModel

NomenclatureProductStoreBalanceLevel.

store_id instance-attribute

store_id: str

UUID of the warehouse

value class-attribute instance-attribute

value: Decimal | None = None

Stock level value. null when valueAssigned = false

value_assigned class-attribute instance-attribute

value_assigned: bool | None = None

true - value is set explicitly and taken from this array; false - taken from defaultMinimum/MaximumStoreBalanceLevel

NomenclatureProductUndeleteRequest

Bases: IikoModel

NomenclatureProductUndeleteRequest.

product_ids instance-attribute

product_ids: list[str]

List of nomenclature product UUIDs to restore

NomenclatureProductUndeleteResponse

Bases: IikoModel

NomenclatureProductUndeleteResponse.

message class-attribute instance-attribute

message: str | None = None

Message confirming successful restoration

NomenclatureProductUpdateBarcodesRequest

Bases: IikoModel

NomenclatureProductUpdateBarcodesRequest.

barcodes instance-attribute

barcodes: list[NomenclatureProductBarcode]

Barcodes

product_id instance-attribute

product_id: str

Product ID

NomenclatureProductUpdateBarcodesResponse

Bases: IikoModel

NomenclatureProductUpdateBarcodesResponse.

message class-attribute instance-attribute

message: str | None = None

Message

product_id class-attribute instance-attribute

product_id: str | None = None

Product ID

NomenclatureProductUpdateRequest

Bases: IikoModel

NomenclatureProductUpdateRequest.

accounting_category_id class-attribute instance-attribute

accounting_category_id: str | None = None

UUID of the accounting category (as configured in the accounting settings)

alcohol_class class-attribute instance-attribute

alcohol_class: str | None = None

Alcohol product class

allergen_group_ids class-attribute instance-attribute

allergen_group_ids: list[str] | None = None

UUIDs of allergen groups. The list of values can be retrieved via the "Get a list of allergen groups" method in the "Directories" category

amount_independent_of_parent_amount class-attribute instance-attribute

amount_independent_of_parent_amount: bool | None = None

The amount does not depend on the parent dish's amount

amount_unit_id instance-attribute

amount_unit_id: str

UUID of the product's unit of measure (mainUnit). The list of values can be retrieved via the "Get a list of amount units" method in the "Directories" category

barcodes class-attribute instance-attribute

barcodes: list[NomenclatureProductBarcode] | None = None

Product barcodes

can_buy_from_cashdesk class-attribute instance-attribute

can_buy_from_cashdesk: bool | None = None

Can be sold directly from the cash desk

can_change_amount_cooked_dish class-attribute instance-attribute

can_change_amount_cooked_dish: bool | None = None

The amount of the cooked dish can be changed

can_set_open_price class-attribute instance-attribute

can_set_open_price: bool | None = None

An open price can be set manually

category_id class-attribute instance-attribute

category_id: str | None = None

UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category

cheque_printable class-attribute instance-attribute

cheque_printable: bool | None = None

Print on the cheque

code instance-attribute

code: str

Product code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a product

cold_loss_percent class-attribute instance-attribute

cold_loss_percent: Decimal | None = None

Weight loss percentage during cold processing

color class-attribute instance-attribute

color: NomenclatureProductRGBColor | None = None

Background button colour for POS

containers class-attribute instance-attribute

containers: list[NomenclatureProductContainer] | None = None

Product containers/packagings

cook_with_main_dish class-attribute instance-attribute

cook_with_main_dish: bool | None = None

Cook together with the main dish

cooking_time_normal class-attribute instance-attribute

cooking_time_normal: int | None = None

Cooking time in normal mode, minutes

cooking_time_peak class-attribute instance-attribute

cooking_time_peak: int | None = None

Cooking time in peak mode, minutes

cooking_type class-attribute instance-attribute

cooking_type: str | None = None

Cooking method

custom_categories class-attribute instance-attribute

custom_categories: (
    list[NomenclatureProductCustomCategory] | None
) = None

Custom nomenclature categories. Empty array or null - no categories set

default_container_id class-attribute instance-attribute

default_container_id: str | None = None

UUID of the default container. The list of values can be retrieved via the "Get a list of containers" method in the "Directories" category

default_course class-attribute instance-attribute

default_course: int | None = None

Default serving course. null - not set; 0 - VIP course; otherwise - course number

default_included_in_menu class-attribute instance-attribute

default_included_in_menu: bool | None = None

Include the product in the menu by default

default_maximum_store_balance_level class-attribute instance-attribute

default_maximum_store_balance_level: Decimal | None = None

Default maximum stock level

default_minimum_store_balance_level class-attribute instance-attribute

default_minimum_store_balance_level: Decimal | None = None

Default minimum stock level

default_sale_price class-attribute instance-attribute

default_sale_price: Decimal | None = None

Default sale price

description class-attribute instance-attribute

description: str | None = None

Product description

description_english class-attribute instance-attribute

description_english: str | None = None

Product description in English

disabled_product_size_ids class-attribute instance-attribute

disabled_product_size_ids: list[str] | None = None

UUIDs of the dish sizes disabled for this product. The list of values can be retrieved via the "Get a list of product sizes" method in the "Directories" category

egais_alc_code class-attribute instance-attribute

egais_alc_code: str | None = None

EGAIS product type code

estimated_purchase_price class-attribute instance-attribute

estimated_purchase_price: Decimal | None = None

Estimated purchase price

excluded_section_ids class-attribute instance-attribute

excluded_section_ids: list[str] | None = None

UUIDs of the menu sections the product is excluded from. The list of values can be retrieved via the "Get a list of menu sections" method in the "Directories" category

expiration_date class-attribute instance-attribute

expiration_date: int | None = None

Shelf life, days

font_color class-attribute instance-attribute

font_color: NomenclatureProductRGBColor | None = None

Font colour on the button for POS

front_image_id class-attribute instance-attribute

front_image_id: str | None = None

UUID of the image for POS

full_name class-attribute instance-attribute

full_name: str | None = None

Full product name

full_name_english class-attribute instance-attribute

full_name_english: str | None = None

Full product name in English

gtin class-attribute instance-attribute

gtin: str | None = None

Global Trade Item Number (GTIN)

hot_loss_percent class-attribute instance-attribute

hot_loss_percent: Decimal | None = None

Weight loss percentage during hot processing

images class-attribute instance-attribute

images: list[NomenclatureProductImage] | None = None

Product quality certificates

invoice_supplier_id class-attribute instance-attribute

invoice_supplier_id: str | None = None

UUID of the default supplier (counterparty) for incoming invoices of this product. The list of values can be retrieved via the "Get counteragents list" method in the "Counteragents" category in "Inventory" section

is_calculate_unit_weight class-attribute instance-attribute

is_calculate_unit_weight: bool | None = None

Calculate unit weight automatically

is_dish_of_day class-attribute instance-attribute

is_dish_of_day: bool | None = None

Dish of the day

is_fixed_price class-attribute instance-attribute

is_fixed_price: bool | None = None

Price is set explicitly and does not depend on markup

is_flyer_program class-attribute instance-attribute

is_flyer_program: bool | None = None

Participates in the flyer programme

is_not_in_store_movement class-attribute instance-attribute

is_not_in_store_movement: bool | None = None

Not included in warehouse stock movement

is_nutrition_value_auto_calculated class-attribute instance-attribute

is_nutrition_value_auto_calculated: bool | None = None

Nutrition value is calculated automatically

is_percentage_of_alcohol_applicable class-attribute instance-attribute

is_percentage_of_alcohol_applicable: bool | None = None

Alcohol content is applicable to this product

is_time_pay_product class-attribute instance-attribute

is_time_pay_product: bool | None = None

Time-pay service product (time-based billing)

item_category_id class-attribute instance-attribute

item_category_id: str | None = None

Item category (for fiscalisation/accounting) of the product. The list of values can be retrieved via the "Get a list of fiscal categories" method in the "Directories" category in "Finance" section

markup_settings class-attribute instance-attribute

markup_settings: (
    list[NomenclatureProductMarkupSetting] | None
) = None

Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used

maximum_store_balance_levels class-attribute instance-attribute

maximum_store_balance_levels: (
    list[NomenclatureProductStoreBalanceLevel] | None
) = None

Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used

minimum_store_balance_levels class-attribute instance-attribute

minimum_store_balance_levels: (
    list[NomenclatureProductStoreBalanceLevel] | None
) = None

Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used

minimum_time_pay_product_duration_minutes class-attribute instance-attribute

minimum_time_pay_product_duration_minutes: int | None = None

Minimum duration of the time-pay service, minutes

modifier_schema_id class-attribute instance-attribute

modifier_schema_id: str | None = None

UUID of the modifier schema. The list of values can be retrieved via the "Get a list of modifier schemas" method in the "Directories" category

modifier_schema_redefinitions class-attribute instance-attribute

modifier_schema_redefinitions: (
    list[NomenclatureProductModifierSchemaRedefinition]
    | None
) = None

Modifier schema value redefinitions for this product

modifiers class-attribute instance-attribute

modifiers: list[NomenclatureProductModifier] | None = None

Top-level dish modifiers

name instance-attribute

name: str

Product name

name_english class-attribute instance-attribute

name_english: str | None = None

Product name in English

name_kitchen class-attribute instance-attribute

name_kitchen: str | None = None

Name for the kitchen screen/printer

nutrition_values class-attribute instance-attribute

nutrition_values: (
    list[NomenclatureProductNutritionValue] | None
) = None

Nutrition values by organization (structural unit) and dish size

outer_economic_activity_nomenclature_code class-attribute instance-attribute

outer_economic_activity_nomenclature_code: str | None = None

Foreign economic activity commodity nomenclature code (TN VED)

parent_group_id class-attribute instance-attribute

parent_group_id: str | None = None

UUID of the parent nomenclature group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the product belongs to the root level

percentage_of_alcohol class-attribute instance-attribute

percentage_of_alcohol: Decimal | None = None

Alcohol content, %

place_type_id class-attribute instance-attribute

place_type_id: str | None = None

Place of preparation/sale type. The list of values can be retrieved via the "Get a list of preparation place types" method in the "Directories" category

position class-attribute instance-attribute

position: int | None = None

Menu position. 0 - sort by Code+Name; otherwise - sort by this value

precheque_printable class-attribute instance-attribute

precheque_printable: bool | None = None

Print on the pre-cheque

price_markup_percent class-attribute instance-attribute

price_markup_percent: Decimal | None = None

Fixed markup (%). Stored with up to 9 decimal places

print_on_add class-attribute instance-attribute

print_on_add: bool | None = None

Print when added to the order

producer_ids class-attribute instance-attribute

producer_ids: list[str] | None = None

UUIDs of the product's manufacturers. The list of values can be retrieved via the "Get a list of producers" method in the "Directories" category

product_article class-attribute instance-attribute

product_article: str | None = None

Product article (num). If null or not provided, it will be assigned automatically by the API server

product_id instance-attribute

product_id: str

UUID of the product to update

product_scale_id class-attribute instance-attribute

product_scale_id: str | None = None

UUID of the dish size scale. The list of values can be retrieved via the "Get a list of product size scales" method in the "Size scales" category

product_size_factors class-attribute instance-attribute

product_size_factors: (
    NomenclatureProductSizeFactors | None
) = None

Write-off factor table by dish size

product_tag_ids class-attribute instance-attribute

product_tag_ids: list[str] | None = None

UUIDs of product tags. The list of values can be retrieved via the "Get a list of product tags" method in the "Directories" category

product_type_for_cooking class-attribute instance-attribute

product_type_for_cooking: str | None = None

Product type for kitchen preparation

rate_schedule class-attribute instance-attribute

rate_schedule: NomenclatureProductRateSchedule | None = None

Time-pay service rate schedule

relative_rate_schedule class-attribute instance-attribute

relative_rate_schedule: bool | None = None

The rate schedule is relative (anchored to the start of the service rather than the time of day)

source_nature class-attribute instance-attribute

source_nature: str | None = None

Raw material nature

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

UUID of the tax category used for the product (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section

time_pay_product_duration_step_minutes class-attribute instance-attribute

time_pay_product_duration_step_minutes: int | None = None

Billing step of the time-pay service, minutes

transfer_type class-attribute instance-attribute

transfer_type: str | None = None

Item transfer type

type instance-attribute

type: str

Product type: GOODS (goods/ingredients), DISH (dishes), PREPARED (semi-prepared items), SERVICE (services), MODIFIER (modifiers), OUTER, RATE, PETROL

unit_capacity class-attribute instance-attribute

unit_capacity: Decimal | None = None

Volume of a product unit

unit_weight class-attribute instance-attribute

unit_weight: Decimal | None = None

Weight of a product unit

use_balance_for_inventory class-attribute instance-attribute

use_balance_for_inventory: bool | None = None

Use stock balance during inventory

use_balance_for_sell class-attribute instance-attribute

use_balance_for_sell: bool | None = None

Use stock balance when selling

use_default_cooking_time class-attribute instance-attribute

use_default_cooking_time: bool | None = None

Use the default cooking time

use_range_for_invoices class-attribute instance-attribute

use_range_for_invoices: bool | None = None

Use a price range in invoices

uz_fiscal_code class-attribute instance-attribute

uz_fiscal_code: str | None = None

Fiscal code of the product for Uzbekistan

NomenclatureProductUpdateResponse

Bases: IikoModel

NomenclatureProductUpdateResponse.

message class-attribute instance-attribute

message: str | None = None

Message confirming successful update

product_article class-attribute instance-attribute

product_article: str | None = None

Article of the updated product

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the updated product

OuterEconomicActivityNomenclatureCode

Bases: IikoModel

OuterEconomicActivityNomenclatureCode.

id class-attribute instance-attribute

id: str | None = None

UUID of the foreign economic activity commodity code

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the code is soft-deleted

name class-attribute instance-attribute

name: str | None = None

Name of the foreign economic activity commodity code

outer_ean_code class-attribute instance-attribute

outer_ean_code: str | None = None

Code per the EAEU FEACN (TN VED) classification

OuterEconomicActivityNomenclatureCodeGetRequest

Bases: IikoModel

OuterEconomicActivityNomenclatureCodeGetRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the requested foreign economic activity commodity code

OuterEconomicActivityNomenclatureCodeListRequest

Bases: IikoModel

OuterEconomicActivityNomenclatureCodeListRequest.

include_deleted class-attribute instance-attribute

include_deleted: bool | None = None

Include deleted codes in the response. Default false

OuterEconomicActivityNomenclatureCodeListResponse

Bases: IikoModel

OuterEconomicActivityNomenclatureCodeListResponse.

items class-attribute instance-attribute

items: (
    list[OuterEconomicActivityNomenclatureCode] | None
) = None

List of foreign economic activity commodity codes

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of foreign economic activity commodity codes matching the request

PlaceType

Bases: IikoModel

PlaceType.

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

PlaceTypeFilter

Bases: IikoModel

PlaceTypeFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

PlaceTypeListRequest

Bases: IikoModel

PlaceTypeListRequest.

filters class-attribute instance-attribute

filters: list[PlaceTypeFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

PlaceTypeListResponse

Bases: IikoModel

PlaceTypeListResponse.

items class-attribute instance-attribute

items: list[PlaceType] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

PreparedChartDto

Bases: IikoModel

PreparedChartDto.

assembled_quantity class-attribute instance-attribute

assembled_quantity: Decimal | None = None

Assembled quantity (bookmark rate). Must be greater than 0

date_from class-attribute instance-attribute

date_from: str | None = None

Start date of the validity period (YYYY-MM-DD)

date_to class-attribute instance-attribute

date_to: str | None = None

End date of the validity period (YYYY-MM-DD)

direct_writeoff_store_specification class-attribute instance-attribute

direct_writeoff_store_specification: (
    StoreSpecification | None
) = None

Organization (structural unit) filter for DIRECT write-off strategy. null — applies to all organizations

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

items class-attribute instance-attribute

items: list[PreparedChartItemDto] | None = None

Ingredient lines of the assembly chart

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product this assembly chart belongs to

product_size_assembly_strategy class-attribute instance-attribute

product_size_assembly_strategy: str | None = None

Size strategy: COMMON (one chart for all sizes) or SPECIFIC (per-size ingredients)

PreparedChartItemDto

Bases: IikoModel

PreparedChartItemDto.

amount class-attribute instance-attribute

amount: Decimal | None = None

Amount of the ingredient written off from stock

id class-attribute instance-attribute

id: str | None = None

UUID of the ingredient line

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the ingredient product

product_size_id class-attribute instance-attribute

product_size_id: str | None = None

UUID of the product size this line applies to. null — applies to all sizes

sort_weight class-attribute instance-attribute

sort_weight: Decimal | None = None

Display order weight

store_specification class-attribute instance-attribute

store_specification: StoreSpecification | None = None

Department applicability filter for the ingredient line

PreparedRequest

Bases: IikoModel

PreparedRequest.

date_from class-attribute instance-attribute

date_from: str | None = None

Date to retrieve the assembly chart for (YYYY-MM-DD)

organization_id class-attribute instance-attribute

organization_id: str | None = None

UUID of the organization (department) to build the assembly chart in the context of. Optional

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product to retrieve the assembly chart for

Producer

Bases: IikoModel

Producer.

code class-attribute instance-attribute

code: str | None = None

Code of the directory entry

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

ProducerFilter

Bases: IikoModel

ProducerFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

ProducerListRequest

Bases: IikoModel

ProducerListRequest.

filters class-attribute instance-attribute

filters: list[ProducerFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

ProducerListResponse

Bases: IikoModel

ProducerListResponse.

items class-attribute instance-attribute

items: list[Producer] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

ProductScaleListResponse

Bases: IikoModel

ProductScaleListResponse.

items class-attribute instance-attribute

items: list[ProductScaleResponse] | None = None

List of product size scales

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. limit <= 0 - no limit, all records are returned

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of product size scales

ProductScaleResponse

Bases: IikoModel

ProductScaleResponse.

id class-attribute instance-attribute

id: str | None = None

UUID of the product size scale

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the scale is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the product size scale

product_sizes class-attribute instance-attribute

product_sizes: list[ProductSizeResponse] | None = None

List of sizes in this scale

ProductSize

Bases: IikoModel

ProductSize.

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

ProductSizeCreateFields

Bases: IikoModel

ProductSizeCreateFields.

default class-attribute instance-attribute

default: bool | None = None

Whether this size is the default for the scale

name class-attribute instance-attribute

name: str | None = None

Name of the size

priority class-attribute instance-attribute

priority: int | None = None

Display priority (order)

short_name class-attribute instance-attribute

short_name: str | None = None

Short name of the size. null is treated as empty string

ProductSizeCreateRequest

Bases: IikoModel

ProductSizeCreateRequest.

name class-attribute instance-attribute

name: str | None = None

Name of the product size scale

product_sizes class-attribute instance-attribute

product_sizes: list[ProductSizeCreateFields] | None = None

List of sizes in this scale

ProductSizeDeleteRequest

Bases: IikoModel

ProductSizeDeleteRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the product size scale

ProductSizeFilter

Bases: IikoModel

ProductSizeFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

ProductSizeGetRequest

Bases: IikoModel

ProductSizeGetRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the product size scale

ProductSizeListRequest

Bases: IikoModel

ProductSizeListRequest.

filters class-attribute instance-attribute

filters: list[ProductSizeFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

ProductSizeListResponse

Bases: IikoModel

ProductSizeListResponse.

items class-attribute instance-attribute

items: list[ProductSize] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

ProductSizeResponse

Bases: IikoModel

ProductSizeResponse.

default class-attribute instance-attribute

default: bool | None = None

Whether this size is the default for the scale

id class-attribute instance-attribute

id: str | None = None

UUID of the size (null when creating a new size inside update)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether this size is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the size

priority class-attribute instance-attribute

priority: int | None = None

Display priority (order)

short_name class-attribute instance-attribute

short_name: str | None = None

Short name of the size. null is treated as empty string

ProductSizeUpdateFields

Bases: IikoModel

ProductSizeUpdateFields.

default class-attribute instance-attribute

default: bool | None = None

Whether this size is the default for the scale

id class-attribute instance-attribute

id: str | None = None

UUID of the size (null when creating a new size inside update)

name class-attribute instance-attribute

name: str | None = None

Name of the size

priority class-attribute instance-attribute

priority: int | None = None

Display priority (order)

short_name class-attribute instance-attribute

short_name: str | None = None

Short name of the size. null is treated as empty string

ProductSizeUpdateRequest

Bases: IikoModel

ProductSizeUpdateRequest.

id class-attribute instance-attribute

id: str | None = None

UUID of the product size scale

name class-attribute instance-attribute

name: str | None = None

Name of the product size scale

product_sizes class-attribute instance-attribute

product_sizes: list[ProductSizeUpdateFields] | None = None

List of sizes in this scale

ProductTag

Bases: IikoModel

ProductTag.

id class-attribute instance-attribute

id: str | None = None

UUID of the directory entry

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Whether the directory entry is deleted

name class-attribute instance-attribute

name: str | None = None

Name of the directory entry

ProductTagFilter

Bases: IikoModel

ProductTagFilter.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Comparison operator: "eq" (equal), "ne" (not equal), "gt" (greater than), "gte" (greater than or equal), "lt" (less than), "lte" (less than or equal), "in" (value in list — uses values[]), "nin" (value not in list — uses values[]), "like" (case-insensitive substring), "blank" (null or empty string), "notblank" (not null and not empty string)

value class-attribute instance-attribute

value: Any | None = None

Scalar value for filtering (used with eq, ne, gt, gte, lt, lte, like)

values class-attribute instance-attribute

values: list[Any] | None = None

Array of values for multi-value filtering (used with "in", "nin")

ProductTagListRequest

Bases: IikoModel

ProductTagListRequest.

filters class-attribute instance-attribute

filters: list[ProductTagFilter] | None = None

Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

ProductTagListResponse

Bases: IikoModel

ProductTagListResponse.

items class-attribute instance-attribute

items: list[ProductTag] | None = None

List of directory entries

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response. Allowed values: 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of directory entries

SaveRequest

Bases: IikoModel

SaveRequest.

appearance class-attribute instance-attribute

appearance: str | None = None

Presentation and serving requirements (up to 2000 characters)

assembled_quantity class-attribute instance-attribute

assembled_quantity: Decimal | None = None

Assembled quantity (bookmark rate). Must be greater than 0

date_from class-attribute instance-attribute

date_from: str | None = None

Start date of the validity period (YYYY-MM-DD)

date_to instance-attribute

date_to: str

End date of the validity period (YYYY-MM-DD)

description class-attribute instance-attribute

description: str | None = None

Free-text description field (up to 2000 characters)

direct_writeoff_store_specification class-attribute instance-attribute

direct_writeoff_store_specification: (
    StoreSpecification | None
) = None

Organization (structural unit) filter for DIRECT write-off strategy. null — applies to all organizations

franchise_master_id class-attribute instance-attribute

franchise_master_id: str | None = None

Franchise master UUID. null — not a franchise object

franchise_original_id class-attribute instance-attribute

franchise_original_id: str | None = None

Franchise original UUID. null — not a franchise object

franchise_unique_id class-attribute instance-attribute

franchise_unique_id: str | None = None

Franchise unique UUID. Required when franchiseMasterId is set

id class-attribute instance-attribute

id: str | None = None

UUID of the assembly chart

items class-attribute instance-attribute

items: list[AssemblyChartItem] | None = None

Ingredient lines of the assembly chart

organoleptic class-attribute instance-attribute

organoleptic: str | None = None

Organoleptic quality indicators (up to 2000 characters)

output_comment class-attribute instance-attribute

output_comment: str | None = None

Output comment / yield note (up to 2000 characters)

picture class-attribute instance-attribute

picture: str | None = None

UUID of the technology image. null — no image

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product this assembly chart belongs to

product_size_assembly_strategy class-attribute instance-attribute

product_size_assembly_strategy: str | None = None

Size strategy: COMMON (one chart for all sizes) or SPECIFIC (per-size ingredients)

technology_description class-attribute instance-attribute

technology_description: str | None = None

Preparation technology description (up to 2000 characters)

version_compatibility class-attribute instance-attribute

version_compatibility: str | None = None

Version compatibility tag. Only V_7_0 is currently accepted

writeoff_strategy class-attribute instance-attribute

writeoff_strategy: str | None = None

Write-off strategy: ASSEMBLE (write off ingredients) or DIRECT (write off the product itself)

StoreSpecification

Bases: IikoModel

StoreSpecification.

inverse class-attribute instance-attribute

inverse: bool | None = None

true — specification applies to all departments EXCEPT the listed ones

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

UUIDs of organizations (structural units) the specification applies to

TreeRequest

Bases: IikoModel

TreeRequest.

date_from class-attribute instance-attribute

date_from: str | None = None

Date to retrieve the assembly chart for (YYYY-MM-DD)

organization_id class-attribute instance-attribute

organization_id: str | None = None

UUID of the organization (department) to build the assembly chart in the context of. Optional

product_id class-attribute instance-attribute

product_id: str | None = None

UUID of the product to retrieve the assembly chart for