GetOrCreateRoamingOrganizationByFnsParticipantId
Находит или создает в Диадоке роуминговую организацию по идентификатору участника ЭДО.
POST /GetOrCreateRoamingOrganizationByFnsParticipantId
Параметры запроса
myBoxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать идентификатор участника ЭДО, представленный структурой GetOrCreateRoamingOrganizationByFnsParticipantIdRequest.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.405— используется неподходящий HTTP-метод.409— не удалось найти или создать роуминговую организацию с указанным идентификатором участника ЭДО.415— тип содержимого запроса не поддерживается.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит данные организации, представленные структурой Organization.
Метод работает по следующим правилам:
- Поиск осуществляется только по роуминговым организациям: первые 3 символа идентификатора участника ЭДО не должны быть равны
2BM(код оператора Контур.Диадок). - Если в Диадоке уже есть роуминговая организация с указанным идентификатором участника ЭДО, метод вернет ее данные.
- Если в Диадоке не найдена роуминговая организация с указанным идентификатором участника ЭДО, метод сделает запрос в базу ФНС и по полученной информации создаст роуминговый ящик для этой организации (со свойством
IsRoaming = true) и вернет ее данные.
Значения полей Sociability, Comment и ReadyForEpdStatus в структуре Organization у роуминговых организаций Диадок получает из базы ФНС и обновляет раз в сутки.
Чтобы найти ящик в Диадоке или получить данные уже существующей организации по идентификатору без создания новой, используйте метод GetOrganization.
Чтобы найти идентификатор участника ЭДО в роуминге по ИНН и КПП, используйте метод SearchFnsParticipants.
Примеры использования
Пример HTTP-запроса:
POST /GetOrCreateRoamingOrganizationByFnsParticipantId?myBoxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json
Пример тела запроса:
{
"FnsParticipantId": "2LT-123456789"
}
Пример тела ответа:
{
"OrgIdGuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"OrgId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"Inn": "7707083893",
"Kpp": "770701001",
"FullName": "Общество с ограниченной ответственностью \"Роуминговый контрагент\"",
"ShortName": "ООО \"Роуминговый контрагент\"",
"JoinedDiadocTreaty": true,
"Boxes": [
{
"BoxId": "b2c3d4e5f6789012abcdef3456789012@diadoc.ru",
"BoxIdGuid": "b2c3d4e5-f678-9012-abcd-ef3456789012",
"Title": "ООО \"Роуминговый контрагент\"",
"InvoiceFormatVersion": "v5_02",
"EncryptedDocumentsAllowed": false
}
],
"Ogrn": "1027700132195",
"FnsParticipantId": "2LT-123456789",
"Address": {
"RussianAddress": {
"ZipCode": "117312",
"Region": "77",
"City": "Москва",
"Street": "Вавилова",
"Building": "19"
},
"AddressCode": ""
},
"Departments": [],
"IfnsCode": "5257",
"IsPilot": false,
"IsActive": true,
"IsTest": false,
"IsBranch": false,
"IsRoaming": true,
"IsEmployee": false,
"InvitationCount": 0,
"SearchCount": 0,
"Sociability": "CounteragentsOnly",
"IsForeign": false,
"HasCertificateToSign": false,
"OrganizationType": "Juridical",
"IsOwner": false,
"ReadyForEpdStatus": "UndefinedEpdStatus",
"Comment": ""
}
См. также
Инструкции:
Методы для работы с организациями:
- GetBox — возвращает данные ящика по указанному идентификатору
- GetMyOrganizations — возвращает список организаций, в которых пользователь является сотрудником
- GetOrCreateRoamingOrganizationByFnsParticipantId — находит или создает роуминговую организацию по идентификатору участника ЭДО
- GetOrganization — возвращает данные организации по указанному идентификатору
- GetOrganizationFeatures — возвращает список дополнительных функций организации
- GetOrganizationsByInnKpp — возвращает данные организации по ИНН
- GetOrganizationsByInnList (V2) — возвращает список организаций и их статус партнерства по списку ИНН
- GetOrganizationsByForeignTaxpayerCode — возвращает данные организации по коду иностранного налогоплательщика
- GetResolutionRoutes — возвращает список всех неудаленных включенных маршрутов согласования для указанного ящика
- Register — находит или создает в Диадоке организацию по сертификату и добавляет владельца сертификата в сотрудники этой организации
- RegisterConfirm — подтверждает владение закрытым ключом сертификата для регистрации в организацию
- SearchFnsParticipants — ищет участников ЭДО в роуминге по ИНН, КПП или идентификатору участника ЭДО
- SendFnsRegistrationMessage — отправляет заявление участника ЭДО для указанного ящика
Методы для работы с роумингом:
- GetOrCreateRoamingOrganizationByFnsParticipantId — находит или создает роуминговую организацию по идентификатору участника ЭДО
- GetRoamingOperators — возвращает список операторов ЭДО и их функции
- SearchFnsParticipants — ищет участников ЭДО в роуминге по ИНН, КПП или идентификатору участника ЭДО