Баланс счёта

finance.get_account_balance

Финансыfinancefinance.accounts.read

Возвращает карточку денежного счёта (касса или банковский) и сводку по его балансу: текущий остаток, начальный остаток, суммарные обороты по приходам и расходам и вычисленный из завершённых транзакций баланс для сверки. Счёт находится по идентификатору accountId или по короткому коду accountCode (например CASH-01, BANK-01) — достаточно одного из них. Только чтение.

Входы

КлючТипОписание
accountIdstringИдентификатор счёта
accountCodestringКод счёта

Выходы

КлючТипОписание
accountobjectСчёт
balanceobjectБаланс

Что делает

Нода находит денежный счёт и возвращает по нему две вещи: карточку самого счёта и сводку по его балансу. Счёт можно указать двумя способами — по идентификатору или по короткому коду (например CASH-01 для кассы или BANK-01 для расчётного счёта). Достаточно одного из них: если известен код, идентификатор передавать не нужно.

Кроме текущего остатка нода отдельно считает остаток «по движению»: берёт начальный остаток счёта, прибавляет все приходы и вычитает все расходы по завершённым транзакциям. Это значение удобно сверять с текущим остатком, чтобы убедиться, что деньги на счёте и история операций сходятся.

Когда применять

Основной сценарий — быстро узнать, сколько денег на конкретном счёте. Например, пользователь спрашивает ассистента «сколько сейчас в кассе CASH-01?» или «какой остаток на расчётном счёте?» — ассистент вызывает эту ноду и отвечает суммой и валютой. В автоматизации ноду используют как проверку перед выплатой или переводом: сверить, что на счёте достаточно средств, и только потом продолжать сценарий.

Также нода подходит для сверки: если текущий остаток и вычисленный из операций остаток расходятся, это повод разобраться с проведёнными транзакциями. Нода только читает данные и ничего не меняет в счёте.

Что на входе

Идентификатор счёта или его короткий код — нужно передать хотя бы одно из полей. Если указан идентификатор, счёт берётся по нему; иначе счёт ищется по коду. Если не передать ни того, ни другого, нода вернёт ошибку, что нужно указать счёт.

Что приходит в ответе

Карточка счёта — это код и наименование, тип (касса или банковский), статус, привязка к точке (для касс), остатки и лимиты, банковские реквизиты (для банковских счетов), валюта и служебные флаги, например отметка счёта по умолчанию.

Сводка по балансу — это текущий остаток, начальный остаток, суммарные приходы и расходы по завершённым операциям, вычисленный из них остаток для сверки, количество учтённых транзакций и валюта счёта.