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

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

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

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

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

Фирма - коммерческое предприятие, которое является участником АТИ.

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

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

данные по своему аккаунту
данные по контактам фирмы
данные по реквизитам фирмы
краткую информацию о фирме
данные по комментариям фирм
дополнительные методы

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

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

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

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

get

/v1.0/account

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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":[...]

]

}

"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

}

{...}

Логин пользователя

admin_email: string (nullable)

Адресс электронной почты администратора фирмы

add_date: date-time

Дата создания аккаунта

firm_type_id: int32

Идентификатор профиля деятельности

firm_type: string (nullable)

Профиль деятельности

payed_services:[{...}]

Структура "Оплаченные услуги"

ati_id: string (nullable)

service_id: int32

Идентификатор лицензии

service_name: string (nullable)

Название лицензии

dependencies: [int32]

Включенные лицензии

}]

firm_active_services:[{...}]

service_id: int32

Идентификатор лицензии

service_name: string (nullable)

Название лицензии

service_amount: int32 (nullable)

Количество лицензии

}]

payed_services_end_date: date-time

Дата окончания оплаченных услуг

has_payed_services: boolean

Оплачены ли у фирмы какие-либо лицензии

read only

is_reset_similarity_point: boolean

Был сброшен балл за соответствие в связи с продолжительной неактивностью фирмы

read only

time_zone_id: string (nullable)

Текстовое описание часового пояса

has_documents: boolean

Флаг о наличии документов связанных с фирмой в таблице FirmDocuments

account_id: string (nullable)

Код фирмы в АТИ

contact_id: int32 (nullable)

Идентификатор контакта

full_firm_name: string (nullable)

Полное название фирмы, учитывается название фирмы, ОПФ и брэнд.

Брэнд не включается в полное название для форм собственности

(другая)
ПБОЮЛ
ПБЮЛ
ФЛП
физ.лицо

firm_name: string (nullable)

Название фирмы

brand: string (nullable)

Брэнд фирмы

ownership: string (nullable)

Организационно-правовая форма фирмы

ownership_id: int32

Идентификатор организационно-правовой формы фирмы

address: string (nullable)

Адрес фирмы

inn: string (nullable)

ИНН фирмы

ogrn: string (nullable)

ОГРН фирмы

time_zone_minutes: int32

Отступ в минутах от UTC для часового пояса, выставленного в кабинете данного аккаунта

claims_sum: double (nullable)

Сумма претензий к данной фирме в рублях

claims_count: int32

Количество претензий от фирм

city_id: int32

Идентификатор города

bad_partner_mentions_count: int32

Количество упоминаний на форуме Недобросовестных партнеров

bad_partner_firms_count: int32

Количество упоминаний о данной фирме на форуме "Недобросовестные партнеры"

recommendations_count: int32

Количество фирм, которые написали сообщение о данной фирме на форуме "Недобросовестные партнеры"

ri_users_attributes: enum

[0, 1, 2, 4, 8, 16, 32, 64, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 262144]

Представляет атрибуты пользователя (таблица ri_users поле Attribute).

ri_users_attributes2: int32

Аттрибуты фирмы

firm_attributes: int32

Аттрибуты фирмы

is_rrd: boolean

Включен ли у фирмы режим РРД

loads_access: int32

Уровень доступа пользователя к грузам

loads_access_reason: int32

Причина понижения доступа пользователя к грузам

load_responses_access: int32

Уровень доступа пользователя к отзывам на грузы

load_responses_access_reason: int32

Причина понижения доступа пользователя к отзывам на грузы

unlimited_stealth_access: int32

Уровень доступа пользователя к стеллс, id сервиса 400

unlimited_stealth_access_reason: int32

Причина понижения доступа пользователя к стеллс

trucks_access: int32

Уровень доступа пользователя к транспорту

trucks_access_reason: int32

Причина понижения доступа пользователя к транспорту

truck_responses_access: int32

Уровень доступа пользователя к отзывам на транспорт

truck_responses_access_reason: int32

Причина понижения доступа пользователя к отзывам на транспорт

position_in_city: int32 (nullable)

Место в рэйтинге по городу

position_in_country: int32 (nullable)

Место в рэйтинге по стране

is_responses_for_black_list_enabled: boolean

Включено принятие встречных предложений от фирм из черного списка

location:{...}

Структура "Город"

city_id: int32

Идентификатор города

region_id: int32 (nullable)

Идентификатор региона, в котором находится город

country_id: int32 (nullable)

Идентификатор страны, в которой находится город

full_name: string (nullable)

Полное название города

read only

short_name: string (nullable)

Краткое название города

read only

is_regional_center: boolean

Является ли город региональным центром

read only

city_size: int32

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

fias_id: uuid (nullable)

Идентификатор города по ФИАС

attributes: enum

[0, 4]

city_name: string (nullable)

Название города

region_name: string (nullable)

Название региона, в котором находится город

country_name: string (nullable)

Название страны, в которой находится город

country_code_name: string (nullable)

Кодовое название страны, в которой находится город

}

passport:{...}

Структура "Паспорт"

ati_id: string (nullable)

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

total_score: double

Сумма баллов пользователя АТИ

ati_data_match_point: double

Данные фирмы в АТИ (название, город) совпадают с настоящими данными фирмы

account_lifetime_point: double

За срок "существования" фирмы

business_activity_point: double

Свидетельство ведения фирмой текущей хозяйственной деятельности.

round_table_point: double

Балл по решению общественного движения пользователей АТИ "Круглый стол"

claim_point: double

Балл за имеющиеся Претензии к пользователю

prof_activity_point: double

За проф. деятельность в АТИ.

ati_administration_point: double

По решению администрации АТИ

clones_point: double

Балл за клонов участника системы

egr_point: double

По данным Единых Государственных Реестров Юридических Лиц и ИП

mass_registration_point: double

Юридическое лицо зарегистрировано по адресу массовой регистрации

mass_founder_point: double

Учредитель юридического лица является учредителем множества других юридических лиц

firm_lifetime_point: double

За давность регистрации в АвтоТрансИнфо

ri_users_attributes: enum

[0, 1, 2, 4, 8, 16, 32, 64, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 262144]

Представляет атрибуты пользователя (таблица ri_users поле Attribute).

recommendations_count: int32

Количество рекомендаций

status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

status_description: string (nullable)

Описание статуса

}

contacts:[{...}]

Список структур "Контакт"

id: int32

Идентификатор контакта

Имя контакта

fixed_rate_agreement_accepted: boolean

Контакт принял соглашение о фиксированной ставке.

telephone: string (nullable)

Телефон контакта

telephone_brand: string (nullable)

Брэнд телефона контакта

telephone_region: string (nullable)

Русское название телефона контакта

lo_users_attributes: int32

Атрибут пользователя

email: string (nullable)

Электронная почта контакта

icq: string (nullable)

Icq контакта

mobile: string (nullable)

Мобильный телефона контакта

mobile_brand: string (nullable)

Брэнд мобильного телефона контакта

mobile_region: string (nullable)

Русское название мобильного телефона контакта

skype_name: string (nullable)

Скайп контакта

fax: string (nullable)

Факс контакта

mobile_operator: string (nullable)

Мобильный оператор

region_id: string (nullable)

Идентификатор региона контакта

city_id: int32 (nullable)

Идентификатор города контакта

is_visibled: boolean

Параметр определяет, является ли контакт видимым или скрытым. От скрытого контакта нельзя добавить груз

is_email_visibled: boolean

Параметр определяет, является ли электронный адрес видимым или скрытым

location:{...}

Структура "Город" контакта

city_id: int32

Идентификатор города

region_id: int32 (nullable)

Идентификатор региона, в котором находится город

country_id: int32 (nullable)

Идентификатор страны, в которой находится город

full_name: string (nullable)

Полное название города

read only

short_name: string (nullable)

Краткое название города

read only

is_regional_center: boolean

Является ли город региональным центром

read only

city_size: int32

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

fias_id: uuid (nullable)

Идентификатор города по ФИАС

attributes: enum

[0, 4]

city_name: string (nullable)

Название города

region_name: string (nullable)

Название региона, в котором находится город

country_name: string (nullable)

Название страны, в которой находится город

country_code_name: string (nullable)

Кодовое название страны, в которой находится город

}

access_rights: int32

Права доступа

note: string (nullable)

Заметка о контакте

has_personal_password: boolean

Наличие личного пароля у контакта

}]

currency_id: int32 (nullable)

Идентификатор валюты

note: string (nullable)

Примечание

http: string (nullable)

Сайт фирмы

taxation_type: enum

[0, 1, 2, 4, 8]

with_vat: boolean

Ндс

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

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

get

/v1.0/firms/contact

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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: int32

Идентификатор контакта

ati_id: string (nullable)

Код фирмы в АТИ

firm_deletion_date: date-time (nullable)

Дата удаления аккаунта

Имя контакта

phone: string (nullable)

Номер телефона (основной)

e_mail: string (nullable)

Электронная почта контакта

email_for_link: string (nullable)

Адрес для отправки письма на задание логина/пароля

icq: string (nullable)

ICQ контакта

mobile: string (nullable)

Номер телефона контакта (мобильный)

fax: string (nullable)

Номер телефона контакта (факс)

note: string (nullable)

Примечание

is_visible: boolean

Контакта виден / скрыт

is_email_visible: boolean

E-mail виден / скрыт

mobile_id: int32 (nullable)

Номер телефона (мобильный) без кода города

phone_id: int32 (nullable)

Номер телефона (основной) без кода города

fax_id: int32 (nullable)

Номер телефона контакта (факс) без кода города

skype_name: string (nullable)

Логин в Skype

city_id: int32 (nullable)

Идентификатори города

attributes: int32 (nullable)

Атрибуты контакта

access_rights: int32

Права контакта (для ррд)

gsm_operator_id: int32 (nullable)

Идентификатор сотового оператора

is_deleted: boolean

Удален ли контакт

read only

deletion_date: date-time (nullable)

Дата удаления контакта

is_photo_exists: boolean

Загружено ли фото

Логин контакта

has_personal_password: boolean

Есть ли персональный пароль

language: string (nullable)

Язык сайта выбранный, контактом

department_id: int32

Идентификатор основного подразделения контакта

position: string (nullable)

Должность

user_rights: enum

[0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 131072, 262144, 2097152, 8388608, 8534011, 16777216, 25313275, 27670527, 27672575]

contact_right_nesting_type_id: enum

[0, 1, 2]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/contacts

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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: int32

Идентификатор контакта

ati_id: string (nullable)

Код фирмы в АТИ

firm_deletion_date: date-time (nullable)

Дата удаления аккаунта

Имя контакта

phone: string (nullable)

Номер телефона (основной)

e_mail: string (nullable)

Электронная почта контакта

email_for_link: string (nullable)

Адрес для отправки письма на задание логина/пароля

icq: string (nullable)

ICQ контакта

mobile: string (nullable)

Номер телефона контакта (мобильный)

fax: string (nullable)

Номер телефона контакта (факс)

note: string (nullable)

Примечание

is_visible: boolean

Контакта виден / скрыт

is_email_visible: boolean

E-mail виден / скрыт

mobile_id: int32 (nullable)

Номер телефона (мобильный) без кода города

phone_id: int32 (nullable)

Номер телефона (основной) без кода города

fax_id: int32 (nullable)

Номер телефона контакта (факс) без кода города

skype_name: string (nullable)

Логин в Skype

city_id: int32 (nullable)

Идентификатори города

attributes: int32 (nullable)

Атрибуты контакта

access_rights: int32

Права контакта (для ррд)

gsm_operator_id: int32 (nullable)

Идентификатор сотового оператора

is_deleted: boolean

Удален ли контакт

read only

deletion_date: date-time (nullable)

Дата удаления контакта

is_photo_exists: boolean

Загружено ли фото

Логин контакта

has_personal_password: boolean

Есть ли персональный пароль

language: string (nullable)

Язык сайта выбранный, контактом

department_id: int32

Идентификатор основного подразделения контакта

position: string (nullable)

Должность

user_rights: enum

[0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 131072, 262144, 2097152, 8388608, 8534011, 16777216, 25313275, 27670527, 27672575]

contact_right_nesting_type_id: enum

[0, 1, 2]

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/{atiId}/contacts/{contactId}/summary

atiId

string

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

contactId

int32

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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: string (nullable)

Код в АТИ.

contact_id: int32

Идентификатор контакта.

Имя контакта.

phone: string (nullable)

Рабочий телефон.

mobile_phone: string (nullable)

Мобильный телефон.

claims_count: int32

Количество претензий.

recommendations_count: int32

Количество рекомендаций.

bad_partner_mentions_count: int32

Количество упоминаний на форуме "Недобросовестные партнеры".

firm_type: string (nullable)

Профиль деятельности фирмы.

firm_name: string (nullable)

Название фирмы.

ownership: string (nullable)

Организационно-правовая форма.

city: string (nullable)

Город

score: double

Количество звезд фирмы.

status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

icq: string (nullable)

Icq контакта

fax: string (nullable)

Факс контакта

skype_name: string (nullable)

Skype контакта

email: string (nullable)

Email контакта

language: string (nullable)

Язык контакта

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/{atiId}/contacts/summary

atiId

string

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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: string (nullable)

Код в АТИ.

contact_id: int32

Идентификатор контакта.

Имя контакта.

phone: string (nullable)

Рабочий телефон.

mobile_phone: string (nullable)

Мобильный телефон.

claims_count: int32

Количество претензий.

recommendations_count: int32

Количество рекомендаций.

bad_partner_mentions_count: int32

Количество упоминаний на форуме "Недобросовестные партнеры".

firm_type: string (nullable)

Профиль деятельности фирмы.

firm_name: string (nullable)

Название фирмы.

ownership: string (nullable)

Организационно-правовая форма.

city: string (nullable)

Город

score: double

Количество звезд фирмы.

status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

icq: string (nullable)

Icq контакта

fax: string (nullable)

Факс контакта

skype_name: string (nullable)

Skype контакта

email: string (nullable)

Email контакта

language: string (nullable)

Язык контакта

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/contact/{atiId}/{contactId}/email

atiId

string

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

contactId

int32

Идентификатор контакта

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"email":"string"

}

{...}

email: string (nullable)

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

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

get

/v1.0/firms/requisites/{requisiteId}

requisiteId

uuid

Идентификатор реквизита

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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":false,

"is_visible":false,

"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: uuid

Идентификтаор реквизита

ati_id: string (nullable)

Код в АТИ фирмы

requisite_type_id: int32

Тип реквизита

requisite_name: string (nullable)

Название реквизита

legal_name: string (nullable)

Юридическое именование фирмы

own_ship_id: int32

Идентификатор формы собственности

fio: string (nullable)

ФИО владельца

inn: string (nullable)

ИНН

ogrn: string (nullable)

ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT

phone: string (nullable)

Телефон

fax: string (nullable)

Факс

email: string (nullable)

Электронный адрес

kpp: string (nullable)

КПП

rs: string (nullable)

Расчетный счет

ks: string (nullable)

КС

bik: string (nullable)

БИК

bank: string (nullable)

Наименование банка

codes: string (nullable)

Коды

is_read_only: boolean

Реквизиты только для чтения

okpo: string (nullable)

ОКПО

is_vat_payer: boolean

Плательщик НДС

last_use_date: date-time (nullable)

Дата последнего использования в системе

is_active: boolean

Активный реквизит

is_visible: boolean

Будет ли виден реквизит пользователю в будущем
Нужен для одноразовых реквизитов, например, при создании счета с оплатой по банковской карте (там создается реквизит из пары полей)

legal_address:{...}

Юридический адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в АТИ фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

post_address:{...}

Почтовый адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в АТИ фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

legal_address_id: uuid

Идентификатор юридического адреса в системе

post_address_id: uuid

Идентификатор почтового адреса в системе

signees:[{...}]

Список подписантов

signee_id: uuid

Идентификатор подписанта.

requisite_id: uuid

Идентификатор реквизита, которому принадлежит эта запись.

full_name: string (nullable)

ФИО (обязательно в родительном падеже).

position: string (nullable)

Должность (обязательно в родительном падеже).

act_upon: string (nullable)

На основании чего действует (обязательно в родительном падеже).

is_default: boolean

Выбирать по умолчанию.

deletion_date: date-time (nullable)

Дата удаления.

full_name_and_position: string (nullable)

Поле, объединяющее FullName и Position. Не является автовычисляемым (т.е. не является конкатенацией полей FullName и Position), создано для других нужд.

}]

person_passport:{...}

Паспорт физического лица

series: string (nullable)

Серия

number: string (nullable)

Номер

date_of_issue: date-time

Дата выдачи

department_code: string (nullable)

Код подразделения

issued_by: string (nullable)

Выдан

registration: string (nullable)

Адрес регистрации

scan_files:[{...}]

Файл со сканом паспорта

link: string (nullable)

Ccылка

id: string (nullable)

Идентификатор

size: int32

Размер

Название

}]

}

available_in_ati_docs: boolean

Доступно в АТИ Доках

read only

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/requisites

atiId

string

Код фирмы в АТИ

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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":false,

"is_visible":false,

"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: uuid

Идентификтаор реквизита

ati_id: string (nullable)

Код в АТИ фирмы

requisite_type_id: int32

Тип реквизита

requisite_name: string (nullable)

Название реквизита

legal_name: string (nullable)

Юридическое именование фирмы

own_ship_id: int32

Идентификатор формы собственности

fio: string (nullable)

ФИО владельца

inn: string (nullable)

ИНН

ogrn: string (nullable)

ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT

phone: string (nullable)

Телефон

fax: string (nullable)

Факс

email: string (nullable)

Электронный адрес

kpp: string (nullable)

КПП

rs: string (nullable)

Расчетный счет

ks: string (nullable)

КС

bik: string (nullable)

БИК

bank: string (nullable)

Наименование банка

codes: string (nullable)

Коды

is_read_only: boolean

Реквизиты только для чтения

okpo: string (nullable)

ОКПО

is_vat_payer: boolean

Плательщик НДС

last_use_date: date-time (nullable)

Дата последнего использования в системе

is_active: boolean

Активный реквизит

is_visible: boolean

legal_address:{...}

Юридический адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в АТИ фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

post_address:{...}

Почтовый адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в АТИ фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

legal_address_id: uuid

Идентификатор юридического адреса в системе

post_address_id: uuid

Идентификатор почтового адреса в системе

signees:[{...}]

Список подписантов

signee_id: uuid

Идентификатор подписанта.

requisite_id: uuid

Идентификатор реквизита, которому принадлежит эта запись.

full_name: string (nullable)

ФИО (обязательно в родительном падеже).

position: string (nullable)

Должность (обязательно в родительном падеже).

act_upon: string (nullable)

На основании чего действует (обязательно в родительном падеже).

is_default: boolean

Выбирать по умолчанию.

deletion_date: date-time (nullable)

Дата удаления.

full_name_and_position: string (nullable)

}]

person_passport:{...}

Паспорт физического лица

series: string (nullable)

Серия

number: string (nullable)

Номер

date_of_issue: date-time

Дата выдачи

department_code: string (nullable)

Код подразделения

issued_by: string (nullable)

Выдан

registration: string (nullable)

Адрес регистрации

scan_files:[{...}]

Файл со сканом паспорта

link: string (nullable)

Ccылка

id: string (nullable)

Идентификатор

size: int32

Размер

Название

}]

}

available_in_ati_docs: boolean

Доступно в АТИ Доках

read only

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/{atiId}/requisites

atiId

string

Код фирмы в АТИ

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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":false,

"is_visible":false,

"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: uuid

Идентификтаор реквизита

ati_id: string (nullable)

Код в АТИ фирмы

requisite_type_id: int32

Тип реквизита

requisite_name: string (nullable)

Название реквизита

legal_name: string (nullable)

Юридическое именование фирмы

own_ship_id: int32

Идентификатор формы собственности

fio: string (nullable)

ФИО владельца

inn: string (nullable)

ИНН

ogrn: string (nullable)

ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT

phone: string (nullable)

Телефон

fax: string (nullable)

Факс

email: string (nullable)

Электронный адрес

kpp: string (nullable)

КПП

rs: string (nullable)

Расчетный счет

ks: string (nullable)

КС

bik: string (nullable)

БИК

bank: string (nullable)

Наименование банка

codes: string (nullable)

Коды

is_read_only: boolean

Реквизиты только для чтения

okpo: string (nullable)

ОКПО

is_vat_payer: boolean

Плательщик НДС

last_use_date: date-time (nullable)

Дата последнего использования в системе

is_active: boolean

Активный реквизит

is_visible: boolean

legal_address:{...}

Юридический адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в АТИ фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

post_address:{...}

Почтовый адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в АТИ фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

legal_address_id: uuid

Идентификатор юридического адреса в системе

post_address_id: uuid

Идентификатор почтового адреса в системе

signees:[{...}]

Список подписантов

signee_id: uuid

Идентификатор подписанта.

requisite_id: uuid

Идентификатор реквизита, которому принадлежит эта запись.

full_name: string (nullable)

ФИО (обязательно в родительном падеже).

position: string (nullable)

Должность (обязательно в родительном падеже).

act_upon: string (nullable)

На основании чего действует (обязательно в родительном падеже).

is_default: boolean

Выбирать по умолчанию.

deletion_date: date-time (nullable)

Дата удаления.

full_name_and_position: string (nullable)

}]

person_passport:{...}

Паспорт физического лица

series: string (nullable)

Серия

number: string (nullable)

Номер

date_of_issue: date-time

Дата выдачи

department_code: string (nullable)

Код подразделения

issued_by: string (nullable)

Выдан

registration: string (nullable)

Адрес регистрации

scan_files:[{...}]

Файл со сканом паспорта

link: string (nullable)

Ccылка

id: string (nullable)

Идентификатор

size: int32

Размер

Название

}]

}

available_in_ati_docs: boolean

Доступно в АТИ Доках

read only

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/summary

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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: string (nullable)

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

brand: string (nullable)

Брэнд фирмы

ownership: string (nullable)

Организационно-правовая форма фирмы

full_name: string (nullable)

Полное имя фирмы: Брэнд (Название фирмы, ОПФ)

firm_name: string (nullable)

Название фирмы

location:{...}

Структура "Город"

city_id: int32

Идентификатор города

region_id: int32 (nullable)

Идентификатор региона, в котором находится город

country_id: int32 (nullable)

Идентификатор страны, в которой находится город

full_name: string (nullable)

Полное название города

read only

short_name: string (nullable)

Краткое название города

read only

is_regional_center: boolean

Является ли город региональным центром

read only

city_size: int32

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

fias_id: uuid (nullable)

Идентификатор города по ФИАС

attributes: enum

[0, 4]

city_name: string (nullable)

Название города

region_name: string (nullable)

Название региона, в котором находится город

country_name: string (nullable)

Название страны, в которой находится город

country_code_name: string (nullable)

Кодовое название страны, в которой находится город

}

address: string (nullable)

Адрес фирмы

web_site: string (nullable)

Сайт фирмы

position_in_city: int32 (nullable)

Место в рэйтинге по городу

position_in_country: int32 (nullable)

Место в рэйтинге по стране

name_eng: string (nullable)

Интернациональное название фирмы

firm_type: string (nullable)

Профиль деятельности фирмы

firm_type_id_int: int32

Идентификатор профиля деятельности

firm_type_id: string (nullable)

(Устаревшее) Идентификатор профиля деятельности строкой

predicted_firm_type_id: int32 (nullable)

Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе

info_reference: string (nullable)

Ссылка на карточку фирмы

passport_reference: string (nullable)

Ссылка на паспорт фирмы

city: string (nullable)

Город, в котором расположена фирма

score: double

Количество звезд фирмы. Если число отрицательно, то это красные звезды

bad_partner_mentions_count: int32

Количество упоминаний на форуме недобросовестных партнеров

claims_count: int32

Количество претензий от фирм

language: string (nullable)

Язык фирмы

recommendations_count: int32

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

inn: string (nullable)

Инн

ogrn: string (nullable)

ОГРН

kpp: string (nullable)

Код причины постановки на учет фирмы

okpo: string (nullable)

Общероссийский классификатор предприятий и организаций

affiliated_firms:[{...}]

Связанные фирмы

firm_name: string (nullable)

Название

inn: string (nullable)

ИНН

tf_firm_color: string (nullable)

Цвет фирмы по системе "Светофор"

tf_has_signals: boolean

Есть факты в системе "Светофор"

}]

negative_points_sum: double

Сумма отрицательных баллов

tf_firm_color: string (nullable)

Цвет фирмы в светофоре

tf_account_color: string (nullable)

Цвет аккаунта в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

registration_date: date-time

Дата регистрации на сайте, которая AddDate из firms.

contact_info_changed: date-time

Дата последних изменений в истории фирмы.

deletion_date: date-time (nullable)

Дата удаления фирмы.

last_month_active_days: int32

Число дней со входами на сайт за последние 30 дней.

firm_documents:[{...}]

Список структуры "Документ фирмы"

link: string (nullable)

Ссылка на документ.

description: string (nullable)

Автогенерируемое описание документа.

creation_date: date-time

Дата создания документа.

Имя документа.

type_id: int32

Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.

}]

verified_trucks: int32

Количеством зарегистрированных ТС

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/firms/summary/{atiId}

atiId

string

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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: string (nullable)

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

brand: string (nullable)

Брэнд фирмы

ownership: string (nullable)

Организационно-правовая форма фирмы

full_name: string (nullable)

Полное имя фирмы: Брэнд (Название фирмы, ОПФ)

firm_name: string (nullable)

Название фирмы

location:{...}

Структура "Город"

city_id: int32

Идентификатор города

region_id: int32 (nullable)

Идентификатор региона, в котором находится город

country_id: int32 (nullable)

Идентификатор страны, в которой находится город

full_name: string (nullable)

Полное название города

read only

short_name: string (nullable)

Краткое название города

read only

is_regional_center: boolean

Является ли город региональным центром

read only

city_size: int32

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

fias_id: uuid (nullable)

Идентификатор города по ФИАС

attributes: enum

[0, 4]

city_name: string (nullable)

Название города

region_name: string (nullable)

Название региона, в котором находится город

country_name: string (nullable)

Название страны, в которой находится город

country_code_name: string (nullable)

Кодовое название страны, в которой находится город

}

address: string (nullable)

Адрес фирмы

web_site: string (nullable)

Сайт фирмы

position_in_city: int32 (nullable)

Место в рэйтинге по городу

position_in_country: int32 (nullable)

Место в рэйтинге по стране

name_eng: string (nullable)

Интернациональное название фирмы

firm_type: string (nullable)

Профиль деятельности фирмы

firm_type_id_int: int32

Идентификатор профиля деятельности

firm_type_id: string (nullable)

(Устаревшее) Идентификатор профиля деятельности строкой

predicted_firm_type_id: int32 (nullable)

Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе

info_reference: string (nullable)

Ссылка на карточку фирмы

passport_reference: string (nullable)

Ссылка на паспорт фирмы

city: string (nullable)

Город, в котором расположена фирма

score: double

Количество звезд фирмы. Если число отрицательно, то это красные звезды

bad_partner_mentions_count: int32

Количество упоминаний на форуме недобросовестных партнеров

claims_count: int32

Количество претензий от фирм

language: string (nullable)

Язык фирмы

recommendations_count: int32

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

inn: string (nullable)

Инн

ogrn: string (nullable)

ОГРН

kpp: string (nullable)

Код причины постановки на учет фирмы

okpo: string (nullable)

Общероссийский классификатор предприятий и организаций

affiliated_firms:[{...}]

Связанные фирмы

firm_name: string (nullable)

Название

inn: string (nullable)

ИНН

tf_firm_color: string (nullable)

Цвет фирмы по системе "Светофор"

tf_has_signals: boolean

Есть факты в системе "Светофор"

}]

negative_points_sum: double

Сумма отрицательных баллов

tf_firm_color: string (nullable)

Цвет фирмы в светофоре

tf_account_color: string (nullable)

Цвет аккаунта в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

registration_date: date-time

Дата регистрации на сайте, которая AddDate из firms.

contact_info_changed: date-time

Дата последних изменений в истории фирмы.

deletion_date: date-time (nullable)

Дата удаления фирмы.

last_month_active_days: int32

Число дней со входами на сайт за последние 30 дней.

firm_documents:[{...}]

Список структуры "Документ фирмы"

link: string (nullable)

Ссылка на документ.

description: string (nullable)

Автогенерируемое описание документа.

creation_date: date-time

Дата создания документа.

Имя документа.

type_id: int32

Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.

}]

verified_trucks: int32

Количеством зарегистрированных ТС

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

�