GetOrganization
Возвращает данные организации по указанному идентификатору.
GET /GetOrganization
Параметры запроса
orgId— идентификатор организации. Необязательный параметр.boxId— идентификатор ящика организации в формате GUID. Необязательный параметр.fnsParticipantId— идентификатор участника электронного документооборота. Необязательный параметр.inn— ИНН организации. Необязательный параметр.kpp— КПП организации. Необязательный параметр.foreignTaxpayerCode— код иностранного налогоплательщика. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.403— запрос сделан от заблокированного клиента API.404— не найдена организация с указанным идентификатором или реквизитом, или найдено несколько организаций с указанным ИНН или кодом иностранного налогоплательщика.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит данные организации, представленные структурой Organization.
В строке запроса должен присутствовать только один из параметров: orgId, boxId, fnsParticipantId, inn или foreignTaxpayerCode. Параметр kpp учитывается, если запрос осуществляется с указанием inn.
При поиске по ИНН или коду иностранного налогоплательщика метод возвращает ответ, только если в Диадоке найдена одна организация с указанным реквизитом, иначе метод вернет ошибку 404 (Not Found). Чтобы получить данные конкретной организации при поиске по ИНН, укажите параметр kpp.
Для получения информации о нескольких ящиках с одним реквизитом используйте:
- метод GetOrganizationsByInnKpp — для поиска по ИНН;
- метод GetOrganizationsByForeignTaxpayerCode — для поиска по коду иностранного налогоплательщика.
Чтобы найти или создать роуминговую организацию по идентификатору участника ЭДО, используйте метод GetOrCreateRoamingOrganizationByFnsParticipantId.
При поиске по ИНН и КПП, если организация с таким КПП не найдена, то метод вернет данные головной организации с указанным ИНН.
Примеры использования
Пример HTTP-запроса:
GET /GetOrganization?boxid={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"OrgIdGuid": "f5758a05-63d1-435e-bc49-79a801d7c275",
"OrgId": "f5758a05-63d1-435e-bc49-79a801d7c275",
"Inn": "1839264655",
"Kpp": "732644841",
"FullName": "Организация 1",
"ShortName": "Организация 1",
"JoinedDiadocTreaty": true,
"Boxes": [
{
"BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"BoxIdGuid": "09ae254c-5cd0-4082-84de-7ccb46d86f82",
"Title": "Организация 1",
"InvoiceFormatVersion": "v5_02",
"EncryptedDocumentsAllowed": true
}
],
"Ogrn": "3071205010489",
"FnsParticipantId": "2BM-1839264655-732644841-202407101103418496883",
"Address": {
"RussianAddress": {
"ZipCode": "987654",
"Region": "66",
"City": "Екатеринбург",
"Street": "Павлодарская",
"Building": "17"
},
"AddressCode": ""
},
"FnsRegistrationDate": "05.12.2024",
"Departments": [
{
"DepartmentId": "6d710055-9b5d-4bc0-ba2f-9e54adda034e",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Дочернее подразделение",
"Abbreviation": "ДП",
"Address": {
"RussianAddress": {
"Region": ""
},
"AddressCode": ""
},
"IsDisabled": false
},
{
"DepartmentId": "b651ed54-04d8-4ca8-99b5-960fba733147",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Подразделение 1",
"Abbreviation": "П1",
"Address": {
"RussianAddress": {
"Region": ""
},
"AddressCode": ""
},
"IsDisabled": false
},
{
"DepartmentId": "32cb2cd3-ed3a-403a-b220-7dfd59c757db",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Подразделение 2",
"Abbreviation": "П2",
"Address": {
"RussianAddress": {
"Region": ""
},
"AddressCode": ""
},
"IsDisabled": false
}
],
"IfnsCode": "4312",
"IsPilot": false,
"IsActive": true,
"IsTest": false,
"IsBranch": false,
"IsRoaming": false,
"IsEmployee": false,
"InvitationCount": 0,
"SearchCount": 0,
"Sociability": "AllOrganizations",
"IsForeign": false,
"HasCertificateToSign": true,
"OrganizationType": "Juridical",
"IsOwner": false,
"Comment": ""
}
См. также
Инструкции:
Методы для работы с организациями:
- GetBox — возвращает данные ящика по указанному идентификатору
- GetMyOrganizations — возвращает список организаций, в которых пользователь является сотрудником
- GetOrCreateRoamingOrganizationByFnsParticipantId — находит или создает роуминговую организацию по идентификатору участника ЭДО
- GetOrganization — возвращает данные организации по указанному идентификатору
- GetOrganizationFeatures — возвращает список дополнительных функций организации
- GetOrganizationsByInnKpp — возвращает данные организации по ИНН
- GetOrganizationsByInnList (V2) — возвращает список организаций и их статус партнерства по списку ИНН
- GetOrganizationsByForeignTaxpayerCode — возвращает данные организации по коду иностранного налогоплательщика
- GetResolutionRoutes — возвращает список всех неудаленных включенных маршрутов согласования для указанного ящика
- Register — находит или создает в Диадоке организацию по сертификату и добавляет владельца сертификата в сотрудники этой организации
- RegisterConfirm — подтверждает владение закрытым ключом сертификата для регистрации в организацию
- SearchFnsParticipants — ищет участников ЭДО в роуминге по ИНН, КПП или идентификатору участника ЭДО
- SendFnsRegistrationMessage — отправляет заявление участника ЭДО для указанного ящика