Помощь
Чат для вопросов по API
Мгновенно ответим на ваши вопросы
api@ati.su
Электронная почта техподдержки
Тикетная система
Оставить заявку на отдел
«Консультанты по интеграции (API)»
api.ati.su - заказы, торги, площадки
Наш телеграм-канал
Код в АТИ:
Выход

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

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

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

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

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

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

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

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

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

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

 
Метод получения текущего контакта фирмы
get
/v1.0/firms/contact
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
{...}
"access_rights":0,
"ati_id":"string",
"attributes":0,
"city_id":0,
"contact_right_nesting_type_id":0,
"deletion_date":"1970-01-01T00:00:00.000Z",
"department_id":0,
"e_mail":"string",
"fax":"string",
"fax_id":0,
"firm_deletion_date":"1970-01-01T00:00:00.000Z",
"gsm_operator_id":0,
"has_personal_password":false,
"icq":"string",
"id":0,
"is_email_visible":false,
"is_photo_exists":false,
"is_visible":false,
"language":"string",
"login":"string",
"mobile":"string",
"mobile_id":0,
"name":"string",
"note":"string",
"phone":"string",
"phone_id":0,
"position":"string",
"skype_name":"string",
"user_rights":0
}
{...}
access_rights: int32

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

ati_id: string

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

attributes: int32

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

city_id: int32

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

contact_right_nesting_type_id: enum
[0, 1, 2]
deletion_date: date-time

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

department_id: int32

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

e_mail: string

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

fax: string

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

fax_id: int32

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

firm_deletion_date: date-time

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

gsm_operator_id: int32

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

has_personal_password: boolean

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

icq: string

ICQ контакта

id: int32

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

is_deleted: boolean

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

read only
is_email_visible: boolean

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

is_photo_exists: boolean

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

is_visible: boolean

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

language: string

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

login: string

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

mobile: string

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

mobile_id: int32

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

name: string

Имя контакта

note: string

Примечание

phone: string

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

phone_id: int32

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

position: string

Должность

skype_name: string

Логин в Skype

user_rights: enum
[0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 131072, 262144, 2097152, 8388608, 8534011, 8536059, 10893311, 10895359]
}
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

 
Метод получения всех контактов фирмы
get
/v1.0/firms/contacts
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"access_rights":0,
"ati_id":"string",
"attributes":0,
"city_id":0,
"contact_right_nesting_type_id":0,
"deletion_date":"1970-01-01T00:00:00.000Z",
"department_id":0,
"e_mail":"string",
"fax":"string",
"fax_id":0,
"firm_deletion_date":"1970-01-01T00:00:00.000Z",
"gsm_operator_id":0,
"has_personal_password":false,
"icq":"string",
"id":0,
"is_email_visible":false,
"is_photo_exists":false,
"is_visible":false,
"language":"string",
"login":"string",
"mobile":"string",
"mobile_id":0,
"name":"string",
"note":"string",
"phone":"string",
"phone_id":0,
"position":"string",
"skype_name":"string",
"user_rights":0
}
]
[{...}]
access_rights: int32

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

ati_id: string

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

attributes: int32

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

city_id: int32

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

contact_right_nesting_type_id: enum
[0, 1, 2]
deletion_date: date-time

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

department_id: int32

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

e_mail: string

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

fax: string

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

fax_id: int32

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

firm_deletion_date: date-time

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

gsm_operator_id: int32

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

has_personal_password: boolean

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

icq: string

ICQ контакта

id: int32

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

is_deleted: boolean

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

read only
is_email_visible: boolean

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

is_photo_exists: boolean

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

is_visible: boolean

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

language: string

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

login: string

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

mobile: string

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

mobile_id: int32

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

name: string

Имя контакта

note: string

Примечание

phone: string

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

phone_id: int32

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

position: string

Должность

skype_name: string

Логин в Skype

user_rights: enum
[0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 131072, 262144, 2097152, 8388608, 8534011, 8536059, 10893311, 10895359]
}]
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

 
Получение краткой информации о контакте фирмы
get
/v1.0/firms/{atiId}/contacts/{contactId}/summary
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
{...}
"ati_id":"string",
"bad_partner_mentions_count":0,
"city_id":0,
"claims_count":0,
"contact_id":0,
"fax":"string",
"firm_name":"string",
"firm_type":"string",
"icq":"string",
"mobile_phone":"string",
"name":"string",
"ownership":"string",
"phone":"string",
"recommendations_count":0,
"score":0.5,
"skype_name":"string",
"status":0
}
{...}

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

ati_id: string

Код в АТИ.

bad_partner_mentions_count: int32

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

city_id: int32

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

claims_count: int32

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

contact_id: int32

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

fax: string

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

firm_name: string

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

firm_type: string

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

icq: string

Icq контакта

mobile_phone: string

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

name: string

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

ownership: string

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

phone: string

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

recommendations_count: int32

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

score: double

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

skype_name: string

Skype контакта

status: enum
[0, 1, 2, 3, 4, 5, 6, 7]
}
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

 
Получение краткой информации о всех контактах фирмы
get
/v1.0/firms/{atiId}/contacts/summary
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"ati_id":"string",
"bad_partner_mentions_count":0,
"city_id":0,
"claims_count":0,
"contact_id":0,
"fax":"string",
"firm_name":"string",
"firm_type":"string",
"icq":"string",
"mobile_phone":"string",
"name":"string",
"ownership":"string",
"phone":"string",
"recommendations_count":0,
"score":0.5,
"skype_name":"string",
"status":0
}
]
[{...}]

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

ati_id: string

Код в АТИ.

bad_partner_mentions_count: int32

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

city_id: int32

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

claims_count: int32

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

contact_id: int32

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

fax: string

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

firm_name: string

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

firm_type: string

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

icq: string

Icq контакта

mobile_phone: string

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

name: string

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

ownership: string

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

phone: string

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

recommendations_count: int32

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

score: double

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

skype_name: string

Skype контакта

status: enum
[0, 1, 2, 3, 4, 5, 6, 7]
}]
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Метод получения реквизитов по ID
get
/v1.0/firms/requisites/{requisiteId}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
{...}
"ati_id":"string",
"available_in_ati_docs":false,
"bank":"string",
"bik":"string",
"codes":"string",
"email":"string",
"fax":"string",
"fio":"string",
"inn":"string",
"is_active":false,
"is_read_only":false,
"is_vat_payer":false,
"kpp":"string",
"ks":"string",
"last_use_date":"1970-01-01T00:00:00.000Z",
"legal_address":{...},
"add_date":"1970-01-01T00:00:00.000Z",
"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"string",
"attributes":0,
"city_id":0,
"city_name":"string",
"country_id":0,
"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fias_level":0,
"formatted_text":"string",
"house_no":"string",
"is_post_address":false,
"litera":"string",
"note":"string",
"office_no":"string",
"part_no":"string",
"post_contact":"string",
"post_index":"string",
"region_id":0,
"send_type_id":0,
"street_name":"string",
"street_type_id":0
},
"legal_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"legal_name":"string",
"ogrn":"string",
"okpo":"string",
"own_ship_id":0,
"person_passport":{...},
"date_of_issue":"1970-01-01T00:00:00.000Z",
"issued_by":"string",
"number":"string",
"registration":"string",
"series":"string"
},
"phone":"string",
"post_address":{...},
"add_date":"1970-01-01T00:00:00.000Z",
"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"string",
"attributes":0,
"city_id":0,
"city_name":"string",
"country_id":0,
"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fias_level":0,
"formatted_text":"string",
"house_no":"string",
"is_post_address":false,
"litera":"string",
"note":"string",
"office_no":"string",
"part_no":"string",
"post_contact":"string",
"post_index":"string",
"region_id":0,
"send_type_id":0,
"street_name":"string",
"street_type_id":0
},
"post_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requisite_name":"string",
"requisite_type_id":0,
"rs":"string",
"signees":[...]
{...}
"act_upon":"string",
"deletion_date":"1970-01-01T00:00:00.000Z",
"full_name":"string",
"full_name_and_position":"string",
"is_default":false,
"position":"string",
"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signee_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
{...}
ati_id: string

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

available_in_ati_docs: boolean

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

bank: string

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

bik: string

БИК

codes: string

Коды

email: string

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

fax: string

Факс

fio: string

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

inn: string

ИНН

is_active: boolean

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

is_read_only: boolean

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

is_vat_payer: boolean

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

kpp: string

КПП

ks: string

КС

last_use_date: date-time

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

legal_address_id: uuid

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

legal_name: string

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

ogrn: string

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

okpo: string

ОКПО

own_ship_id: int32

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

phone: string

Телефон

post_address_id: uuid

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

requisite_id: uuid

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

requisite_name: string

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

requisite_type_id: int32

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

rs: string

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

}
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

 
Метод получения реквизитов фирмы
get
/v1.0/firms/requisites
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"ati_id":"string",
"available_in_ati_docs":false,
"bank":"string",
"bik":"string",
"codes":"string",
"email":"string",
"fax":"string",
"fio":"string",
"inn":"string",
"is_active":false,
"is_read_only":false,
"is_vat_payer":false,
"kpp":"string",
"ks":"string",
"last_use_date":"1970-01-01T00:00:00.000Z",
"legal_address":{...},
"add_date":"1970-01-01T00:00:00.000Z",
"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"string",
"attributes":0,
"city_id":0,
"city_name":"string",
"country_id":0,
"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fias_level":0,
"formatted_text":"string",
"house_no":"string",
"is_post_address":false,
"litera":"string",
"note":"string",
"office_no":"string",
"part_no":"string",
"post_contact":"string",
"post_index":"string",
"region_id":0,
"send_type_id":0,
"street_name":"string",
"street_type_id":0
},
"legal_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"legal_name":"string",
"ogrn":"string",
"okpo":"string",
"own_ship_id":0,
"person_passport":{...},
"date_of_issue":"1970-01-01T00:00:00.000Z",
"issued_by":"string",
"number":"string",
"registration":"string",
"series":"string"
},
"phone":"string",
"post_address":{...},
"add_date":"1970-01-01T00:00:00.000Z",
"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"string",
"attributes":0,
"city_id":0,
"city_name":"string",
"country_id":0,
"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fias_level":0,
"formatted_text":"string",
"house_no":"string",
"is_post_address":false,
"litera":"string",
"note":"string",
"office_no":"string",
"part_no":"string",
"post_contact":"string",
"post_index":"string",
"region_id":0,
"send_type_id":0,
"street_name":"string",
"street_type_id":0
},
"post_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requisite_name":"string",
"requisite_type_id":0,
"rs":"string",
"signees":[...]
{...}
"act_upon":"string",
"deletion_date":"1970-01-01T00:00:00.000Z",
"full_name":"string",
"full_name_and_position":"string",
"is_default":false,
"position":"string",
"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signee_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
]
[{...}]
ati_id: string

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

available_in_ati_docs: boolean

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

bank: string

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

bik: string

БИК

codes: string

Коды

email: string

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

fax: string

Факс

fio: string

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

inn: string

ИНН

is_active: boolean

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

is_read_only: boolean

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

is_vat_payer: boolean

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

kpp: string

КПП

ks: string

КС

last_use_date: date-time

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

legal_address_id: uuid

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

legal_name: string

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

ogrn: string

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

okpo: string

ОКПО

own_ship_id: int32

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

phone: string

Телефон

post_address_id: uuid

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

requisite_id: uuid

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

requisite_name: string

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

requisite_type_id: int32

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

rs: string

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

}]
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

 
Метод получения реквизитов фирмы
get
/v1.0/firms/{atiId}/requisites
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"ati_id":"string",
"available_in_ati_docs":false,
"bank":"string",
"bik":"string",
"codes":"string",
"email":"string",
"fax":"string",
"fio":"string",
"inn":"string",
"is_active":false,
"is_read_only":false,
"is_vat_payer":false,
"kpp":"string",
"ks":"string",
"last_use_date":"1970-01-01T00:00:00.000Z",
"legal_address":{...},
"add_date":"1970-01-01T00:00:00.000Z",
"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"string",
"attributes":0,
"city_id":0,
"city_name":"string",
"country_id":0,
"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fias_level":0,
"formatted_text":"string",
"house_no":"string",
"is_post_address":false,
"litera":"string",
"note":"string",
"office_no":"string",
"part_no":"string",
"post_contact":"string",
"post_index":"string",
"region_id":0,
"send_type_id":0,
"street_name":"string",
"street_type_id":0
},
"legal_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"legal_name":"string",
"ogrn":"string",
"okpo":"string",
"own_ship_id":0,
"person_passport":{...},
"date_of_issue":"1970-01-01T00:00:00.000Z",
"issued_by":"string",
"number":"string",
"registration":"string",
"series":"string"
},
"phone":"string",
"post_address":{...},
"add_date":"1970-01-01T00:00:00.000Z",
"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"string",
"attributes":0,
"city_id":0,
"city_name":"string",
"country_id":0,
"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fias_level":0,
"formatted_text":"string",
"house_no":"string",
"is_post_address":false,
"litera":"string",
"note":"string",
"office_no":"string",
"part_no":"string",
"post_contact":"string",
"post_index":"string",
"region_id":0,
"send_type_id":0,
"street_name":"string",
"street_type_id":0
},
"post_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requisite_name":"string",
"requisite_type_id":0,
"rs":"string",
"signees":[...]
{...}
"act_upon":"string",
"deletion_date":"1970-01-01T00:00:00.000Z",
"full_name":"string",
"full_name_and_position":"string",
"is_default":false,
"position":"string",
"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signee_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
]
[{...}]
ati_id: string

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

available_in_ati_docs: boolean

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

bank: string

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

bik: string

БИК

codes: string

Коды

email: string

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

fax: string

Факс

fio: string

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

inn: string

ИНН

is_active: boolean

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

is_read_only: boolean

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

is_vat_payer: boolean

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

kpp: string

КПП

ks: string

КС

last_use_date: date-time

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

legal_address_id: uuid

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

legal_name: string

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

ogrn: string

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

okpo: string

ОКПО

own_ship_id: int32

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

phone: string

Телефон

post_address_id: uuid

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

requisite_id: uuid

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

requisite_name: string

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

requisite_type_id: int32

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

rs: string

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

}]
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Получение краткой информации о своей фирме
get
/v1.0/firms/summary
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
{...}
"affiliated_firms":[...],
{...}
"firm_name":"string",
"inn":"string",
"tf_firm_color":"string",
"tf_has_signals":false
}
],
"ati_id":"string",
"bad_partner_mentions_count":0,
"city":"string",
"claims_count":0,
"contact_info_changed":"1970-01-01T00:00:00.000Z",
"firm_documents":[...],
{...}
"creation_date":"1970-01-01T00:00:00.000Z",
"description":"string",
"link":"string"
}
],
"firm_type":"string",
"full_name":"string",
"info_reference":"string",
"inn":"string",
"last_month_active_days":0,
"negative_points_sum":0.5,
"ogrn":"string",
"passport_reference":"string",
"recommendations_count":0,
"registration_date":"1970-01-01T00:00:00.000Z",
"score":0.5,
"tf_account_color":"string",
"tf_firm_color":"string",
"tf_has_signals":false
}
{...}
ati_id: string

Код в АТИ.

bad_partner_mentions_count: int32

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

city: string

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

claims_count: int32

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

contact_info_changed: date-time

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

firm_type: string

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

full_name: string

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

info_reference: string

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

inn: string

Инн

last_month_active_days: int32

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

negative_points_sum: double

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

ogrn: string

ОГРН

passport_reference: string

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

recommendations_count: int32

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

registration_date: date-time

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

score: double

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

tf_account_color: string

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

tf_firm_color: string

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

tf_has_signals: boolean

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

}
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

 
Получение краткой информации по фирме (по идентификатору)
get
/v1.0/firms/summary/{atiId}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
{...}
"affiliated_firms":[...],
{...}
"firm_name":"string",
"inn":"string",
"tf_firm_color":"string",
"tf_has_signals":false
}
],
"ati_id":"string",
"bad_partner_mentions_count":0,
"city":"string",
"claims_count":0,
"contact_info_changed":"1970-01-01T00:00:00.000Z",
"firm_documents":[...],
{...}
"creation_date":"1970-01-01T00:00:00.000Z",
"description":"string",
"link":"string"
}
],
"firm_type":"string",
"full_name":"string",
"info_reference":"string",
"inn":"string",
"last_month_active_days":0,
"negative_points_sum":0.5,
"ogrn":"string",
"passport_reference":"string",
"recommendations_count":0,
"registration_date":"1970-01-01T00:00:00.000Z",
"score":0.5,
"tf_account_color":"string",
"tf_firm_color":"string",
"tf_has_signals":false
}
{...}
ati_id: string

Код в АТИ.

bad_partner_mentions_count: int32

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

city: string

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

claims_count: int32

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

contact_info_changed: date-time

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

firm_type: string

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

full_name: string

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

info_reference: string

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

inn: string

Инн

last_month_active_days: int32

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

negative_points_sum: double

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

ogrn: string

ОГРН

passport_reference: string

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

recommendations_count: int32

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

registration_date: date-time

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

score: double

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

tf_account_color: string

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

tf_firm_color: string

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

tf_has_signals: boolean

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

}
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

 
Получение краткой информации по фирмам (по идентификаторам)
post
/v1.0/firms/summaries
Развернуть все Свернуть все
[string]

Список идентификаторов фирм

CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Success
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"affiliated_firms":[...],
{...}
"firm_name":"string",
"inn":"string",
"tf_firm_color":"string",
"tf_has_signals":false
}
],
"ati_id":"string",
"bad_partner_mentions_count":0,
"city":"string",
"claims_count":0,
"contact_info_changed":"1970-01-01T00:00:00.000Z",
"firm_documents":[...],
{...}
"creation_date":"1970-01-01T00:00:00.000Z",
"description":"string",
"link":"string"
}
],
"firm_type":"string",
"full_name":"string",
"info_reference":"string",
"inn":"string",
"last_month_active_days":0,
"negative_points_sum":0.5,
"ogrn":"string",
"passport_reference":"string",
"recommendations_count":0,
"registration_date":"1970-01-01T00:00:00.000Z",
"score":0.5,
"tf_account_color":"string",
"tf_firm_color":"string",
"tf_has_signals":false
}
]
[{...}]
ati_id: string

Код в АТИ.

bad_partner_mentions_count: int32

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

city: string

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

claims_count: int32

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

contact_info_changed: date-time

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

firm_type: string

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

full_name: string

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

info_reference: string

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

inn: string

Инн

last_month_active_days: int32

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

negative_points_sum: double

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

ogrn: string

ОГРН

passport_reference: string

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

recommendations_count: int32

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

registration_date: date-time

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

score: double

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

tf_account_color: string

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

tf_firm_color: string

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

tf_has_signals: boolean

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

}]
400 Bad Request
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
401 Unauthorized
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
402 Client Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
403 Forbidden
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
404 Not Found
Развернуть все Свернуть все
500 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
504 Server Error
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}
error: string
reason: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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