Registration API

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

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

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

---

[POST]/api/v2/registration

Регистрация организации по сертификату.

Основной сценарий Зарегистрировать организацию по сертификату.

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
certificateBody	Да	string(binary)	Открытая часть сертификата организации в формате Base64.
email	Да	string	Почта, с которой зарегистрирован аккаунт пользователя.
tariffId	Нет	string(uuid)	Идентификатор тарифа.
partnerCode	Нет	integer(int32)	Код обслуживающей организации.
warrantNumber	Нет	string	Номер МЧД.
issuerInn	Нет	string	ИНН доверителя.

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

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

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

{
  "id": "6a65415a-1a41-416c-ae18-cbdbb2175b87",
  "abonentId": "8e26fb42-b2f1-45ed-b2ce-ab4c9308cbc5",
  "creatorUserId": "07d3ba7c-d0aa-4cdc-bec4-236d2e180003",
  "taxAuthority": {
    "id": "7157f9f8-fd9d-425f-939e-bd06fd6e90af",
    "code": "9999",
    "name": "Межрайонная инспекция ФНС России № 2 по Республике Тестостан"
  },
  "status": "AwaitingPayment",
  "partnerInfo": {
    "code": 1,
    "name": "АО \"Тестовый оператор\" ОПС ЭДО",
    "phone": "8 (000) 000 00 00",
    "email": "test@test.ru"
  },
  "inn": "9649563683",
  "kpp": "000000000",
  "ogrn": "0000000000000",
  "organizationShortName": "Тестовое наименование организации",
  "ipRegistrationCertificateNumber": "00 000000000",
  "ipRegistrationDate": "2015-01-02",
  "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"
  },
  "name": "Константин",
  "surname": "Константинопольский",
  "patronymic": "Константинович",
  "snils": "138-050-393 43",
  "position": "Директор",
  "phone": "+70000000000",
  "email": "test@test.ru",
  "tariffs": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "extensions": [
        "42F774E0-2325-45FA-A94D-F10A578A1EA0"
      ]
    }
  ]
}

---

[GET]/api/v1/registration/requests

Получение списка заявок на подключение новых абонентов.

Основной сценарий Запросить заявки на подключение новых абонентов в систему ЭДО.

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

Название	Обязат.	Место	Тип	Описание
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).
Inn	Нет	Query	string	ИНН организации.
Kpp	Нет	Query	string	КПП организации.
Status	Нет	Query	RequestStatus	Статус заявки.

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

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

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

{
  "count": 1,
  "data": [
    {
      "id": "a6a4bcd3-78c1-4504-a0c4-9cf18c5bb043",
      "abonentId": "71067ff8-fc03-4309-abee-8cefb13103dd",
      "inn": "9649563683",
      "kpp": "000000000",
      "organizationShortName": "Тестовое наименование организации",
      "organizationFullName": "ООО \"Тестовое наименование организации\"",
      "creationDate": "2022-02-11T13:03:05.670Z",
      "status": "AwaitingPayment"
    }
  ]
}

---

[GET]/api/v1/registration/requests/{registrationRequestId}

Получение информации по заявке на подключение нового абонента.

Основной сценарий Запросить информацию по заявке на подключение новых абонентов.

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

Название	Обязат.	Место	Тип	Описание
registrationRequestId	Да	Path	string(uuid)

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

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

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

{
  "id": "6a65415a-1a41-416c-ae18-cbdbb2175b87",
  "abonentId": "8e26fb42-b2f1-45ed-b2ce-ab4c9308cbc5",
  "creatorUserId": "07d3ba7c-d0aa-4cdc-bec4-236d2e180003",
  "taxAuthority": {
    "id": "7157f9f8-fd9d-425f-939e-bd06fd6e90af",
    "code": "9999",
    "name": "Межрайонная инспекция ФНС России № 2 по Республике Тестостан"
  },
  "status": "AwaitingPayment",
  "partnerInfo": {
    "code": 1,
    "name": "АО \"Тестовый оператор\" ОПС ЭДО",
    "phone": "8 (000) 000 00 00",
    "email": "test@test.ru"
  },
  "inn": "9649563683",
  "kpp": "000000000",
  "ogrn": "0000000000000",
  "organizationShortName": "Тестовое наименование организации",
  "ipRegistrationCertificateNumber": "00 000000000",
  "ipRegistrationDate": "2015-01-02",
  "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"
  },
  "name": "Константин",
  "surname": "Константинопольский",
  "patronymic": "Константинович",
  "snils": "138-050-393 43",
  "position": "Директор",
  "phone": "+70000000000",
  "email": "test@test.ru",
  "tariffs": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "extensions": [
        "42F774E0-2325-45FA-A94D-F10A578A1EA0"
      ]
    }
  ]
}

---

[PUT]/api/v1/registration/requests/{registrationRequestId}

Обновление выбранных реквизитов регистрационной заявки абонента с очисткой незаполненных реквизитов.

Основной сценарий Обновить заполненные реквизиты регистрационной заявки.
Дополнительный сценарий Заполнить пустые реквизиты регистрационной заявки.

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

Название	Обязат.	Место	Тип	Описание
registrationRequestId	Да	Path	string(uuid)	Идентификатор заявки на регистрацию.

Тело запроса

Тип запроса: application/json

Обновляемые параметры заявки на регистрацию.

Название	Обязат.	Тип	Описание
partnerCode	Нет	string	Код партнера.
kpp	Нет	string	КПП. Обязателен для ЮЛ.
taxAuthorityId	Нет	string(uuid)	Идентификатор ИФНС. Обязателен для ЮЛ или ИП, имеющих ОГРН.
legalAddress	Нет	Одна из: AddressRequestArgs	Юридический адрес организации. Заполнять в формате “КЛАДР”
actualAddress	Нет	Одна из: AddressRequestArgs	Физический адрес организации. Обязателен для ЮЛ или ИП, имеющих ОГРН. Заполнять в формате “КЛАДР”.
email	Нет	string	Электронная почта организации.
phone	Нет	string	Номер телефона организации.
ipRegistrationCertificateNumber	Нет	string	Номер свидельства о регистрации ИП. Обязателен для ИП, чей сертификат выдан до 2017 года.
ipRegistrationDate	Нет	date-time	Дата регистрации ИП. Обязателен для ИП, имеющих ОГРН.

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

{
  "partnerCode": "0000",
  "kpp": "999901001",
  "taxAuthorityId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовое поселение",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "2",
    "apartment": "1"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовое поселение",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "2",
    "apartment": "1"
  },
  "email": "test@test.ru",
  "phone": "+70000000000",
  "ipRegistrationCertificateNumber": "00 000000000",
  "ipRegistrationDate": "2022-02-11T13:03:05.670Z"
}

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

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

---

[PATCH]/api/v1/registration/requests/{registrationRequestId}

Обновление выбранных реквизитов регистрационной заявки абонента с игнорированием незаполненных реквизитов.

Основной сценарий Обновить заполненные реквизиты регистрационной заявки.
Дополнительный сценарий Заполнить пустые реквизиты регистрационной заявки.

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

Название	Обязат.	Место	Тип	Описание
registrationRequestId	Да	Path	string(uuid)	Идентификатор заявки на регистрацию.

Тело запроса

Тип запроса: application/json

Обновляемые параметры заявки на регистрацию.

Название	Обязат.	Тип	Описание
partnerCode	Нет	string	Код партнера.
kpp	Нет	string	КПП. Обязателен для ЮЛ.
taxAuthorityId	Нет	string(uuid)	Идентификатор ИФНС. Обязателен для ЮЛ или ИП, имеющих ОГРН.
legalAddress	Нет	Одна из: AddressRequestArgs	Юридический адрес организации. Заполнять в формате “КЛАДР”
actualAddress	Нет	Одна из: AddressRequestArgs	Физический адрес организации. Обязателен для ЮЛ или ИП, имеющих ОГРН. Заполнять в формате “КЛАДР”.
email	Нет	string	Электронная почта организации.
phone	Нет	string	Номер телефона организации.
ipRegistrationCertificateNumber	Нет	string	Номер свидельства о регистрации ИП. Обязателен для ИП, чей сертификат выдан до 2017 года.
ipRegistrationDate	Нет	date-time	Дата регистрации ИП. Обязателен для ИП, имеющих ОГРН.

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

{
  "partnerCode": "0000",
  "kpp": "999901001",
  "taxAuthorityId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовое поселение",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "2",
    "apartment": "1"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовое поселение",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "2",
    "apartment": "1"
  },
  "email": "test@test.ru",
  "phone": "+70000000000",
  "ipRegistrationCertificateNumber": "00 000000000",
  "ipRegistrationDate": "2022-02-11T13:03:05.670Z"
}

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

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

---

[DELETE]/api/v1/registration/requests/{registrationRequestId}

Удаление созданной заявки на регистрацию нового абонента. Примечание — удалить заявку возможно только в статусе New или Rejected. В случае попытки удаления заявки в любом другом статусе, система вернет сообщение об ошибке: “Невозможно удалить отправленную или принятую заявку на регистрацию”.

Основной сценарий Удалить созданную заявку на регистрацию.

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

Название	Обязат.	Место	Тип	Описание
registrationRequestId	Да	Path	string(uuid)	Идентификатор заявки на регистрацию.

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

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

---

[POST]/api/v1/registration

Создание заявки на подключение абонента при помощи открытого ключа сертификата в формате Base64.

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

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
certificateBody	Да	string(binary)

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

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

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

{
  "id": "6a65415a-1a41-416c-ae18-cbdbb2175b87",
  "abonentId": "8e26fb42-b2f1-45ed-b2ce-ab4c9308cbc5",
  "creatorUserId": "07d3ba7c-d0aa-4cdc-bec4-236d2e180003",
  "taxAuthority": {
    "id": "7157f9f8-fd9d-425f-939e-bd06fd6e90af",
    "code": "9999",
    "name": "Межрайонная инспекция ФНС России № 2 по Республике Тестостан"
  },
  "status": "AwaitingPayment",
  "partnerInfo": {
    "code": 1,
    "name": "АО \"Тестовый оператор\" ОПС ЭДО",
    "phone": "8 (000) 000 00 00",
    "email": "test@test.ru"
  },
  "inn": "9649563683",
  "kpp": "000000000",
  "ogrn": "0000000000000",
  "organizationShortName": "Тестовое наименование организации",
  "ipRegistrationCertificateNumber": "00 000000000",
  "ipRegistrationDate": "2015-01-02",
  "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"
  },
  "name": "Константин",
  "surname": "Константинопольский",
  "patronymic": "Константинович",
  "snils": "138-050-393 43",
  "position": "Директор",
  "phone": "+70000000000",
  "email": "test@test.ru",
  "tariffs": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "extensions": [
        "42F774E0-2325-45FA-A94D-F10A578A1EA0"
      ]
    }
  ]
}

---

[PUT]/api/v1/registration/requests/{registrationRequestId}/tariff

Обновляет тариф у заявки на регистрацию нового абонента.

Основной сценарий Обновить тариф у регистрируемого абонента.

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

Название	Обязат.	Место	Тип	Описание
registrationRequestId	Да	Path	string(uuid)	Идентификатор заявки на регистрацию.

Тело запроса

Тип запроса: application/json

Список тарифов. Тип контента: ChangeTariffsRequestArgs[array]

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

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

---

[PUT]/api/v1/registration/requests/{registrationRequestId}/dispatch

Отправка регистрационной заявки на подключение в сервис Астрал.ЭДО.

Основной сценарий Отправить готовую заявку с выбранным тарифом на обработку.

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

Название	Обязат.	Место	Тип	Описание
registrationRequestId	Да	Path	string(uuid)	Идентификатор заявки на регистрацию.

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

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

---

[GET]/api/v1/registration/tariffs

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

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

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

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

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

{
  "count": 1,
  "data": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "name": "Промо",
      "duration": 30,
      "limit": 100
    }
  ]
}

---

[GET]/api/v1/registration/tariffs/extensions

Получение списка расширений для тарифов.

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

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

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

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

{
  "count": 1,
  "data": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "name": "100",
      "duration": 360,
      "limit": 100
    }
  ]
}

---

[GET]/api/v1/registration/tax-authority

Получение информации по списку ИФНС, зарегистрированных в системе.

Основной сценарий Получить список ИФНС с указанным идентификатором, кодом и наименованием конкретного налогового органа.

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

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

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

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

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

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

---

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

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

---

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"
}

---

AddressRequestArgs

Параметры запроса на изменение адреса.

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

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

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

---

ChangeTariffsRequestArgs

Параметры запроса на изменение тарифа.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор тарифа.
extensions	Нет	string(uuid)[array]	Список расширений.

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

{
  "id": "04843C66-B294-439B-A832-B1DDD9A23120",
  "extensions": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ]
}

---

PartnerInfo

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

Название	Обязат.	Тип	Описание
code	Да	integer(int32)	Код партнера.
name	Да	string	Наименование партнера.
phone	Нет	string	Номер телефона.
email	Нет	string	Электронная почта.

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

{
  "code": 1,
  "name": "АО \"Тестовый оператор\" ОПС ЭДО",
  "phone": "8 (000) 000 00 00",
  "email": "test@test.ru"
}

---

RegistrationRequest

Информация о заявке на регистрацию абонента.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор заявки.
abonentId	Да	string(uuid)	Внутренний идентификатор абонента.
creatorUserId	Да	string(uuid)	Идентификатор пользователя, создавшего заявку.
taxAuthority	Нет	Одна из: TaxAuthority	Информация об ИФНС абонента.
status	Да	Одна из: RequestStatus	Статус заявки.
partnerInfo	Нет	Одна из: PartnerInfo	Информация о партнёре.
inn	Да	string	ИНН организации.
kpp	Нет	string	КПП организации.
ogrn	Нет	string	ОГРН организации.
organizationShortName	Да	string	Наименование организации.
ipRegistrationCertificateNumber	Нет	string	Номер свидетельства регистрации ИП.
ipRegistrationDate	Нет	string	Дата свидетельства регистрации ИП.
legalAddress	Да	Одна из: Address	Юридический адрес организации.
actualAddress	Да	Одна из: Address	Физический адрес организации.
name	Да	string	Имя владельца сертификата.
surname	Да	string	Фамилия владельца сертификата.
patronymic	Нет	string	Отчество владельца сертификата.
snils	Нет	string	СНИЛС владельца сертификата.
position	Нет	string	Должность владельца сертификата.
phone	Нет	string	Номер телефона организации.
email	Да	string	Электронный адрес организации.
tariffs	Нет	Tariff[array]	Список тарифов.

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

{
  "id": "6a65415a-1a41-416c-ae18-cbdbb2175b87",
  "abonentId": "8e26fb42-b2f1-45ed-b2ce-ab4c9308cbc5",
  "creatorUserId": "07d3ba7c-d0aa-4cdc-bec4-236d2e180003",
  "taxAuthority": {
    "id": "7157f9f8-fd9d-425f-939e-bd06fd6e90af",
    "code": "9999",
    "name": "Межрайонная инспекция ФНС России № 2 по Республике Тестостан"
  },
  "status": "AwaitingPayment",
  "partnerInfo": {
    "code": 1,
    "name": "АО \"Тестовый оператор\" ОПС ЭДО",
    "phone": "8 (000) 000 00 00",
    "email": "test@test.ru"
  },
  "inn": "9649563683",
  "kpp": "000000000",
  "ogrn": "0000000000000",
  "organizationShortName": "Тестовое наименование организации",
  "ipRegistrationCertificateNumber": "00 000000000",
  "ipRegistrationDate": "2015-01-02",
  "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"
  },
  "name": "Константин",
  "surname": "Константинопольский",
  "patronymic": "Константинович",
  "snils": "138-050-393 43",
  "position": "Директор",
  "phone": "+70000000000",
  "email": "test@test.ru",
  "tariffs": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "extensions": [
        "42F774E0-2325-45FA-A94D-F10A578A1EA0"
      ]
    }
  ]
}

---

RegistrationRequestShort

Информация о заявке на регистрацию абонента.

Название	Обязат.	Тип	Описание
id	Нет	string(uuid)	Идентификатор заявки на регистрацию.
abonentId	Нет	string(uuid)	Внутренний идентификатор регистрируемого абонента.
inn	Нет	string	ИНН организации.
kpp	Нет	string	КПП организации.
organizationShortName	Нет	string	Краткое наименование регистрируемой организации.
organizationFullName	Нет	string	Наименование регистрируемой организации.
creationDate	Нет	date-time-offset	Дата создания заявки.
status	Нет	Одна из: RequestStatus	Статус заявки.

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

{
  "id": "a6a4bcd3-78c1-4504-a0c4-9cf18c5bb043",
  "abonentId": "71067ff8-fc03-4309-abee-8cefb13103dd",
  "inn": "9649563683",
  "kpp": "000000000",
  "organizationShortName": "Тестовое наименование организации",
  "organizationFullName": "ООО \"Тестовое наименование организации\"",
  "creationDate": "2022-02-11T13:03:05.670Z",
  "status": "AwaitingPayment"
}

---

RegistrationRequestShortResultList

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

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

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

{
  "count": 1,
  "data": [
    {
      "id": "a6a4bcd3-78c1-4504-a0c4-9cf18c5bb043",
      "abonentId": "71067ff8-fc03-4309-abee-8cefb13103dd",
      "inn": "9649563683",
      "kpp": "000000000",
      "organizationShortName": "Тестовое наименование организации",
      "organizationFullName": "ООО \"Тестовое наименование организации\"",
      "creationDate": "2022-02-11T13:03:05.670Z",
      "status": "AwaitingPayment"
    }
  ]
}

---

RequestStatus

Статус заявки на подключение нового абонента.

Значение	Описание
Accepted	Принята.
AwaitingPayment	Ожидает оплаты.
New	Новая.
Rejected	Отменена.
Removed	Удалена.
Sent	Отправлена.

---

Tariff

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

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор тарифа.
extensions	Нет	string(uuid)[array]	Список идентификаторов расширений.

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

{
  "id": "68b09b27-5701-47ed-8468-98886351473b",
  "extensions": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ]
}

---

TariffExtension

Детальная информация о расширении для тарифа.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор расширения для тарифа.
name	Да	string	Наименование расширения для тарифа.
duration	Да	integer(int32)	Срок действия расширения для тарифа в днях.
limit	Да	integer(int32)	Лимит документов в расширении для тарифа.

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

{
  "id": "68b09b27-5701-47ed-8468-98886351473b",
  "name": "100",
  "duration": 360,
  "limit": 100
}

---

TariffExtensionResultList

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

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

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

{
  "count": 1,
  "data": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "name": "100",
      "duration": 360,
      "limit": 100
    }
  ]
}

---

TariffInfo

Детальная информация о тарифе.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор тарифа.
name	Да	string	Наименование тарифа.
duration	Да	integer(int32)	Срок действия тарифа в днях.
limit	Да	integer(int32)	Лимит документов в тарифе.

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

{
  "id": "68b09b27-5701-47ed-8468-98886351473b",
  "name": "Промо",
  "duration": 30,
  "limit": 100
}

---

TariffInfoResultList

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

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

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

{
  "count": 1,
  "data": [
    {
      "id": "68b09b27-5701-47ed-8468-98886351473b",
      "name": "Промо",
      "duration": 30,
      "limit": 100
    }
  ]
}

---

TaxAuthority

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

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

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

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

---

TaxAuthorityResultList

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

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

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

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

---

UpdateRegistrationRequestArgs

Параметры запроса на изменение заявки на регистрацию.

Название	Обязат.	Тип	Описание
partnerCode	Нет	string	Код партнера.
kpp	Нет	string	КПП. Обязателен для ЮЛ.
taxAuthorityId	Нет	string(uuid)	Идентификатор ИФНС. Обязателен для ЮЛ или ИП, имеющих ОГРН.
legalAddress	Нет	Одна из: AddressRequestArgs	Юридический адрес организации. Заполнять в формате “КЛАДР”
actualAddress	Нет	Одна из: AddressRequestArgs	Физический адрес организации. Обязателен для ЮЛ или ИП, имеющих ОГРН. Заполнять в формате “КЛАДР”.
email	Нет	string	Электронная почта организации.
phone	Нет	string	Номер телефона организации.
ipRegistrationCertificateNumber	Нет	string	Номер свидельства о регистрации ИП. Обязателен для ИП, чей сертификат выдан до 2017 года.
ipRegistrationDate	Нет	date-time	Дата регистрации ИП. Обязателен для ИП, имеющих ОГРН.

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

{
  "partnerCode": "0000",
  "kpp": "999901001",
  "taxAuthorityId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовое поселение",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "2",
    "apartment": "1"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовое поселение",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "2",
    "apartment": "1"
  },
  "email": "test@test.ru",
  "phone": "+70000000000",
  "ipRegistrationCertificateNumber": "00 000000000",
  "ipRegistrationDate": "2022-02-11T13:03:05.670Z"
}