Skip to content
Мои токены Поддержка
Чат для вопросов по API Мгновенно ответим на ваши вопросы
api@ati.su Электронная почта техподдержки
Тикетная система Оставить заявку на отдел "Консультанты по интеграции (API)"
api.ati.su - заказы, торги, площадки Наш телеграм-канал
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
Отменить

API роумингового неформализованного документа

Роуминговый неформализованный (РНФ) документ - создание из редактора

Последовательность вызовов для создания черновика роумингового неформализованного документа (РНФ)

  1. Создание и/или сохранение документа
  2. Обновление роуминговых участников электронного документооборота (ЭДО)
  3. Получение роуминговых участников электронного документооборота (ЭДО)

Последовательность вызовов для отправки РНФ документа

  1. Конвертация документа в формат роуминга (pdf)
  2. Получение файла РНФ документа
  3. Отправка РНФ документа

Роуминговый неформализованный (РНФ) документ - создание из файла

Последовательность вызовов для создания РНФ документооборота

  1. Создание РНФ документооборота
  2. Получение метаданных документооборота

Последовательность вызовов для отправки РНФ документа

  1. Получение файла РНФ документа
  2. Отправка РНФ документа

Последовательность вызовов для создания и отправки извещения о получении (ИОП) РНФ

  1. Создание извещения о получении РНФ документа
  2. Отправка извещения о получении РНФ документа

Последовательность вызовов для создания и отправки ответной подписи РНФ

  1. Получение файла РНФ документа
  2. Подписание РНФ документа получателем с использованием откреплённой подписи

Последовательность вызовов для создания и отправки уведомления об уточнении (УОУ) РНФ

  1. Создание уведомления об уточнении РНФ документа
  2. Отправка уведомления об уточнении РНФ документа

Получение информации по РНФ документу

  1. Получение истории документооборота
  2. Получение списка ID превью

Роуминговые неформализованные (РНФ) документы из редактора

Создание черновика РНФ документа

Позволяет создать черновик документа или обновить существующий документ. В методе передаётся общая метаинформация о документе. Список доступных doctype указан в разделе.

Создание и/или сохранение документа
post /gw/atidocs/api/2.0/documents
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/atidocs/api/2.0/documents' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Документ отправлен
Модель
{...}
ok: boolean
result: string

id документа

}
Пример
{...}
"ok":false,
"result":"string"
}
400 Некорректный запрос
Модель
null
Пример
null
404 Документ не найден
Модель
null
Пример
null

Обновление роуминговых участников электронного документооборота (ЭДО)

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

Обновление роуминговых участников документооборота
put /gw/native_informal_documents/v4/documents/{document_id}/roaming-participants
Запрос
Модель
{...}
sender_edo_id: string (nullable)

ID ЭДО пользователя отправителя документа

receiver_edo_id: string (nullable)

ID ЭДО пользователя получателя документа

receiver_edo_name: string (nullable)

Имя получателя документооборота

}
Пример запроса 
curl 'https://api.ati.su/gw/native_informal_documents/v4/documents/{document_id}/roaming-participants' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"sender_edo_id":"string","receiver_edo_id":"string","receiver_edo_name":"string"}'
Ответ
200 ID документа
Модель
{...}
id*: string
}
Пример
{...}
"id":"string"
}
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение роуминговых участников электронного документооборота (ЭДО)

Получение информации о роуминговых участниках документооборота
get /gw/native_informal_documents/v4/documents/{document_id}/roaming-participants
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/native_informal_documents/v4/documents/{document_id}/roaming-participants' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Информация о роуминговых участниках документооборота
Модель
{...}
sender_edo_id: string (nullable)

ID ЭДО пользователя отправителя документа

receiver_edo_id: string (nullable)

ID ЭДО пользователя получателя документа

receiver_edo_name: string (nullable)

Имя получателя документооборота

}
Пример
{...}
"sender_edo_id":"string",
"receiver_edo_id":"string",
"receiver_edo_name":"string"
}
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Конвертация документа в формат роуминга (pdf)

Позволяет сконвертировать XML-файл документа в формат (pdf), подходящий для отправки в роуминг.

Конвертация документа в формат роуминга
post /gw/native_informal_documents/v4/documents/{document_id}/convert-to-roaming
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/native_informal_documents/v4/documents/{document_id}/convert-to-roaming' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 ID документооборота в системе роуминговых документов
Модель
{...}
id*: string
}
Пример
{...}
"id":"string"
}
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение файла РНФ документа

Позволяет получить файл РНФ документа, для которого нужно будет сформировать подпись для последующей его отправки.

Получение файла РНФ документа
get /gw/roaming_informal_documents/v4/docflows/{docflow_id}/body
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/body' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Файл РНФ документа
Модель
{missing-type-info}
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка РНФ документа

Позволяет отправить РНФ документ контрагенту в роуминге. При отправке необходимо указать строку подписи прикладываемого файла РНФ документа в формате base64, а также номер МЧД (если подписание при помощи сертификата физического лица).

После успешной отправки проставляется статус документооборота «waiting_for_roaming_response» («Ожидается ответ контрагента»).

Отправка роумингового неформализованного документа
post /gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
204 Успешная отправка роумингового неформализованного документа
Модель
null
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Роуминговые неформализованные документы из файла

Создание РНФ документооборота

Позволяет создать РНФ документооборот без какого-либо тела. С этого момента создатель РНФ документа может получать метаинформацию по нему.

Получателем РНФ документа может быть только роуминговый контрагент. Между отправителем и получателем РНФ документа должна быть настроена роуминговая связь.

Создание документооборота
post /gw/roaming_informal_documents/v4/docflows
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
201 ID документооборота
Модель
{...}
id*: string

ID документооборота

}
Пример
{...}
"id":"string"
}
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение метаданных документооборота

Позволяет получать метаданные документооборота только его создателю.

Получение метаданных документооборота
get /gw/roaming_informal_documents/v4/docflows/{docflow_id}/meta
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/meta' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Обогащенные метаданные документооборота
Модель
{...}
doctype*: enum
[upd_dop, upd_schf, upd_schfdop]

Тип документа

number: string (nullable)

Номер документа

date: date (nullable)

Дата документа

id*: string

ID документооборота

state*: enum
[draft, waiting_for_roaming_provider_confirmation, waiting_for_roaming_user_response, waiting_for_read_confirmation, waiting_for_title_2, clarification_notification_requested, done, roaming_error, receiver_refused_to_sign, annulment_requested, annulment_done]

Статус документооборота

created_at*: date-time

Дата создания документооборота

updated_at*: date-time

Дата обновления документооборота

flags*: [enum]
[can_be_archived, can_be_deleted, can_be_unarchived, can_be_undeleted, can_be_annulled, needs_read_confirmation, edo_can_be_signed]

Флаги доступности действий над документооборотом

}
Пример
{...}
"doctype":"upd_dop",
"number":"string",
"date":"1970-01-01",
"id":"string",
"state":"draft",
"created_at":"1970-01-01T00:00:00.000Z",
"updated_at":"1970-01-01T00:00:00.000Z",
"sender":{...},
"signature":{...},
"certificate_id":"string",
"mchd_id":"string"
},
"user_type":"string",
"ati_id":"string",
"firm_name":"string",
"contact_id":0,
"contact_name":"string",
"edo_user_id":"string"
},
"receiver":{...},
"signature":{...},
"certificate_id":"string",
"mchd_id":"string"
},
"user_type":"string",
"ati_id":"string",
"firm_name":"string",
"contact_id":0,
"contact_name":"string",
"edo_user_id":"string"
},
"flags":[...]
"can_be_archived"
]
}
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение файла РНФ документа

Позволяет получить файл РНФ документа, для которого нужно будет сформировать подпись для последующей его отправки.

Получение файла РНФ документа
get /gw/roaming_informal_documents/v4/docflows/{docflow_id}/body
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/body' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Файл РНФ документа
Модель
{missing-type-info}
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка РНФ документа

Позволяет отправить РНФ документ роуминговому контрагенту. При отправке необходимо указать строку подписи прикладываемого файла РНФ документа в формате base64, а также номер МЧД (если подписание при помощи сертификата физического лица).

После успешной отправки проставляется статус документооборота «waiting_for_roaming_response» («Ожидается ответ контрагента»)

Отправка роумингового неформализованного документа
post /gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
204 Успешная отправка роумингового неформализованного документа
Модель
null
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Работа с извещением о получении (ИОП) РНФ документа

Создание извещения о получении документа

Извещение о получении - служебный документ, регламентированный приказом 14Н. ИОП формируется при получении РНФ документа и гарантирует, что документ доставлен до получателя без ошибок.

В ответе метода формируется XML-файл, для которого нужно будет сформировать подпись для последующей его отправки. После подписания полученного XML-файла его нельзя изменять (если изменение произошло, то нужно будет снова подписать обновленный XML-файл)

Создание извещения о получении документа
post /gw/roaming_informal_documents/v4/docflows/{docflow_id}/title-1-read-confirmation
Запрос
Модель
{...}
}
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/title-1-read-confirmation' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"signer_info":{"first_name":"string","last_name":"string","patronymic":"string","position":"string"},"mchd_info":{"mchd_id":"string","mchd_issued_at":"1970-01-01T00:00:00.000Z"}}'
Ответ
200 Файл Извещения о получении документа
Модель
{missing-type-info}
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка извещения о получении РНФ документа

При отправке необходимо указать строку подписи прикладываемого XML-файла ИОП в формате base64, а также номер МЧД (если подписание при помощи сертификата физического лица).

Данные в теле ИОП валидируются согласно Приказу ФНС РФ от 30.01.2012 N ММВ-7-6/36@.

После успешной отправки статус документооборота изменится с «waiting_for_roaming_response» («Ожидается ответ контрагента») на

  • «done» («Документооборот завершен»), если РНФ документ без запроса решения
  • «waiting_for_response_signature» («Ожидается ответная подпись»), если РНФ документ с запросом решения
Отправка извещения о получении роумингового неформализованного документа
post /gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1-read-confirmation/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1-read-confirmation/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
204 Успешная отправка извещения о получении роумингового неформализованного документа
Модель
null
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Работа с ответной подписью РНФ документа

Получение файла РНФ документа

Позволяет получить файл РНФ документа, чтобы сформировать для него открепленную подпись.

Получение файла РНФ документа
get /gw/roaming_informal_documents/v4/docflows/{docflow_id}/body
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/body' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Файл РНФ документа
Модель
{missing-type-info}
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Подписание РНФ документа получателем с использованием откреплённой подписи

Позволяет получателю РНФ документа подписать его с использованием открепленной подписи. После успешной отправки статус документооборота изменится с «waiting_for_response_signature» («Ожидается ответная подпись») на «done» («Документооборот завершен»).

Подписание роумингового неформализованного документа получателем с использованием открепленной подписи
post /gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-2/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-2/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
204 Успешное подписание роумингового неформализованного документа от лица получателя с использованием открепленной подписи
Модель
null
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Работа с уведомлением об уточнении (УОУ) РНФ документа

Создание уведомления об уточнении РНФ документа

Если получатель обнаружил в полученном РНФ документе ошибку, он может направить уведомление об уточнении РНФ документа. При формировании УОУ следует указать причину запроса УОУ.

УОУ может запросить только получатель РНФ документа.

УОУ можно запросить:

  • после отправки РНФ документа
  • после подписания ИОП

В ответе метода формируется XML-файл, для которого нужно будет сформировать подпись для последующей его отправки. После подписания полученного XML-файла его нельзя изменять (если изменение произошло, то нужно будет снова подписать обновленный XML-файл)

Создание Уведомления об уточнении документа
post /gw/roaming_informal_documents/v4/docflows/{docflow_id}/clarification-notification
Запрос
Модель
{...}
}
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/clarification-notification' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"signer_info":{"first_name":"string","last_name":"string","patronymic":"string","position":"string"},"mchd_info":{"mchd_id":"string","mchd_issued_at":"1970-01-01T00:00:00.000Z"}}'
Ответ
200 Файл Уведомления об уточнении документа
Модель
{missing-type-info}
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка уведомления об уточнении документа

При отправке необходимо указать строку подписи прикладываемого XML-файла УОУ в формате base64, а также номер МЧД (если подписание при помощи сертификата физического лица).

Данные в теле УОУ валидируются согласно Приказу ФНС РФ от 30.01.2012 N ММВ-7-6/36@.

После успешной отправки статус документооборота изменится с того, который был до запроса УОУ, на «clarification_notification_requested» («На уточнении»)

Отправка уведомления об уточнении роумингового неформализованного документа
post /gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1-clarification-notification/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1-clarification-notification/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
204 Успешная отправка уведомления об уточнении роумингового неформализованного документа
Модель
null
Пример
null
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение информации по РНФ документу

Получение истории РНФ документа

Получение истории документооборота
get /gw/roaming_informal_documents/v4/docflows/{docflow_id}/history
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/history' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 История изменений статусов документооборота
Модель
[]
Пример
[...]
{...}
"document_type":"title-1",
"action_type":"start_sending",
"actor_type":"sender_user",
"created_at":"1970-01-01T00:00:00.000Z"
}
]
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение списка ID превью

Получение списка ID превью
get /gw/roaming_informal_documents/v4/docflows/{docflow_id}/preview
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/roaming_informal_documents/v4/docflows/{docflow_id}/preview' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Список ID превью
Модель
{...}
pages*: integer

Количество страниц

pattern*: string

Шаблон URL для запроса изображения страницы, например '/folder/page_%PAGE%.png'

}
Пример
{...}
"pages":0,
"pattern":"string"
}
422 Ошибка валидации
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}