Словари для работы с фирмами

Получение списка организационно-правовых форм (ОПФ)

Каждой организационно-правовой форме присвоен свой уникальный идентификатор в базе данных ATI.SU. Воспользуйтесь словарем списка ОПФ, чтобы найти нужные id.

Получение списка ОПФ

get /v1.0/dictionaries/ownerships

Модель и примеры

Запрос

Пример запроса

CURL

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

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/dictionaries/ownerships");

Ответ

200 Список организационно-правовых форм

Модель

[{...}]

Id: int64

Id

Id2: guid

Guid

Name: string

Название

FullName: string

Полное название

}]

Пример

[...]

{...}

"Id":0,

"Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name":"string",

"FullName":"string"

}

]

Консоль

Отправить

Параметры

Нет параметров

Словари аккаунта

Метод получения профилей деятельности фирм

get /v1.0/firms/dictionaries/account/firmtypes

Модель и примеры

Запрос

Пример запроса

CURL

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

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/firms/dictionaries/account/firmtypes");

Ответ

200 Success

Модель

[{...}]

Структура "Профиль деятельности".

id: int32

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

name: string (nullable)

Название типа

russian_name: string (nullable)

Название типа.

english_name: string (nullable)

Английское название типа.

enable_for_registration: boolean

Флаг, означающий, что данный профиль деятельности доступен для выбора при регистрации.

}]

Пример

[...]

{...}

"id":0,

"name":"string",

"russian_name":"string",

"english_name":"string",

"enable_for_registration":false

}

]

400 Bad Request

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

401 Unauthorized

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

402 Client Error

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

403 Forbidden

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

404 Not Found

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

500 Server Error

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

504 Server Error

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

Консоль

Отправить

Параметры

enableForRegistration true false Доступность профиля при регистрации

Метод получения профилей деятельности фирм

get /v1.0/firms/dictionaries/account/firmtypes/{id}

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/firms/dictionaries/account/firmtypes/{id}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/firms/dictionaries/account/firmtypes/{id}");

Ответ

200 Success

Модель

{...}

Структура "Профиль деятельности".

id: int32

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

name: string (nullable)

Название типа

russian_name: string (nullable)

Название типа.

english_name: string (nullable)

Английское название типа.

enable_for_registration: boolean

Флаг, означающий, что данный профиль деятельности доступен для выбора при регистрации.

}

Пример

{...}

"id":0,

"name":"string",

"russian_name":"string",

"english_name":"string",

"enable_for_registration":false

}

400 Bad Request

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

401 Unauthorized

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

402 Client Error

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

403 Forbidden

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

404 Not Found

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

500 Server Error

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

504 Server Error

Модель

{...}

error: string (nullable)

reason: string (nullable)

}

Пример

{...}

"error":"string",

"reason":"string"

}

Консоль

Отправить

Параметры

id Идентификатор профиля фирмы

Словари реквизитов

Возвращает справочник стран, доступных в реквизитах.

get /v1.0/firms/requisites/countries

Модель и примеры

Запрос

Пример запроса

CURL

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

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/firms/requisites/countries");

Ответ

200 OK

Модель

[{...}]

Сущность страны для справочников сервиса

id: int32

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

name: null,string

Полное название страны.

short_name: null,string

Короткое название страны.

default_ownership:{...}

Форма собственности по умолчанию для данной страны

id: int32

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

name: null,string

Полное название формы собственности (рус.).

name_eng: null,string

Полное название формы собственности (англ.).

short_name: null,string

Короткое название формы собственности (рус.).

short_name_eng: null,string

Короткое название формы собственности (англ.).

ownership_type: null,string

Тип формы собственности: "LegalPerson" / "SoleProprietor" / "NaturalPerson".

read only

ownership_type_name: null,string

Устаревшее поле. Используй поле OwnershipType

read only

requisite_types: [int32]

Список идентификаторов типов реквизитов, применимых к этой форме собственности

}

ownerships:[{...}]

Список всех доступных в данной стране форм собственности

id: int32

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

name: null,string

Полное название формы собственности (рус.).

name_eng: null,string

Полное название формы собственности (англ.).

short_name: null,string

Короткое название формы собственности (рус.).

short_name_eng: null,string

Короткое название формы собственности (англ.).

ownership_type: null,string

Тип формы собственности: "LegalPerson" / "SoleProprietor" / "NaturalPerson".

read only

ownership_type_name: null,string

Устаревшее поле. Используй поле OwnershipType

read only

requisite_types: [int32]

Список идентификаторов типов реквизитов, применимых к этой форме собственности

}]

}]

Пример

[...]

{...}

"id":1,

"name":"Россия",

"short_name":"РФ",

"default_ownership":{...},

"id":1,

"name":"Общество с ограниченной ответственностью",

"name_eng":"Limited Liability Company",

"short_name":"ООО",

"short_name_eng":"LLC",

"ownership_type":"LegalPerson",

"ownership_type_name":"LegalPerson",

"requisite_types":[...]

0

]

},

"ownerships":[...]

{...}

"id":1,

"name":"Общество с ограниченной ответственностью",

"name_eng":"Limited Liability Company",

"short_name":"ООО",

"short_name_eng":"LLC",

"ownership_type":"LegalPerson",

"ownership_type_name":"LegalPerson",

"requisite_types":[...]

0

]

}

]

}

]

400 Неверные входные данные.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"invalid_input_data",

"reason":"Неверные входные данные."

}

403 Отсутствует разрешение.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"forbidden",

"reason":"Отсутствует разрешение."

}

404 Ресурс не найден

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"not_found",

"reason":"Ресурс не найден"

}

500 Произошла ошибка во время выполнения запроса.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"internal_error",

"reason":"Произошла ошибка во время выполнения запроса."

}

Консоль

Отправить

Параметры

Нет параметров

Возвращает справочник частей адреса (типы улиц, зданий, частей строений, помещений).

get /v1.0/firms/requisites/addressparts

Модель и примеры

Запрос

Пример запроса

CURL

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

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/firms/requisites/addressparts");

Ответ

200 OK

Модель

{...}

Типы адресов.

street_types:[{...}]

Коллекция типов улиц (например, проспект).

id: int32

Идентификатор элемента адреса.

name: null,string

Полное название элемента адреса.

short_name: null,string

Короткое название элемента адреса.

}]

building_types:[{...}]

Коллекция типов зданий (например, дом).

id: int32

Идентификатор элемента адреса.

name: null,string

Полное название элемента адреса.

short_name: null,string

Короткое название элемента адреса.

}]

building_part_types:[{...}]

Коллекция типов строений (например, корпус).

id: int32

Идентификатор элемента адреса.

name: null,string

Полное название элемента адреса.

short_name: null,string

Короткое название элемента адреса.

}]

room_types:[{...}]

Коллекция типов помещений (например, офис).

id: int32

Идентификатор элемента адреса.

name: null,string

Полное название элемента адреса.

short_name: null,string

Короткое название элемента адреса.

}]

}

Пример

{...}

"street_types":[...],

{...}

"id":1,

"name":"проспект",

"short_name":"пр-кт"

}

],

"building_types":[...],

{...}

"id":1,

"name":"проспект",

"short_name":"пр-кт"

}

],

"building_part_types":[...],

{...}

"id":1,

"name":"проспект",

"short_name":"пр-кт"

}

],

"room_types":[...]

{...}

"id":1,

"name":"проспект",

"short_name":"пр-кт"

}

]

}

400 Неверные входные данные.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"invalid_input_data",

"reason":"Неверные входные данные."

}

403 Отсутствует разрешение.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"forbidden",

"reason":"Отсутствует разрешение."

}

404 Ресурс не найден

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"not_found",

"reason":"Ресурс не найден"

}

500 Произошла ошибка во время выполнения запроса.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"internal_error",

"reason":"Произошла ошибка во время выполнения запроса."

}

Консоль

Отправить

Параметры

Нет параметров

Возвращает список форм собственности, доступных для указанной страны.

get /v1.0/firms/requisites/ownerships/{countryId}

Модель и примеры

Запрос

Пример запроса

CURL

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

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/firms/requisites/ownerships/{countryId}");

Ответ

200 OK

Модель

[{...}]

Форма собственности (организационно-правовая форма) фирмы из справочника по стране.

id: int32

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

name: null,string

Полное название формы собственности (рус.).

name_eng: null,string

Полное название формы собственности (англ.).

short_name: null,string

Короткое название формы собственности (рус.).

short_name_eng: null,string

Короткое название формы собственности (англ.).

ownership_type: null,string

Тип формы собственности: "LegalPerson" / "SoleProprietor" / "NaturalPerson".

read only

ownership_type_name: null,string

Устаревшее поле. Используй поле OwnershipType

read only

requisite_types: [int32]

Список идентификаторов типов реквизитов, применимых к этой форме собственности

}]

Пример

[...]

{...}

"id":1,

"name":"Общество с ограниченной ответственностью",

"name_eng":"Limited Liability Company",

"short_name":"ООО",

"short_name_eng":"LLC",

"ownership_type":"LegalPerson",

"ownership_type_name":"LegalPerson",

"requisite_types":[...]

0

]

}

]

400 Неверные входные данные.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"invalid_input_data",

"reason":"Неверные входные данные."

}

403 Отсутствует разрешение.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"forbidden",

"reason":"Отсутствует разрешение."

}

404 Ресурс не найден

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"not_found",

"reason":"Ресурс не найден"

}

500 Произошла ошибка во время выполнения запроса.

Модель

{...}

Стандартный ответ с описанием ошибки

error: null,string

Код ошибки

reason: null,string

Описание ошибки

}

Пример

{...}

"error":"internal_error",

"reason":"Произошла ошибка во время выполнения запроса."

}

Консоль

Отправить

Параметры

countryId Идентификатор страны (из `GET /v1.0/firms/requisites/countries`).