GetCounteragent (V3)

Метод GetCounteragent возвращает информацию о контрагенте.

GET /V3/GetCounteragent
Query Parameters:

  • myBoxId – идентификатор ящика организации, для которой осуществляется поиск контрагента.

  • counteragentBoxId – идентификатор ящика организации контрагента.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором myBoxId закончилась подписка на API.

  • 403 Forbidden – доступ к списку контрагентов организации myBoxId с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – партнерские отношения между организациями myBoxId и counteragentBoxId не установлены.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит информацию о контрагенте с идентификатором counteragentBoxId для организации myBoxId, представленную структурой Counteragent. Вложенная в нее структура Counteragent.Organization.Departments содержит только видимые подразделения и их родительские подразделения.

Метод доступен только сотрудникам с доступом к ящику.

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

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

GET /V3/GetCounteragent?myBoxId={{myBoxId}}&counteragentBoxId={{counteragentBoxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: DiadocAuth ddauth_api_client_id={{client_id}}, ddauth_token={{auth_token}}
Accept: application/json; charset=utf-8

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

{
    "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
    },
    "CurrentStatus": "IsMyCounteragent",
    "LastEventTimestampTicks": 638585445988979088,
    "MessageToCounteragent": "Примите приглашение к сотрудничеству",
    "InvitationDocumentId": {
        "MessageId": "215a68d5-28a0-4c6a-b9ec-cdba1530fd49",
        "EntityId": "ad810ad2-8d4f-4fd9-9321-5359dfc0a37a"
    },
    "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7"
}

См. также

Определение:
Инструкции:
Методы для работы с контрагентами:
Устаревшие версии метода: