GetOrganization
Возвращает данные организации по указанному идентификатору.
- GET /GetOrganization
- Query Parameters:
orgId – идентификатор организации. Необязательный параметр.
boxId – идентификатор ящика организации. Необязательный параметр.
fnsParticipantId – идентификатор участника электронного документооборота. Необязательный параметр.
inn – ИНН организации. Необязательный параметр.
kpp – КПП организации. Необязательный параметр.
- Request Headers:
Authorization – данные, необходимые для авторизации. В заголовке нужно передать
DiadocAuth ddauth_api_client_id
.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorization
или в этом заголовке содержатся некорректные авторизационные данные.404 Not Found – не найдена организация с указанным идентификатором.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит данные организации, представленные структурой Organization.
В строке запроса должен присутствовать только один из параметров: orgId
, boxId
, fnsParticipantId
или inn
. Параметр kpp
учитывается, если запрос осуществляется с указанием inn
.
При поиске по ИНН метод возвращает ответ, только если в Диадоке найдена одна организация с указанным ИНН, иначе метод вернет ошибку 403 (Not Found)
. Для получения информации о конкретной организации укажите параметр kpp
. Для получения информации о нескольких ящиках с одним ИНН рекомендуем пользоваться методом GetOrganizationsByInnKpp.
При поиске по ИНН и КПП, если организация с таким КПП не найдена, то метод вернет данные головной организации с указанным ИНН.
Примеры использования
Пример HTTP-запроса:
GET /GetOrganization?boxid={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Пример тела ответа:
{
"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
}
См. также
- Инструкции:
- Методы для работы с организациями:
GetMyOrganizations — возвращает список организаций, к которым пользователь имеет доступ
GetOrganization — возвращает данные организации по указанному идентификатору
GetOrganizationFeatures — возвращает список дополнительных функций организации
GetOrganizationsByInnKpp — возвращает данные организации по ИНН
GetOrganizationsByInnList (V2) — возвращает список организаций и их статус партнерства по списку ИНН
GetResolutionRoutes — возвращает список всех неудаленных включенных маршрутов согласования для указанного ящика
Register — находит или создает в Диадоке организацию по сертификату и добавляет владельца сертификата в сотрудники этой организации
RegisterConfirm — подтверждает владение закрытым ключом сертификата для регистрации в организацию