Общие требования

Все запросы требуют заголовок Service-Key с вашим API-ключом.
ИНН пользователя, который отправляет запрос — должен существовать в системе.
Все файлы должны быть в формате PDF.

См. спецификацию: Redoc

1. Получение документа по ID

Метод: api/recon/get_document_by_id

Тип запроса: GET

Описание: Получение документа по его айди и ИНН пользователя. Если документ найден и ИНН отправителя привязан, возвращается ссылка на файл. В противном случае возвращается ошибка.

Query Parameters

Параметр	Обязательный	Тип	Описание
reconciliation_id	Да	integer	ID Документа
user_inn	Да	string	ИНН пользователя

Header Parameters

Параметр	Обязательный	Тип	Описание
Service-Key	Да	string	API-ключ сервиса

Ответы

Успешный ответ

HTTP/1.1 200 OK
Content-Type: application/json

{
  "file_url": "https://.../document.pdf"
}

Ошибки

HTTP/1.1 4XX/5XX
Content-Type: application/json

{
  "error": "Не найден документ или ИНН отправителя не зарегистрирован"
}

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

Метод: api/recon/get_document_list

Тип запроса: GET

Описание: Получение списка документов, к которым имеет доступ отправитель, по его ИНН.

Query Parameters

Параметр	Обязательный	Тип	Описание
user_inn	Да	string	ИНН пользователя

Header Parameters

Параметр	Обязательный	Тип	Описание
Service-Key	Да	string	API-ключ сервиса

Ответы

Успешный ответ

HTTP/1.1 200 OK
Content-Type: application/json

Список документов с ID, названием, ссылкой на файл и статусом подписания

Ошибка

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": "DOCUMENTS_NOT_FOUND"
}

3. Загрузка нового документа

Метод: api/recon/process_document

Тип запроса: POST

Описание: Загрузка нового документа (акта сверки) в систему. Проверяется ИНН отправителя.

Header Parameters

Параметр	Обязательный	Тип	Описание
Service-Key	Да	string	API-ключ сервиса

Body Parameters (multipart/form-data)

Параметр	Обязательный	Тип	Описание
reconciliation_name	Да	string	Название акта
reconciliation_number	Да	string	Номер акта
company_inn	Нет	string	ИНН принимающей компании
main_accountant_inn	Да	string	ИНН отправляющего человека
receiver_accountant_inn	Нет	string	ИНН принимающего человека
reconciliation_file	Да	binary	PDF-файл документа
receiver_company_inn	Нет	string	ИНН принимающей компании

Для отправки конкретному пользователю указывайте receiver_accountant_inn и company_inn (Для отправки конкретному пользователю, вам нужно знать его инн)

Для отправки на инн компании указывайте receiver_company_inn. В этом случае документ будет доставлен пользователю, который первым зарегистрировал компанию в системе (самый старший участник).

Ответы

Успешный ответ

HTTP/1.1 201 Created
Content-Type: application/json

Документ успешно загружен

Ошибки

HTTP/1.1 400 Bad Request
Ошибка загрузки (файл не отправлен или неверный формат)

HTTP/1.1 403 Forbidden
ИНН отправителя не зарегистрирован в системе

Важные заметки

Service-Key обязателен во всех запросах. Для получения ключа обратитесь к администратору.
Проверяется только ИНН отправителя документа.
Все файлы должны быть в формате PDF.