Inventory models¶
Models of the inventory endpoints.
Generated by python -m codegen from the iikoCloud OpenAPI specification. Do not edit by hand.
AccountingCategory
¶
AccountingCategoryGetByIDRequest
¶
AccountingCategoryListRequest
¶
AccountingCategoryListResponse
¶
Bases: IikoModel
AccountingCategoryListResponse.
entities
class-attribute
instance-attribute
¶
entities: list[AccountingCategory] | None = None
List of entities
AccountingTransactionUserResponse
¶
Conception
¶
ConceptionGetByIDRequest
¶
ConceptionListRequest
¶
ConceptionListResponse
¶
Bases: IikoModel
ConceptionListResponse.
entities
class-attribute
instance-attribute
¶
entities: list[Conception] | None = None
List of entities
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
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
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)
DisassembleDocumentCreateRequest
¶
DisassembleDocumentGetItem
¶
DisassembleDocumentGetResponse
¶
Bases: IikoModel
DisassembleDocumentGetResponse.
amount_unit
class-attribute
instance-attribute
¶
amount_unit: str | None = None
Unit of measure identifier (GUID)
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
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)
DisassembleDocumentSaveResponse
¶
DisassembleDocumentUpdateRequest
¶
GetCostPricesRequest
¶
GetCostPricesResponse
¶
GetCounteragentsRequest
¶
GetCounteragentsResponse
¶
GetPriceListRequest
¶
GetPriceListResponse
¶
Bases: IikoModel
GetPriceListResponse.
items
class-attribute
instance-attribute
¶
items: list[PriceListItem] | None = None
List of supplier price list items
IncomingInventoryCreateFirstStepItem
¶
IncomingInventoryCreateItem
¶
Bases: IikoModel
IncomingInventoryCreateItem.
amount_unit
class-attribute
instance-attribute
¶
amount_unit: str | None = None
Unit of measure identifier (GUID)
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)
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
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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
¶
items: list[IncomingInventoryCreateItem]
Main inventory items (second step / all products). Must contain at least one element
items_first_step
instance-attribute
¶
items_first_step: list[IncomingInventoryCreateFirstStepItem]
First step items (dishes, preparations, modifiers). Can be an empty array
IncomingInventoryGetFirstItem
¶
IncomingInventoryGetItem
¶
Bases: IikoModel
IncomingInventoryGetItem.
amount_unit
class-attribute
instance-attribute
¶
amount_unit: str | None = None
Unit of measure identifier (GUID)
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
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
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
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
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)
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
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
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)
IncomingInventorySaveResponse
¶
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
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept 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
¶
items: list[IncomingInventoryCreateItem]
Main inventory items (second step / all products). Must contain at least one element
items_first_step
instance-attribute
¶
items_first_step: list[IncomingInventoryCreateFirstStepItem]
First step items (dishes, preparations, modifiers). Can be an empty array
IncomingInvoice
¶
Bases: IikoModel
IncomingInvoice.
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)
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)
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
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
IncomingInvoiceItem
¶
Bases: IikoModel
IncomingInvoiceItem.
actual_amount
class-attribute
instance-attribute
¶
actual_amount: Decimal | None = None
Actual 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
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_article
class-attribute
instance-attribute
¶
product_article: str | None = None
Nomenclature article
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
IncomingInvoiceRequest
¶
Bases: IikoModel
IncomingInvoiceRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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)
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)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag
IncomingInvoiceRequestItem
¶
Bases: IikoModel
IncomingInvoiceRequestItem.
actual_amount
class-attribute
instance-attribute
¶
actual_amount: Decimal | None = None
Actual 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
price
class-attribute
instance-attribute
¶
price: Decimal | None = None
Price including VAT. Required if sum is not specified
sum
class-attribute
instance-attribute
¶
sum: Decimal | None = None
Amount including VAT. Required if price is not specified
IncomingInvoiceSaveResponse
¶
IncomingReturnedInvoiceCreateItem
¶
Bases: IikoModel
IncomingReturnedInvoiceCreateItem.
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
price
class-attribute
instance-attribute
¶
price: Decimal | None = None
Price including VAT. Required if sum is not specified
product_size
class-attribute
instance-attribute
¶
product_size: str | None = None
Product size identifier (GUID)
sum
class-attribute
instance-attribute
¶
sum: Decimal | None = None
Amount including VAT. Required if price is not specified
IncomingReturnedInvoiceCreateRequest
¶
Bases: IikoModel
IncomingReturnedInvoiceCreateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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
outgoing_invoice_id
class-attribute
instance-attribute
¶
outgoing_invoice_id: str | None = None
Associated outgoing invoice identifier (GUID)
IncomingReturnedInvoiceGetItem
¶
Bases: IikoModel
IncomingReturnedInvoiceGetItem.
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
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_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)
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
IncomingReturnedInvoiceGetResponse
¶
Bases: IikoModel
IncomingReturnedInvoiceGetResponse.
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
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)
IncomingReturnedInvoiceListItem
¶
Bases: IikoModel
IncomingReturnedInvoiceListItem.
assigned_stores
class-attribute
instance-attribute
¶
Receipt locations (UUID array)
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
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_without_vat
class-attribute
instance-attribute
¶
sum_without_vat: Decimal | None = None
Amount excluding VAT
IncomingReturnedInvoiceSaveResponse
¶
IncomingReturnedInvoiceUpdateRequest
¶
Bases: IikoModel
IncomingReturnedInvoiceUpdateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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
outgoing_invoice_id
class-attribute
instance-attribute
¶
outgoing_invoice_id: str | None = None
Associated outgoing invoice identifier (GUID)
InternalTransferCreateItem
¶
InternalTransferCreateRequest
¶
Bases: IikoModel
InternalTransferCreateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag
InternalTransferGetItem
¶
InternalTransferGetResponse
¶
Bases: IikoModel
InternalTransferGetResponse.
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
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)
InternalTransferListItem
¶
Bases: IikoModel
InternalTransferListItem.
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
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
InternalTransferSaveResponse
¶
InternalTransferUpdateRequest
¶
Bases: IikoModel
InternalTransferUpdateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag
InventoryPaymentType
¶
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
MeasureUnit
¶
MeasureUnitGetByIDRequest
¶
MeasureUnitListRequest
¶
MeasureUnitListResponse
¶
Bases: IikoModel
MeasureUnitListResponse.
entities
class-attribute
instance-attribute
¶
entities: list[MeasureUnit] | None = None
List of entities
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
OutgoingInvoice
¶
Bases: IikoModel
OutgoingInvoice.
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)
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
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)
OutgoingInvoiceItem
¶
Bases: IikoModel
OutgoingInvoiceItem.
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
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_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)
sum
class-attribute
instance-attribute
¶
sum: Decimal | None = None
Amount including VAT. Required if price is not specified
OutgoingInvoiceRequest
¶
Bases: IikoModel
OutgoingInvoiceRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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)
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
OutgoingInvoiceRequestItem
¶
Bases: IikoModel
OutgoingInvoiceRequestItem.
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
price
class-attribute
instance-attribute
¶
price: Decimal | None = None
Price including VAT. Required if sum is not specified
product_size
class-attribute
instance-attribute
¶
product_size: str | None = None
Product size identifier (GUID)
OutgoingInvoiceSaveResponse
¶
PayOutgoingInvoiceRequest
¶
PayRequest
¶
PaymentTypeGetByIDRequest
¶
PaymentTypeListRequest
¶
PaymentTypeListResponse
¶
Bases: IikoModel
PaymentTypeListResponse.
entities
class-attribute
instance-attribute
¶
entities: list[InventoryPaymentType] | None = None
List of entities
PriceItem
¶
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
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)
ProductionDocumentCreateItem
¶
ProductionDocumentCreateRequest
¶
Bases: IikoModel
ProductionDocumentCreateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag
ProductionDocumentGetItem
¶
Bases: IikoModel
ProductionDocumentGetItem.
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)
ProductionDocumentGetResponse
¶
Bases: IikoModel
ProductionDocumentGetResponse.
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
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)
ProductionDocumentListItem
¶
Bases: IikoModel
ProductionDocumentListItem.
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
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
ProductionDocumentSaveResponse
¶
ProductionDocumentUpdateRequest
¶
Bases: IikoModel
ProductionDocumentUpdateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag
ReturnedInvoiceCreateItem
¶
Bases: IikoModel
ReturnedInvoiceCreateItem.
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
price
class-attribute
instance-attribute
¶
price: Decimal | None = None
Price including VAT. Required if sum is not specified
sum
class-attribute
instance-attribute
¶
sum: Decimal | None = None
Amount including VAT. Required if price is not specified
ReturnedInvoiceCreateRequest
¶
Bases: IikoModel
ReturnedInvoiceCreateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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)
ReturnedInvoiceGetItem
¶
Bases: IikoModel
ReturnedInvoiceGetItem.
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
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_article
class-attribute
instance-attribute
¶
product_article: str | None = None
Nomenclature article
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
ReturnedInvoiceGetResponse
¶
Bases: IikoModel
ReturnedInvoiceGetResponse.
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
status
class-attribute
instance-attribute
¶
status: str | None = None
Document status (NEW — not processed, PROCESSED — processed, DELETED — deleted)
ReturnedInvoiceListItem
¶
Bases: IikoModel
ReturnedInvoiceListItem.
assigned_stores
class-attribute
instance-attribute
¶
Write-off locations (UUID array)
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
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
ReturnedInvoiceSaveResponse
¶
ReturnedInvoiceUpdateRequest
¶
Bases: IikoModel
ReturnedInvoiceUpdateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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)
SalesDocumentCreateItem
¶
Bases: IikoModel
SalesDocumentCreateItem.
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
price
class-attribute
instance-attribute
¶
price: Decimal | None = None
Price including VAT. Required if sum is not specified
product_size
class-attribute
instance-attribute
¶
product_size: str | None = None
Product size identifier (GUID)
SalesDocumentCreateRequest
¶
Bases: IikoModel
SalesDocumentCreateRequest.
banquet
class-attribute
instance-attribute
¶
banquet: bool | None = None
Banquet order flag. Default false. Optional
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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
SalesDocumentSaveResponse
¶
SalesDocumentUpdateRequest
¶
Bases: IikoModel
SalesDocumentUpdateRequest.
banquet
class-attribute
instance-attribute
¶
banquet: bool | None = None
Banquet order flag. Default false. Optional
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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
SetPaymentDateOutgoingResponse
¶
SetPaymentDateResponse
¶
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
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)
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 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 identifiers (GUID); if absent — all products with non-zero balances. 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
Store
¶
Bases: IikoModel
Store.
address
class-attribute
instance-attribute
¶
address: str | None = None
Store address; null if the address is not filled in
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
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
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
StoresListRequest
¶
TransformationDocumentCreateItem
¶
TransformationDocumentCreateRequest
¶
Bases: IikoModel
TransformationDocumentCreateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag
TransformationDocumentGetItem
¶
TransformationDocumentGetResponse
¶
Bases: IikoModel
TransformationDocumentGetResponse.
amount_unit
class-attribute
instance-attribute
¶
amount_unit: str | None = None
Unit of measure identifier (GUID)
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
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)
TransformationDocumentSaveResponse
¶
TransformationDocumentUpdateRequest
¶
Bases: IikoModel
TransformationDocumentUpdateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag
WriteoffDocumentCreateItem
¶
WriteoffDocumentCreateRequest
¶
Bases: IikoModel
WriteoffDocumentCreateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
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
WriteoffDocumentGetItem
¶
Bases: IikoModel
WriteoffDocumentGetItem.
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)
WriteoffDocumentGetResponse
¶
Bases: IikoModel
WriteoffDocumentGetResponse.
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
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)
WriteoffDocumentSaveResponse
¶
WriteoffDocumentUpdateRequest
¶
Bases: IikoModel
WriteoffDocumentUpdateRequest.
conception
class-attribute
instance-attribute
¶
conception: str | None = None
Concept identifier (GUID)
is_automatic
class-attribute
instance-attribute
¶
is_automatic: bool | None = None
Automatic document creation flag