Finance¶

Endpoints of the Finance section of the iikoCloud API documentation.

Finance.IncomingService¶

An incoming service act is a document used by a restaurant to record the receipt of services from a supplier (accounting services, rent, maintenance, delivery, etc.).

iiko.finance.incoming_service.cancel() `async` ¶

cancel(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> IncomingServiceSaveResponse

Cancel incoming service act draft.

POST /api/finance/v1/incoming_service/cancel

Changes the incoming service act status from NEW to CANCELED

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`IncomingServiceSaveResponse`	The `IncomingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.incoming_service.create() `async` ¶

create(
    *,
    counteragent: str,
    date: str,
    items: Sequence[
        IncomingServiceCreateItem | Mapping[str, Any]
    ],
    organization_id: str,
    comment: str | None = None,
    conception: str | None = None,
    contract_date: str | None = None,
    contract_number: str | None = None,
    document_id: str | None = None,
    due_date: str | None = None,
    employee_pass_to_account: str | None = None,
    incoming_date: str | None = None,
    incoming_document_number: str | None = None,
    invoice: str | None = None,
    is_automatic: bool | None = None,
    is_editable: bool | None = None,
    number: str | None = None,
    revenue_account: str | None = None,
    timeout: float | None = None,
) -> IncomingServiceSaveResponse

Create incoming service act.

POST /api/finance/v1/incoming_service/create

Creates a new incoming service act

Parameters:

Name	Type	Description	Default
`counteragent`	`str`	Counteragent identifier (GUID)	required
`date`	`str`	Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)	required
`items`	`Sequence[IncomingServiceCreateItem \| Mapping[str, Any]]`	List of document items	required
`organization_id`	`str`	Organization identifier (GUID)	required
`comment`	`str \| None`	Comment	`None`
`conception`	`str \| None`	Concept identifier (GUID)	`None`
`contract_date`	`str \| None`	Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)	`None`
`contract_number`	`str \| None`	Contract number	`None`
`document_id`	`str \| None`	See the API reference.	`None`
`due_date`	`str \| None`	Payment due date	`None`
`employee_pass_to_account`	`str \| None`	Charge to employee	`None`
`incoming_date`	`str \| None`	Incoming document date (YYYY-MM-DD)	`None`
`incoming_document_number`	`str \| None`	Incoming external document number	`None`
`invoice`	`str \| None`	Invoice number	`None`
`is_automatic`	`bool \| None`	Automatic document creation flag	`None`
`is_editable`	`bool \| None`	Editable flag. true — available for editing	`None`
`number`	`str \| None`	Document number	`None`
`revenue_account`	`str \| None`	Revenue account identifier (GUID)	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`IncomingServiceSaveResponse`	The `IncomingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.incoming_service.get() `async` ¶

get(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> IncomingServiceGetResponse

Get incoming service act.

POST /api/finance/v1/incoming_service/get

Gets an incoming service act by identifier

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`IncomingServiceGetResponse`	The `IncomingServiceGetResponse` response.

iikoCloud API reference

iiko.finance.incoming_service.list() `async` ¶

list(
    *,
    from_: str,
    organization_id: str,
    to: str,
    timeout: float | None = None,
) -> list[IncomingServiceListItem]

Export incoming service acts.

POST /api/finance/v1/incoming_service/list

Exports incoming service acts for the specified period

Parameters:

Name	Type	Description	Default
`from_`	`str`	Period start date (YYYY-MM-DD format)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`to`	`str`	Period end date (YYYY-MM-DD format)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`list[IncomingServiceListItem]`	The `list[IncomingServiceListItem]` response.

iikoCloud API reference

iiko.finance.incoming_service.post() `async` ¶

post(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> IncomingServiceSaveResponse

Post incoming service act.

POST /api/finance/v1/incoming_service/post

Changes the incoming service act status from NEW to PROCESSED

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`IncomingServiceSaveResponse`	The `IncomingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.incoming_service.unpost() `async` ¶

unpost(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> IncomingServiceSaveResponse

Unpost incoming service act.

POST /api/finance/v1/incoming_service/unpost

Changes the incoming service act status from PROCESSED to NEW

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`IncomingServiceSaveResponse`	The `IncomingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.incoming_service.update() `async` ¶

update(
    *,
    counteragent: str,
    date: str,
    document_id: str,
    items: Sequence[
        IncomingServiceCreateItem | Mapping[str, Any]
    ],
    number: str,
    organization_id: str,
    comment: str | None = None,
    conception: str | None = None,
    contract_date: str | None = None,
    contract_number: str | None = None,
    due_date: str | None = None,
    employee_pass_to_account: str | None = None,
    incoming_date: str | None = None,
    incoming_document_number: str | None = None,
    invoice: str | None = None,
    is_automatic: bool | None = None,
    is_editable: bool | None = None,
    revenue_account: str | None = None,
    timeout: float | None = None,
) -> IncomingServiceSaveResponse

Edit incoming service act.

POST /api/finance/v1/incoming_service/update

Edits an existing incoming service act

Parameters:

Name	Type	Description	Default
`counteragent`	`str`	Counteragent identifier (GUID)	required
`date`	`str`	Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)	required
`document_id`	`str`	Document identifier (GUID)	required
`items`	`Sequence[IncomingServiceCreateItem \| Mapping[str, Any]]`	List of document items	required
`number`	`str`	Document number	required
`organization_id`	`str`	Organization identifier (GUID)	required
`comment`	`str \| None`	Comment	`None`
`conception`	`str \| None`	Concept identifier (GUID)	`None`
`contract_date`	`str \| None`	Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)	`None`
`contract_number`	`str \| None`	Contract number	`None`
`due_date`	`str \| None`	Payment due date	`None`
`employee_pass_to_account`	`str \| None`	Charge to employee	`None`
`incoming_date`	`str \| None`	Incoming document date (YYYY-MM-DD)	`None`
`incoming_document_number`	`str \| None`	Incoming external document number	`None`
`invoice`	`str \| None`	Invoice number	`None`
`is_automatic`	`bool \| None`	Automatic document creation flag	`None`
`is_editable`	`bool \| None`	Editable flag. true — available for editing	`None`
`revenue_account`	`str \| None`	Revenue account identifier (GUID)	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`IncomingServiceSaveResponse`	The `IncomingServiceSaveResponse` response.

iikoCloud API reference

Finance.OutgoingService¶

An outgoing service act is a document used by a restaurant to record the provision of services to a buyer.

iiko.finance.outgoing_service.cancel() `async` ¶

cancel(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> OutgoingServiceSaveResponse

Cancel outgoing service act draft.

POST /api/finance/v1/outgoing_service/cancel

Changes the outgoing service act status from NEW to CANCELED

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`OutgoingServiceSaveResponse`	The `OutgoingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.outgoing_service.create() `async` ¶

create(
    *,
    counteragent: str,
    date: str,
    items: Sequence[
        OutgoingServiceCreateItem | Mapping[str, Any]
    ],
    organization_id: str,
    comment: str | None = None,
    conception: str | None = None,
    contract_date: str | None = None,
    contract_number: str | None = None,
    document_id: str | None = None,
    due_date: str | None = None,
    is_automatic: bool | None = None,
    is_editable: bool | None = None,
    number: str | None = None,
    revenue_account: str | None = None,
    timeout: float | None = None,
) -> OutgoingServiceSaveResponse

Create outgoing service act.

POST /api/finance/v1/outgoing_service/create

Creates a new outgoing service act

Parameters:

Name	Type	Description	Default
`counteragent`	`str`	Counteragent identifier (GUID)	required
`date`	`str`	Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)	required
`items`	`Sequence[OutgoingServiceCreateItem \| Mapping[str, Any]]`	List of document items	required
`organization_id`	`str`	Organization identifier (GUID)	required
`comment`	`str \| None`	Comment	`None`
`conception`	`str \| None`	Concept identifier (GUID)	`None`
`contract_date`	`str \| None`	Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)	`None`
`contract_number`	`str \| None`	Contract number	`None`
`document_id`	`str \| None`	See the API reference.	`None`
`due_date`	`str \| None`	Payment due date	`None`
`is_automatic`	`bool \| None`	Automatic document creation flag	`None`
`is_editable`	`bool \| None`	Editable flag. true — available for editing	`None`
`number`	`str \| None`	Document number	`None`
`revenue_account`	`str \| None`	Revenue account identifier (GUID)	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`OutgoingServiceSaveResponse`	The `OutgoingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.outgoing_service.get() `async` ¶

get(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> OutgoingServiceGetResponse

Get outgoing service act.

POST /api/finance/v1/outgoing_service/get

Gets an outgoing service act by identifier

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`OutgoingServiceGetResponse`	The `OutgoingServiceGetResponse` response.

iikoCloud API reference

iiko.finance.outgoing_service.list() `async` ¶

list(
    *,
    from_: str,
    organization_id: str,
    to: str,
    timeout: float | None = None,
) -> list[OutgoingServiceListItem]

Export outgoing service acts.

POST /api/finance/v1/outgoing_service/list

Exports outgoing service acts for the specified period

Parameters:

Name	Type	Description	Default
`from_`	`str`	Period start date (YYYY-MM-DD format)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`to`	`str`	Period end date (YYYY-MM-DD format)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`list[OutgoingServiceListItem]`	The `list[OutgoingServiceListItem]` response.

iikoCloud API reference

iiko.finance.outgoing_service.post() `async` ¶

post(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> OutgoingServiceSaveResponse

Post outgoing service act.

POST /api/finance/v1/outgoing_service/post

Changes the outgoing service act status from NEW to PROCESSED

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`OutgoingServiceSaveResponse`	The `OutgoingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.outgoing_service.unpost() `async` ¶

unpost(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> OutgoingServiceSaveResponse

Unpost outgoing service act.

POST /api/finance/v1/outgoing_service/unpost

Changes the outgoing service act status from PROCESSED to NEW

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`OutgoingServiceSaveResponse`	The `OutgoingServiceSaveResponse` response.

iikoCloud API reference

iiko.finance.outgoing_service.update() `async` ¶

update(
    *,
    counteragent: str,
    date: str,
    document_id: str,
    items: Sequence[
        OutgoingServiceCreateItem | Mapping[str, Any]
    ],
    number: str,
    organization_id: str,
    comment: str | None = None,
    conception: str | None = None,
    contract_date: str | None = None,
    contract_number: str | None = None,
    due_date: str | None = None,
    is_automatic: bool | None = None,
    is_editable: bool | None = None,
    revenue_account: str | None = None,
    timeout: float | None = None,
) -> OutgoingServiceSaveResponse

Edit outgoing service act.

POST /api/finance/v1/outgoing_service/update

Edits an existing outgoing service act

Parameters:

Name	Type	Description	Default
`counteragent`	`str`	Counteragent identifier (GUID)	required
`date`	`str`	Document date and time (ISO 8601 YYYY-MM-DDThh:mm:ss.sss±hh:mm)	required
`document_id`	`str`	Document identifier (GUID)	required
`items`	`Sequence[OutgoingServiceCreateItem \| Mapping[str, Any]]`	List of document items	required
`number`	`str`	Document number	required
`organization_id`	`str`	Organization identifier (GUID)	required
`comment`	`str \| None`	Comment	`None`
`conception`	`str \| None`	Concept identifier (GUID)	`None`
`contract_date`	`str \| None`	Contract date (ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm)	`None`
`contract_number`	`str \| None`	Contract number	`None`
`due_date`	`str \| None`	Payment due date	`None`
`is_automatic`	`bool \| None`	Automatic document creation flag	`None`
`is_editable`	`bool \| None`	Editable flag. true — available for editing	`None`
`revenue_account`	`str \| None`	Revenue account identifier (GUID)	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`OutgoingServiceSaveResponse`	The `OutgoingServiceSaveResponse` response.

iikoCloud API reference

Finance.AccountTransactions¶

iiko.finance.account_transactions.list() `async` ¶

list(
    *,
    account_id: str,
    from_: str,
    organization_id: str,
    to: str,
    timeout: float | None = None,
) -> AccountTransactionsResponse

Get account transactions.

POST /api/finance/v1/account_transactions/list

Returns a list of transactions for the specified account

Parameters:

Name	Type	Description	Default
`account_id`	`str`	Account ID. string (UUID). Required	required
`from_`	`str`	Period start date (YYYY-MM-DD format)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`to`	`str`	Period end date (YYYY-MM-DD format)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountTransactionsResponse`	The `AccountTransactionsResponse` response.

iikoCloud API reference

Finance.DocumentTransactions¶

iiko.finance.document_transactions.list() `async` ¶

list(
    *,
    document_id: str,
    organization_id: str,
    timeout: float | None = None,
) -> list[DocumentTransactionItem]

Get document transactions.

POST /api/finance/v1/document_transactions/list

Returns a list of transactions for the specified document

Parameters:

Name	Type	Description	Default
`document_id`	`str`	Document identifier (GUID)	required
`organization_id`	`str`	Organization identifier (GUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`list[DocumentTransactionItem]`	The `list[DocumentTransactionItem]` response.

iikoCloud API reference

Finance.AccountType¶

iiko.finance.account_type.list() `async` ¶

list(*, timeout: float | None = None) -> list[AccountType]

List of account types.

POST /api/finance/v1/account-type/list

Returns the list of valid account types

Parameters:

Name	Type	Description	Default
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`list[AccountType]`	The `list[AccountType]` response.

iikoCloud API reference

Finance.CashFlowCategory¶

iiko.finance.cash_flow_category.create() `async` ¶

create(
    *,
    code: str,
    name: str,
    type: str,
    parent_id: str | None = None,
    timeout: float | None = None,
) -> CashFlowCategoryResponse

Create cash flow category.

POST /api/finance/v1/cash-flow-category/create

Creates a cash flow category

Parameters:

Name	Type	Description	Default
`code`	`str`	Cash flow category code	required
`name`	`str`	Display name	required
`type`	`str`	Cash flow category type. Allowed values: `FINANCE`, `INVESTMENT`, `OPERATIONAL`	required
`parent_id`	`str \| None`	Parent cash flow category UUID	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CashFlowCategoryResponse`	The `CashFlowCategoryResponse` response.

iikoCloud API reference

iiko.finance.cash_flow_category.delete() `async` ¶

delete(
    *, id: str, timeout: float | None = None
) -> CashFlowCategoryCascadeResponse

Delete cash flow category.

POST /api/finance/v1/cash-flow-category/delete

Marks a cash flow category and its active descendants as deleted

Parameters:

Name	Type	Description	Default
`id`	`str`	Cash flow category UUID. string (UUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CashFlowCategoryCascadeResponse`	The `CashFlowCategoryCascadeResponse` response.

iikoCloud API reference

iiko.finance.cash_flow_category.get() `async` ¶

get(
    *, id: str, timeout: float | None = None
) -> CashFlowCategoryResponse

Get cash flow category.

POST /api/finance/v1/cash-flow-category/get

Returns a cash flow category by id

Parameters:

Name	Type	Description	Default
`id`	`str`	Cash flow category UUID. string (UUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CashFlowCategoryResponse`	The `CashFlowCategoryResponse` response.

iikoCloud API reference

iiko.finance.cash_flow_category.list() `async` ¶

list(
    *,
    filters: Sequence[
        CashFlowCategoryFilter | Mapping[str, Any]
    ],
    limit: int,
    offset: int,
    timeout: float | None = None,
) -> CashFlowCategoryListResponse

List of cash flow categories.

POST /api/finance/v1/cash-flow-category/list

Returns a list of cash flow categories

Parameters:

Name	Type	Description	Default
`filters`	`Sequence[CashFlowCategoryFilter \| Mapping[str, Any]]`	Request filters. All filters are applied simultaneously (AND)	required
`limit`	`int`	Maximum number of records in the response.	required
`offset`	`int`	Number of records to skip from the beginning.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CashFlowCategoryListResponse`	The `CashFlowCategoryListResponse` response.

iikoCloud API reference

iiko.finance.cash_flow_category.restore() `async` ¶

restore(
    *,
    id: str,
    restore_descendants: bool,
    timeout: float | None = None,
) -> CashFlowCategoryCascadeResponse

Restore cash flow category.

POST /api/finance/v1/cash-flow-category/restore

Restores a cash flow category

Parameters:

Name	Type	Description	Default
`id`	`str`	Cash flow category UUID. string (UUID)	required
`restore_descendants`	`bool`	Flag to restore child accounts	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CashFlowCategoryCascadeResponse`	The `CashFlowCategoryCascadeResponse` response.

iikoCloud API reference

iiko.finance.cash_flow_category.update() `async` ¶

update(
    *,
    code: str,
    id: str,
    name: str,
    type: str,
    parent_id: str | None = None,
    timeout: float | None = None,
) -> CashFlowCategoryResponse

Update cash flow category.

POST /api/finance/v1/cash-flow-category/update

Updates a cash flow category

Parameters:

Name	Type	Description	Default
`code`	`str`	Cash flow category code	required
`id`	`str`	Cash flow category UUID. string (UUID)	required
`name`	`str`	Display name	required
`type`	`str`	Cash flow category type. Allowed values: `FINANCE`, `INVESTMENT`, `OPERATIONAL`	required
`parent_id`	`str \| None`	Parent cash flow category UUID	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CashFlowCategoryResponse`	The `CashFlowCategoryResponse` response.

iikoCloud API reference

Finance.Account¶

iiko.finance.account.create() `async` ¶

create(
    *,
    description: str,
    name: str,
    start_balance_date: str,
    start_balance_sum: Decimal | float,
    type: str,
    code: str | None = None,
    is_custom_transactions_allowed: bool | None = None,
    parent_id: str | None = None,
    timeout: float | None = None,
) -> AccountResponse

Create financial account.

POST /api/finance/v1/account/create

Creates a financial account

Parameters:

Name	Type	Description	Default
`description`	`str`	Account description	required
`name`	`str`	Display name	required
`start_balance_date`	`str`	Start balance date (YYYY-MM-DD format)	required
`start_balance_sum`	`Decimal \| float`	Start balance amount	required
`type`	`str`	Account type code	required
`code`	`str \| None`	Account code	`None`
`is_custom_transactions_allowed`	`bool \| None`	Whether custom transactions are allowed for the account	`None`
`parent_id`	`str \| None`	Parent account UUID	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountResponse`	The `AccountResponse` response.

iikoCloud API reference

iiko.finance.account.delete() `async` ¶

delete(
    *, id: str, timeout: float | None = None
) -> AccountDeleteResponse

Delete financial account.

POST /api/finance/v1/account/delete

Marks a financial account as deleted

Parameters:

Name	Type	Description	Default
`id`	`str`	Account UUID. string (UUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountDeleteResponse`	The `AccountDeleteResponse` response.

iikoCloud API reference

iiko.finance.account.get() `async` ¶

get(
    *, id: str, timeout: float | None = None
) -> AccountResponse

Get financial account.

POST /api/finance/v1/account/get

Returns a financial account by id

Parameters:

Name	Type	Description	Default
`id`	`str`	Account UUID. string (UUID)	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountResponse`	The `AccountResponse` response.

iikoCloud API reference

iiko.finance.account.list() `async` ¶

list(
    *,
    filters: Sequence[AccountFilter | Mapping[str, Any]],
    limit: int,
    offset: int,
    timeout: float | None = None,
) -> AccountListResponse

List of financial accounts.

POST /api/finance/v1/account/list

Returns a list of financial accounts

Parameters:

Name	Type	Description	Default
`filters`	`Sequence[AccountFilter \| Mapping[str, Any]]`	Request filters. All filters are applied simultaneously (AND)	required
`limit`	`int`	Maximum number of records in the response.	required
`offset`	`int`	Number of records to skip from the beginning.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountListResponse`	The `AccountListResponse` response.

iikoCloud API reference

iiko.finance.account.restore() `async` ¶

restore(
    *,
    id: str,
    restore_descendants: bool,
    timeout: float | None = None,
) -> AccountRestoreResponse

Restore financial account.

POST /api/finance/v1/account/restore

Restores a deleted financial account

Parameters:

Name	Type	Description	Default
`id`	`str`	Account UUID. string (UUID)	required
`restore_descendants`	`bool`	Flag to restore child accounts	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountRestoreResponse`	The `AccountRestoreResponse` response.

iikoCloud API reference

iiko.finance.account.update() `async` ¶

update(
    *,
    description: str,
    id: str,
    name: str,
    start_balance_date: str,
    start_balance_sum: Decimal | float,
    type: str,
    code: str | None = None,
    parent_id: str | None = None,
    timeout: float | None = None,
) -> AccountResponse

Update financial account.

POST /api/finance/v1/account/update

Updates a financial account

Parameters:

Name	Type	Description	Default
`description`	`str`	Account description	required
`id`	`str`	Account UUID. string (UUID)	required
`name`	`str`	Display name	required
`start_balance_date`	`str`	Start balance date (YYYY-MM-DD format)	required
`start_balance_sum`	`Decimal \| float`	Start balance amount	required
`type`	`str`	Account type code	required
`code`	`str \| None`	Account code	`None`
`parent_id`	`str \| None`	Parent account UUID	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountResponse`	The `AccountResponse` response.

iikoCloud API reference

Finance.Directories¶

iiko.finance.item_category.list() `async` ¶

list(
    *,
    filters: Sequence[FilterCondition | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> ItemCategoryListResponse

Get a list of fiscal categories.

POST /api/finance/v1/item-category/list

Returns a list of fiscal categories

Parameters:

Name	Type	Description	Default
`filters`	`Sequence[FilterCondition \| Mapping[str, Any]] \| None`	Request filters. All filters are applied simultaneously (AND)	`None`
`limit`	`int \| None`	Maximum number of records in the response.	`None`
`offset`	`int \| None`	Number of records to skip from the beginning.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`ItemCategoryListResponse`	The `ItemCategoryListResponse` response.

iikoCloud API reference

iiko.finance.tax_category.list() `async` ¶

list(
    *,
    filters: Sequence[FilterCondition | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> TaxCategoryListResponse

Get a list of tax categories.

POST /api/finance/v1/tax-category/list

Returns a list of tax categories

Parameters:

Name	Type	Description	Default
`filters`	`Sequence[FilterCondition \| Mapping[str, Any]] \| None`	Request filters. All filters are applied simultaneously (AND)	`None`
`limit`	`int \| None`	Maximum number of records in the response.	`None`
`offset`	`int \| None`	Number of records to skip from the beginning.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`TaxCategoryListResponse`	The `TaxCategoryListResponse` response.

iikoCloud API reference

Finance.AccountPosting¶

iiko.finance.account_posting.list() `async` ¶

list(
    *,
    account_id: str | None = None,
    counteragent_id: str | None = None,
    from_: str | None = None,
    organization_ids: Sequence[str] | None = None,
    to: str | None = None,
    timeout: float | None = None,
) -> AccountPostingListResponse

Account postings.

POST /api/finance/v1/account-posting/list

Returns a list of postings for a financial account over a period

Parameters:

Name	Type	Description	Default
`account_id`	`str \| None`	Financial account UUID. string (UUID)	`None`
`counteragent_id`	`str \| None`	Filter by counteragent UUID. string (UUID), nullable	`None`
`from_`	`str \| None`	Period start date (YYYY-MM-DD)	`None`
`organization_ids`	`Sequence[str] \| None`	List of organization UUIDs to filter by. string[] (UUID)	`None`
`to`	`str \| None`	Period end date (YYYY-MM-DD)	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`AccountPostingListResponse`	The `AccountPostingListResponse` response.

iikoCloud API reference

Finance.BalanceSheet¶

iiko.finance.balance_sheet.list() `async` ¶

list(
    *,
    balance_at: str | None = None,
    organization_ids: Sequence[str] | None = None,
    timeout: float | None = None,
) -> BalanceSheetListResponse

Balance sheet.

POST /api/finance/v1/balance-sheet/list

Returns account balances as of a given date

Parameters:

Name	Type	Description	Default
`balance_at`	`str \| None`	Date to retrieve balances for (YYYY-MM-DD)	`None`
`organization_ids`	`Sequence[str] \| None`	List of organization UUIDs to filter by. string[] (UUID)	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`BalanceSheetListResponse`	The `BalanceSheetListResponse` response.

iikoCloud API reference

Finance.ChartOfAccounts¶

iiko.finance.chart_of_accounts.list() `async` ¶

list(
    *,
    account_type: str | None = None,
    is_deleted: bool | None = None,
    timeout: float | None = None,
) -> ChartOfAccountsListResponse

Chart of accounts.

POST /api/finance/v1/chart-of-accounts/list

Returns the chart of financial accounts

Parameters:

Name	Type	Description	Default
`account_type`	`str \| None`	Account type (ENUM)	`None`
`is_deleted`	`bool \| None`	Deletion flag	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`ChartOfAccountsListResponse`	The `ChartOfAccountsListResponse` response.

iikoCloud API reference

Finance¶

Finance.IncomingService¶

iiko.finance.incoming_service.cancel() async ¶

iiko.finance.incoming_service.create() async ¶

iiko.finance.incoming_service.get() async ¶

iiko.finance.incoming_service.list() async ¶

iiko.finance.incoming_service.post() async ¶

iiko.finance.incoming_service.unpost() async ¶

iiko.finance.incoming_service.update() async ¶

Finance.OutgoingService¶

iiko.finance.outgoing_service.cancel() async ¶

iiko.finance.outgoing_service.create() async ¶

iiko.finance.outgoing_service.get() async ¶

iiko.finance.outgoing_service.list() async ¶

iiko.finance.outgoing_service.post() async ¶

iiko.finance.outgoing_service.unpost() async ¶

iiko.finance.outgoing_service.update() async ¶

Finance.AccountTransactions¶

iiko.finance.account_transactions.list() async ¶

Finance.DocumentTransactions¶

iiko.finance.document_transactions.list() async ¶

Finance.AccountType¶

iiko.finance.account_type.list() async ¶

Finance.CashFlowCategory¶

iiko.finance.cash_flow_category.create() async ¶

iiko.finance.cash_flow_category.delete() async ¶

iiko.finance.cash_flow_category.get() async ¶

iiko.finance.cash_flow_category.list() async ¶

iiko.finance.cash_flow_category.restore() async ¶

iiko.finance.cash_flow_category.update() async ¶

Finance.Account¶

iiko.finance.account.create() async ¶

iiko.finance.account.delete() async ¶

iiko.finance.account.get() async ¶

iiko.finance.account.list() async ¶

iiko.finance.account.restore() async ¶

iiko.finance.account.update() async ¶

Finance.Directories¶

iiko.finance.item_category.list() async ¶

iiko.finance.tax_category.list() async ¶

Finance.AccountPosting¶

iiko.finance.account_posting.list() async ¶

Finance.BalanceSheet¶

iiko.finance.balance_sheet.list() async ¶

Finance.ChartOfAccounts¶

iiko.finance.chart_of_accounts.list() async ¶

iiko.finance.incoming_service.cancel() `async` ¶

iiko.finance.incoming_service.create() `async` ¶

iiko.finance.incoming_service.get() `async` ¶

iiko.finance.incoming_service.list() `async` ¶

iiko.finance.incoming_service.post() `async` ¶

iiko.finance.incoming_service.unpost() `async` ¶

iiko.finance.incoming_service.update() `async` ¶

iiko.finance.outgoing_service.cancel() `async` ¶

iiko.finance.outgoing_service.create() `async` ¶

iiko.finance.outgoing_service.get() `async` ¶

iiko.finance.outgoing_service.list() `async` ¶

iiko.finance.outgoing_service.post() `async` ¶

iiko.finance.outgoing_service.unpost() `async` ¶

iiko.finance.outgoing_service.update() `async` ¶

iiko.finance.account_transactions.list() `async` ¶

iiko.finance.document_transactions.list() `async` ¶

iiko.finance.account_type.list() `async` ¶

iiko.finance.cash_flow_category.create() `async` ¶

iiko.finance.cash_flow_category.delete() `async` ¶

iiko.finance.cash_flow_category.get() `async` ¶

iiko.finance.cash_flow_category.list() `async` ¶

iiko.finance.cash_flow_category.restore() `async` ¶

iiko.finance.cash_flow_category.update() `async` ¶

iiko.finance.account.create() `async` ¶

iiko.finance.account.delete() `async` ¶

iiko.finance.account.get() `async` ¶

iiko.finance.account.list() `async` ¶

iiko.finance.account.restore() `async` ¶

iiko.finance.account.update() `async` ¶

iiko.finance.item_category.list() `async` ¶

iiko.finance.tax_category.list() `async` ¶

iiko.finance.account_posting.list() `async` ¶

iiko.finance.balance_sheet.list() `async` ¶

iiko.finance.chart_of_accounts.list() `async` ¶