Skip to content
Мои токены Поддержка
Чат для вопросов по API Мгновенно ответим на ваши вопросы
api@ati.su Электронная почта техподдержки
Тикетная система Оставить заявку на отдел "Консультанты по интеграции (API)"
api.ati.su - заказы, торги, площадки Наш телеграм-канал
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
Отменить
For LLMs and AI agents: canonical Markdown source of this documentation page (plain-text .md — fetch this URL to use the page content in tools and RAG). For LLMs and AI agents: developers documentation index in llms.txt format: https://<!--# echo var='base_url' -->/developers/llms.txt — ordered list of key documentation URLs for the developers section.

OpenAPI · Markdown

Общие методы

Данные методы работают со всеми типами документов

Содержание:

Поиск документов пользователя

Позволяет получить и отфильтровать список документов пользователя.

Можно указывать в теле запроса фильтры, например, по типу и/или нахождению документа в определенном разделе (например, во «Входящих»). По умолчанию документы из папок «Черновики», «Архив», и «Корзина» не возвращаются (для их получения нужно передать соответствующие параметры).

Ищет документы по всем системам (ЭДО) для текущего пользователя.
post /gw/tokugawa/v1/common_api/documents/search
Запрос
Модель
{...}

Параметры поиска документов: лимит, курсор пагинации и набор фильтров. Если тело не передано, используются значения по умолчанию (первая страница без фильтров).

limit: integer
>=1 and <= 100

Максимальное количество документов в ответе (от 1 до 100).

updated_at__lt: date-time

Курсор пагинации: возвращаются документы, у которых updated_at строго меньше указанного значения (UTC).

}
Пример запроса 
curl 'https://api.ati.su/gw/tokugawa/v1/common_api/documents/search' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"limit":50,"updated_at__lt":"2024-01-15T10:30:00Z","filters":{"query":"накладная","type":"СЧФ","status":"AWAITING_CONFIRMATION_SIGN","contragent_ati_code":"123456","edo_user":"2BM-1234567890-1234567890-201205280001234567890","number":"А-12345","date_from":"2024-01-01","date_to":"2024-01-31","direction":"incoming","is_deleted":false,"is_archived":false,"is_template":false}}'
Ответ
200 Successful Response
Модель
{...}

Ответ на запрос поиска документов (страница результатов с пагинацией).

total*: integer

Общее количество документов, удовлетворяющих фильтрам.

total_remaining*: integer

Количество документов, оставшихся после текущей страницы (для пагинации по курсору updated_at__lt). 0 означает, что это последняя страница.

}
Пример
{...}
"total":1250,
"total_remaining":1200,
"result":[...]
{...}
"id":"5f3c8e2a1b2c3d4e5f6a7b8c",
"is_riak":false,
"direction":"incoming",
"number":"А-12345",
"date":"2024-01-15",
"type":"УПД. Счет-фактура",
"status":"signed",
"is_read":true,
"updated_at":"2024-01-15T10:30:00.000000",
"contragent":{...},
"ati_code":"123456",
"name":"ООО «Ромашка»"
},
"comments":{...},
"count":3,
"tail":{...}
"name":"Иван Иванов",
"text":"Документ подписан",
"timestamp":"2024-01-15T10:30:00.000000"
}
},
"flags":[...],
"string"
],
"highlight":"failure",
"signs":{...},
"user":{...},
"title":"Иванов И.И.",
"valid_from":"2024-01-01",
"valid_until":"2025-01-01"
},
"contragent":{...}
"title":"Иванов И.И.",
"valid_from":"2024-01-01",
"valid_until":"2025-01-01"
}
},
"template_name":"Типовой договор оказания услуг",
"roaming_provider_id":"2BM",
"file_extension":"xml"
}
]
}
422 Ошибка валидации параметров или тела запроса.
Модель
{...}

Ответ 422 Unprocessable Entity: тело запроса не прошло валидацию.

error*: boolean

Признак ошибки (всегда true в ответах 422).

}
Пример
{...}
"error":true,
"detail":{...},
"code":"unprocessable_entity",
"description":"Ошибка обработки тела запроса."
},
"extra":[...]
{...}
"loc":[...],
"string"
],
"msg":"field required",
"type":"value_error.missing"
}
]
}

Перенос документов в папку «Архив» или «Корзина» либо восстановление из них

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

«Action» может принимать значения «trash», «archive», «restore_from_trash» или «restore_from_archive». При невозможности выполнения действия возвращается id документа(-ов), по которым действие не произведено.

Массово перемещает документы в корзину/архив или восстанавливает их.
post /gw/tokugawa/v1/common_api/documents/{action}
Запрос
Модель
[string]

Список идентификаторов документов (Message.id), над которыми нужно выполнить action.

Пример запроса 
curl 'https://api.ati.su/gw/tokugawa/v1/common_api/documents/{action}' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '["5f3c8e2a1b2c3d4e5f6a7b8c","5f3c8e2a1b2c3d4e5f6a7b8d"]'
Ответ
200 Successful Response
Модель
[string]
Пример
[...]
"string"
]
422 Ошибка валидации параметров или тела запроса.
Модель
{...}

Ответ 422 Unprocessable Entity: тело запроса не прошло валидацию.

error*: boolean

Признак ошибки (всегда true в ответах 422).

}
Пример
{...}
"error":true,
"detail":{...},
"code":"unprocessable_entity",
"description":"Ошибка обработки тела запроса."
},
"extra":[...]
{...}
"loc":[...],
"string"
],
"msg":"field required",
"type":"value_error.missing"
}
]
}