Группы контрагентов

Контрагентов, с которыми установлены партнерские отношения, можно распределять по группам.

Создание группы контрагентов

Чтобы создать группу контрагентов, выполните следующие действия:

1. С помощью метода CreateCounteragentGroup создайте группу и укажите, в какие подразделения контрагенты группы смогут отправлять документы. В ответе метод вернет информацию о созданной группе.

2. С помощью метода AddCounteragentToGroup добавьте контрагентов в созданную группу. Вызвать метод нужно для каждого контрагента, которого вы хотите добавить в группу.

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

POST /CreateCounteragentGroup?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

Пример тела запроса метода CreateCounteragentGroup:

{
    "Name": "Группа",
    "Departments": {
        "DepartmentIds": [
            "6d710055-9b5d-4bc0-ba2f-9e54adda034e"
        ]
    }
}

Пример ответа метода CreateCounteragentGroup:

{
    "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
    "Name": "Группа",
    "Departments": {
        "DepartmentIds": [
            "6d710055-9b5d-4bc0-ba2f-9e54adda034e"
        ]
    }
}

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

POST /AddCounteragentToGroup?boxId={{boxId}}&counteragentGroupId={{groupId}}&counteragentBoxId={{counteragentBoxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}

Получение списка групп контрагентов

Чтобы отредактировать, удалить или получить информацию о конкретной группе, нужно знать ее идентификатор. Получить идентификаторы и информацию обо всех группах организации можно с помощью метода GetCounteragentGroups. Метод возвращает список всех существующих групп в указанной организации, включая группу по умолчанию.

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

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

Пример ответа метода GetCounteragentGroups:

{
    "Groups": [
        {
            "CounteragentGroupId": "00000000-0000-0000-0000-000000000000",
            "Name": "По умолчанию"
        },
        {
            "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
            "Name": "Группа",
            "Departments": {
                "DepartmentIds": [
                    "6d710055-9b5d-4bc0-ba2f-9e54adda034e"
                ]
            }
        },
        {
            "CounteragentGroupId": "db0c29b8-bbd3-42a0-aa8b-beba1aeabdf4",
            "Name": "Группа2"
        }
    ],
    "TotalCount": 3
}

Получение информации о группе контрагентов

Чтобы получить информацию о группе контрагентов по ее идентификатору, используйте метод GetCounteragentGroup.

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

GET /GetCounteragentGroup?boxId={{boxId}}&counteragentGroupId=ecd591dd-b56f-4178-ab4a-8a5532f231f7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

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

{
    "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
    "Name": "Группа",
    "Departments": {
        "DepartmentIds": [
            "b651ed54-04d8-4ca8-99b5-960fba733147",
            "32cb2cd3-ed3a-403a-b220-7dfd59c757db"
        ]
    }
}

Получение списка контрагентов группы

Чтобы получить информацию о контрагентах, состоящих в группе, используйте метод GetCounteragentsFromGroup. По идентификатору группы он вернет список контрагентов этой группы.

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

GET /GetCounteragentsFromGroup?boxId={{boxId}}&counteragentGroupId=ecd591dd-b56f-4178-ab4a-8a5532f231f7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

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

{
    "CounteragentBoxId": [
        "1f208d03-2a60-4f64-91b1-b7aad54cfaf3"
    ],
    "TotalCount": 1,
    "AfterIndexKey": "08DCA6534D6F9E72038D201F602A644F91B1B7AAD54CFAF3"
}

Редактирование группы контрагентов

Чтобы изменить название или список подразделений, в которые контрагенты группы могут отправлять документы, используйте метод UpdateCounteragentGroup. На странице метода описаны все случаи редактирования подразделений группы.

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

POST /UpdateCounteragentGroup?boxId={{boxId}}&counteragentGroupId=ecd591dd-b56f-4178-ab4a-8a5532f231f7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

Пример тела запроса метода UpdateCounteragentGroup:

{
    "Name": "Новое имя",
    "GroupDepartments":
    {
        "AnyDepartment": "false",
        "Departments": {
            "DepartmentIds": [
                "b651ed54-04d8-4ca8-99b5-960fba733147",
                "32cb2cd3-ed3a-403a-b220-7dfd59c757db"
            ]
        }
    }
}

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

{
    "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
    "Name": "Новое имя",
    "Departments": {
        "DepartmentIds": [
            "b651ed54-04d8-4ca8-99b5-960fba733147",
            "32cb2cd3-ed3a-403a-b220-7dfd59c757db"
        ]
    }
}

Удаление группы контрагентов

Чтобы удалить группу контрагентов, используйте метод DeleteCounteragentGroup. После удаления группы все контрагенты, находящиеся в ней, будут перемещены в группу «По умолчанию».

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

POST /DeleteCounteragentGroup?boxId={{boxId}}&counteragentGroupId=db0c29b8-bbd3-42a0-aa8b-beba1aeabdf4 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}