GetCounteragent (V3)
Возвращает данные контрагента по указанному идентификатору
GET /V3/GetCounteragent
Параметры запроса
myBoxId— идентификатор ящика организации, для которой осуществляется поиск контрагента, в формате GUID.counteragentBoxId— идентификатор ящика организации контрагента в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к списку контрагентов указанной организации с предоставленным авторизационным токеном запрещен.404— партнерские отношения между указанными организациями не установлены.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит информацию о контрагенте с идентификатором counteragentBoxId для организации myBoxId, представленную структурой Counteragent. Вложенная в нее структура Counteragent.Organization.Departments содержит только видимые подразделения и их родительские подразделения.
Метод доступен только сотрудникам с доступом к ящику.
Метод работает по следующим правилам:
- Если организация с идентификатором
counteragentBoxIdне является контрагентом для организацииmyBoxId, метод вернет ошибку404 (Not Found). - Если между организациями с идентификаторами
counteragentBoxIdиmyBoxIdне было никакого взаимодействия, метод вернет ошибку404 (Not Found).
Примеры использования
Пример HTTP-запроса:
GET /V3/GetCounteragent?myBoxId={{myBoxId}}&counteragentBoxId={{counteragentBoxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"LastEventTimestamp": "2024-08-06T12:36:38.8979088Z",
"Organization": {
"OrgIdGuid": "72c3b5bf-3a9f-4fb5-a3ef-112cb2b3a8dc",
"OrgId": "72c3b5bf-3a9f-4fb5-a3ef-112cb2b3a8dc",
"Inn": "9147414342",
"Kpp": "757645784",
"FullName": "Ромашка",
"ShortName": "Ромашка",
"JoinedDiadocTreaty": true,
"Boxes": [
{
"BoxId": "2a208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"BoxIdGuid": "2a208d03-2a60-4f64-91b1-b7aad54cfaf3",
"Title": "Ромашка",
"InvoiceFormatVersion": "v5_02",
"EncryptedDocumentsAllowed": false
}
],
"Ogrn": "9130523523154",
"FnsParticipantId": "2BM-9147414342-757645784-202407101104400484330",
"Address": {
"RussianAddress": {
"ZipCode": "620142",
"Region": "66",
"City": "Екатеринбург",
"Street": "Сажинская",
"Building": "11"
},
"AddressCode": ""
},
"Departments": [
{
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"ParentDepartmentId": "",
"Name": "Головное подразделение",
"Abbreviation": "ГП",
"Address": {
"RussianAddress": {
"Region": ""
},
"AddressCode": ""
},
"IsDisabled": false
}
],
"IfnsCode": "6174",
"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": ""
},
"CurrentStatus": "IsMyCounteragent",
"LastEventTimestampTicks": 638585445988979088,
"MessageToCounteragent": "Примите приглашение к сотрудничеству",
"InvitationDocumentId": {
"MessageId": "215a68d5-28a0-4c6a-b9ec-cdba1530fd49",
"EntityId": "ad810ad2-8d4f-4fd9-9321-5359dfc0a37a"
},
"CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7"
}
См. также
Инструкции:
Методы для работы с контрагентами:
- GetBox — по идентификатору ящика возвращает информацию об организации, которой он принадлежит
- GetCounteragent (V3) — возвращает данные контрагента по указанному идентификатору
- GetCounteragentCertificates (V2) — возвращает список сертификатов контрагента
- GetOrganization — по идентификатору организации возвращает принадлежащий ей ящик и ее данные: например, ИНН, КПП, название и т.п.
- GetOrganizationsByInnKpp — возвращает организации с указанными ИНН и КПП
- GetOrganizationsByInnList (V2) — возвращает организации и их статусы по указанному списку ИНН