Перейти к основному содержимому

SearchFnsParticipants

Ищет участников электронного документооборота в роуминге по ИНН, КПП или идентификатору участника ЭДО.

POST /SearchFnsParticipants

Параметры запроса

  • myBoxId — идентификатор ящика организации в формате GUID.

Заголовки запроса

Тело запроса

Тело запроса должно содержать параметры поиска, представленные структурой SearchFnsParticipantsRequest.

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен.
  • 405 — используется неподходящий HTTP-метод.
  • 409 — организация, от имени которой выполняется запрос, не зарегистрирована в ФНС и у нее нет идентификатора участника ЭДО.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит результат поиска, представленный структурой SearchFnsParticipantsResponse.

Метод работает по следующим правилам:

  • Поиск осуществляется только по роуминговым организациям: первые 3 символа идентификатора участника ЭДО не должны быть равны 2BM (код оператора Контур.Диадок).
  • В теле запроса в структуре SearchFnsParticipantsRequest должен быть заполнен хотя бы один из наборов параметров: Inn или FnsParticipantId.
  • Если одновременно указаны ИНН и идентификатор участника ЭДО, поиск будет производится только по идентификатору участника ЭДО.
  • При поиске юридического лица (ИНН состоит из 10 символов) обязательно указывать КПП, иначе метод вернет ошибку 400 (Bad Request).
  • При поиске по ИНН и КПП из результата исключаются организации Диадока: в ответе остаются только роуминговые участники ЭДО.
  • Если абонент не найден в ФНС или запретил доступ к своим данным, метод вернет 200 (OK) с соответствующим статусом в структуре SearchFnsParticipantsResponse, а список Participants будет пустым.

Найденный идентификатор участника ЭДО можно использовать для поиска или создания роуминговой организации методом GetOrCreateRoamingOrganizationByFnsParticipantId.

Примеры использования

Пример HTTP-запроса:

POST /SearchFnsParticipants?myBoxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

Пример тела запроса:

{
"Inn": "7707083893",
"Kpp": "770701001"
}

Пример тела ответа:

{
"Status": "OkFnsParticipantSearchStatus",
"Participants": [
{
"FnsParticipantId": "2LT-123456789",
"Inn": "7707083893",
"Kpp": "770701001",
"FullName": "Общество с ограниченной ответственностью \"Роуминговый контрагент\""
}
]
}

См. также

Методы для работы с роумингом:

  • GetOrCreateRoamingOrganizationByFnsParticipantId — находит или создает роуминговую организацию по идентификатору участника ЭДО
  • GetRoamingOperators — возвращает список операторов ЭДО и их функции
  • SearchFnsParticipants — ищет участников ЭДО в роуминге по ИНН, КПП или идентификатору участника ЭДО

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года