# API для работы с Фирмами

## Используемые термины

**Аккаунт** - идентификатор фирмы в пространстве ATI.SU, включает в себя информацию об управляющем, оплаченных услугах, активных лицензиях, о рейтинге фирмы и контактах.

**Контакт** - рабочий профиль сотрудника, в котором указаны телефон, email, должность. У фирмы может быть несколько контактов.

**Реквизиты** - юридические данные фирмы.

**Фирма** - коммерческое предприятие, которое является участником ATI.SU.

## Возможности API

С помощью API Фирм участник ATI.SU может получить информацию о своем аккаунте и информацию по фирмам:

- [данные по своему аккаунту](#информация-об-аккаунте)
- [данные по контактам фирмы](#контакты-фирмы)
- [данные по реквизитам фирмы](#реквизиты-фирмы)
- [краткую информацию о фирме](#данные-по-фирмам)
- [данные по комментариям фирм](#комментарии-фирм)
- [дополнительные методы](#дополнительные-методы-поиска-информации-о-фирме)

## Методы для работы с Фирмами

### Информация об аккаунте

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

<a id="get-v1.2-account"></a>

**Версия: 1.2**

Получение информации о своей фирме

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.2/account' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "login": "string",
  "admin_email": "string",
  "add_date": "1970-01-01T00:00:00.000Z",
  "firm_type_id": 0,
  "firm_type": "string",
  "payed_services": [
    {
      "ati_id": "string",
      "service_id": 0,
      "service_name": "string",
      "dependencies": [
        0
      ]
    }
  ],
  "firm_active_services": [
    {
      "service_id": 0,
      "service_name": "string",
      "service_amount": 0
    }
  ],
  "payed_services_end_date": "1970-01-01T00:00:00.000Z",
  "time_zone_id": "string",
  "has_documents": false,
  "account_id": "string",
  "contact_id": 0,
  "full_firm_name": "string",
  "firm_name": "string",
  "brand": "string",
  "ownership": "string",
  "ownership_id": 0,
  "address": "string",
  "inn": "string",
  "ogrn": "string",
  "time_zone_minutes": 0,
  "claims_sum": 0.5,
  "claims_count": 0,
  "city_id": 0,
  "bad_partner_mentions_count": 0,
  "bad_partner_firms_count": 0,
  "recommendations_count": 0,
  "ri_users_attributes": 0,
  "ri_users_attributes2": 0,
  "firm_attributes": 0,
  "is_rrd": false,
  "loads_access": 0,
  "loads_access_reason": 0,
  "load_responses_access": 0,
  "load_responses_access_reason": 0,
  "unlimited_stealth_access": 0,
  "unlimited_stealth_access_reason": 0,
  "trucks_access": 0,
  "trucks_access_reason": 0,
  "truck_responses_access": 0,
  "truck_responses_access_reason": 0,
  "position_in_city": 0,
  "position_in_country": 0,
  "is_responses_for_black_list_enabled": false,
  "location": {
    "city_id": 0,
    "region_id": 0,
    "country_id": 0,
    "city_size": 0,
    "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "attributes": 0,
    "city_name": "string",
    "region_name": "string",
    "country_name": "string",
    "country_code_name": "string"
  },
  "passport": {
    "ati_id": "string",
    "total_score": 0.5,
    "ati_data_match_point": 0.5,
    "account_lifetime_point": 0.5,
    "business_activity_point": 0.5,
    "round_table_point": 0.5,
    "claim_point": 0.5,
    "prof_activity_point": 0.5,
    "ati_administration_point": 0.5,
    "clones_point": 0.5,
    "egr_point": 0.5,
    "mass_registration_point": 0.5,
    "mass_founder_point": 0.5,
    "firm_lifetime_point": 0.5,
    "ri_users_attributes": 0,
    "recommendations_count": 0,
    "status": 0,
    "status_description": "string"
  },
  "contacts": [
    {
      "id": 0,
      "name": "string",
      "fixed_rate_agreement_accepted": false,
      "telephone": "string",
      "telephone_brand": "string",
      "telephone_region": "string",
      "lo_users_attributes": 0,
      "email": "string",
      "icq": "string",
      "mobile": "string",
      "mobile_brand": "string",
      "mobile_region": "string",
      "skype_name": "string",
      "fax": "string",
      "mobile_operator": "string",
      "region_id": "string",
      "city_id": 0,
      "is_visibled": false,
      "is_email_visibled": false,
      "location": {
        "city_id": 0,
        "region_id": 0,
        "country_id": 0,
        "city_size": 0,
        "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "attributes": 0,
        "city_name": "string",
        "region_name": "string",
        "country_name": "string",
        "country_code_name": "string"
      },
      "access_rights": 0,
      "note": "string",
      "has_personal_password": false
    }
  ],
  "currency_id": 0,
  "note": "string",
  "http": "string",
  "taxation_type": 0,
  "with_vat": false
}
```

**Описание полей ответа**
- `login` — Логин пользователя
- `admin_email` — Адресс электронной почты администратора фирмы
- `add_date` — Дата создания аккаунта
- `firm_type_id` — Идентификатор профиля деятельности
- `firm_type` — Профиль деятельности
- `payed_services` — Структура "Оплаченные услуги"
- `payed_services[].service_id` — Идентификатор лицензии
- `payed_services[].service_name` — Название лицензии
- `payed_services[].dependencies` — Включенные лицензии
- `firm_active_services[].service_id` — Идентификатор лицензии
- `firm_active_services[].service_name` — Название лицензии
- `firm_active_services[].service_amount` — Количество лицензии
- `payed_services_end_date` — Дата окончания оплаченных услуг
- `time_zone_id` — Текстовое описание часового пояса
- `has_documents` — Флаг о наличии документов связанных с фирмой в таблице FirmDocuments
- `account_id` — Код фирмы в ATI.SU
- `contact_id` — Идентификатор контакта
- `full_firm_name` — Полное название фирмы, учитывается название фирмы, ОПФ и брэнд. Брэнд не включается в полное название для форм собственности (другая) ПБОЮЛ ПБЮЛ ФЛП физ.лицо
- `firm_name` — Название фирмы
- `brand` — Брэнд фирмы
- `ownership` — Организационно-правовая форма фирмы
- `ownership_id` — Идентификатор организационно-правовой формы фирмы
- `address` — Адрес фирмы
- `inn` — ИНН фирмы
- `ogrn` — ОГРН фирмы
- `time_zone_minutes` — Отступ в минутах от UTC для часового пояса, выставленного в кабинете данного аккаунта
- `claims_sum` — Сумма претензий к данной фирме в рублях
- `claims_count` — Количество претензий от фирм
- `city_id` — Идентификатор города
- `bad_partner_mentions_count` — Количество упоминаний на форуме Недобросовестных партнеров
- `bad_partner_firms_count` — Количество упоминаний о данной фирме на форуме "Недобросовестные партнеры"
- `recommendations_count` — Количество фирм, которые написали сообщение о данной фирме на форуме "Недобросовестные партнеры"
- `ri_users_attributes` — Аттрибуты фирмы
- `ri_users_attributes2` — Аттрибуты фирмы
- `firm_attributes` — Аттрибуты фирмы
- `is_rrd` — Включен ли у фирмы режим РРД
- `loads_access` — Уровень доступа пользователя к грузам
- `loads_access_reason` — Причина понижения доступа пользователя к грузам
- `load_responses_access` — Уровень доступа пользователя к отзывам на грузы
- `load_responses_access_reason` — Причина понижения доступа пользователя к отзывам на грузы
- `unlimited_stealth_access` — Уровень доступа пользователя к стеллс, id сервиса 400
- `unlimited_stealth_access_reason` — Причина понижения доступа пользователя к стеллс
- `trucks_access` — Уровень доступа пользователя к транспорту
- `trucks_access_reason` — Причина понижения доступа пользователя к транспорту
- `truck_responses_access` — Уровень доступа пользователя к отзывам на транспорт
- `truck_responses_access_reason` — Причина понижения доступа пользователя к отзывам на транспорт
- `position_in_city` — Место в рэйтинге по городу
- `position_in_country` — Место в рэйтинге по стране
- `is_responses_for_black_list_enabled` — Включено принятие встречных предложений от фирм из черного списка
- `location` — Структура "Город"
- `location.city_id` — Идентификатор города
- `location.region_id` — Идентификатор региона, в котором находится город
- `location.country_id` — Идентификатор страны, в которой находится город
- `location.city_size` — Идентификатор размера города
- `location.fias_id` — Идентификатор города по ФИАС
- `location.attributes` — Аттрибуты города
- `location.city_name` — Название города
- `location.region_name` — Название региона, в котором находится город
- `location.country_name` — Название страны, в которой находится город
- `location.country_code_name` — Кодовое название страны, в которой находится город
- `passport` — Структура "Паспорт"
- `passport.ati_id` — Идентификатор фирмы
- `passport.total_score` — Сумма баллов пользователя ATI.SU
- `passport.ati_data_match_point` — Данные фирмы в ATI.SU (название, город) совпадают с настоящими данными фирмы
- `passport.account_lifetime_point` — За срок "существования" фирмы
- `passport.business_activity_point` — Свидетельство ведения фирмой текущей хозяйственной деятельности.
- `passport.round_table_point` — Балл по решению общественного движения пользователей ATI.SU "Круглый стол"
- `passport.claim_point` — Балл за имеющиеся Претензии к пользователю
- `passport.prof_activity_point` — За проф. деятельность в ATI.SU.
- `passport.ati_administration_point` — По решению администрации ATI.SU
- `passport.clones_point` — Балл за клонов участника системы
- `passport.egr_point` — По данным Единых Государственных Реестров Юридических Лиц и ИП
- `passport.mass_registration_point` — Юридическое лицо зарегистрировано по адресу массовой регистрации
- `passport.mass_founder_point` — Учредитель юридического лица является учредителем множества других юридических лиц
- `passport.firm_lifetime_point` — За давность регистрации в АвтоТрансИнфо
- `passport.ri_users_attributes` — Аттрибуты фирмы
- `passport.recommendations_count` — Количество рекомендаций
- `passport.status` — Статус отвечает за цвет подложки звезд
- `passport.status_description` — Описание статуса
- `contacts` — Список структур "Контакт"
- `contacts[].id` — Идентификатор контакта
- `contacts[].name` — Имя контакта
- `contacts[].fixed_rate_agreement_accepted` — Контакт принял соглашение о фиксированной ставке.
- `contacts[].telephone` — Телефон контакта
- `contacts[].telephone_brand` — Брэнд телефона контакта
- `contacts[].telephone_region` — Русское название телефона контакта
- `contacts[].lo_users_attributes` — Атрибут пользователя
- `contacts[].email` — Электронная почта контакта
- `contacts[].icq` — Icq контакта
- `contacts[].mobile` — Мобильный телефона контакта
- `contacts[].mobile_brand` — Брэнд мобильного телефона контакта
- `contacts[].mobile_region` — Русское название мобильного телефона контакта
- `contacts[].skype_name` — Скайп контакта
- `contacts[].fax` — Факс контакта
- `contacts[].mobile_operator` — Мобильный оператор
- `contacts[].region_id` — Идентификатор региона контакта
- `contacts[].city_id` — Идентификатор города контакта
- `contacts[].is_visibled` — Параметр определяет, является ли контакт видимым или скрытым. От скрытого контакта нельзя добавить груз
- `contacts[].is_email_visibled` — Параметр определяет, является ли электронный адрес видимым или скрытым
- `contacts[].location` — Структура "Город" контакта
- `contacts[].location.city_id` — Идентификатор города
- `contacts[].location.region_id` — Идентификатор региона, в котором находится город
- `contacts[].location.country_id` — Идентификатор страны, в которой находится город
- `contacts[].location.city_size` — Идентификатор размера города
- `contacts[].location.fias_id` — Идентификатор города по ФИАС
- `contacts[].location.attributes` — Аттрибуты города
- `contacts[].location.city_name` — Название города
- `contacts[].location.region_name` — Название региона, в котором находится город
- `contacts[].location.country_name` — Название страны, в которой находится город
- `contacts[].location.country_code_name` — Кодовое название страны, в которой находится город
- `contacts[].access_rights` — Права доступа
- `contacts[].note` — Заметка о контакте
- `contacts[].has_personal_password` — Наличие личного пароля у контакта
- `currency_id` — Идентификатор валюты
- `note` — Примечание
- `http` — Сайт фирмы
- `taxation_type` — Тип налогооблажения
- `with_vat` — Ндс

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


### Контакты фирмы

#### Получение текущего контакта своей фирмы

<a id="get-v1.0-firms-contact"></a>

Метод получения текущего контакта фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/contact' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "id": 0,
  "firm_name": "string",
  "ownership": "string",
  "ownership_id": 0,
  "ati_id": "string",
  "firm_deletion_date": "1970-01-01T00:00:00.000Z",
  "name": "string",
  "phone": "string",
  "e_mail": "string",
  "email_for_link": "string",
  "icq": "string",
  "mobile": "string",
  "fax": "string",
  "note": "string",
  "is_visible": false,
  "is_email_visible": false,
  "mobile_id": 0,
  "phone_id": 0,
  "fax_id": 0,
  "skype_name": "string",
  "city_id": 0,
  "attributes": 0,
  "access_rights": 0,
  "gsm_operator_id": 0,
  "deletion_date": "1970-01-01T00:00:00.000Z",
  "is_photo_exists": false,
  "login": "string",
  "has_personal_password": false,
  "language": "string",
  "department_id": 0,
  "position": "string",
  "user_rights": 0,
  "contact_right_nesting_type_id": 0
}
```

**Описание полей ответа**
- `id` — Идентификатор контакта
- `firm_name` — Название фирмы
- `ownership` — Организационно-правовая форма
- `ownership_id` — Форма собственности
- `ati_id` — Код фирмы в ATI.SU
- `firm_deletion_date` — Дата удаления аккаунта
- `name` — Имя контакта
- `phone` — Номер телефона (основной)
- `e_mail` — Электронная почта контакта
- `email_for_link` — Адрес для отправки письма на задание логина/пароля
- `icq` — ICQ контакта
- `mobile` — Номер телефона контакта (мобильный)
- `fax` — Номер телефона контакта (факс)
- `note` — Примечание
- `is_visible` — Контакта виден / скрыт
- `is_email_visible` — E-mail виден / скрыт
- `mobile_id` — Номер телефона (мобильный) без кода города
- `phone_id` — Номер телефона (основной) без кода города
- `fax_id` — Номер телефона контакта (факс) без кода города
- `skype_name` — Логин в Skype
- `city_id` — Идентификатори города
- `attributes` — Атрибуты контакта
- `access_rights` — Права контакта (для ррд)
- `gsm_operator_id` — Идентификатор сотового оператора
- `deletion_date` — Дата удаления контакта
- `is_photo_exists` — Загружено ли фото
- `login` — Логин контакта
- `has_personal_password` — Есть ли персональный пароль
- `language` — Язык сайта выбранный, контактом
- `department_id` — Идентификатор основного подразделения контакта
- `position` — Должность
- `user_rights` — Права контакта в новой схеме
- `contact_right_nesting_type_id` — Уровень доступа к другим подразделениям

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение всех контактов своей фирмы

<a id="get-v1.0-firms-contacts"></a>

Метод получения всех контактов фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/contacts' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "id": 0,
    "firm_name": "string",
    "ownership": "string",
    "ownership_id": 0,
    "ati_id": "string",
    "firm_deletion_date": "1970-01-01T00:00:00.000Z",
    "name": "string",
    "phone": "string",
    "e_mail": "string",
    "email_for_link": "string",
    "icq": "string",
    "mobile": "string",
    "fax": "string",
    "note": "string",
    "is_visible": false,
    "is_email_visible": false,
    "mobile_id": 0,
    "phone_id": 0,
    "fax_id": 0,
    "skype_name": "string",
    "city_id": 0,
    "attributes": 0,
    "access_rights": 0,
    "gsm_operator_id": 0,
    "deletion_date": "1970-01-01T00:00:00.000Z",
    "is_photo_exists": false,
    "login": "string",
    "has_personal_password": false,
    "language": "string",
    "department_id": 0,
    "position": "string",
    "user_rights": 0,
    "contact_right_nesting_type_id": 0
  }
]
```

**Описание полей ответа**
- `[].id` — Идентификатор контакта
- `[].firm_name` — Название фирмы
- `[].ownership` — Организационно-правовая форма
- `[].ownership_id` — Форма собственности
- `[].ati_id` — Код фирмы в ATI.SU
- `[].firm_deletion_date` — Дата удаления аккаунта
- `[].name` — Имя контакта
- `[].phone` — Номер телефона (основной)
- `[].e_mail` — Электронная почта контакта
- `[].email_for_link` — Адрес для отправки письма на задание логина/пароля
- `[].icq` — ICQ контакта
- `[].mobile` — Номер телефона контакта (мобильный)
- `[].fax` — Номер телефона контакта (факс)
- `[].note` — Примечание
- `[].is_visible` — Контакта виден / скрыт
- `[].is_email_visible` — E-mail виден / скрыт
- `[].mobile_id` — Номер телефона (мобильный) без кода города
- `[].phone_id` — Номер телефона (основной) без кода города
- `[].fax_id` — Номер телефона контакта (факс) без кода города
- `[].skype_name` — Логин в Skype
- `[].city_id` — Идентификатори города
- `[].attributes` — Атрибуты контакта
- `[].access_rights` — Права контакта (для ррд)
- `[].gsm_operator_id` — Идентификатор сотового оператора
- `[].deletion_date` — Дата удаления контакта
- `[].is_photo_exists` — Загружено ли фото
- `[].login` — Логин контакта
- `[].has_personal_password` — Есть ли персональный пароль
- `[].language` — Язык сайта выбранный, контактом
- `[].department_id` — Идентификатор основного подразделения контакта
- `[].position` — Должность
- `[].user_rights` — Права контакта в новой схеме
- `[].contact_right_nesting_type_id` — Уровень доступа к другим подразделениям

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение краткой информации о контакте другой фирмы по его идентификатору

<a id="get-v1.0-firms-{atiId}-contacts-{contactId}-summary"></a>

Получение краткой информации о контакте фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/string/contacts/0/summary' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "ati_id": "string",
  "contact_id": 0,
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "claims_count": 0,
  "recommendations_count": 0,
  "bad_partner_mentions_count": 0,
  "firm_type": "string",
  "firm_name": "string",
  "ownership": "string",
  "city": "string",
  "score": 0.5,
  "status": 0,
  "icq": "string",
  "fax": "string",
  "skype_name": "string",
  "email": "string",
  "language": "string"
}
```

**Описание полей ответа**
- `ati_id` — Код в ATI.SU.
- `contact_id` — Идентификатор контакта.
- `name` — Имя контакта.
- `phone` — Рабочий телефон.
- `mobile_phone` — Мобильный телефон.
- `claims_count` — Количество претензий.
- `recommendations_count` — Количество рекомендаций.
- `bad_partner_mentions_count` — Количество упоминаний на форуме "Недобросовестные партнеры".
- `firm_type` — Профиль деятельности фирмы.
- `firm_name` — Название фирмы.
- `ownership` — Организационно-правовая форма.
- `city` — Город
- `score` — Количество звезд фирмы.
- `status` — Статус, определяющий цвет подложки звезд.
- `icq` — Icq контакта
- `fax` — Факс контакта
- `skype_name` — Skype контакта
- `email` — Email контакта
- `language` — Язык контакта

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение краткой информации обо всех контактах другой фирмы

<a id="get-v1.0-firms-{atiId}-contacts-summary"></a>

Получение краткой информации о всех контактах фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/string/contacts/summary' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "ati_id": "string",
    "contact_id": 0,
    "name": "string",
    "phone": "string",
    "mobile_phone": "string",
    "claims_count": 0,
    "recommendations_count": 0,
    "bad_partner_mentions_count": 0,
    "firm_type": "string",
    "firm_name": "string",
    "ownership": "string",
    "city": "string",
    "score": 0.5,
    "status": 0,
    "icq": "string",
    "fax": "string",
    "skype_name": "string",
    "email": "string",
    "language": "string"
  }
]
```

**Описание полей ответа**
- `[].ati_id` — Код в ATI.SU.
- `[].contact_id` — Идентификатор контакта.
- `[].name` — Имя контакта.
- `[].phone` — Рабочий телефон.
- `[].mobile_phone` — Мобильный телефон.
- `[].claims_count` — Количество претензий.
- `[].recommendations_count` — Количество рекомендаций.
- `[].bad_partner_mentions_count` — Количество упоминаний на форуме "Недобросовестные партнеры".
- `[].firm_type` — Профиль деятельности фирмы.
- `[].firm_name` — Название фирмы.
- `[].ownership` — Организационно-правовая форма.
- `[].city` — Город
- `[].score` — Количество звезд фирмы.
- `[].status` — Статус, определяющий цвет подложки звезд.
- `[].icq` — Icq контакта
- `[].fax` — Факс контакта
- `[].skype_name` — Skype контакта
- `[].email` — Email контакта
- `[].language` — Язык контакта

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение email конкретного контакта фирмы

<a id="get-v1.0-firms-contact-{atiId}-{contactId}-email"></a>

Получить email контакта

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/contact/string/0/email' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "email": "string"
}
```

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Изменение контакта фирмы

<a id="put-v1.0-firms-contacts"></a>

Метод редактирования контакта фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/contacts' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "firm_id": 0,
  "firm_name": "string",
  "ownership": "string",
  "ownership_id": 0,
  "password": "string",
  "id": 0,
  "ati_id": "string",
  "firm_deletion_date": "1970-01-01T00:00:00.000Z",
  "name": "string",
  "phone": "string",
  "e_mail": "string",
  "email_for_link": "string",
  "icq": "string",
  "mobile": "string",
  "fax": "string",
  "note": "string",
  "is_visible": false,
  "is_email_visible": false,
  "mobile_id": 0,
  "phone_id": 0,
  "fax_id": 0,
  "skype_name": "string",
  "city_id": 0,
  "attributes": 0,
  "access_rights": 0,
  "gsm_operator_id": 0,
  "deletion_date": "1970-01-01T00:00:00.000Z",
  "is_photo_exists": false,
  "login": "string",
  "has_personal_password": false,
  "language": "string",
  "department_id": 0,
  "position": "string",
  "user_rights": 0,
  "contact_right_nesting_type_id": 0
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Описание полей запроса**
- `firm_id` — Идентификатор фирмы
- `firm_name` — Название фирмы
- `ownership` — Организационно-правовая форма
- `ownership_id` — Форма собственности
- `password` — Пароль
- `id` — Идентификатор контакта
- `ati_id` — Код фирмы в ATI.SU
- `firm_deletion_date` — Дата удаления аккаунта
- `name` — Имя контакта
- `phone` — Номер телефона (основной)
- `e_mail` — Электронная почта контакта
- `email_for_link` — Адрес для отправки письма на задание логина/пароля
- `icq` — ICQ контакта
- `mobile` — Номер телефона контакта (мобильный)
- `fax` — Номер телефона контакта (факс)
- `note` — Примечание
- `is_visible` — Контакта виден / скрыт
- `is_email_visible` — E-mail виден / скрыт
- `mobile_id` — Номер телефона (мобильный) без кода города
- `phone_id` — Номер телефона (основной) без кода города
- `fax_id` — Номер телефона контакта (факс) без кода города
- `skype_name` — Логин в Skype
- `city_id` — Идентификатори города
- `attributes` — Атрибуты контакта
- `access_rights` — Права контакта (для ррд)
- `gsm_operator_id` — Идентификатор сотового оператора
- `deletion_date` — Дата удаления контакта
- `is_photo_exists` — Загружено ли фото
- `login` — Логин контакта
- `has_personal_password` — Есть ли персональный пароль
- `language` — Язык сайта выбранный, контактом
- `department_id` — Идентификатор основного подразделения контакта
- `position` — Должность
- `user_rights` — Права контакта в новой схеме
- `contact_right_nesting_type_id` — Уровень доступа к другим подразделениям

**Пример ответа (200)**

```json
{
  "id": 0,
  "firm_name": "string",
  "ownership": "string",
  "ownership_id": 0,
  "ati_id": "string",
  "firm_deletion_date": "1970-01-01T00:00:00.000Z",
  "name": "string",
  "phone": "string",
  "e_mail": "string",
  "email_for_link": "string",
  "icq": "string",
  "mobile": "string",
  "fax": "string",
  "note": "string",
  "is_visible": false,
  "is_email_visible": false,
  "mobile_id": 0,
  "phone_id": 0,
  "fax_id": 0,
  "skype_name": "string",
  "city_id": 0,
  "attributes": 0,
  "access_rights": 0,
  "gsm_operator_id": 0,
  "deletion_date": "1970-01-01T00:00:00.000Z",
  "is_photo_exists": false,
  "login": "string",
  "has_personal_password": false,
  "language": "string",
  "department_id": 0,
  "position": "string",
  "user_rights": 0,
  "contact_right_nesting_type_id": 0
}
```

**Описание полей ответа**
- `id` — Идентификатор контакта
- `firm_name` — Название фирмы
- `ownership` — Организационно-правовая форма
- `ownership_id` — Форма собственности
- `ati_id` — Код фирмы в ATI.SU
- `firm_deletion_date` — Дата удаления аккаунта
- `name` — Имя контакта
- `phone` — Номер телефона (основной)
- `e_mail` — Электронная почта контакта
- `email_for_link` — Адрес для отправки письма на задание логина/пароля
- `icq` — ICQ контакта
- `mobile` — Номер телефона контакта (мобильный)
- `fax` — Номер телефона контакта (факс)
- `note` — Примечание
- `is_visible` — Контакта виден / скрыт
- `is_email_visible` — E-mail виден / скрыт
- `mobile_id` — Номер телефона (мобильный) без кода города
- `phone_id` — Номер телефона (основной) без кода города
- `fax_id` — Номер телефона контакта (факс) без кода города
- `skype_name` — Логин в Skype
- `city_id` — Идентификатори города
- `attributes` — Атрибуты контакта
- `access_rights` — Права контакта (для ррд)
- `gsm_operator_id` — Идентификатор сотового оператора
- `deletion_date` — Дата удаления контакта
- `is_photo_exists` — Загружено ли фото
- `login` — Логин контакта
- `has_personal_password` — Есть ли персональный пароль
- `language` — Язык сайта выбранный, контактом
- `department_id` — Идентификатор основного подразделения контакта
- `position` — Должность
- `user_rights` — Права контакта в новой схеме
- `contact_right_nesting_type_id` — Уровень доступа к другим подразделениям

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


### Реквизиты фирмы

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

<a id="get-v1.0-firms-requisites-{requisiteId}"></a>

Метод получения реквизитов по ID

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/requisites/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "requisite_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ati_id": "string",
  "requisite_type_id": 0,
  "requisite_name": "string",
  "legal_name": "string",
  "own_ship_id": 0,
  "fio": "string",
  "inn": "string",
  "ogrn": "string",
  "phone": "string",
  "fax": "string",
  "email": "string",
  "kpp": "string",
  "rs": "string",
  "ks": "string",
  "bik": "string",
  "bank": "string",
  "codes": "string",
  "is_read_only": false,
  "okpo": "string",
  "is_vat_payer": false,
  "last_use_date": "1970-01-01T00:00:00.000Z",
  "is_active": true,
  "is_visible": true,
  "legal_address": {
    "address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ati_id": "string",
    "country_id": 0,
    "region_id": 0,
    "city_id": 0,
    "city_name": "string",
    "post_index": "string",
    "street_type_id": 0,
    "street_name": "string",
    "house_no": "string",
    "part_no": "string",
    "litera": "string",
    "office_no": "string",
    "post_contact": "string",
    "add_date": "1970-01-01T00:00:00.000Z",
    "attributes": 0,
    "send_type_id": 0,
    "note": "string",
    "formatted_text": "string",
    "is_post_address": false,
    "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fias_level": 0
  },
  "post_address": {
    "address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ati_id": "string",
    "country_id": 0,
    "region_id": 0,
    "city_id": 0,
    "city_name": "string",
    "post_index": "string",
    "street_type_id": 0,
    "street_name": "string",
    "house_no": "string",
    "part_no": "string",
    "litera": "string",
    "office_no": "string",
    "post_contact": "string",
    "add_date": "1970-01-01T00:00:00.000Z",
    "attributes": 0,
    "send_type_id": 0,
    "note": "string",
    "formatted_text": "string",
    "is_post_address": false,
    "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fias_level": 0
  },
  "legal_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "post_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "signees": [
    {
      "signee_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "requisite_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "full_name": "string",
      "position": "string",
      "act_upon": "string",
      "is_default": false,
      "deletion_date": "1970-01-01T00:00:00.000Z",
      "full_name_and_position": "string"
    }
  ],
  "person_passport": {
    "series": "string",
    "number": "string",
    "date_of_issue": "1970-01-01T00:00:00.000Z",
    "department_code": "string",
    "issued_by": "string",
    "registration": "string",
    "scan_files": [
      {
        "link": "string",
        "id": "string",
        "size": 0,
        "name": "string"
      }
    ]
  }
}
```

**Описание полей ответа**
- `requisite_id` — Идентификтаор реквизита
- `ati_id` — Код в ATI.SU фирмы
- `requisite_type_id` — Тип реквизита
- `requisite_name` — Название реквизита
- `legal_name` — Юридическое именование фирмы
- `own_ship_id` — Идентификатор формы собственности
- `fio` — ФИО владельца
- `inn` — ИНН
- `ogrn` — ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT
- `phone` — Телефон
- `fax` — Факс
- `email` — Электронный адрес
- `kpp` — КПП
- `rs` — Расчетный счет
- `ks` — КС
- `bik` — БИК
- `bank` — Наименование банка
- `codes` — Коды
- `is_read_only` — Реквизиты только для чтения
- `okpo` — ОКПО
- `is_vat_payer` — Плательщик НДС
- `last_use_date` — Дата последнего использования в системе
- `is_active` — Активный реквизит
- `is_visible` — Будет ли виден реквизит пользователю в будущем Нужен для одноразовых реквизитов, например, при создании счета с оплатой по банковской карте (там создается реквизит из пары полей)
- `legal_address` — Юридический адрес
- `legal_address.address_id` — Идентификатор адреса
- `legal_address.ati_id` — Код в ATI.SU фирмы
- `legal_address.country_id` — Идентификатор страны
- `legal_address.region_id` — Идентификатор региона
- `legal_address.city_id` — Идентификатор Города
- `legal_address.city_name` — Название города
- `legal_address.post_index` — Почтовый индекс
- `legal_address.street_type_id` — Тип улицы
- `legal_address.street_name` — Улица
- `legal_address.house_no` — Номер дома
- `legal_address.part_no` — Корпус дома
- `legal_address.litera` — Литера
- `legal_address.office_no` — Номер офиса
- `legal_address.post_contact` — Получатель почты
- `legal_address.add_date` — Дата добавления
- `legal_address.attributes` — Аттрибуты
- `legal_address.send_type_id` — ?
- `legal_address.note` — Примечание
- `legal_address.formatted_text` — ?
- `legal_address.is_post_address` — Является почтовым адресом
- `legal_address.fias_id` — Идентификатор в ФИАС
- `legal_address.fias_level` — Уровень в ФИАС
- `post_address` — Почтовый адрес
- `post_address.address_id` — Идентификатор адреса
- `post_address.ati_id` — Код в ATI.SU фирмы
- `post_address.country_id` — Идентификатор страны
- `post_address.region_id` — Идентификатор региона
- `post_address.city_id` — Идентификатор Города
- `post_address.city_name` — Название города
- `post_address.post_index` — Почтовый индекс
- `post_address.street_type_id` — Тип улицы
- `post_address.street_name` — Улица
- `post_address.house_no` — Номер дома
- `post_address.part_no` — Корпус дома
- `post_address.litera` — Литера
- `post_address.office_no` — Номер офиса
- `post_address.post_contact` — Получатель почты
- `post_address.add_date` — Дата добавления
- `post_address.attributes` — Аттрибуты
- `post_address.send_type_id` — ?
- `post_address.note` — Примечание
- `post_address.formatted_text` — ?
- `post_address.is_post_address` — Является почтовым адресом
- `post_address.fias_id` — Идентификатор в ФИАС
- `post_address.fias_level` — Уровень в ФИАС
- `legal_address_id` — Идентификатор юридического адреса в системе
- `post_address_id` — Идентификатор почтового адреса в системе
- `signees` — Список подписантов
- `signees[].signee_id` — Идентификатор подписанта.
- `signees[].requisite_id` — Идентификатор реквизита, которому принадлежит эта запись.
- `signees[].full_name` — ФИО (обязательно в родительном падеже).
- `signees[].position` — Должность (обязательно в родительном падеже).
- `signees[].act_upon` — На основании чего действует (обязательно в родительном падеже).
- `signees[].is_default` — Выбирать по умолчанию.
- `signees[].deletion_date` — Дата удаления.
- `signees[].full_name_and_position` — Поле, объединяющее FullName и Position. Не является автовычисляемым (т.е. не является конкатенацией полей FullName и Position), создано для других нужд.
- `person_passport` — Паспорт физического лица
- `person_passport.series` — Серия
- `person_passport.number` — Номер
- `person_passport.date_of_issue` — Дата выдачи
- `person_passport.department_code` — Код подразделения
- `person_passport.issued_by` — Выдан
- `person_passport.registration` — Адрес регистрации
- `person_passport.scan_files[].link` — Ccылка
- `person_passport.scan_files[].id` — Идентификатор
- `person_passport.scan_files[].size` — Размер
- `person_passport.scan_files[].name` — Название

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение всех реквизитов своей фирмы

<a id="get-v1.0-firms-requisites"></a>

Метод получения реквизитов фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/requisites?atiId=string&withShortRequisite=false' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "requisite_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ati_id": "string",
    "requisite_type_id": 0,
    "requisite_name": "string",
    "legal_name": "string",
    "own_ship_id": 0,
    "fio": "string",
    "inn": "string",
    "ogrn": "string",
    "phone": "string",
    "fax": "string",
    "email": "string",
    "kpp": "string",
    "rs": "string",
    "ks": "string",
    "bik": "string",
    "bank": "string",
    "codes": "string",
    "is_read_only": false,
    "okpo": "string",
    "is_vat_payer": false,
    "last_use_date": "1970-01-01T00:00:00.000Z",
    "is_active": true,
    "is_visible": true,
    "legal_address": {
      "address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ati_id": "string",
      "country_id": 0,
      "region_id": 0,
      "city_id": 0,
      "city_name": "string",
      "post_index": "string",
      "street_type_id": 0,
      "street_name": "string",
      "house_no": "string",
      "part_no": "string",
      "litera": "string",
      "office_no": "string",
      "post_contact": "string",
      "add_date": "1970-01-01T00:00:00.000Z",
      "attributes": 0,
      "send_type_id": 0,
      "note": "string",
      "formatted_text": "string",
      "is_post_address": false,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fias_level": 0
    },
    "post_address": {
      "address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ati_id": "string",
      "country_id": 0,
      "region_id": 0,
      "city_id": 0,
      "city_name": "string",
      "post_index": "string",
      "street_type_id": 0,
      "street_name": "string",
      "house_no": "string",
      "part_no": "string",
      "litera": "string",
      "office_no": "string",
      "post_contact": "string",
      "add_date": "1970-01-01T00:00:00.000Z",
      "attributes": 0,
      "send_type_id": 0,
      "note": "string",
      "formatted_text": "string",
      "is_post_address": false,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fias_level": 0
    },
    "legal_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "post_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "signees": [
      {
        "signee_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requisite_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "full_name": "string",
        "position": "string",
        "act_upon": "string",
        "is_default": false,
        "deletion_date": "1970-01-01T00:00:00.000Z",
        "full_name_and_position": "string"
      }
    ],
    "person_passport": {
      "series": "string",
      "number": "string",
      "date_of_issue": "1970-01-01T00:00:00.000Z",
      "department_code": "string",
      "issued_by": "string",
      "registration": "string",
      "scan_files": [
        {
          "link": "string",
          "id": "string",
          "size": 0,
          "name": "string"
        }
      ]
    }
  }
]
```

**Описание полей ответа**
- `[].requisite_id` — Идентификтаор реквизита
- `[].ati_id` — Код в ATI.SU фирмы
- `[].requisite_type_id` — Тип реквизита
- `[].requisite_name` — Название реквизита
- `[].legal_name` — Юридическое именование фирмы
- `[].own_ship_id` — Идентификатор формы собственности
- `[].fio` — ФИО владельца
- `[].inn` — ИНН
- `[].ogrn` — ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT
- `[].phone` — Телефон
- `[].fax` — Факс
- `[].email` — Электронный адрес
- `[].kpp` — КПП
- `[].rs` — Расчетный счет
- `[].ks` — КС
- `[].bik` — БИК
- `[].bank` — Наименование банка
- `[].codes` — Коды
- `[].is_read_only` — Реквизиты только для чтения
- `[].okpo` — ОКПО
- `[].is_vat_payer` — Плательщик НДС
- `[].last_use_date` — Дата последнего использования в системе
- `[].is_active` — Активный реквизит
- `[].is_visible` — Будет ли виден реквизит пользователю в будущем Нужен для одноразовых реквизитов, например, при создании счета с оплатой по банковской карте (там создается реквизит из пары полей)
- `[].legal_address` — Юридический адрес
- `[].legal_address.address_id` — Идентификатор адреса
- `[].legal_address.ati_id` — Код в ATI.SU фирмы
- `[].legal_address.country_id` — Идентификатор страны
- `[].legal_address.region_id` — Идентификатор региона
- `[].legal_address.city_id` — Идентификатор Города
- `[].legal_address.city_name` — Название города
- `[].legal_address.post_index` — Почтовый индекс
- `[].legal_address.street_type_id` — Тип улицы
- `[].legal_address.street_name` — Улица
- `[].legal_address.house_no` — Номер дома
- `[].legal_address.part_no` — Корпус дома
- `[].legal_address.litera` — Литера
- `[].legal_address.office_no` — Номер офиса
- `[].legal_address.post_contact` — Получатель почты
- `[].legal_address.add_date` — Дата добавления
- `[].legal_address.attributes` — Аттрибуты
- `[].legal_address.send_type_id` — ?
- `[].legal_address.note` — Примечание
- `[].legal_address.formatted_text` — ?
- `[].legal_address.is_post_address` — Является почтовым адресом
- `[].legal_address.fias_id` — Идентификатор в ФИАС
- `[].legal_address.fias_level` — Уровень в ФИАС
- `[].post_address` — Почтовый адрес
- `[].post_address.address_id` — Идентификатор адреса
- `[].post_address.ati_id` — Код в ATI.SU фирмы
- `[].post_address.country_id` — Идентификатор страны
- `[].post_address.region_id` — Идентификатор региона
- `[].post_address.city_id` — Идентификатор Города
- `[].post_address.city_name` — Название города
- `[].post_address.post_index` — Почтовый индекс
- `[].post_address.street_type_id` — Тип улицы
- `[].post_address.street_name` — Улица
- `[].post_address.house_no` — Номер дома
- `[].post_address.part_no` — Корпус дома
- `[].post_address.litera` — Литера
- `[].post_address.office_no` — Номер офиса
- `[].post_address.post_contact` — Получатель почты
- `[].post_address.add_date` — Дата добавления
- `[].post_address.attributes` — Аттрибуты
- `[].post_address.send_type_id` — ?
- `[].post_address.note` — Примечание
- `[].post_address.formatted_text` — ?
- `[].post_address.is_post_address` — Является почтовым адресом
- `[].post_address.fias_id` — Идентификатор в ФИАС
- `[].post_address.fias_level` — Уровень в ФИАС
- `[].legal_address_id` — Идентификатор юридического адреса в системе
- `[].post_address_id` — Идентификатор почтового адреса в системе
- `[].signees` — Список подписантов
- `[].signees[].signee_id` — Идентификатор подписанта.
- `[].signees[].requisite_id` — Идентификатор реквизита, которому принадлежит эта запись.
- `[].signees[].full_name` — ФИО (обязательно в родительном падеже).
- `[].signees[].position` — Должность (обязательно в родительном падеже).
- `[].signees[].act_upon` — На основании чего действует (обязательно в родительном падеже).
- `[].signees[].is_default` — Выбирать по умолчанию.
- `[].signees[].deletion_date` — Дата удаления.
- `[].signees[].full_name_and_position` — Поле, объединяющее FullName и Position. Не является автовычисляемым (т.е. не является конкатенацией полей FullName и Position), создано для других нужд.
- `[].person_passport` — Паспорт физического лица
- `[].person_passport.series` — Серия
- `[].person_passport.number` — Номер
- `[].person_passport.date_of_issue` — Дата выдачи
- `[].person_passport.department_code` — Код подразделения
- `[].person_passport.issued_by` — Выдан
- `[].person_passport.registration` — Адрес регистрации
- `[].person_passport.scan_files[].link` — Ccылка
- `[].person_passport.scan_files[].id` — Идентификатор
- `[].person_passport.scan_files[].size` — Размер
- `[].person_passport.scan_files[].name` — Название

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение реквизитов другой фирмы

<a id="get-v1.0-firms-{atiId}-requisites"></a>

Метод получения реквизитов фирмы

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/string/requisites?withShortRequisite=false' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "requisite_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ati_id": "string",
    "requisite_type_id": 0,
    "requisite_name": "string",
    "legal_name": "string",
    "own_ship_id": 0,
    "fio": "string",
    "inn": "string",
    "ogrn": "string",
    "phone": "string",
    "fax": "string",
    "email": "string",
    "kpp": "string",
    "rs": "string",
    "ks": "string",
    "bik": "string",
    "bank": "string",
    "codes": "string",
    "is_read_only": false,
    "okpo": "string",
    "is_vat_payer": false,
    "last_use_date": "1970-01-01T00:00:00.000Z",
    "is_active": true,
    "is_visible": true,
    "legal_address": {
      "address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ati_id": "string",
      "country_id": 0,
      "region_id": 0,
      "city_id": 0,
      "city_name": "string",
      "post_index": "string",
      "street_type_id": 0,
      "street_name": "string",
      "house_no": "string",
      "part_no": "string",
      "litera": "string",
      "office_no": "string",
      "post_contact": "string",
      "add_date": "1970-01-01T00:00:00.000Z",
      "attributes": 0,
      "send_type_id": 0,
      "note": "string",
      "formatted_text": "string",
      "is_post_address": false,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fias_level": 0
    },
    "post_address": {
      "address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ati_id": "string",
      "country_id": 0,
      "region_id": 0,
      "city_id": 0,
      "city_name": "string",
      "post_index": "string",
      "street_type_id": 0,
      "street_name": "string",
      "house_no": "string",
      "part_no": "string",
      "litera": "string",
      "office_no": "string",
      "post_contact": "string",
      "add_date": "1970-01-01T00:00:00.000Z",
      "attributes": 0,
      "send_type_id": 0,
      "note": "string",
      "formatted_text": "string",
      "is_post_address": false,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fias_level": 0
    },
    "legal_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "post_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "signees": [
      {
        "signee_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requisite_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "full_name": "string",
        "position": "string",
        "act_upon": "string",
        "is_default": false,
        "deletion_date": "1970-01-01T00:00:00.000Z",
        "full_name_and_position": "string"
      }
    ],
    "person_passport": {
      "series": "string",
      "number": "string",
      "date_of_issue": "1970-01-01T00:00:00.000Z",
      "department_code": "string",
      "issued_by": "string",
      "registration": "string",
      "scan_files": [
        {
          "link": "string",
          "id": "string",
          "size": 0,
          "name": "string"
        }
      ]
    }
  }
]
```

**Описание полей ответа**
- `[].requisite_id` — Идентификтаор реквизита
- `[].ati_id` — Код в ATI.SU фирмы
- `[].requisite_type_id` — Тип реквизита
- `[].requisite_name` — Название реквизита
- `[].legal_name` — Юридическое именование фирмы
- `[].own_ship_id` — Идентификатор формы собственности
- `[].fio` — ФИО владельца
- `[].inn` — ИНН
- `[].ogrn` — ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT
- `[].phone` — Телефон
- `[].fax` — Факс
- `[].email` — Электронный адрес
- `[].kpp` — КПП
- `[].rs` — Расчетный счет
- `[].ks` — КС
- `[].bik` — БИК
- `[].bank` — Наименование банка
- `[].codes` — Коды
- `[].is_read_only` — Реквизиты только для чтения
- `[].okpo` — ОКПО
- `[].is_vat_payer` — Плательщик НДС
- `[].last_use_date` — Дата последнего использования в системе
- `[].is_active` — Активный реквизит
- `[].is_visible` — Будет ли виден реквизит пользователю в будущем Нужен для одноразовых реквизитов, например, при создании счета с оплатой по банковской карте (там создается реквизит из пары полей)
- `[].legal_address` — Юридический адрес
- `[].legal_address.address_id` — Идентификатор адреса
- `[].legal_address.ati_id` — Код в ATI.SU фирмы
- `[].legal_address.country_id` — Идентификатор страны
- `[].legal_address.region_id` — Идентификатор региона
- `[].legal_address.city_id` — Идентификатор Города
- `[].legal_address.city_name` — Название города
- `[].legal_address.post_index` — Почтовый индекс
- `[].legal_address.street_type_id` — Тип улицы
- `[].legal_address.street_name` — Улица
- `[].legal_address.house_no` — Номер дома
- `[].legal_address.part_no` — Корпус дома
- `[].legal_address.litera` — Литера
- `[].legal_address.office_no` — Номер офиса
- `[].legal_address.post_contact` — Получатель почты
- `[].legal_address.add_date` — Дата добавления
- `[].legal_address.attributes` — Аттрибуты
- `[].legal_address.send_type_id` — ?
- `[].legal_address.note` — Примечание
- `[].legal_address.formatted_text` — ?
- `[].legal_address.is_post_address` — Является почтовым адресом
- `[].legal_address.fias_id` — Идентификатор в ФИАС
- `[].legal_address.fias_level` — Уровень в ФИАС
- `[].post_address` — Почтовый адрес
- `[].post_address.address_id` — Идентификатор адреса
- `[].post_address.ati_id` — Код в ATI.SU фирмы
- `[].post_address.country_id` — Идентификатор страны
- `[].post_address.region_id` — Идентификатор региона
- `[].post_address.city_id` — Идентификатор Города
- `[].post_address.city_name` — Название города
- `[].post_address.post_index` — Почтовый индекс
- `[].post_address.street_type_id` — Тип улицы
- `[].post_address.street_name` — Улица
- `[].post_address.house_no` — Номер дома
- `[].post_address.part_no` — Корпус дома
- `[].post_address.litera` — Литера
- `[].post_address.office_no` — Номер офиса
- `[].post_address.post_contact` — Получатель почты
- `[].post_address.add_date` — Дата добавления
- `[].post_address.attributes` — Аттрибуты
- `[].post_address.send_type_id` — ?
- `[].post_address.note` — Примечание
- `[].post_address.formatted_text` — ?
- `[].post_address.is_post_address` — Является почтовым адресом
- `[].post_address.fias_id` — Идентификатор в ФИАС
- `[].post_address.fias_level` — Уровень в ФИАС
- `[].legal_address_id` — Идентификатор юридического адреса в системе
- `[].post_address_id` — Идентификатор почтового адреса в системе
- `[].signees` — Список подписантов
- `[].signees[].signee_id` — Идентификатор подписанта.
- `[].signees[].requisite_id` — Идентификатор реквизита, которому принадлежит эта запись.
- `[].signees[].full_name` — ФИО (обязательно в родительном падеже).
- `[].signees[].position` — Должность (обязательно в родительном падеже).
- `[].signees[].act_upon` — На основании чего действует (обязательно в родительном падеже).
- `[].signees[].is_default` — Выбирать по умолчанию.
- `[].signees[].deletion_date` — Дата удаления.
- `[].signees[].full_name_and_position` — Поле, объединяющее FullName и Position. Не является автовычисляемым (т.е. не является конкатенацией полей FullName и Position), создано для других нужд.
- `[].person_passport` — Паспорт физического лица
- `[].person_passport.series` — Серия
- `[].person_passport.number` — Номер
- `[].person_passport.date_of_issue` — Дата выдачи
- `[].person_passport.department_code` — Код подразделения
- `[].person_passport.issued_by` — Выдан
- `[].person_passport.registration` — Адрес регистрации
- `[].person_passport.scan_files[].link` — Ccылка
- `[].person_passport.scan_files[].id` — Идентификатор
- `[].person_passport.scan_files[].size` — Размер
- `[].person_passport.scan_files[].name` — Название

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


### Данные по фирмам

#### Получение краткой информации о своей фирме

<a id="get-v1.0-firms-summary"></a>

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

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/summary' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "ati_id": "string",
  "brand": "string",
  "ownership": "string",
  "full_name": "string",
  "firm_name": "string",
  "location": {
    "city_id": 0,
    "region_id": 0,
    "country_id": 0,
    "city_size": 0,
    "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "attributes": 0,
    "city_name": "string",
    "region_name": "string",
    "country_name": "string",
    "country_code_name": "string"
  },
  "address": "string",
  "web_site": "string",
  "position_in_city": 0,
  "position_in_country": 0,
  "name_eng": "string",
  "firm_type": "string",
  "firm_type_id_int": 0,
  "firm_type_id": "string",
  "predicted_firm_type_id": 0,
  "info_reference": "string",
  "passport_reference": "string",
  "city": "string",
  "score": 0.5,
  "bad_partner_mentions_count": 0,
  "claims_count": 0,
  "language": "string",
  "recommendations_count": 0,
  "inn": "string",
  "ogrn": "string",
  "kpp": "string",
  "okpo": "string",
  "affiliated_firms": [
    {
      "firm_name": "string",
      "inn": "string",
      "tf_firm_color": "string",
      "tf_has_signals": false
    }
  ],
  "negative_points_sum": 0.5,
  "tf_firm_color": "string",
  "tf_account_color": "string",
  "tf_has_signals": false,
  "registration_date": "1970-01-01T00:00:00.000Z",
  "contact_info_changed": "1970-01-01T00:00:00.000Z",
  "deletion_date": "1970-01-01T00:00:00.000Z",
  "last_month_active_days": 0,
  "firm_documents": [
    {
      "link": "string",
      "description": "string",
      "creation_date": "1970-01-01T00:00:00.000Z",
      "name": "string",
      "type_id": 0
    }
  ],
  "verified_trucks": 0
}
```

**Описание полей ответа**
- `ati_id` — Идентификатор фирмы
- `brand` — Брэнд фирмы
- `ownership` — Организационно-правовая форма фирмы
- `full_name` — Полное имя фирмы: Брэнд (Название фирмы, ОПФ)
- `firm_name` — Название фирмы
- `location` — Структура "Город"
- `location.city_id` — Идентификатор города
- `location.region_id` — Идентификатор региона, в котором находится город
- `location.country_id` — Идентификатор страны, в которой находится город
- `location.city_size` — Идентификатор размера города
- `location.fias_id` — Идентификатор города по ФИАС
- `location.attributes` — Аттрибуты города
- `location.city_name` — Название города
- `location.region_name` — Название региона, в котором находится город
- `location.country_name` — Название страны, в которой находится город
- `location.country_code_name` — Кодовое название страны, в которой находится город
- `address` — Адрес фирмы
- `web_site` — Сайт фирмы
- `position_in_city` — Место в рэйтинге по городу
- `position_in_country` — Место в рэйтинге по стране
- `name_eng` — Интернациональное название фирмы
- `firm_type` — Профиль деятельности фирмы
- `firm_type_id_int` — Идентификатор профиля деятельности
- `firm_type_id` — (Устаревшее) Идентификатор профиля деятельности строкой
- `predicted_firm_type_id` — Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе
- `info_reference` — Ссылка на карточку фирмы
- `passport_reference` — Ссылка на паспорт фирмы
- `city` — Город, в котором расположена фирма
- `score` — Количество звезд фирмы. Если число отрицательно, то это красные звезды
- `bad_partner_mentions_count` — Количество упоминаний на форуме недобросовестных партнеров
- `claims_count` — Количество претензий от фирм
- `language` — Язык фирмы
- `recommendations_count` — Количество рекомендаций от фирм
- `inn` — Инн
- `ogrn` — ОГРН
- `kpp` — Код причины постановки на учет фирмы
- `okpo` — Общероссийский классификатор предприятий и организаций
- `affiliated_firms` — Связанные фирмы
- `affiliated_firms[].firm_name` — Название
- `affiliated_firms[].inn` — ИНН
- `affiliated_firms[].tf_firm_color` — Цвет фирмы по системе "Светофор"
- `affiliated_firms[].tf_has_signals` — Есть факты в системе "Светофор"
- `negative_points_sum` — Сумма отрицательных баллов
- `tf_firm_color` — Цвет фирмы в светофоре
- `tf_account_color` — Цвет аккаунта в светофоре
- `tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `registration_date` — Дата регистрации на сайте, которая AddDate из firms.
- `contact_info_changed` — Дата последних изменений в истории фирмы.
- `deletion_date` — Дата удаления фирмы.
- `last_month_active_days` — Число дней со входами на сайт за последние 30 дней.
- `firm_documents` — Список структуры "Документ фирмы"
- `firm_documents[].link` — Ссылка на документ.
- `firm_documents[].description` — Автогенерируемое описание документа.
- `firm_documents[].creation_date` — Дата создания документа.
- `firm_documents[].name` — Имя документа.
- `firm_documents[].type_id` — Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.
- `verified_trucks` — Количеством зарегистрированных ТС

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение краткой информации о фирме по её идентификатору

<a id="get-v1.0-firms-summary-{atiId}"></a>

Получение краткой информации по фирме (по идентификатору)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/summary/string' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "ati_id": "string",
  "brand": "string",
  "ownership": "string",
  "full_name": "string",
  "firm_name": "string",
  "location": {
    "city_id": 0,
    "region_id": 0,
    "country_id": 0,
    "city_size": 0,
    "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "attributes": 0,
    "city_name": "string",
    "region_name": "string",
    "country_name": "string",
    "country_code_name": "string"
  },
  "address": "string",
  "web_site": "string",
  "position_in_city": 0,
  "position_in_country": 0,
  "name_eng": "string",
  "firm_type": "string",
  "firm_type_id_int": 0,
  "firm_type_id": "string",
  "predicted_firm_type_id": 0,
  "info_reference": "string",
  "passport_reference": "string",
  "city": "string",
  "score": 0.5,
  "bad_partner_mentions_count": 0,
  "claims_count": 0,
  "language": "string",
  "recommendations_count": 0,
  "inn": "string",
  "ogrn": "string",
  "kpp": "string",
  "okpo": "string",
  "affiliated_firms": [
    {
      "firm_name": "string",
      "inn": "string",
      "tf_firm_color": "string",
      "tf_has_signals": false
    }
  ],
  "negative_points_sum": 0.5,
  "tf_firm_color": "string",
  "tf_account_color": "string",
  "tf_has_signals": false,
  "registration_date": "1970-01-01T00:00:00.000Z",
  "contact_info_changed": "1970-01-01T00:00:00.000Z",
  "deletion_date": "1970-01-01T00:00:00.000Z",
  "last_month_active_days": 0,
  "firm_documents": [
    {
      "link": "string",
      "description": "string",
      "creation_date": "1970-01-01T00:00:00.000Z",
      "name": "string",
      "type_id": 0
    }
  ],
  "verified_trucks": 0
}
```

**Описание полей ответа**
- `ati_id` — Идентификатор фирмы
- `brand` — Брэнд фирмы
- `ownership` — Организационно-правовая форма фирмы
- `full_name` — Полное имя фирмы: Брэнд (Название фирмы, ОПФ)
- `firm_name` — Название фирмы
- `location` — Структура "Город"
- `location.city_id` — Идентификатор города
- `location.region_id` — Идентификатор региона, в котором находится город
- `location.country_id` — Идентификатор страны, в которой находится город
- `location.city_size` — Идентификатор размера города
- `location.fias_id` — Идентификатор города по ФИАС
- `location.attributes` — Аттрибуты города
- `location.city_name` — Название города
- `location.region_name` — Название региона, в котором находится город
- `location.country_name` — Название страны, в которой находится город
- `location.country_code_name` — Кодовое название страны, в которой находится город
- `address` — Адрес фирмы
- `web_site` — Сайт фирмы
- `position_in_city` — Место в рэйтинге по городу
- `position_in_country` — Место в рэйтинге по стране
- `name_eng` — Интернациональное название фирмы
- `firm_type` — Профиль деятельности фирмы
- `firm_type_id_int` — Идентификатор профиля деятельности
- `firm_type_id` — (Устаревшее) Идентификатор профиля деятельности строкой
- `predicted_firm_type_id` — Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе
- `info_reference` — Ссылка на карточку фирмы
- `passport_reference` — Ссылка на паспорт фирмы
- `city` — Город, в котором расположена фирма
- `score` — Количество звезд фирмы. Если число отрицательно, то это красные звезды
- `bad_partner_mentions_count` — Количество упоминаний на форуме недобросовестных партнеров
- `claims_count` — Количество претензий от фирм
- `language` — Язык фирмы
- `recommendations_count` — Количество рекомендаций от фирм
- `inn` — Инн
- `ogrn` — ОГРН
- `kpp` — Код причины постановки на учет фирмы
- `okpo` — Общероссийский классификатор предприятий и организаций
- `affiliated_firms` — Связанные фирмы
- `affiliated_firms[].firm_name` — Название
- `affiliated_firms[].inn` — ИНН
- `affiliated_firms[].tf_firm_color` — Цвет фирмы по системе "Светофор"
- `affiliated_firms[].tf_has_signals` — Есть факты в системе "Светофор"
- `negative_points_sum` — Сумма отрицательных баллов
- `tf_firm_color` — Цвет фирмы в светофоре
- `tf_account_color` — Цвет аккаунта в светофоре
- `tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `registration_date` — Дата регистрации на сайте, которая AddDate из firms.
- `contact_info_changed` — Дата последних изменений в истории фирмы.
- `deletion_date` — Дата удаления фирмы.
- `last_month_active_days` — Число дней со входами на сайт за последние 30 дней.
- `firm_documents` — Список структуры "Документ фирмы"
- `firm_documents[].link` — Ссылка на документ.
- `firm_documents[].description` — Автогенерируемое описание документа.
- `firm_documents[].creation_date` — Дата создания документа.
- `firm_documents[].name` — Имя документа.
- `firm_documents[].type_id` — Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.
- `verified_trucks` — Количеством зарегистрированных ТС

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение краткой информации о фирмах по их идентификаторам

<a id="post-v1.0-firms-summaries"></a>

Получение краткой информации по фирмам (по идентификаторам)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/summaries' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  "string"
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "ati_id": "string",
    "brand": "string",
    "ownership": "string",
    "full_name": "string",
    "firm_name": "string",
    "location": {
      "city_id": 0,
      "region_id": 0,
      "country_id": 0,
      "city_size": 0,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributes": 0,
      "city_name": "string",
      "region_name": "string",
      "country_name": "string",
      "country_code_name": "string"
    },
    "address": "string",
    "web_site": "string",
    "position_in_city": 0,
    "position_in_country": 0,
    "name_eng": "string",
    "firm_type": "string",
    "firm_type_id_int": 0,
    "firm_type_id": "string",
    "predicted_firm_type_id": 0,
    "info_reference": "string",
    "passport_reference": "string",
    "city": "string",
    "score": 0.5,
    "bad_partner_mentions_count": 0,
    "claims_count": 0,
    "language": "string",
    "recommendations_count": 0,
    "inn": "string",
    "ogrn": "string",
    "kpp": "string",
    "okpo": "string",
    "affiliated_firms": [
      {
        "firm_name": "string",
        "inn": "string",
        "tf_firm_color": "string",
        "tf_has_signals": false
      }
    ],
    "negative_points_sum": 0.5,
    "tf_firm_color": "string",
    "tf_account_color": "string",
    "tf_has_signals": false,
    "registration_date": "1970-01-01T00:00:00.000Z",
    "contact_info_changed": "1970-01-01T00:00:00.000Z",
    "deletion_date": "1970-01-01T00:00:00.000Z",
    "last_month_active_days": 0,
    "firm_documents": [
      {
        "link": "string",
        "description": "string",
        "creation_date": "1970-01-01T00:00:00.000Z",
        "name": "string",
        "type_id": 0
      }
    ],
    "verified_trucks": 0
  }
]
```

**Описание полей ответа**
- `[].ati_id` — Идентификатор фирмы
- `[].brand` — Брэнд фирмы
- `[].ownership` — Организационно-правовая форма фирмы
- `[].full_name` — Полное имя фирмы: Брэнд (Название фирмы, ОПФ)
- `[].firm_name` — Название фирмы
- `[].location` — Структура "Город"
- `[].location.city_id` — Идентификатор города
- `[].location.region_id` — Идентификатор региона, в котором находится город
- `[].location.country_id` — Идентификатор страны, в которой находится город
- `[].location.city_size` — Идентификатор размера города
- `[].location.fias_id` — Идентификатор города по ФИАС
- `[].location.attributes` — Аттрибуты города
- `[].location.city_name` — Название города
- `[].location.region_name` — Название региона, в котором находится город
- `[].location.country_name` — Название страны, в которой находится город
- `[].location.country_code_name` — Кодовое название страны, в которой находится город
- `[].address` — Адрес фирмы
- `[].web_site` — Сайт фирмы
- `[].position_in_city` — Место в рэйтинге по городу
- `[].position_in_country` — Место в рэйтинге по стране
- `[].name_eng` — Интернациональное название фирмы
- `[].firm_type` — Профиль деятельности фирмы
- `[].firm_type_id_int` — Идентификатор профиля деятельности
- `[].firm_type_id` — (Устаревшее) Идентификатор профиля деятельности строкой
- `[].predicted_firm_type_id` — Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе
- `[].info_reference` — Ссылка на карточку фирмы
- `[].passport_reference` — Ссылка на паспорт фирмы
- `[].city` — Город, в котором расположена фирма
- `[].score` — Количество звезд фирмы. Если число отрицательно, то это красные звезды
- `[].bad_partner_mentions_count` — Количество упоминаний на форуме недобросовестных партнеров
- `[].claims_count` — Количество претензий от фирм
- `[].language` — Язык фирмы
- `[].recommendations_count` — Количество рекомендаций от фирм
- `[].inn` — Инн
- `[].ogrn` — ОГРН
- `[].kpp` — Код причины постановки на учет фирмы
- `[].okpo` — Общероссийский классификатор предприятий и организаций
- `[].affiliated_firms` — Связанные фирмы
- `[].affiliated_firms[].firm_name` — Название
- `[].affiliated_firms[].inn` — ИНН
- `[].affiliated_firms[].tf_firm_color` — Цвет фирмы по системе "Светофор"
- `[].affiliated_firms[].tf_has_signals` — Есть факты в системе "Светофор"
- `[].negative_points_sum` — Сумма отрицательных баллов
- `[].tf_firm_color` — Цвет фирмы в светофоре
- `[].tf_account_color` — Цвет аккаунта в светофоре
- `[].tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `[].registration_date` — Дата регистрации на сайте, которая AddDate из firms.
- `[].contact_info_changed` — Дата последних изменений в истории фирмы.
- `[].deletion_date` — Дата удаления фирмы.
- `[].last_month_active_days` — Число дней со входами на сайт за последние 30 дней.
- `[].firm_documents` — Список структуры "Документ фирмы"
- `[].firm_documents[].link` — Ссылка на документ.
- `[].firm_documents[].description` — Автогенерируемое описание документа.
- `[].firm_documents[].creation_date` — Дата создания документа.
- `[].firm_documents[].name` — Имя документа.
- `[].firm_documents[].type_id` — Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.
- `[].verified_trucks` — Количеством зарегистрированных ТС

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


### Комментарии фирм

#### Получение всех своих комментариев о других фирмах

<a id="get-v1.0-firms-comments"></a>

Получение всех своих комментариев о других фирмах

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/comments' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ati_id": "string",
    "user_id": 0,
    "commented_firm_ati_id": "string",
    "comment": "string",
    "added_date": "1970-01-01T00:00:00.000Z"
  }
]
```

**Описание полей ответа**
- `[].id` — Идентификатор комментария
- `[].ati_id` — Идентификатор фирмы, оставившей комментарий
- `[].user_id` — Идентификатор контакта
- `[].commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `[].comment` — Текст комментария
- `[].added_date` — Дата добавления комментария

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение своего комментария о фирме

<a id="get-v1.0-firms-comments-{atiId}"></a>

Получение своего комментария о фирме, указанной в atiId

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/comments/string' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ati_id": "string",
  "user_id": 0,
  "commented_firm_ati_id": "string",
  "comment": "string",
  "added_date": "1970-01-01T00:00:00.000Z"
}
```

**Описание полей ответа**
- `id` — Идентификатор комментария
- `ati_id` — Идентификатор фирмы, оставившей комментарий
- `user_id` — Идентификатор контакта
- `commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `comment` — Текст комментария
- `added_date` — Дата добавления комментария

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение своего комментария о фирмах

<a id="post-v1.0-firms-comments-byfirms"></a>

Получение своих комментариев о фирмах, указанных в atiIds

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/comments/byfirms' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  "string"
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ati_id": "string",
    "user_id": 0,
    "commented_firm_ati_id": "string",
    "comment": "string",
    "added_date": "1970-01-01T00:00:00.000Z"
  }
]
```

**Описание полей ответа**
- `[].id` — Идентификатор комментария
- `[].ati_id` — Идентификатор фирмы, оставившей комментарий
- `[].user_id` — Идентификатор контакта
- `[].commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `[].comment` — Текст комментария
- `[].added_date` — Дата добавления комментария

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Получение своего комментария о фирме по идентификатору комментария

<a id="get-v1.0-firms-comments-{commentId}"></a>

Получение своего комментария о фирме по идентификатору комментария commentId

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (200)**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ati_id": "string",
  "user_id": 0,
  "commented_firm_ati_id": "string",
  "comment": "string",
  "added_date": "1970-01-01T00:00:00.000Z"
}
```

**Описание полей ответа**
- `id` — Идентификатор комментария
- `ati_id` — Идентификатор фирмы, оставившей комментарий
- `user_id` — Идентификатор контакта
- `commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `comment` — Текст комментария
- `added_date` — Дата добавления комментария

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Добавление комментария о фирме

<a id="post-v1.0-firms-comments"></a>

Добавление комментария о фирме

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/comments' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ati_id": "string",
  "user_id": 0,
  "commented_firm_ati_id": "string",
  "comment": "string",
  "added_date": "1970-01-01T00:00:00.000Z"
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Описание полей запроса**
- `ati_id` — Идентификатор фирмы, оставившей комментарий
- `user_id` — Идентификатор контакта
- `commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `comment` — Текст комментария
- `added_date` — Дата добавления комментария

**Пример ответа (200)**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ati_id": "string",
  "user_id": 0,
  "commented_firm_ati_id": "string",
  "comment": "string",
  "added_date": "1970-01-01T00:00:00.000Z"
}
```

**Описание полей ответа**
- `id` — Идентификатор комментария
- `ati_id` — Идентификатор фирмы, оставившей комментарий
- `user_id` — Идентификатор контакта
- `commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `comment` — Текст комментария
- `added_date` — Дата добавления комментария

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Изменение комментария о фирме

<a id="put-v1.0-firms-comments"></a>

Изменение комментария о фирме

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/comments' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ati_id": "string",
  "user_id": 0,
  "commented_firm_ati_id": "string",
  "comment": "string",
  "added_date": "1970-01-01T00:00:00.000Z"
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Описание полей запроса**
- `id` — Идентификатор комментария
- `ati_id` — Идентификатор фирмы, оставившей комментарий
- `user_id` — Идентификатор контакта
- `commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `comment` — Текст комментария
- `added_date` — Дата добавления комментария

**Пример ответа (200)**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ati_id": "string",
  "user_id": 0,
  "commented_firm_ati_id": "string",
  "comment": "string",
  "added_date": "1970-01-01T00:00:00.000Z"
}
```

**Описание полей ответа**
- `id` — Идентификатор комментария
- `ati_id` — Идентификатор фирмы, оставившей комментарий
- `user_id` — Идентификатор контакта
- `commented_firm_ati_id` — Идентификатор фирмы, о которой оставили комментарий
- `comment` — Текст комментария
- `added_date` — Дата добавления комментария

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


#### Удаление комментария о фирме по идентификатору комментария

<a id="delete-v1.0-firms-comments-{commentId}"></a>

Удаление комментария о фирме по идентификатору комментария commentId

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/firms.openapi.json)

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


### Дополнительные методы поиска информации о фирме

- [Групповое получение краткой информации о фирмаx по email](https://ati.su/developers/raw/api/catalogs/firm-search.md#post-v1.0-firms-search-summaries-emails)
- [Групповое получение краткой информации о фирмаx по ИНН](https://ati.su/developers/raw/api/catalogs/firm-search.md#post-v1.0-firms-search-summaries)
- [Получение краткой информации о фирме по ИНН и по номеру телефона](https://ati.su/developers/raw/api/catalogs/firm-search.md#get-v1.0-firms-search-summary)
---

## llms.txt

Индекс ключевых страниц документации для LLM и AI-агентов доступен в [основном llms.txt](https://ati.su/developers/llms.txt).