Abonents API

Группа методов для работы со списком абонентов.

Описание методов

Данный блок содержит подробное описание по каждому методу API.

[GET]/api/v1/abonents

Получение списка абонентов.

Основной сценарий Получить список абонентов для работы в системе.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).

Возможные ответы метода

Код	Тип	Описание
200	AbonentShortResultList	Список абонентов в системе.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
      "globalId": "2АЕ28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
      "status": "Demo",
      "shortName": "Рога и Копыта",
      "fullName": "ООО «Рога и Копыта»",
      "inn": "9614663486",
      "kpp": "999901006",
      "ogrn": "1239535705122"
    }
  ]
}

[GET]/api/v1/abonents/{abonentId}

Получение информации по абоненту.

Основной сценарий Получить информацию по абоненту, зарегистрированному в системе.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Path	string(uuid)	Внутренний идентификатор абонента.

Возможные ответы метода

Код	Тип	Описание
200	Abonent	Информацию по абоненту в системе.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "registrationRequestId": "28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "status": "Demo",
  "license": {
    "type": "Unlimited",
    "activationDate": "2022-02-11T13:03:05.670Z",
    "expirationDate": "2022-02-11T13:03:05.670Z",
    "limit": 100,
    "balance": 1000,
    "extensionActivationDate": "2022-02-11T13:03:05.670Z",
    "extensionExpirationDate": "2022-02-11T13:03:05.670Z"
  },
  "shortName": "Рога и Копыта",
  "fullName": "ООО «Рога и Копыта»",
  "inn": "9614663486",
  "kpp": "999901006",
  "ogrn": "1239535705122",
  "taxAuthority": {
    "id": "7157f9f8-fd9d-425f-939e-bd06fd6e90af",
    "code": "9999",
    "name": "Межрайонная инспекция ФНС России № 2 по Республике Тестостан"
  },
  "bankDetails": {
    "name": "Банк получателя",
    "bic": "044525700",
    "correspondentAccount": "30101810200000000700",
    "checkingAccount": "40817810099910004318",
    "address": "000000, г Тестовый, Тестовый р-н, ул Тестовая, д 404 стр 4"
  },
  "additionalDetails": {
    "okved": "01.02.03",
    "okpo": "4634958066",
    "oktmo": "15456454646",
    "okato": "00000000000",
    "okpd": "00.00.00.000",
    "okopf": "20101",
    "okfs": "59"
  },
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "email": "test@test.tt",
  "phone": "+70000000000",
  "ipRegistrationCertificateNumber": "77 225511122",
  "ipRegistrationDate": "2022-02-11T13:03:05.670Z",
  "employees": [
    {
      "id": "28029AF1-EB5C-42F8-8413-8B2FDD03607F",
      "userId": "A7362E20-BCCF-4E55-BA6A-8228ED1C7E76",
      "name": "Константин",
      "surname": "Константинопольский",
      "patronymic": "Константинович",
      "snils": "184-895-799 60",
      "email": "test@test.tt",
      "phone": "+70000000000",
      "subdivision": "Отдел разработки",
      "position": "Директор",
      "certificateSkid": "26816952015D4B63897BA99771D130F3",
      "certificateAuthority": "Тестовое УЦ",
      "certificateNotAfter": "2022-02-11T13:03:05.670Z",
      "certificateNotBefore": "2022-02-11T13:03:05.670Z",
      "serialNumber": "01D616E407A9C7500000001703410002",
      "dssCertificateId": "8713B259-816D-4815-8C5A-A995440FAB4B",
      "certificateInn": "961554835351",
      "warrant": {
        "number": "1f2289b0-649c-4b67-87a3-0ac3c027d91b",
        "startDate": "2022-02-11T13:03:05.670Z",
        "endDate": "2022-02-11T13:03:05.670Z",
        "status": "Rejected"
      },
      "status": "Blocked"
    }
  ],
  "documents": [
    {
      "type": "OperatorAgreement",
      "fileName": "Соглашение о выборе оператора",
      "size": 4042,
      "uploadDate": "2022-02-11T13:03:05.670Z"
    }
  ]
}

[PATCH]/api/v1/abonents/{abonentId}/MigrateToDocs

Перенос абонента АЭДО в Доки

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
apiKey	Да	Header	string	Ключ доступа к API
abonentId	Да	Path	string(uuid)	Идентификатор абонента

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Перенос абонента успешно выполнен.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Описание дополнительных моделей

Данный блок содержит описание дополнительных моделей.

Abonent

Информация об абоненте.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор абонента.
globalId	Да	string	Идентификатор участника ЭДО (ИдЭДО).
registrationRequestId	Да	string	Идентификатор первоначальной заявки на регистрацию.
status	Да	Одна из: AbonentStatus	Статус абонента.
license	Да	Одна из: License	Сведения о лицензии.
shortName	Да	string	Краткое наименование.
fullName	Да	string	Полное наименование.
inn	Да	string	ИНН.
kpp	Нет	string	КПП.
ogrn	Да	string	ОГРН.
taxAuthority	Нет	Одна из: TaxAuthority	Код ИФНС.
bankDetails	Нет	Одна из: BankDetails	Банковские реквизиты.
additionalDetails	Нет	Одна из: AdditionalDetails	Дополнительные реквизиты организации.
legalAddress	Да	Одна из: Address	Юридический адрес.
actualAddress	Нет	Одна из: Address	Фактический адрес.
email	Нет	string	Электронный адрес.
phone	Нет	string	Телефон.
ipRegistrationCertificateNumber	Нет	string	Номер свидетельства о регистрации ИП.
ipRegistrationDate	Нет	date-time	Дата регистрации ИП.
employees	Нет	Employee[array]	Список всех сотрудников организации.
documents	Нет	Document[array]	Документы организации.

Пример модели

{
  "id": "28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "registrationRequestId": "28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "status": "Demo",
  "license": {
    "type": "Unlimited",
    "activationDate": "2022-02-11T13:03:05.670Z",
    "expirationDate": "2022-02-11T13:03:05.670Z",
    "limit": 100,
    "balance": 1000,
    "extensionActivationDate": "2022-02-11T13:03:05.670Z",
    "extensionExpirationDate": "2022-02-11T13:03:05.670Z"
  },
  "shortName": "Рога и Копыта",
  "fullName": "ООО «Рога и Копыта»",
  "inn": "9614663486",
  "kpp": "999901006",
  "ogrn": "1239535705122",
  "taxAuthority": {
    "id": "7157f9f8-fd9d-425f-939e-bd06fd6e90af",
    "code": "9999",
    "name": "Межрайонная инспекция ФНС России № 2 по Республике Тестостан"
  },
  "bankDetails": {
    "name": "Банк получателя",
    "bic": "044525700",
    "correspondentAccount": "30101810200000000700",
    "checkingAccount": "40817810099910004318",
    "address": "000000, г Тестовый, Тестовый р-н, ул Тестовая, д 404 стр 4"
  },
  "additionalDetails": {
    "okved": "01.02.03",
    "okpo": "4634958066",
    "oktmo": "15456454646",
    "okato": "00000000000",
    "okpd": "00.00.00.000",
    "okopf": "20101",
    "okfs": "59"
  },
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "email": "test@test.tt",
  "phone": "+70000000000",
  "ipRegistrationCertificateNumber": "77 225511122",
  "ipRegistrationDate": "2022-02-11T13:03:05.670Z",
  "employees": [
    {
      "id": "28029AF1-EB5C-42F8-8413-8B2FDD03607F",
      "userId": "A7362E20-BCCF-4E55-BA6A-8228ED1C7E76",
      "name": "Константин",
      "surname": "Константинопольский",
      "patronymic": "Константинович",
      "snils": "184-895-799 60",
      "email": "test@test.tt",
      "phone": "+70000000000",
      "subdivision": "Отдел разработки",
      "position": "Директор",
      "certificateSkid": "26816952015D4B63897BA99771D130F3",
      "certificateAuthority": "Тестовое УЦ",
      "certificateNotAfter": "2022-02-11T13:03:05.670Z",
      "certificateNotBefore": "2022-02-11T13:03:05.670Z",
      "serialNumber": "01D616E407A9C7500000001703410002",
      "dssCertificateId": "8713B259-816D-4815-8C5A-A995440FAB4B",
      "certificateInn": "961554835351",
      "warrant": {
        "number": "1f2289b0-649c-4b67-87a3-0ac3c027d91b",
        "startDate": "2022-02-11T13:03:05.670Z",
        "endDate": "2022-02-11T13:03:05.670Z",
        "status": "Rejected"
      },
      "status": "Blocked"
    }
  ],
  "documents": [
    {
      "type": "OperatorAgreement",
      "fileName": "Соглашение о выборе оператора",
      "size": 4042,
      "uploadDate": "2022-02-11T13:03:05.670Z"
    }
  ]
}

AbonentDocumentType

Тип документа.

Значение	Описание
OperatorAgreement	Соглашение о выборе оператора.
Unknown	Неизвестный документ.

AbonentShort

Краткая информация об абоненте.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор абонента.
globalId	Да	string	Идентификатор участника ЭДО (ИдЭДО).
status	Да	Одна из: AbonentStatus	Статус абонента.
shortName	Да	string	Краткое наименование.
fullName	Нет	string	Полное наименование.
inn	Да	string	ИНН.
kpp	Нет	string	КПП.
ogrn	Нет	string	ОГРН.

Пример модели

{
  "id": "28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "globalId": "2АЕ28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "status": "Demo",
  "shortName": "Рога и Копыта",
  "fullName": "ООО «Рога и Копыта»",
  "inn": "9614663486",
  "kpp": "999901006",
  "ogrn": "1239535705122"
}

AbonentShortResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	AbonentShort[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "id": "28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
      "globalId": "2АЕ28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
      "status": "Demo",
      "shortName": "Рога и Копыта",
      "fullName": "ООО «Рога и Копыта»",
      "inn": "9614663486",
      "kpp": "999901006",
      "ogrn": "1239535705122"
    }
  ]
}

AbonentStatus

Состояние абонента.

Значение	Описание
Approved	Заявка подтверждена.
Blocked	Абонент заблокирован.
Demo	Демо
None	Без состояния.
Processing	Обрабатывается заявка на регистрацию.
Rejected	Заявка отклонена.

AdditionalDetails

Информация по дополнительным реквизитам.

Название	Обязат.	Тип	Описание
okved	Нет	string	Общероссийский Классификатор Видов Экономической Деятельности.
okpo	Нет	string	Общероссийский Классификатор Предприятий и Организаций
oktmo	Нет	string	Общероссийский Классификатор Территорий Муниципальных Образований.
okato	Нет	string	Общероссийский Классификатор Административно-Территориальных Образований.
okpd	Нет	string	Общероссийский Классификатор Продукции по видам экономической Деятельности.
okopf	Нет	string	Общероссийский Классификатор Организационно-Правовых Форм.
okfs	Нет	string	Общероссийский Классификатор Форм Собственности.

Пример модели

{
  "okved": "01.02.03",
  "okpo": "4634958066",
  "oktmo": "15456454646",
  "okato": "00000000000",
  "okpd": "00.00.00.000",
  "okopf": "20101",
  "okfs": "59"
}

Address

Информация об адресе.

Название	Обязат.	Тип	Описание
postalIndex	Нет	string	Почтовый индекс.
regionCode	Да	string	Код региона.
regionName	Нет	string	Название региона.
area	Нет	string	Район.
city	Нет	string	Город.Это поле обязательно, если поле Settlement пустое.
settlement	Нет	string	Населенный пункт.Это поле обязательно, если поле City пустое.
street	Нет	string	Улица.
house	Нет	string	Дом.
housing	Нет	string	Корпус.
apartment	Нет	string	Квартира.

Пример модели

{
  "postalIndex": "000000",
  "regionCode": "000",
  "regionName": "Тестовый регион",
  "area": "Тестовый район",
  "city": "Тестовый город",
  "settlement": "Тестовый населённый пункт",
  "street": "Тестовая улица",
  "house": "404",
  "housing": "А",
  "apartment": "10"
}

BankDetails

Информация по банковскому счёту.

Название	Обязат.	Тип	Описание
name	Нет	string	Наименование.
bic	Нет	string	Банковский идентификационный код.
correspondentAccount	Нет	string	Корреспондентский счёт.
checkingAccount	Нет	string	Контокоррентный счёт.
address	Нет	string	Адрес банка.

Пример модели

{
  "name": "Банк получателя",
  "bic": "044525700",
  "correspondentAccount": "30101810200000000700",
  "checkingAccount": "40817810099910004318",
  "address": "000000, г Тестовый, Тестовый р-н, ул Тестовая, д 404 стр 4"
}

Document

Информация о документе.

Название	Обязат.	Тип	Описание
type	Да	Одна из: AbonentDocumentType	Тип документа.
fileName	Да	string	Наименование файла.
size	Да	integer(int64)	Размер.
uploadDate	Да	date-time-offset	Дата загрузки.

Пример модели

{
  "type": "OperatorAgreement",
  "fileName": "Соглашение о выборе оператора",
  "size": 4042,
  "uploadDate": "2022-02-11T13:03:05.670Z"
}

Employee

Информация о сотруднике.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор сотрудника.
userId	Да	string(uuid)	Идентификатор пользователя.
name	Да	string	Имя.
surname	Да	string	Фамилия.
patronymic	Нет	string	Отчество.
snils	Нет	string	СНИЛС.
email	Нет	string	Почта.
phone	Нет	string	Телефон.
subdivision	Нет	string	Подразделение.
position	Нет	string	Должность.
certificateSkid	Нет	string	Идентификатор ключа субъекта.
certificateAuthority	Нет	string	Наименование УЦ.
certificateNotAfter	Нет	date-time	Дата окончания действия сертификата пользователя.
certificateNotBefore	Нет	date-time	Дата начала действия сертификата пользователя.
serialNumber	Нет	string	Серийный номер сертификата.
dssCertificateId	Нет	string	Идентификатор облачного сертификата.
certificateInn	Нет	string	ИНН.
warrant	Нет	Одна из: Warrant	Машиночитаемая доверенность (МЧД).
status	Да	Одна из: EmployeeStatus	Статус сотрудника.

Пример модели

{
  "id": "28029AF1-EB5C-42F8-8413-8B2FDD03607F",
  "userId": "A7362E20-BCCF-4E55-BA6A-8228ED1C7E76",
  "name": "Константин",
  "surname": "Константинопольский",
  "patronymic": "Константинович",
  "snils": "184-895-799 60",
  "email": "test@test.tt",
  "phone": "+70000000000",
  "subdivision": "Отдел разработки",
  "position": "Директор",
  "certificateSkid": "26816952015D4B63897BA99771D130F3",
  "certificateAuthority": "Тестовое УЦ",
  "certificateNotAfter": "2022-02-11T13:03:05.670Z",
  "certificateNotBefore": "2022-02-11T13:03:05.670Z",
  "serialNumber": "01D616E407A9C7500000001703410002",
  "dssCertificateId": "8713B259-816D-4815-8C5A-A995440FAB4B",
  "certificateInn": "961554835351",
  "warrant": {
    "number": "1f2289b0-649c-4b67-87a3-0ac3c027d91b",
    "startDate": "2022-02-11T13:03:05.670Z",
    "endDate": "2022-02-11T13:03:05.670Z",
    "status": "Rejected"
  },
  "status": "Blocked"
}

EmployeeStatus

Статус сотрудника.

Значение	Описание
Active	Активен.
Blocked	Заблокирован.
Inactive	Не активен.

License

Информация по лицензии.

Название	Обязат.	Тип	Описание
type	Да	Одна из: LicenseType	Тип лицензии.
activationDate	Нет	date-time-offset	Дата активации текущего тарифа лицензии.
expirationDate	Нет	date-time-offset	Дата окончания срока действия одобренных пролонгаций лицензии.
limit	Да	integer(int32)	Ограничение.
balance	Да	integer(int32)	Баланс.
extensionActivationDate	Нет	date-time-offset	Дата активации текущего расширения к тарифу лицензии.
extensionExpirationDate	Нет	date-time-offset	Дата окончания срока действия расширения ограниченной продолжительности.

Пример модели

{
  "type": "Unlimited",
  "activationDate": "2022-02-11T13:03:05.670Z",
  "expirationDate": "2022-02-11T13:03:05.670Z",
  "limit": 100,
  "balance": 1000,
  "extensionActivationDate": "2022-02-11T13:03:05.670Z",
  "extensionExpirationDate": "2022-02-11T13:03:05.670Z"
}

LicenseType

Тип лицензии.

Значение	Описание
Limited	Ограниченная.
Unlimited	Безлимитная.

TaxAuthority

Информация об ИФНС.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор налогового органа.
code	Да	string	Код налогового органа.
name	Да	string	Наименование налогового органа.

Пример модели

{
  "id": "7157f9f8-fd9d-425f-939e-bd06fd6e90af",
  "code": "9999",
  "name": "Межрайонная инспекция ФНС России № 2 по Республике Тестостан"
}

Warrant

Информация о доверенности.

Название	Обязат.	Тип	Описание
number	Да	string	Номер доверенности.
startDate	Да	date-time-offset	Дата начала действия доверенности.
endDate	Да	date-time-offset	Срок окончания действия доверенности.
status	Да	Одна из: WarrantStatus	Статус доверенности.

Пример модели

{
  "number": "1f2289b0-649c-4b67-87a3-0ac3c027d91b",
  "startDate": "2022-02-11T13:03:05.670Z",
  "endDate": "2022-02-11T13:03:05.670Z",
  "status": "Rejected"
}

WarrantStatus

Статусы доверенности.

Значение	Описание
Active	Действующая доверенность.
Created	Доверенность существует, но не вступила в действие.
Expired	Доверенность истекла.
Processing	Ожидает подтверждения (отправлена в ФНС)
Rejected	Отказ в регистрации (отклонена ФНС при регистрации)
Revoked	Доверенность отменена.

Abonents API

Описание методов​

[GET]/api/v1/abonents​

Параметры в строке запроса​

Возможные ответы метода​

[GET]/api/v1/abonents/{abonentId}​

Параметры в строке запроса​

Возможные ответы метода​

[PATCH]/api/v1/abonents/{abonentId}/MigrateToDocs​

Параметры в строке запроса​

Возможные ответы метода​

Описание дополнительных моделей​

Abonent​

AbonentDocumentType​

AbonentShort​

AbonentShortResultList​

AbonentStatus​

AdditionalDetails​

Address​

BankDetails​

Document​

Employee​

EmployeeStatus​

License​

LicenseType​

TaxAuthority​

Warrant​

WarrantStatus​

Описание методов

[GET]/api/v1/abonents

Параметры в строке запроса

Возможные ответы метода

[GET]/api/v1/abonents/{abonentId}

Параметры в строке запроса

Возможные ответы метода

[PATCH]/api/v1/abonents/{abonentId}/MigrateToDocs

Параметры в строке запроса

Возможные ответы метода

Описание дополнительных моделей

Abonent

AbonentDocumentType

AbonentShort

AbonentShortResultList

AbonentStatus

AdditionalDetails

Address

BankDetails

Document

Employee

EmployeeStatus

License

LicenseType

TaxAuthority

Warrant

WarrantStatus