GetBox

Возвращает данные ящика по указанному идентификатору.

GET /GetBox
Query Parameters:

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

Request Headers:
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:

Тело ответа содержит информацию о ящике с идентификатором boxId, представленную структурой Box.

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

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

GET /V3/GetBox?boxid={{BoxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

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

{
    "BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
    "BoxIdGuid": "09ae254c-5cd0-4082-84de-7ccb46d86f82",
    "Title": "Ромашка",
    "Organization": {
        "OrgIdGuid": "f5758a05-63d1-435e-bc49-79a801d7c275",
        "OrgId": "f5758a05-63d1-435e-bc49-79a801d7c275",
        "Inn": "7725600340",
        "Kpp": "732644841",
        "FullName": "Ромашка",
        "ShortName": "Ромашка",
        "JoinedDiadocTreaty": true,
        "Boxes": [
            {
                "BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
                "BoxIdGuid": "09ae254c-5cd0-4082-84de-7ccb46d86f82",
                "Title": "Ромашка",
                "InvoiceFormatVersion": "v5_02",
                "EncryptedDocumentsAllowed": true
            }
        ],
        "Ogrn": "3071205010489",
        "FnsParticipantId": "2BM-7725600340-732644841-202407101103418496883",
        "Address": {
            "RussianAddress": {
                "ZipCode": "987654",
                "Region": "77",
                "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
    },
    "InvoiceFormatVersion": "v5_02",
    "EncryptedDocumentsAllowed": true
}