Перейти к основному содержанию
POST
Разобрать банковскую выписку в предложения

Авторизации

tungo.session_token
string
cookie
обязательно

Сессия кабинета: cookie ставит вход через /v1/auth/* (Better Auth), браузер шлёт её сам — фронтенду кабинета ничего добавлять не нужно (fetch с credentials: 'include'). За HTTPS имя cookie — __Secure-tungo.session_token. Сессия кончилась — 401 authentication_error: отправить на вход.

Заголовки

Idempotency-Key
string

Ключ повтора (например, UUID): повтор с тем же ключом и тем же телом не выполняет действие второй раз, а отдаёт прежний ответ

Maximum string length: 255

Параметры пути

co
string
обязательно

id компании, co_… — из GET /v1/companies

Тело

application/json

Банковская выписка, которую разобрать в предложения

text
string

Содержимое выписки в формате 1CClientBankExchange («выгрузка для 1С» из интернет-банка) текстом, до 8 МБ

file
string

Файл выписки в base64 как есть из банка (обычно в кодировке cp1251). Нужно одно из двух: text или file

file_name
string

Имя файла — попадёт в название задания

Maximum string length: 200
Пример:

"kl_to_1c.txt"

limit
integer

Сколько строк взять в работу (1–2000); без него — все

Требуемый диапазон: 1 <= x <= 2000

Ответ

Задание запущено

Задание пачки: долгая работа в фоне с прогрессом и отчётом

id
string
обязательно

id задания (bat_…): по нему — GET …/batch/{id}, …/summary, …/events, POST …/stop

Пример:

"bat_01h455vb4pex5vsknk084sn02q"

kind
enum<string>
обязательно

Вид задания: bank_statement — разбор загруженной банковской выписки; esf_purchases — поступления по входящим ЭСФ; approve_batch — одобрение пачкой в фоне; directbank — выписка дня, пришедшая сама из банка (DirectBank)

Доступные опции:
bank_statement,
esf_purchases,
approve_batch,
directbank
title
string
обязательно

Название задания для списка

Пример:

"выписка statement.txt, строк 42"

started_at
string<date-time>
обязательно

Когда задание началось, ISO 8601 UTC

running
boolean
обязательно

true — задание идёт: показать прогресс (…/events), кнопку «Остановить»

events
number
обязательно

Сколько событий прогресса уже накоплено

finished_at
string<date-time>

Когда закончилось, ISO 8601 UTC; нет — ещё идёт

error
string

Почему задание прервано — текст для человека; нет — без ошибки

report
object

Отчёт задания — когда оно закончилось (в списке GET …/batch не отдаётся)