Объекты счета

Получить балансы счетов

GET /(company_code)/v2/aol/account/balance

Получить объекты баланса для счетов

Должен быть указан фильтр либо по account_id, либо по profile и name_mask.

Если используется name_mask, пользователи с ролями EMPLOYEE, COMPANY должны передавать параметр ledger.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
URL-параметры запроса:
 
  • profile (string) – (Необязательно) Код профиля для запроса счетов. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • account_id (integer/string) – (Необязательно) Идентификатор счета для запроса, либо список идентификаторов, разделенных запятыми
  • name_mask (string) – (Необязательно) Маска (регулярное выражение) имени счета
  • ledger (string) – (Необязательно) Название журнала счета
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты данных балансов счетов
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных баланса счета

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля Тип Описание
account_id integer Идентификатор счета
name string Имя счета
beginning_balance integer Начальное сальдо
debits integer Оборот по дебету
credits integer Оборот по кредиту
net integer Движение по счету
ending_balance integer Конечное сальдо

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted

Подробнее см. Коды ошибок.

Получить оборотно-сальдовые ведомости счетов

GET /(company_code)/v2/aol/account/trialbalance

Получить объекты оборотно-сальдовой ведомости для счетов

Должен быть указан фильтр либо по account_id, либо по profile и name_mask.

Если используется name_mask, пользователи с ролями EMPLOYEE, COMPANY должны передавать параметр ledger.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
URL-параметры запроса:
 
  • profile (string) – (Необязательно) Код профиля для запроса счетов. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • account_id (integer/string) – (Необязательно) Идентификатор счета для запроса, либо список идентификаторов, разделенных запятыми
  • name_mask (string) – (Необязательно) Маска (регулярное выражение) имени счета
  • ledger (string) – (Необязательно) Название журнала счета
  • start_date (string) – Начальная дата оборотно-сальдовой ведомости в формате ISO: YYYY-MM-DD
  • end_date (string) – Конечная дата оборотно-сальдовой ведомости в формате ISO: YYYY-MM-DD
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты данных оборотно-сальдовых ведомостей
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных оборотно-сальдовой ведомости

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля Тип Описание
account_id integer Идентификатор счета
name string Имя счета
balances array/null Объекты оборотно-сальдовой ведомости за периоды

Поля данных оборотно-сальдовой ведомости за период

У каждого объекта в массиве balances есть следующие поля:

Имя поля Тип Описание
period string Наименование периода
beginning_dr integer Начальное сальдо по дебету
beginning_cr integer Начальное сальдо по кредиту
debits integer Оборот по дебету
credits integer Оборот по кредиту
ending_dr integer Конечное сальдо по дебету
ending_cr integer Конечное сальдо по кредиту

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted

Подробнее см. Коды ошибок.