Методы для работы с учетными записями

Подробная спецификация методов представлена в swagger в разделе Accounts.

Список доступных методов:

Получение списка всех доступных учетных записей

Метод: GET All

Метод вернет список доступных учетных записей авторизованного пользователя. Пользователь определяется по Access Token из запроса.

Администратор всегда получит данные по всем учетным записям. Если подключен многопользовательский режим, то пользователи получат данные только по тем учетным записям, в которые у них есть доступ.

Для пользователей Компаний-Партнеров и партнеров УЦ учетные записи фильтруются по переданному в запросе api-key. Таким образом, пользователи получат данные по тем учетным записям, к которым у них есть доступ.

В ответ на вызов метода можно получить актуальную информацию по каждой учетной записи:

  • сведения о головной организации: ИНН, КПП, наименование;

  • список продуктов Контура, к которым пользователь имеет доступ;

  • role – роль пользователя в данной учетной записи: администратор, пользователь, генеральный директор;

  • name – наименование учетной записи;

  • abonent-Id – идентификатор группы учетных записей;

  • разрешения для пользователя из запроса:

    • has-web-access — флаг доступа в веб-интерфейс Контур.Экстерн. Если вернулось значение true, то пользователь имеет доступ в веб-интерфейс Контур.Экстерна;

    • is-demand-recipient – флаг получателя требований. Если вернулось значение true, то пользователь может получать требования из ФНС;

    • can-add-organizations – флаг добавления дочерних организаций. Если вернулось значение true, то пользователь может добавлять дочерние организации в учетную запись .

Создание новой учетной записи

Метод: POST Account

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

Для пользователей сервисов Компаний-Партнеров можно создать учетную запись, если организации этих пользователей еще не зарегистрированы в Контур.Экстерне.

Получение учетной записи по идентификатору

Метод: GET Account

Метод вернет сведения об учетной записи по идентификатору accountId.

Получение списка пользователей учетной записи

Метод: GET Users

Метод вернет всех пользователей для указанной учетной записи.

Администратор может получить данные о всех пользователях учетной записи. Если подключен многопользовательский режим, то пользователь может получить данные только по себе.

В ответ на вызов данного метода можно получить всю актуальную информацию по пользователю:

  • login – логин пользователя;

  • fio – ФИО пользователя;

  • login-certificates – сертификаты для авторизации и их отпечатки;

  • права доступа и уровень доступа:

    • is-enabled – флаг включенных прав доступа. Если вернулось значение true, то пользователю назначены уровень доступ access-level и права доступа organizations-access и forms-access. Если вернулось значение false, то пользователь имеет доступ ко всем организациям и формам отчетности.

    • access-level – уровень доступа:

      • none – нет доступа;

      • read – доступен только просмотр;

      • edit – доступно заполнение отчетности;

      • send – доступно заполнение, подписание и отправка отчетности.

    • organizations-access:

      • has-all-organizations-access – флаг доступа к организациям. Если вернулось значение true, то пользователю доступны для работы все организации учетной записи;

      • organization-ids – список индентификаторов организаций. При значении has-all-organizations-access = false метод вернет список идентификатор организаций, которые доступны пользователю.

    • forms-access:

      • has-all-forms-access – флаг доступа к формам отчетности. Если метод вернул значение true, то пользователю доступны для работы все формы отчетности;

      • form-ids – список идентификаторов форм. При значении has-all-forms-access = false метод вернет список идентификатор форм отчетности, которые доступны пользователю.