Skip to content

Inventory models

Models of the inventory endpoints.

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

AccountingCategory

Bases: IikoModel

AccountingCategory.

code class-attribute instance-attribute

code: str | None = None

User-defined accounting category code

id class-attribute instance-attribute

id: str | None = None

Accounting category identifier (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating that the accounting category is logically deleted

name class-attribute instance-attribute

name: str | None = None

Display name of the accounting category

AccountingCategoryGetByIDRequest

Bases: IikoModel

AccountingCategoryGetByIDRequest.

id class-attribute instance-attribute

id: str | None = None

Entity identifier (UUID)

AccountingCategoryListRequest

Bases: IikoModel

AccountingCategoryListRequest.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Filter by deletion status; omit to return all records

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records (0 = no limit)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip

revision class-attribute instance-attribute

revision: int | None = None

Return only records with revision >= this value

AccountingCategoryListResponse

Bases: IikoModel

AccountingCategoryListResponse.

entities class-attribute instance-attribute

entities: list[AccountingCategory] | None = None

List of entities

limit class-attribute instance-attribute

limit: int | None = None

Limit value from the request

offset class-attribute instance-attribute

offset: int | None = None

Offset value from the request

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the filter

AccountingTransactionUserResponse

Bases: IikoModel

AccountingTransactionUserResponse.

accounting_transaction_id class-attribute instance-attribute

accounting_transaction_id: str | None = None

Transaction identifier

message class-attribute instance-attribute

message: str | None = None

Operation result message

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization identifier

Conception

Bases: IikoModel

Conception.

code class-attribute instance-attribute

code: str | None = None

User-defined conception code

id class-attribute instance-attribute

id: str | None = None

Conception identifier (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating that the conception is logically deleted

name class-attribute instance-attribute

name: str | None = None

Display name of the conception

ConceptionGetByIDRequest

Bases: IikoModel

ConceptionGetByIDRequest.

id class-attribute instance-attribute

id: str | None = None

Entity identifier (UUID)

ConceptionListRequest

Bases: IikoModel

ConceptionListRequest.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Filter by deletion status; omit to return all records

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records (0 = no limit)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip

revision class-attribute instance-attribute

revision: int | None = None

Return only records with revision >= this value

ConceptionListResponse

Bases: IikoModel

ConceptionListResponse.

entities class-attribute instance-attribute

entities: list[Conception] | None = None

List of entities

limit class-attribute instance-attribute

limit: int | None = None

Limit value from the request

offset class-attribute instance-attribute

offset: int | None = None

Offset value from the request

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the filter

CorporationSettings

Bases: IikoModel

CorporationSettings.

crm_id class-attribute instance-attribute

crm_id: str | None = None

Corporation identifier in CRM as represented; null if not set

currency class-attribute instance-attribute

currency: Any | None = None

Corporation currency settings in the structure received from internal API server; null if no settings

default_deviation_action class-attribute instance-attribute

default_deviation_action: str | None = None

Action when the price deviates from the internal price list, if the supplier has no own price list: NOT_NOTIFY — do not warn, NOTIFY — warn, DISABLE — forbid posting, DISABLE_GREATER — forbid posting when the price is exceeded

default_distribution_algorithm class-attribute instance-attribute

default_distribution_algorithm: str | None = None

Default service cost distribution algorithm: DISTRIBUTION_BY_SUM — by amount, DISTRIBUTION_BY_AMOUNT — by quantity, DISTRIBUTION_NOT_SPECIFIED — not specified

delete_zero_production_order_items class-attribute instance-attribute

delete_zero_production_order_items: bool | None = None

Flag for deleting items with zero quantity in internal production orders when saving

deleted class-attribute instance-attribute

deleted: bool | None = None

Flag indicating that the corporation is logically deleted

description class-attribute instance-attribute

description: str | None = None

Text description of the corporation; null if the description is not filled in

document_settings class-attribute instance-attribute

document_settings: Any | None = None

Corporation document settings in the structure received from internal API server; null if no settings

gln class-attribute instance-attribute

gln: str | None = None

Global Location Number (GLN) of the corporation; null if the number is not set

id class-attribute instance-attribute

id: str | None = None

Corporation entity identifier

local_id class-attribute instance-attribute

local_id: str | None = None

Local corporation identifier; null if not set

money_precision class-attribute instance-attribute

money_precision: int | None = None

Number of decimal places to which internal API server rounds monetary values and monetary calculation results

name class-attribute instance-attribute

name: str | None = None

Display name of the corporation; null if the name is not filled in

parent class-attribute instance-attribute

parent: str | None = None

Identifier of the parent entity; null if the corporation is a root entity

personal_data_processing_settings class-attribute instance-attribute

personal_data_processing_settings: Any | None = None

Personal data processing and notification settings; null if no settings

round_cost_for_guests class-attribute instance-attribute

round_cost_for_guests: bool | None = None

Flag for rounding the order cost to a whole number in favor of the guest

round_price_per_unit_for_guests class-attribute instance-attribute

round_price_per_unit_for_guests: bool | None = None

Flag for rounding the unit price down

vat_accounting class-attribute instance-attribute

vat_accounting: str | None = None

VAT accounting mode in the price of incoming goods: VAT_INCLUDED_IN_PRICE — VAT included, VAT_NOT_INCLUDED_IN_PRICE — VAT not included

CostPriceItem

Bases: IikoModel

CostPriceItem.

amount_factor class-attribute instance-attribute

amount_factor: Decimal | None = None

Quantity factor

is_evaluative class-attribute instance-attribute

is_evaluative: bool | None = None

Estimated price flag

product_id class-attribute instance-attribute

product_id: str | None = None

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

store_id class-attribute instance-attribute

store_id: str | None = None

Store identifier (GUID)

value class-attribute instance-attribute

value: Decimal | None = None

Cost price value

Counteragent

Bases: IikoModel

Counteragent.

card_number class-attribute instance-attribute

card_number: str | None = None

Card number

cell_phone class-attribute instance-attribute

cell_phone: str | None = None

Mobile phone

client class-attribute instance-attribute

client: bool | None = None

Is client

code class-attribute instance-attribute

code: str | None = None

Counteragent code

company class-attribute instance-attribute

company: str | None = None

Company

email class-attribute instance-attribute

email: str | None = None

Email

employee class-attribute instance-attribute

employee: bool | None = None

Is employee

first_name class-attribute instance-attribute

first_name: str | None = None

First name

id class-attribute instance-attribute

id: str | None = None

Counteragent identifier (GUID)

last_name class-attribute instance-attribute

last_name: str | None = None

Last name

middle_name class-attribute instance-attribute

middle_name: str | None = None

Middle name

name class-attribute instance-attribute

name: str | None = None

Counteragent name

phone class-attribute instance-attribute

phone: str | None = None

Phone

supplier class-attribute instance-attribute

supplier: bool | None = None

Is supplier

supplier_type class-attribute instance-attribute

supplier_type: str | None = None

Supplier type

taxpayer_id_number class-attribute instance-attribute

taxpayer_id_number: str | None = None

Taxpayer ID number

DisassembleDocumentCreateItem

Bases: IikoModel

DisassembleDocumentCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

num instance-attribute

num: int

Item sequence number

product instance-attribute

product: str

Product identifier (GUID)

DisassembleDocumentCreateRequest

Bases: IikoModel

DisassembleDocumentCreateRequest.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

product instance-attribute

product: str

Product identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

DisassembleDocumentGetItem

Bases: IikoModel

DisassembleDocumentGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

num class-attribute instance-attribute

num: int | None = None

Item sequence number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

DisassembleDocumentGetResponse

Bases: IikoModel

DisassembleDocumentGetResponse.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

items class-attribute instance-attribute

items: list[DisassembleDocumentGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

store_to class-attribute instance-attribute

store_to: str | None = None

Receipt store identifier (GUID)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

DisassembleDocumentListItem

Bases: IikoModel

DisassembleDocumentListItem.

DisassembleDocumentSaveResponse

Bases: IikoModel

DisassembleDocumentSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

DisassembleDocumentUpdateRequest

Bases: IikoModel

DisassembleDocumentUpdateRequest.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id instance-attribute

document_id: str

Document identifier (GUID)

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

product instance-attribute

product: str

Product identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

GetCostPricesRequest

Bases: IikoModel

GetCostPricesRequest.

date_incoming instance-attribute

date_incoming: str

Date for cost price calculation (ISO8601 format, e.g. 2025-12-26T12:40:26.801+03:00)

items instance-attribute

items: list[PriceItem]

List of nomenclature items for cost price retrieval

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

GetCostPricesResponse

Bases: IikoModel

GetCostPricesResponse.

items class-attribute instance-attribute

items: list[CostPriceItem] | None = None

List of item cost prices

problem_items class-attribute instance-attribute

problem_items: list[PriceItem] | None = None

List of problem items

GetCounteragentsRequest

Bases: IikoModel

GetCounteragentsRequest.

limit class-attribute instance-attribute

limit: int | None = None

Number of records to return (1-500)

offset class-attribute instance-attribute

offset: int | None = None

Pagination offset

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization identifier (GUID)

type class-attribute instance-attribute

type: list[str] | None = None

Counteragent type (supplier, employee, client)

GetCounteragentsResponse

Bases: IikoModel

GetCounteragentsResponse.

counteragents class-attribute instance-attribute

counteragents: list[Counteragent] | None = None

List of counteragents

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of counteragents

GetPriceListRequest

Bases: IikoModel

GetPriceListRequest.

counteragent_id instance-attribute

counteragent_id: str

Counteragent identifier (GUID). The counteragent must be a supplier

GetPriceListResponse

Bases: IikoModel

GetPriceListResponse.

items class-attribute instance-attribute

items: list[PriceListItem] | None = None

List of supplier price list items

IncomingInventoryCreateFirstStepItem

Bases: IikoModel

IncomingInventoryCreateFirstStepItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

num instance-attribute

num: int

Item sequence number

product instance-attribute

product: str

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

IncomingInventoryCreateItem

Bases: IikoModel

IncomingInventoryCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

container_count class-attribute instance-attribute

container_count: Decimal | None = None

Quantity in container/package (containerId)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

is_disassembled class-attribute instance-attribute

is_disassembled: bool | None = None

Ingredient flag. true — item is an ingredient of another first-step item

num instance-attribute

num: int

Item sequence number

product instance-attribute

product: str

Product identifier (GUID)

IncomingInventoryCreateRequest

Bases: IikoModel

IncomingInventoryCreateRequest.

account_shortage class-attribute instance-attribute

account_shortage: str | None = None

Shortage account identifier (GUID). Default 07926ff3-9319-b93e-80ff-1897825fdead

account_surplus class-attribute instance-attribute

account_surplus: str | None = None

Surplus account identifier (GUID). Default 67af8bc9-628f-2124-2345-3750bb7db6fa

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

Main inventory items (second step / all products). Must contain at least one element

items_first_step instance-attribute

First step items (dishes, preparations, modifiers). Can be an empty array

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store instance-attribute

store: str

Inventory store identifier (GUID)

IncomingInventoryGetFirstItem

Bases: IikoModel

IncomingInventoryGetFirstItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

num class-attribute instance-attribute

num: int | None = None

Item sequence number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

turnover class-attribute instance-attribute

turnover: Decimal | None = None

Product turnover for the period. Read-only. Can be null

IncomingInventoryGetItem

Bases: IikoModel

IncomingInventoryGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

container_count class-attribute instance-attribute

container_count: Decimal | None = None

Quantity in container/package (containerId)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

container_name class-attribute instance-attribute

container_name: str | None = None

Container/package name

count class-attribute instance-attribute

count: Decimal | None = None

Quantity in base unit of measure

count_gross class-attribute instance-attribute

count_gross: Decimal | None = None

Gross weight (with container)

current_actual_amount class-attribute instance-attribute

current_actual_amount: Decimal | None = None

Actual quantity including dishes and preparations. Read-only

is_disassembled class-attribute instance-attribute

is_disassembled: bool | None = None

Ingredient flag. true — item is an ingredient of another first-step item

num class-attribute instance-attribute

num: int | None = None

Item sequence number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

recalculation_date class-attribute instance-attribute

recalculation_date: str | None = None

Recalculation date. Read-only. Can be null

recalculation_number class-attribute instance-attribute

recalculation_number: int | None = None

Recalculation sequence number. Read-only

status class-attribute instance-attribute

status: str | None = None

Item status (NEW — unsaved, SAVE — saved, RECALC — recalculated/deleted)

turnover class-attribute instance-attribute

turnover: Decimal | None = None

Product turnover for the period. Read-only. Can be null

IncomingInventoryGetResponse

Bases: IikoModel

IncomingInventoryGetResponse.

account_shortage class-attribute instance-attribute

account_shortage: str | None = None

Shortage account identifier (GUID). Default 07926ff3-9319-b93e-80ff-1897825fdead

account_surplus class-attribute instance-attribute

account_surplus: str | None = None

Surplus account identifier (GUID). Default 67af8bc9-628f-2124-2345-3750bb7db6fa

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

current_step class-attribute instance-attribute

current_step: int | None = None

Current inventory step. Read-only

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[IncomingInventoryGetItem] | None = None

Main inventory items (second step / all products). Must contain at least one element

items_first_step class-attribute instance-attribute

items_first_step: (
    list[IncomingInventoryGetFirstItem] | None
) = None

First step items (dishes, preparations, modifiers). Can be an empty array

number class-attribute instance-attribute

number: str | None = None

Document number

register_turnover class-attribute instance-attribute

register_turnover: bool | None = None

Flag for tracking product movement over the period. Read-only

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

store class-attribute instance-attribute

store: str | None = None

Inventory store identifier (GUID)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

IncomingInventoryListItem

Bases: IikoModel

IncomingInventoryListItem.

account_shortage class-attribute instance-attribute

account_shortage: str | None = None

Shortage account identifier (GUID). Default 07926ff3-9319-b93e-80ff-1897825fdead

account_surplus class-attribute instance-attribute

account_surplus: str | None = None

Surplus account identifier (GUID). Default 67af8bc9-628f-2124-2345-3750bb7db6fa

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

deleted class-attribute instance-attribute

deleted: bool | None = None

Flag indicating that the document is deleted

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

number class-attribute instance-attribute

number: str | None = None

Document number

processed class-attribute instance-attribute

processed: bool | None = None

Flag indicating that the document is processed

shortage_sum class-attribute instance-attribute

shortage_sum: Decimal | None = None

Shortage sum

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT

surplus_sum class-attribute instance-attribute

surplus_sum: Decimal | None = None

Surplus sum

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

IncomingInventorySaveResponse

Bases: IikoModel

IncomingInventorySaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

IncomingInventoryUpdateRequest

Bases: IikoModel

IncomingInventoryUpdateRequest.

account_shortage class-attribute instance-attribute

account_shortage: str | None = None

Shortage account identifier (GUID). Default 07926ff3-9319-b93e-80ff-1897825fdead

account_surplus class-attribute instance-attribute

account_surplus: str | None = None

Surplus account identifier (GUID). Default 67af8bc9-628f-2124-2345-3750bb7db6fa

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id instance-attribute

document_id: str

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

Main inventory items (second step / all products). Must contain at least one element

items_first_step instance-attribute

First step items (dishes, preparations, modifiers). Can be an empty array

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store instance-attribute

store: str

Inventory store identifier (GUID)

IncomingInvoice

Bases: IikoModel

IncomingInvoice.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

delivery_on_time class-attribute instance-attribute

delivery_on_time: bool | None = None

On-time delivery flag

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

employee_pass_to_account class-attribute instance-attribute

employee_pass_to_account: str | None = None

Charge to employee

incoming_date class-attribute instance-attribute

incoming_date: str | None = None

Incoming document date (YYYY-MM-DD)

incoming_document_number class-attribute instance-attribute

incoming_document_number: str | None = None

Incoming external document number

internal_outgoing_invoice_id class-attribute instance-attribute

internal_outgoing_invoice_id: str | None = None

Associated outgoing invoice identifier (GUID)

invoice class-attribute instance-attribute

invoice: str | None = None

Invoice number

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[IncomingInvoiceItem] | None = None

List of document items

matches_to_the_order class-attribute instance-attribute

matches_to_the_order: bool | None = None

Matches the order

number class-attribute instance-attribute

number: str | None = None

Document number

payment_date class-attribute instance-attribute

payment_date: str | None = None

Payment date (YYYY-MM-DD)

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

transport_invoice_number class-attribute instance-attribute

transport_invoice_number: str | None = None

Transport invoice number

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

IncomingInvoiceItem

Bases: IikoModel

IncomingInvoiceItem.

actual_amount class-attribute instance-attribute

actual_amount: Decimal | None = None

Actual quantity

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

customs_declaration_number class-attribute instance-attribute

customs_declaration_number: str | None = None

Customs declaration number

is_additional_expense class-attribute instance-attribute

is_additional_expense: bool | None = None

Is additional expense

num class-attribute instance-attribute

num: int | None = None

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

price_without_vat class-attribute instance-attribute

price_without_vat: Decimal | None = None

Price excluding VAT

producer class-attribute instance-attribute

producer: str | None = None

Manufacturer / importer

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_article class-attribute instance-attribute

product_article: str | None = None

Nomenclature article

store class-attribute instance-attribute

store: str | None = None

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

supplier_product class-attribute instance-attribute

supplier_product: str | None = None

Supplier product

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

IncomingInvoiceRequest

Bases: IikoModel

IncomingInvoiceRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent instance-attribute

counteragent: str

Counteragent identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

delivery_on_time class-attribute instance-attribute

delivery_on_time: bool | None = None

On-time delivery flag

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

employee_pass_to_account class-attribute instance-attribute

employee_pass_to_account: str | None = None

Charge to employee

incoming_date class-attribute instance-attribute

incoming_date: str | None = None

Incoming document date (YYYY-MM-DD)

incoming_document_number class-attribute instance-attribute

incoming_document_number: str | None = None

Incoming external document number

internal_outgoing_invoice_id class-attribute instance-attribute

internal_outgoing_invoice_id: str | None = None

Associated outgoing invoice identifier (GUID)

invoice class-attribute instance-attribute

invoice: str | None = None

Invoice number

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

transport_invoice_number class-attribute instance-attribute

transport_invoice_number: str | None = None

Transport invoice number

IncomingInvoiceRequestItem

Bases: IikoModel

IncomingInvoiceRequestItem.

actual_amount class-attribute instance-attribute

actual_amount: Decimal | None = None

Actual quantity

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

customs_declaration_number class-attribute instance-attribute

customs_declaration_number: str | None = None

Customs declaration number

is_additional_expense class-attribute instance-attribute

is_additional_expense: bool | None = None

Is additional expense

num instance-attribute

num: int

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

product instance-attribute

product: str

Product identifier (GUID)

store instance-attribute

store: str

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

supplier_product class-attribute instance-attribute

supplier_product: str | None = None

Supplier product

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

IncomingInvoiceSaveResponse

Bases: IikoModel

IncomingInvoiceSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

IncomingReturnedInvoiceCreateItem

Bases: IikoModel

IncomingReturnedInvoiceCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_factor class-attribute instance-attribute

amount_factor: Decimal | None = None

Write-off factor

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

customs_declaration_number class-attribute instance-attribute

customs_declaration_number: str | None = None

Customs declaration number

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount amount

income_price class-attribute instance-attribute

income_price: Decimal | None = None

Cost price at the time of return

income_sum class-attribute instance-attribute

income_sum: Decimal | None = None

Cost sum at the time of return

num instance-attribute

num: int

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

product instance-attribute

product: str

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

store instance-attribute

store: str

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

supplier_product class-attribute instance-attribute

supplier_product: str | None = None

Buyer's product

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

IncomingReturnedInvoiceCreateRequest

Bases: IikoModel

IncomingReturnedInvoiceCreateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent instance-attribute

counteragent: str

Counteragent identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

outgoing_invoice_id class-attribute instance-attribute

outgoing_invoice_id: str | None = None

Associated outgoing invoice identifier (GUID)

processing_mode instance-attribute

processing_mode: str

Processing mode (RETURN_DISH — return dish, RETURN_GOOD — return ingredients, DO_NOT_RETURN — no warehouse)

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

IncomingReturnedInvoiceGetItem

Bases: IikoModel

IncomingReturnedInvoiceGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_factor class-attribute instance-attribute

amount_factor: Decimal | None = None

Write-off factor

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

customs_declaration_number class-attribute instance-attribute

customs_declaration_number: str | None = None

Customs declaration number

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount amount

income_price class-attribute instance-attribute

income_price: Decimal | None = None

Cost price at the time of return

income_sum class-attribute instance-attribute

income_sum: Decimal | None = None

Cost sum at the time of return

num class-attribute instance-attribute

num: int | None = None

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

price_without_vat class-attribute instance-attribute

price_without_vat: Decimal | None = None

Price excluding VAT

producer class-attribute instance-attribute

producer: str | None = None

Manufacturer / importer

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_article class-attribute instance-attribute

product_article: str | None = None

Nomenclature article

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

store class-attribute instance-attribute

store: str | None = None

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

supplier_product class-attribute instance-attribute

supplier_product: str | None = None

Buyer's product

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

IncomingReturnedInvoiceGetResponse

Bases: IikoModel

IncomingReturnedInvoiceGetResponse.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[IncomingReturnedInvoiceGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

outgoing_invoice_id class-attribute instance-attribute

outgoing_invoice_id: str | None = None

Associated outgoing invoice identifier (GUID)

processing_mode class-attribute instance-attribute

processing_mode: str | None = None

Processing mode (RETURN_DISH — return dish, RETURN_GOOD — return ingredients, DO_NOT_RETURN — no warehouse)

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

IncomingReturnedInvoiceListItem

Bases: IikoModel

IncomingReturnedInvoiceListItem.

assigned_stores class-attribute instance-attribute

assigned_stores: list[str] | None = None

Receipt locations (UUID array)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

deleted class-attribute instance-attribute

deleted: bool | None = None

Flag indicating that the document is deleted

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

number class-attribute instance-attribute

number: str | None = None

Document number

processed class-attribute instance-attribute

processed: bool | None = None

Flag indicating that the document is processed

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

IncomingReturnedInvoiceSaveResponse

Bases: IikoModel

IncomingReturnedInvoiceSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

IncomingReturnedInvoiceUpdateRequest

Bases: IikoModel

IncomingReturnedInvoiceUpdateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent instance-attribute

counteragent: str

Counteragent identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

document_id instance-attribute

document_id: str

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

outgoing_invoice_id class-attribute instance-attribute

outgoing_invoice_id: str | None = None

Associated outgoing invoice identifier (GUID)

processing_mode instance-attribute

processing_mode: str

Processing mode (RETURN_DISH — return dish, RETURN_GOOD — return ingredients, DO_NOT_RETURN — no warehouse)

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

InternalTransferCreateItem

Bases: IikoModel

InternalTransferCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

num instance-attribute

num: int

Item sequence number

product instance-attribute

product: str

Product identifier (GUID)

InternalTransferCreateRequest

Bases: IikoModel

InternalTransferCreateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

InternalTransferGetItem

Bases: IikoModel

InternalTransferGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

num class-attribute instance-attribute

num: int | None = None

Item sequence number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

InternalTransferGetResponse

Bases: IikoModel

InternalTransferGetResponse.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[InternalTransferGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

store_to class-attribute instance-attribute

store_to: str | None = None

Receipt store identifier (GUID)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

InternalTransferListItem

Bases: IikoModel

InternalTransferListItem.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

deleted class-attribute instance-attribute

deleted: bool | None = None

Flag indicating that the document is deleted

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

number class-attribute instance-attribute

number: str | None = None

Document number

processed class-attribute instance-attribute

processed: bool | None = None

Flag indicating that the document is processed

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

store_to class-attribute instance-attribute

store_to: str | None = None

Receipt store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

InternalTransferSaveResponse

Bases: IikoModel

InternalTransferSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

InternalTransferUpdateRequest

Bases: IikoModel

InternalTransferUpdateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id instance-attribute

document_id: str

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

InventoryPaymentType

Bases: IikoModel

InventoryPaymentType.

code class-attribute instance-attribute

code: str | None = None

User-defined payment type code

id class-attribute instance-attribute

id: str | None = None

Payment type identifier (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating that the payment type is logically deleted

name class-attribute instance-attribute

name: str | None = None

Display name of the payment type

JurPerson

Bases: IikoModel

JurPerson.

children class-attribute instance-attribute

children: list[Organization] | None = None

Child organizations with the same recursive structure; an empty array is returned for a leaf node

code class-attribute instance-attribute

code: str | None = None

User-defined legal entity code; null if the code is not set

jur_person_id class-attribute instance-attribute

jur_person_id: str | None = None

Legal entity identifier

name class-attribute instance-attribute

name: str | None = None

Display name of the legal entity; null if the name is not provided by the source

type class-attribute instance-attribute

type: str | None = None

Legal entity type. Always takes the value JUR_PERSON

MeasureUnit

Bases: IikoModel

MeasureUnit.

code class-attribute instance-attribute

code: str | None = None

User-defined measure unit code

full_name class-attribute instance-attribute

full_name: str | None = None

Full name of the measure unit (e.g. kilogram)

id class-attribute instance-attribute

id: str | None = None

Measure unit identifier (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating that the measure unit is logically deleted

name class-attribute instance-attribute

name: str | None = None

Short display name of the measure unit (e.g. kg)

MeasureUnitGetByIDRequest

Bases: IikoModel

MeasureUnitGetByIDRequest.

id class-attribute instance-attribute

id: str | None = None

Entity identifier (UUID)

MeasureUnitListRequest

Bases: IikoModel

MeasureUnitListRequest.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Filter by deletion status; omit to return all records

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records (0 = no limit)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip

revision class-attribute instance-attribute

revision: int | None = None

Return only records with revision >= this value

MeasureUnitListResponse

Bases: IikoModel

MeasureUnitListResponse.

entities class-attribute instance-attribute

entities: list[MeasureUnit] | None = None

List of entities

limit class-attribute instance-attribute

limit: int | None = None

Limit value from the request

offset class-attribute instance-attribute

offset: int | None = None

Offset value from the request

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the filter

Organization

Bases: IikoModel

Organization.

children class-attribute instance-attribute

children: list[Organization] | None = None

Child organizations with the same recursive structure; an empty array is returned for a leaf node

code class-attribute instance-attribute

code: str | None = None

User-defined organization code; null if the code is not set

crm_id class-attribute instance-attribute

crm_id: int | None = None

Numeric organization identifier in CRM

iiko_uid class-attribute instance-attribute

iiko_uid: str | None = None

Organization identifier; null if not provided by the source

is_cloud class-attribute instance-attribute

is_cloud: bool | None = None

Flag indicating that the organization runs on cloud infrastructure

name class-attribute instance-attribute

name: str | None = None

Display name of the organization; null if the name is not provided by the source

organization_id class-attribute instance-attribute

organization_id: str | None = None

UOC organization identifier

parent_id class-attribute instance-attribute

parent_id: str | None = None

UOC identifier of the parent organization; null for the root node

rating class-attribute instance-attribute

rating: Decimal | None = None

Organization rating as represented by the source; null if the rating is absent

type class-attribute instance-attribute

type: str | None = None

Organization type. Confirmed values: Chain — a chain, Rms — an organization

version class-attribute instance-attribute

version: str | None = None

internal API server version of the organization; null if the version is unknown

OrganizationRequest

Bases: IikoModel

OrganizationRequest.

OutgoingInvoice

Bases: IikoModel

OutgoingInvoice.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

internal_incoming_invoice_id class-attribute instance-attribute

internal_incoming_invoice_id: str | None = None

Associated incoming invoice identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[OutgoingInvoiceItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

payment_date class-attribute instance-attribute

payment_date: str | None = None

Payment date (YYYY-MM-DD)

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

OutgoingInvoiceItem

Bases: IikoModel

OutgoingInvoiceItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_factor class-attribute instance-attribute

amount_factor: Decimal | None = None

Write-off factor

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount amount

num class-attribute instance-attribute

num: int | None = None

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

price_without_vat class-attribute instance-attribute

price_without_vat: Decimal | None = None

Price excluding VAT

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_article class-attribute instance-attribute

product_article: str | None = None

Nomenclature article

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

store class-attribute instance-attribute

store: str | None = None

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

OutgoingInvoiceRequest

Bases: IikoModel

OutgoingInvoiceRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent instance-attribute

counteragent: str

Counteragent identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

internal_incoming_invoice_id class-attribute instance-attribute

internal_incoming_invoice_id: str | None = None

Associated incoming invoice identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

OutgoingInvoiceRequestItem

Bases: IikoModel

OutgoingInvoiceRequestItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount amount

num instance-attribute

num: int

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

product instance-attribute

product: str

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

store instance-attribute

store: str

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

OutgoingInvoiceSaveResponse

Bases: IikoModel

OutgoingInvoiceSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

PayOutgoingInvoiceRequest

Bases: IikoModel

PayOutgoingInvoiceRequest.

account_id instance-attribute

account_id: str

Account identifier (GUID)

amount instance-attribute

amount: Decimal

Payment amount

cfo_item_id class-attribute instance-attribute

cfo_item_id: str | None = None

Cash flow item identifier (GUID)

document_id instance-attribute

document_id: str

Outgoing invoice identifier (GUID)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

payment_date instance-attribute

payment_date: str

Payment date (ISO 8601, e.g. 2026-08-15T12:00:00.00+00:00)

PayRequest

Bases: IikoModel

PayRequest.

account_id instance-attribute

account_id: str

Account identifier (GUID)

amount instance-attribute

amount: Decimal

Payment amount

cfo_item_id class-attribute instance-attribute

cfo_item_id: str | None = None

Cash flow item identifier (GUID)

document_id instance-attribute

document_id: str

Incoming invoice identifier (GUID)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

payment_date instance-attribute

payment_date: str

Payment date (ISO 8601, e.g. 2026-08-15T12:00:00.00+00:00)

PaymentTypeGetByIDRequest

Bases: IikoModel

PaymentTypeGetByIDRequest.

id class-attribute instance-attribute

id: str | None = None

Entity identifier (UUID)

PaymentTypeListRequest

Bases: IikoModel

PaymentTypeListRequest.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Filter by deletion status; omit to return all records

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records (0 = no limit)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip

revision class-attribute instance-attribute

revision: int | None = None

Return only records with revision >= this value

PaymentTypeListResponse

Bases: IikoModel

PaymentTypeListResponse.

entities class-attribute instance-attribute

entities: list[InventoryPaymentType] | None = None

List of entities

limit class-attribute instance-attribute

limit: int | None = None

Limit value from the request

offset class-attribute instance-attribute

offset: int | None = None

Offset value from the request

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the filter

PriceItem

Bases: IikoModel

PriceItem.

amount_factor instance-attribute

amount_factor: Decimal

Quantity factor

product_id instance-attribute

product_id: str

Product identifier (GUID)

store_id instance-attribute

store_id: str

Store identifier (GUID)

PriceListItem

Bases: IikoModel

PriceListItem.

allowable_price_deviation class-attribute instance-attribute

allowable_price_deviation: Decimal | None = None

Allowable price deviation

container_id class-attribute instance-attribute

container_id: str | None = None

Container/packaging identifier (GUID)

native_product_code class-attribute instance-attribute

native_product_code: str | None = None

Our product code

native_product_id class-attribute instance-attribute

native_product_id: str | None = None

Our product identifier (GUID) matched to the supplier product

native_product_name class-attribute instance-attribute

native_product_name: str | None = None

Our product name

native_product_num class-attribute instance-attribute

native_product_num: str | None = None

Our product article/number

price class-attribute instance-attribute

price: Decimal | None = None

Purchase price

supplier_product_code class-attribute instance-attribute

supplier_product_code: str | None = None

Supplier product code

supplier_product_id class-attribute instance-attribute

supplier_product_id: str | None = None

Supplier product identifier (GUID)

supplier_product_name class-attribute instance-attribute

supplier_product_name: str | None = None

Supplier product name

supplier_product_num class-attribute instance-attribute

supplier_product_num: str | None = None

Supplier product article/number

ProductionDocumentCreateItem

Bases: IikoModel

ProductionDocumentCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

num instance-attribute

num: int

Item sequence number

product instance-attribute

product: str

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

ProductionDocumentCreateRequest

Bases: IikoModel

ProductionDocumentCreateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

ProductionDocumentGetItem

Bases: IikoModel

ProductionDocumentGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_factor class-attribute instance-attribute

amount_factor: Decimal | None = None

Write-off factor

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

num class-attribute instance-attribute

num: int | None = None

Item sequence number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

ProductionDocumentGetResponse

Bases: IikoModel

ProductionDocumentGetResponse.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[ProductionDocumentGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

store_to class-attribute instance-attribute

store_to: str | None = None

Receipt store identifier (GUID)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

ProductionDocumentListItem

Bases: IikoModel

ProductionDocumentListItem.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

deleted class-attribute instance-attribute

deleted: bool | None = None

Flag indicating that the document is deleted

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

number class-attribute instance-attribute

number: str | None = None

Document number

processed class-attribute instance-attribute

processed: bool | None = None

Flag indicating that the document is processed

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

store_to class-attribute instance-attribute

store_to: str | None = None

Receipt store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

ProductionDocumentSaveResponse

Bases: IikoModel

ProductionDocumentSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

ProductionDocumentUpdateRequest

Bases: IikoModel

ProductionDocumentUpdateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id instance-attribute

document_id: str

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

ReturnedInvoiceCreateItem

Bases: IikoModel

ReturnedInvoiceCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

customs_declaration_number class-attribute instance-attribute

customs_declaration_number: str | None = None

Customs declaration number

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount amount

num instance-attribute

num: int

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

product instance-attribute

product: str

Product identifier (GUID)

store instance-attribute

store: str

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

supplier_product class-attribute instance-attribute

supplier_product: str | None = None

Supplier product

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

ReturnedInvoiceCreateRequest

Bases: IikoModel

ReturnedInvoiceCreateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent instance-attribute

counteragent: str

Counteragent identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

incoming_invoice_id class-attribute instance-attribute

incoming_invoice_id: str | None = None

Associated incoming invoice identifier (GUID)

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

ReturnedInvoiceGetItem

Bases: IikoModel

ReturnedInvoiceGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

customs_declaration_number class-attribute instance-attribute

customs_declaration_number: str | None = None

Customs declaration number

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount amount

num class-attribute instance-attribute

num: int | None = None

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

price_without_vat class-attribute instance-attribute

price_without_vat: Decimal | None = None

Price excluding VAT

producer class-attribute instance-attribute

producer: str | None = None

Manufacturer / importer

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_article class-attribute instance-attribute

product_article: str | None = None

Nomenclature article

store class-attribute instance-attribute

store: str | None = None

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

supplier_product class-attribute instance-attribute

supplier_product: str | None = None

Supplier product

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

ReturnedInvoiceGetResponse

Bases: IikoModel

ReturnedInvoiceGetResponse.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

incoming_invoice_id class-attribute instance-attribute

incoming_invoice_id: str | None = None

Associated incoming invoice identifier (GUID)

items class-attribute instance-attribute

items: list[ReturnedInvoiceGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

ReturnedInvoiceListItem

Bases: IikoModel

ReturnedInvoiceListItem.

assigned_stores class-attribute instance-attribute

assigned_stores: list[str] | None = None

Write-off locations (UUID array)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

deleted class-attribute instance-attribute

deleted: bool | None = None

Flag indicating that the document is deleted

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

number class-attribute instance-attribute

number: str | None = None

Document number

processed class-attribute instance-attribute

processed: bool | None = None

Flag indicating that the document is processed

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

sum_without_vat class-attribute instance-attribute

sum_without_vat: Decimal | None = None

Amount excluding VAT

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

ReturnedInvoiceSaveResponse

Bases: IikoModel

ReturnedInvoiceSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

ReturnedInvoiceUpdateRequest

Bases: IikoModel

ReturnedInvoiceUpdateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

counteragent instance-attribute

counteragent: str

Counteragent identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

document_id instance-attribute

document_id: str

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

incoming_invoice_id class-attribute instance-attribute

incoming_invoice_id: str | None = None

Associated incoming invoice identifier (GUID)

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

SalesDocumentCreateItem

Bases: IikoModel

SalesDocumentCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount amount

num instance-attribute

num: int

Item sequence number

price class-attribute instance-attribute

price: Decimal | None = None

Price including VAT. Required if sum is not specified

product instance-attribute

product: str

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

store class-attribute instance-attribute

store: str | None = None

Store identifier (GUID)

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

vat_percent class-attribute instance-attribute

vat_percent: Decimal | None = None

VAT percentage

SalesDocumentCreateRequest

Bases: IikoModel

SalesDocumentCreateRequest.

banquet class-attribute instance-attribute

banquet: bool | None = None

Banquet order flag. Default false. Optional

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

SalesDocumentGetItem

Bases: IikoModel

SalesDocumentGetItem.

SalesDocumentGetResponse

Bases: IikoModel

SalesDocumentGetResponse.

SalesDocumentListItem

Bases: IikoModel

SalesDocumentListItem.

SalesDocumentSaveResponse

Bases: IikoModel

SalesDocumentSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

SalesDocumentUpdateRequest

Bases: IikoModel

SalesDocumentUpdateRequest.

banquet class-attribute instance-attribute

banquet: bool | None = None

Banquet order flag. Default false. Optional

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

default_store class-attribute instance-attribute

default_store: str | None = None

Default store identifier (GUID)

document_id instance-attribute

document_id: str

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

SetPaymentDateOutgoingRequest

Bases: IikoModel

SetPaymentDateOutgoingRequest.

document_id instance-attribute

document_id: str

Incoming invoice identifier (GUID)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

payment_date instance-attribute

payment_date: str

Payment date (ISO 8601, e.g. 2026-08-15T12:00:00.00+00:00)

SetPaymentDateOutgoingResponse

Bases: IikoModel

SetPaymentDateOutgoingResponse.

message class-attribute instance-attribute

message: str | None = None

Operation result message

SetPaymentDateRequest

Bases: IikoModel

SetPaymentDateRequest.

document_id instance-attribute

document_id: str

Incoming invoice identifier (GUID)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

payment_date instance-attribute

payment_date: str

Payment date (ISO 8601, e.g. 2026-08-15T12:00:00.00+00:00)

SetPaymentDateResponse

Bases: IikoModel

SetPaymentDateResponse.

message class-attribute instance-attribute

message: str | None = None

Operation result message

StockBalanceDetails

Bases: IikoModel

StockBalanceDetails.

amount_unit_id class-attribute instance-attribute

amount_unit_id: str | None = None

Main product unit identifier (GUID)

amount_unit_name class-attribute instance-attribute

amount_unit_name: str | None = None

Main product unit name

maximum_quantity class-attribute instance-attribute

maximum_quantity: Decimal | None = None

Effective maximum quantity level for the store (v1: always 0)

minimum_quantity class-attribute instance-attribute

minimum_quantity: Decimal | None = None

Effective minimum quantity level for the store (v1: always 0)

parent_group_id class-attribute instance-attribute

parent_group_id: str | None = None

Immediate parent group identifier (GUID); null if no group is set

parent_group_name class-attribute instance-attribute

parent_group_name: str | None = None

Immediate parent group name; null if no group is set

product_name class-attribute instance-attribute

product_name: str | None = None

Current product name

store_display_name class-attribute instance-attribute

store_display_name: str | None = None

Display name in the form storeParentName: storeName

store_name class-attribute instance-attribute

store_name: str | None = None

Current store name

store_parent_id class-attribute instance-attribute

store_parent_id: str | None = None

Structural parent of the store (organization identifier in v1)

store_parent_name class-attribute instance-attribute

store_parent_name: str | None = None

Name of the structural parent of the store (organization name in v1)

StockBalanceItem

Bases: IikoModel

StockBalanceItem.

cost_sum class-attribute instance-attribute

cost_sum: Decimal | None = None

Cost sum in the organization currency

details class-attribute instance-attribute

details: StockBalanceDetails | None = None

Current reference details of the row; null when shouldIncludeDetails is false

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization identifier (GUID)

product_id class-attribute instance-attribute

product_id: str | None = None

Product identifier (GUID)

quantity class-attribute instance-attribute

quantity: Decimal | None = None

Quantity in the main unit of the product

store_id class-attribute instance-attribute

store_id: str | None = None

Store identifier (GUID)

StockBalanceListRequest

Bases: IikoModel

StockBalanceListRequest.

balance_at instance-attribute

balance_at: str

Balance calculation moment in RFC 3339 format; timezone offset is optional (UTC when absent); returned unchanged in the response

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of rows in the page, from 1 to 1000; default 50

offset class-attribute instance-attribute

offset: int | None = None

Number of rows to skip; non-negative; default 0

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization identifier (GUID)

product_group_ids class-attribute instance-attribute

product_group_ids: list[str] | None = None

Product group identifiers (GUID); products of these groups are included recursively with subgroups. Non-empty unique array of up to 1000 items

product_ids class-attribute instance-attribute

product_ids: list[str] | None = None

Product identifiers (GUID); if absent — all products with non-zero balances. Non-empty unique array of up to 1000 items

should_include_details class-attribute instance-attribute

should_include_details: bool | None = None

Flag to include current reference details for the response rows; default false

store_ids class-attribute instance-attribute

store_ids: list[str] | None = None

Store identifiers (GUID); if absent — all organization stores. Non-empty unique array of up to 1000 items

StockBalanceListResponse

Bases: IikoModel

StockBalanceListResponse.

balance_at class-attribute instance-attribute

balance_at: str | None = None

Balance calculation moment echoed from the request without changes

currency_code class-attribute instance-attribute

currency_code: str | None = None

Organization currency code (ISO 4217 alpha-3)

generated_at class-attribute instance-attribute

generated_at: str | None = None

Response generation time in RFC 3339 UTC format

items class-attribute instance-attribute

items: list[StockBalanceItem] | None = None

Rows of non-zero balances

limit class-attribute instance-attribute

limit: int | None = None

Limit value from the request

offset class-attribute instance-attribute

offset: int | None = None

Offset value from the request

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization identifier (GUID) echoed from the request

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of rows before pagination

Store

Bases: IikoModel

Store.

address class-attribute instance-attribute

address: str | None = None

Store address; null if the address is not filled in

code class-attribute instance-attribute

code: str | None = None

User-defined store code

custom_transactions_allowed class-attribute instance-attribute

custom_transactions_allowed: bool | None = None

Flag indicating whether custom transactions can be created on the associated store account

deleted class-attribute instance-attribute

deleted: bool | None = None

Flag indicating that the store is logically deleted

description class-attribute instance-attribute

description: str | None = None

Text description of the store; null if the description is not filled in

external_store_guid class-attribute instance-attribute

external_store_guid: str | None = None

GUID of the supplier store from which internal API server automatically creates an internal transfer when posting a sales act; null if the supplier store is not configured

gln class-attribute instance-attribute

gln: str | None = None

Global Location Number (GLN) of the store; null if the number is not set

id class-attribute instance-attribute

id: str | None = None

Store identifier

modified_at class-attribute instance-attribute

modified_at: str | None = None

Date and time of the last modification in ISO 8601 format with time zone; null if unknown

name class-attribute instance-attribute

name: str | None = None

Display name of the store

organization_id class-attribute instance-attribute

organization_id: str | None = None

Identifier of the parent store entity in the NPE hierarchy; null if no link is set

parent class-attribute instance-attribute

parent: str | None = None

Identifier of the parent store entity; null if no parent is set

representative_supplier class-attribute instance-attribute

representative_supplier: str | None = None

Store's representative supplier: outgoing invoices in its name automatically create incoming invoices for this store; null if not configured

revision class-attribute instance-attribute

revision: int | None = None

Store revision number

system_account class-attribute instance-attribute

system_account: bool | None = None

Flag indicating that the account associated with the store is a system account

type class-attribute instance-attribute

type: str | None = None

Store entity type

StoreListResponse

Bases: IikoModel

StoreListResponse.

StoresListRequest

Bases: IikoModel

StoresListRequest.

filters class-attribute instance-attribute

filters: list[FilterCondition] | None = None

Filter conditions (AND-combined)

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records (0 = no limit)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip

TransformationDocumentCreateItem

Bases: IikoModel

TransformationDocumentCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

num instance-attribute

num: int

Item sequence number

product instance-attribute

product: str

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

TransformationDocumentCreateRequest

Bases: IikoModel

TransformationDocumentCreateRequest.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit instance-attribute

amount_unit: str

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

product instance-attribute

product: str

Product identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

TransformationDocumentGetItem

Bases: IikoModel

TransformationDocumentGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_factor class-attribute instance-attribute

amount_factor: Decimal | None = None

Write-off factor

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

num class-attribute instance-attribute

num: int | None = None

Item sequence number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

TransformationDocumentGetResponse

Bases: IikoModel

TransformationDocumentGetResponse.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[TransformationDocumentGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

store_to class-attribute instance-attribute

store_to: str | None = None

Receipt store identifier (GUID)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

TransformationDocumentListItem

Bases: IikoModel

TransformationDocumentListItem.

TransformationDocumentSaveResponse

Bases: IikoModel

TransformationDocumentSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

TransformationDocumentUpdateRequest

Bases: IikoModel

TransformationDocumentUpdateRequest.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit instance-attribute

amount_unit: str

Unit of measure identifier (GUID)

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id instance-attribute

document_id: str

Document identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

product instance-attribute

product: str

Product identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

store_to instance-attribute

store_to: str

Receipt store identifier (GUID)

WriteoffDocumentCreateItem

Bases: IikoModel

WriteoffDocumentCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

num instance-attribute

num: int

Item sequence number

product instance-attribute

product: str

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

WriteoffDocumentCreateRequest

Bases: IikoModel

WriteoffDocumentCreateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

expense_account instance-attribute

expense_account: str

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)

WriteoffDocumentGetItem

Bases: IikoModel

WriteoffDocumentGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

amount_factor class-attribute instance-attribute

amount_factor: Decimal | None = None

Write-off factor

amount_unit class-attribute instance-attribute

amount_unit: str | None = None

Unit of measure identifier (GUID)

container_id class-attribute instance-attribute

container_id: str | None = None

Container identifier (GUID)

num class-attribute instance-attribute

num: int | None = None

Item sequence number

product class-attribute instance-attribute

product: str | None = None

Product identifier (GUID)

product_size class-attribute instance-attribute

product_size: str | None = None

Product size identifier (GUID)

WriteoffDocumentGetResponse

Bases: IikoModel

WriteoffDocumentGetResponse.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date class-attribute instance-attribute

date: str | None = None

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

Document creation date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

date_modified class-attribute instance-attribute

date_modified: str | None = None

Document last modification date (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

expense_account class-attribute instance-attribute

expense_account: str | None = None

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items class-attribute instance-attribute

items: list[WriteoffDocumentGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

status class-attribute instance-attribute

status: str | None = None

Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)

store_from class-attribute instance-attribute

store_from: str | None = None

Write-off store identifier (GUID)

user_created class-attribute instance-attribute

user_created: str | None = None

User who created the document (GUID)

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the document (GUID)

WriteoffDocumentListItem

Bases: IikoModel

WriteoffDocumentListItem.

WriteoffDocumentSaveResponse

Bases: IikoModel

WriteoffDocumentSaveResponse.

document_id class-attribute instance-attribute

document_id: str | None = None

Document identifier (GUID)

document_number class-attribute instance-attribute

document_number: str | None = None

Document number

message class-attribute instance-attribute

message: str | None = None

Operation result message

WriteoffDocumentUpdateRequest

Bases: IikoModel

WriteoffDocumentUpdateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

date instance-attribute

date: str

Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)

document_id instance-attribute

document_id: str

Document identifier (GUID)

expense_account instance-attribute

expense_account: str

Expense account identifier (GUID)

is_automatic class-attribute instance-attribute

is_automatic: bool | None = None

Automatic document creation flag

is_editable class-attribute instance-attribute

is_editable: bool | None = None

Editable flag. true — available for editing

items instance-attribute

List of document items

number instance-attribute

number: str

Document number

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

store_from instance-attribute

store_from: str

Write-off store identifier (GUID)