Finance models

Models of the finance endpoints.

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

Account

Bases: IikoModel

Account.

code class-attribute instance-attribute

code: str | None = None

Account code

created_at class-attribute instance-attribute

created_at: str | None = None

Creation date and time

deleted_at class-attribute instance-attribute

deleted_at: str | None = None

Deletion date and time

description class-attribute instance-attribute

description: str | None = None

Account description

id class-attribute instance-attribute

id: str | None = None

Account UUID. string (UUID)

is_custom_transactions_allowed class-attribute instance-attribute

is_custom_transactions_allowed: bool | None = None

Whether custom transactions are allowed for the account

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

is_system_account class-attribute instance-attribute

is_system_account: bool | None = None

Whether the account is a system account

modified_at class-attribute instance-attribute

modified_at: str | None = None

Last modification date and time

name class-attribute instance-attribute

name: str | None = None

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent account UUID

revision class-attribute instance-attribute

revision: int | None = None

Revision

start_balance_date class-attribute instance-attribute

start_balance_date: str | None = None

Start balance date (YYYY-MM-DD format)

start_balance_sum class-attribute instance-attribute

start_balance_sum: Decimal | None = None

Start balance amount

type class-attribute instance-attribute

type: str | None = None

Account type code

AccountCreateRequest

Bases: IikoModel

AccountCreateRequest.

code class-attribute instance-attribute

code: str | None = None

Account code

description instance-attribute

description: str

Account description

is_custom_transactions_allowed class-attribute instance-attribute

is_custom_transactions_allowed: bool | None = None

Whether custom transactions are allowed for the account

name instance-attribute

name: str

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent account UUID

start_balance_date instance-attribute

start_balance_date: str

Start balance date (YYYY-MM-DD format)

start_balance_sum instance-attribute

start_balance_sum: Decimal

Start balance amount

type instance-attribute

type: str

Account type code

AccountDeleteRequest

Bases: IikoModel

AccountDeleteRequest.

id instance-attribute

id: str

Account UUID. string (UUID)

AccountDeleteResponse

Bases: IikoModel

AccountDeleteResponse.

id class-attribute instance-attribute

id: str | None = None

Account UUID. string (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

AccountFilter

Bases: IikoModel

AccountFilter.

field class-attribute instance-attribute

field: str | None = None

Field name to filter by

op class-attribute instance-attribute

op: str | None = None

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

value class-attribute instance-attribute

value: Any | None = None

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

values class-attribute instance-attribute

values: list[str] | None = None

Array of values for multiple filtering (used with "in", "nin")

AccountGetRequest

Bases: IikoModel

AccountGetRequest.

id instance-attribute

id: str

Account UUID. string (UUID)

AccountListRequest

Bases: IikoModel

AccountListRequest.

filters instance-attribute

filters: list[AccountFilter]

Request filters. All filters are applied simultaneously (AND)

limit instance-attribute

limit: int

Maximum number of records in the response.

offset instance-attribute

offset: int

Number of records to skip from the beginning.

AccountListResponse

Bases: IikoModel

AccountListResponse.

accounts class-attribute instance-attribute

accounts: list[Account] | None = None

List of accounts

count class-attribute instance-attribute

count: int | None = None

Number of items returned in the response

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

AccountPostingListRequest

Bases: IikoModel

AccountPostingListRequest.

account_id class-attribute instance-attribute

account_id: str | None = None

Financial account UUID. string (UUID)

counteragent_id class-attribute instance-attribute

counteragent_id: str | None = None

Filter by counteragent UUID. string (UUID), nullable

from_ class-attribute instance-attribute

from_: str | None = Field(default=None, alias='from')

Period start date (YYYY-MM-DD)

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

List of organization UUIDs to filter by. string[] (UUID)

to class-attribute instance-attribute

to: str | None = None

Period end date (YYYY-MM-DD)

AccountPostingListResponse

Bases: IikoModel

AccountPostingListResponse.

account_id class-attribute instance-attribute

account_id: str | None = None

Financial account UUID. string (UUID)

can_edit class-attribute instance-attribute

can_edit: bool | None = None

Whether postings can be edited

opening_balance_amount class-attribute instance-attribute

opening_balance_amount: Decimal | None = None

Opening balance at the start of the period. decimal

period_change_amount class-attribute instance-attribute

period_change_amount: Decimal | None = None

Net change in balance over the period. decimal

postings class-attribute instance-attribute

postings: list[Posting] | None = None

List of postings

AccountResponse

Bases: IikoModel

AccountResponse.

code class-attribute instance-attribute

code: str | None = None

Account code

created_at class-attribute instance-attribute

created_at: str | None = None

Creation date and time

deleted_at class-attribute instance-attribute

deleted_at: str | None = None

Deletion date and time

description class-attribute instance-attribute

description: str | None = None

Account description

id class-attribute instance-attribute

id: str | None = None

Account UUID. string (UUID)

is_custom_transactions_allowed class-attribute instance-attribute

is_custom_transactions_allowed: bool | None = None

Whether custom transactions are allowed for the account

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

is_system_account class-attribute instance-attribute

is_system_account: bool | None = None

Whether the account is a system account

modified_at class-attribute instance-attribute

modified_at: str | None = None

Last modification date and time

name class-attribute instance-attribute

name: str | None = None

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent account UUID

revision class-attribute instance-attribute

revision: int | None = None

Revision

start_balance_date class-attribute instance-attribute

start_balance_date: str | None = None

Start balance date (YYYY-MM-DD format)

start_balance_sum class-attribute instance-attribute

start_balance_sum: Decimal | None = None

Start balance amount

type class-attribute instance-attribute

type: str | None = None

Account type code

AccountRestoreRequest

Bases: IikoModel

AccountRestoreRequest.

id instance-attribute

id: str

Account UUID. string (UUID)

restore_descendants instance-attribute

restore_descendants: bool

Flag to restore child accounts

AccountRestoreResponse

Bases: IikoModel

AccountRestoreResponse.

id class-attribute instance-attribute

id: str | None = None

Account UUID. string (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

restore_descendants class-attribute instance-attribute

restore_descendants: bool | None = None

Flag to restore child accounts

AccountTransactionsListRequest

Bases: IikoModel

AccountTransactionsListRequest.

account_id instance-attribute

account_id: str

Account ID. string (UUID). Required

from_ class-attribute instance-attribute

from_: str = Field(alias='from')

Period start date (YYYY-MM-DD format)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

to instance-attribute

to: str

Period end date (YYYY-MM-DD format)

AccountTransactionsResponse

Bases: IikoModel

AccountTransactionsResponse.

items class-attribute instance-attribute

items: list[TransactionItem] | None = None

Array of transactions

start_balance class-attribute instance-attribute

start_balance: Decimal | None = None

Opening (incoming) account balance at the start of the period. decimal

sum_total class-attribute instance-attribute

sum_total: Decimal | None = None

Total amount of all transactions in the selection. decimal

AccountType

Bases: IikoModel

AccountType.

code class-attribute instance-attribute

code: str | None = None

Account type code

title class-attribute instance-attribute

title: str | None = None

Account type title

AccountTypeListRequest

Bases: IikoModel

AccountTypeListRequest.

AccountUpdateRequest

Bases: IikoModel

AccountUpdateRequest.

code class-attribute instance-attribute

code: str | None = None

Account code

description instance-attribute

description: str

Account description

id instance-attribute

id: str

Account UUID. string (UUID)

name instance-attribute

name: str

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent account UUID

start_balance_date instance-attribute

start_balance_date: str

Start balance date (YYYY-MM-DD format)

start_balance_sum instance-attribute

start_balance_sum: Decimal

Start balance amount

type instance-attribute

type: str

Account type code

BalanceItem

Bases: IikoModel

BalanceItem.

account_id class-attribute instance-attribute

account_id: str | None = None

Financial account UUID. string (UUID)

balance_amount class-attribute instance-attribute

balance_amount: Decimal | None = None

Account balance. decimal

BalanceSheetListRequest

Bases: IikoModel

BalanceSheetListRequest.

balance_at class-attribute instance-attribute

balance_at: str | None = None

Date to retrieve balances for (YYYY-MM-DD)

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

List of organization UUIDs to filter by. string[] (UUID)

BalanceSheetListResponse

Bases: IikoModel

BalanceSheetListResponse.

balance_at class-attribute instance-attribute

balance_at: str | None = None

Date to retrieve balances for (YYYY-MM-DD)

balances class-attribute instance-attribute

balances: list[BalanceItem] | None = None

List of account balances

CashFlowCategory

Bases: IikoModel

CashFlowCategory.

code class-attribute instance-attribute

code: str | None = None

Cash flow category code

created_at class-attribute instance-attribute

created_at: str | None = None

Creation date and time

deleted_at class-attribute instance-attribute

deleted_at: str | None = None

Deletion date and time

id class-attribute instance-attribute

id: str | None = None

Cash flow category UUID. string (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

modified_at class-attribute instance-attribute

modified_at: str | None = None

Last modification date and time

name class-attribute instance-attribute

name: str | None = None

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent cash flow category UUID

revision class-attribute instance-attribute

revision: int | None = None

Revision

type class-attribute instance-attribute

type: str | None = None

Cash flow category type. Allowed values: FINANCE, INVESTMENT, OPERATIONAL

CashFlowCategoryCascadeResponse

Bases: IikoModel

CashFlowCategoryCascadeResponse.

affected_ids class-attribute instance-attribute

affected_ids: list[str] | None = None

List of affected cash flow category identifiers

id class-attribute instance-attribute

id: str | None = None

Cash flow category UUID. string (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

CashFlowCategoryCreateRequest

Bases: IikoModel

CashFlowCategoryCreateRequest.

code instance-attribute

code: str

Cash flow category code

name instance-attribute

name: str

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent cash flow category UUID

type instance-attribute

type: str

Cash flow category type. Allowed values: FINANCE, INVESTMENT, OPERATIONAL

CashFlowCategoryDeleteRequest

Bases: IikoModel

CashFlowCategoryDeleteRequest.

id instance-attribute

id: str

Cash flow category UUID. string (UUID)

CashFlowCategoryFilter

Bases: IikoModel

CashFlowCategoryFilter.

field class-attribute instance-attribute

field: str | None = None

Field name to filter by

op class-attribute instance-attribute

op: str | None = None

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

value class-attribute instance-attribute

value: Any | None = None

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

values class-attribute instance-attribute

values: list[str] | None = None

Array of values for multiple filtering (used with "in", "nin")

CashFlowCategoryGetRequest

Bases: IikoModel

CashFlowCategoryGetRequest.

id instance-attribute

id: str

Cash flow category UUID. string (UUID)

CashFlowCategoryListRequest

Bases: IikoModel

CashFlowCategoryListRequest.

filters instance-attribute

filters: list[CashFlowCategoryFilter]

Request filters. All filters are applied simultaneously (AND)

limit instance-attribute

limit: int

Maximum number of records in the response.

offset instance-attribute

offset: int

Number of records to skip from the beginning.

CashFlowCategoryListResponse

Bases: IikoModel

CashFlowCategoryListResponse.

cash_flow_categories class-attribute instance-attribute

cash_flow_categories: list[CashFlowCategory] | None = None

List of cash flow categories

count class-attribute instance-attribute

count: int | None = None

Number of items returned in the response

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

CashFlowCategoryResponse

Bases: IikoModel

CashFlowCategoryResponse.

code class-attribute instance-attribute

code: str | None = None

Cash flow category code

created_at class-attribute instance-attribute

created_at: str | None = None

Creation date and time

deleted_at class-attribute instance-attribute

deleted_at: str | None = None

Deletion date and time

id class-attribute instance-attribute

id: str | None = None

Cash flow category UUID. string (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

modified_at class-attribute instance-attribute

modified_at: str | None = None

Last modification date and time

name class-attribute instance-attribute

name: str | None = None

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent cash flow category UUID

revision class-attribute instance-attribute

revision: int | None = None

Revision

type class-attribute instance-attribute

type: str | None = None

Cash flow category type. Allowed values: FINANCE, INVESTMENT, OPERATIONAL

CashFlowCategoryRestoreRequest

Bases: IikoModel

CashFlowCategoryRestoreRequest.

id instance-attribute

id: str

Cash flow category UUID. string (UUID)

restore_descendants instance-attribute

restore_descendants: bool

Flag to restore child accounts

CashFlowCategoryUpdateRequest

Bases: IikoModel

CashFlowCategoryUpdateRequest.

code instance-attribute

code: str

Cash flow category code

id instance-attribute

id: str

Cash flow category UUID. string (UUID)

name instance-attribute

name: str

Display name

parent_id class-attribute instance-attribute

parent_id: str | None = None

Parent cash flow category UUID

type instance-attribute

type: str

Cash flow category type. Allowed values: FINANCE, INVESTMENT, OPERATIONAL

ChartOfAccount

Bases: IikoModel

ChartOfAccount.

account_group class-attribute instance-attribute

account_group: str | None = None

Account group: ASSETS, LIABILITIES, EQUITY, INCOME_EXPENSES

account_type class-attribute instance-attribute

account_type: str | None = None

Account type (ENUM)

code class-attribute instance-attribute

code: str | None = None

Account code

description class-attribute instance-attribute

description: str | None = None

Account description

id class-attribute instance-attribute

id: str | None = None

Account UUID. string (UUID)

is_custom_transactions_allowed class-attribute instance-attribute

is_custom_transactions_allowed: bool | None = None

Whether custom transactions are allowed for the account

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deletion flag

is_system_account class-attribute instance-attribute

is_system_account: bool | None = None

Whether the account is a system account

name class-attribute instance-attribute

name: str | None = None

Display name

parent_account_id class-attribute instance-attribute

parent_account_id: str | None = None

Parent account UUID. string (UUID), nullable

ChartOfAccountsListRequest

Bases: IikoModel

ChartOfAccountsListRequest.

account_type class-attribute instance-attribute

account_type: str | None = None

Account type (ENUM)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deletion flag

ChartOfAccountsListResponse

Bases: IikoModel

ChartOfAccountsListResponse.

accounts class-attribute instance-attribute

accounts: list[ChartOfAccount] | None = None

List of accounts

DocumentTransactionItem

Bases: IikoModel

DocumentTransactionItem.

cash_flow_category class-attribute instance-attribute

cash_flow_category: str | None = None

Cash flow category. string (UUID), or null

cash_order_number class-attribute instance-attribute

cash_order_number: str | None = None

Cash order number. string, or null

comment class-attribute instance-attribute

comment: str | None = None

Transaction comment. string, or null

conception class-attribute instance-attribute

conception: str | None = None

Concept the transaction belongs to. string (UUID), or null

date class-attribute instance-attribute

date: str | None = None

Transaction accounting date and time. string (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

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

date_modified class-attribute instance-attribute

date_modified: str | None = None

Transaction last modified date. string (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm), or null

date_secondary class-attribute instance-attribute

date_secondary: str | None = None

Secondary transaction date. string (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm), or null

document_id class-attribute instance-attribute

document_id: str | None = None

Related document ID. string (UUID), or null

document_item_id class-attribute instance-attribute

document_item_id: str | None = None

Document item ID. string (UUID), or null

from_ class-attribute instance-attribute

from_: TransactionSide | None = Field(
    default=None, alias="from"
)

Transaction FROM (debit) side

id class-attribute instance-attribute

id: str | None = None

Transaction UUID. string (UUID)

number class-attribute instance-attribute

number: str | None = None

Related document or cash session number. string, or null

session class-attribute instance-attribute

session: str | None = None

Cash session in which the transaction was created. string (UUID), or null

sum class-attribute instance-attribute

sum: Decimal | None = None

Transaction amount. decimal

to class-attribute instance-attribute

to: TransactionSide | None = None

Transaction TO (credit) side

type class-attribute instance-attribute

type: str | None = None

Transaction type, ENUM

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the transaction. string (UUID), or null

DocumentTransactionsListRequest

Bases: IikoModel

DocumentTransactionsListRequest.

document_id instance-attribute

document_id: str

Document identifier (GUID)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

IncomingServiceCreateItem

Bases: IikoModel

IncomingServiceCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

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)

revenue_account instance-attribute

revenue_account: str

Revenue account identifier (GUID)

split_vat class-attribute instance-attribute

split_vat: bool | None = None

Split VAT accounting flag

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

vat_percent instance-attribute

vat_percent: Decimal

VAT percentage

IncomingServiceCreateRequest

Bases: IikoModel

IncomingServiceCreateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

contract_date class-attribute instance-attribute

contract_date: str | None = None

Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

contract_number class-attribute instance-attribute

contract_number: str | None = None

Contract number

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)

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

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

items: list[IncomingServiceCreateItem]

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)

IncomingServiceGetItem

Bases: IikoModel

IncomingServiceGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

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

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

split_vat class-attribute instance-attribute

split_vat: bool | None = None

Split VAT accounting flag

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

IncomingServiceGetResponse

Bases: IikoModel

IncomingServiceGetResponse.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

contract_date class-attribute instance-attribute

contract_date: str | None = None

Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

contract_number class-attribute instance-attribute

contract_number: str | None = None

Contract number

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)

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

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[IncomingServiceGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

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)

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)

IncomingServiceListItem

Bases: IikoModel

IncomingServiceListItem.

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)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

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. 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)

IncomingServiceSaveResponse

Bases: IikoModel

IncomingServiceSaveResponse.

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

IncomingServiceUpdateRequest

Bases: IikoModel

IncomingServiceUpdateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

contract_date class-attribute instance-attribute

contract_date: str | None = None

Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

contract_number class-attribute instance-attribute

contract_number: str | None = None

Contract number

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)

document_id instance-attribute

document_id: str

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

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

items: list[IncomingServiceCreateItem]

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)

ItemCategory

Bases: IikoModel

ItemCategory.

code class-attribute instance-attribute

code: str | None = None

Fiscal category code

id class-attribute instance-attribute

id: str | None = None

Fiscal category UUID. string (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

name class-attribute instance-attribute

name: str | None = None

Display name

ItemCategoryListRequest

Bases: IikoModel

ItemCategoryListRequest.

filters class-attribute instance-attribute

filters: list[FilterCondition] | None = None

Request filters. All filters are applied simultaneously (AND)

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

ItemCategoryListResponse

Bases: IikoModel

ItemCategoryListResponse.

items class-attribute instance-attribute

items: list[ItemCategory] | None = None

List of fiscal categories

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the filters

OutgoingServiceCreateItem

Bases: IikoModel

OutgoingServiceCreateItem.

amount instance-attribute

amount: Decimal

Product quantity

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)

revenue_account instance-attribute

revenue_account: str

Revenue account identifier (GUID)

split_vat class-attribute instance-attribute

split_vat: bool | None = None

Split VAT accounting flag

sum class-attribute instance-attribute

sum: Decimal | None = None

Amount including VAT. Required if price is not specified

vat_percent instance-attribute

vat_percent: Decimal

VAT percentage

OutgoingServiceCreateRequest

Bases: IikoModel

OutgoingServiceCreateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

contract_date class-attribute instance-attribute

contract_date: str | None = None

Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

contract_number class-attribute instance-attribute

contract_number: str | None = None

Contract number

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)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

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[OutgoingServiceCreateItem]

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)

OutgoingServiceGetItem

Bases: IikoModel

OutgoingServiceGetItem.

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity

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

revenue_account class-attribute instance-attribute

revenue_account: str | None = None

Revenue account identifier (GUID)

split_vat class-attribute instance-attribute

split_vat: bool | None = None

Split VAT accounting flag

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

OutgoingServiceGetResponse

Bases: IikoModel

OutgoingServiceGetResponse.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

contract_date class-attribute instance-attribute

contract_date: str | None = None

Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

contract_number class-attribute instance-attribute

contract_number: str | None = None

Contract number

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)

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

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[OutgoingServiceGetItem] | None = None

List of document items

number class-attribute instance-attribute

number: str | None = None

Document number

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)

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)

OutgoingServiceListItem

Bases: IikoModel

OutgoingServiceListItem.

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)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

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. 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)

OutgoingServiceSaveResponse

Bases: IikoModel

OutgoingServiceSaveResponse.

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

OutgoingServiceUpdateRequest

Bases: IikoModel

OutgoingServiceUpdateRequest.

comment class-attribute instance-attribute

comment: str | None = None

Comment

conception class-attribute instance-attribute

conception: str | None = None

Concept identifier (GUID)

contract_date class-attribute instance-attribute

contract_date: str | None = None

Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

contract_number class-attribute instance-attribute

contract_number: str | None = None

Contract number

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)

document_id instance-attribute

document_id: str

Document identifier (GUID)

due_date class-attribute instance-attribute

due_date: str | None = None

Payment due date

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[OutgoingServiceCreateItem]

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)

Posting

Bases: IikoModel

Posting.

balance_amount class-attribute instance-attribute

balance_amount: Decimal | None = None

Cumulative account balance after posting. decimal

can_edit class-attribute instance-attribute

can_edit: bool | None = None

Whether the posting can be edited

cash_flow_category_id class-attribute instance-attribute

cash_flow_category_id: str | None = None

Cash flow category UUID. string (UUID), nullable

cash_order_number class-attribute instance-attribute

cash_order_number: str | None = None

Cash order number. string, nullable

comment class-attribute instance-attribute

comment: str | None = None

Posting comment. string, nullable

conception_id class-attribute instance-attribute

conception_id: str | None = None

Conception UUID. string (UUID), nullable

corresponding_account_id class-attribute instance-attribute

corresponding_account_id: str | None = None

Corresponding account UUID. string (UUID)

counteragent_id class-attribute instance-attribute

counteragent_id: str | None = None

Counteragent UUID. string (UUID), nullable

created_at class-attribute instance-attribute

created_at: str | None = None

Creation date and time. string, nullable

department_id class-attribute instance-attribute

department_id: str | None = None

Department UUID. string (UUID), nullable

document_at class-attribute instance-attribute

document_at: str | None = None

Document date (YYYY-MM-DD)

document_id class-attribute instance-attribute

document_id: str | None = None

Document UUID. string (UUID), nullable

document_number class-attribute instance-attribute

document_number: str | None = None

Document number. string, nullable

is_credit_side class-attribute instance-attribute

is_credit_side: bool | None = None

Credit side flag (true = credit, false = debit)

modified_at class-attribute instance-attribute

modified_at: str | None = None

Last modification date and time. string, nullable

modified_by_user_id class-attribute instance-attribute

modified_by_user_id: str | None = None

UUID of the user who last modified the posting. string (UUID), nullable

posted_at class-attribute instance-attribute

posted_at: str | None = None

Actual posting date. string (YYYY-MM-DD), nullable

posting_amount class-attribute instance-attribute

posting_amount: Decimal | None = None

Posting amount. decimal

posting_id class-attribute instance-attribute

posting_id: str | None = None

Posting UUID. string (UUID)

posting_type class-attribute instance-attribute

posting_type: str | None = None

Posting type (ENUM)

secondary_counteragent_id class-attribute instance-attribute

secondary_counteragent_id: str | None = None

Secondary counteragent UUID. string (UUID), nullable

TaxCategory

Bases: IikoModel

TaxCategory.

id class-attribute instance-attribute

id: str | None = None

Tax category UUID. string (UUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deleted flag

name class-attribute instance-attribute

name: str | None = None

Display name

TaxCategoryListRequest

Bases: IikoModel

TaxCategoryListRequest.

filters class-attribute instance-attribute

filters: list[FilterCondition] | None = None

Request filters. All filters are applied simultaneously (AND)

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

TaxCategoryListResponse

Bases: IikoModel

TaxCategoryListResponse.

items class-attribute instance-attribute

items: list[TaxCategory] | None = None

List of tax categories

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the filters

TransactionItem

Bases: IikoModel

TransactionItem.

account class-attribute instance-attribute

account: str | None = None

Account or store. string (UUID)

balance class-attribute instance-attribute

balance: Decimal | None = None

Accumulated account balance after this transaction. decimal

cash_flow_category class-attribute instance-attribute

cash_flow_category: str | None = None

Cash flow category. string (UUID), or null

cash_order_number class-attribute instance-attribute

cash_order_number: str | None = None

Cash order number. string, or null

cause_event_id class-attribute instance-attribute

cause_event_id: str | None = None

ID of the event that caused the transaction creation. string (UUID), or null

comment class-attribute instance-attribute

comment: str | None = None

Transaction comment. string, or null

conception class-attribute instance-attribute

conception: str | None = None

Concept the transaction belongs to. string (UUID), or null

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent. string (UUID), or null

date class-attribute instance-attribute

date: str | None = None

Transaction accounting date and time. string (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)

date_created class-attribute instance-attribute

date_created: str | None = None

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

date_modified class-attribute instance-attribute

date_modified: str | None = None

Transaction last modified date. string (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm), or null

date_secondary class-attribute instance-attribute

date_secondary: str | None = None

Secondary transaction date. string (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm), or null

document_id class-attribute instance-attribute

document_id: str | None = None

Related document ID. string (UUID), or null

document_type class-attribute instance-attribute

document_type: str | None = None

Document type, ENUM

number class-attribute instance-attribute

number: str | None = None

Related document or cash session number. string, or null

penalty_or_bonus_type class-attribute instance-attribute

penalty_or_bonus_type: str | None = None

Penalty/bonus type — filled only for PENALTY / BONUS transactions. UUID, or null

second_counteragent class-attribute instance-attribute

second_counteragent: str | None = None

Corresponding counteragent (employee/user) for the transaction. string (UUID), or null

session class-attribute instance-attribute

session: str | None = None

Cash session in which the transaction was created. string (UUID), or null

sum class-attribute instance-attribute

sum: Decimal | None = None

Transaction amount. decimal

terminal class-attribute instance-attribute

terminal: str | None = None

Terminal on which the transaction was created. string (UUID), or null

type class-attribute instance-attribute

type: str | None = None

Transaction type, ENUM

user_modified class-attribute instance-attribute

user_modified: str | None = None

User who last modified the transaction. string (UUID), or null

TransactionSide

Bases: IikoModel

TransactionSide.

account class-attribute instance-attribute

account: str | None = None

Account or store. string (UUID)

amount class-attribute instance-attribute

amount: Decimal | None = None

Product quantity. decimal, or null

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent. string (UUID), or null

product class-attribute instance-attribute

product: str | None = None

Product. string (UUID), or null