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

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

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

Получение справочника организационно-правовых форм. API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Организационно-правовая форма указывается в реквизитах фирмы.

get /v1.0/dictionaries/ownerships

Модель и примеры
Консоль

Параметры

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

Запрос

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

CURL
1C

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

Процедура Выполнить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

Числовой идентификатор записи справочника.

Id2: guid

Идентификатор записи справочника в виде guid.

Name: string

Название записи справочника на русском.

FullName: string

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

}]

Пример

[...]

{...}

"Id":1,

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

"Name":"Тент.",

"FullName":"Акционерное общество"

}

]

Тот же список в словаре own_ships: короткое и полное название формы на нескольких языках. Идентификатор формы в нём называется dictionary_item_id и совпадает с id в методе выше. Элемент с dictionary_item_id 0 «(другая)» означает, что форма не указана или её нет в списке. Если перевода на запрошенный язык нет, приходит русское название.

Авторизация

Получение организационно-правовых форм Организационно-правовые формы фирм: ООО, ИП, АО и другие, в том числе формы других стран. Идентификатор организационно-правовой формы в API фирм и реквизитов совпадает с dictionary_item_id этого словаря. Элемент с dictionary_item_id 0 «(другая)» означает, что форма не указана или её нет в списке. Названия приходят на языке из параметра locale; если перевода нет, приходит русское название. Список общий для всех стран. Формы, доступные в конкретной стране, отдаёт метод GET https://api.ati.su/v1.0/firms/requisites/ownerships/{countryId}.

get /gw/marshak/v1/dictionaries/own_ships

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/marshak/v1/dictionaries/own_ships");

Ответ

200 Элементы словаря own_ships

Модель

[{...}]

Организационно-правовые формы фирм: ООО, ИП, АО и другие, в том числе формы других стран. Идентификатор организационно-правовой формы в API фирм и реквизитов совпадает с dictionary_item_id этого словаря. Элемент с dictionary_item_id 0 «(другая)» означает, что форма не указана или её нет в списке. Названия приходят на языке из параметра locale; если перевода нет, приходит русское название. Список общий для всех стран. Формы, доступные в конкретной стране, отдаёт метод GET https://api.ati.su/v1.0/firms/requisites/ownerships/{countryId}.

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

full_own_ship_name: string

Полное название организационно-правовой формы.

own_ship_name: string

Краткое название организационно-правовой формы, например ООО или ИП.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

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

"own_ship_name":"ООО"

}

]

get /gw/oauth2/marshak/v1/dictionaries/own_ships

Тестирование запросов возможно только с авторизацией Bearer

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/oauth2/marshak/v1/dictionaries/own_ships");

Ответ

200 Элементы словаря own_ships

Модель

[{...}]

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

full_own_ship_name: string

Полное название организационно-правовой формы.

own_ship_name: string

Краткое название организационно-правовой формы, например ООО или ИП.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

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

"own_ship_name":"ООО"

}

]

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

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

Справочник профилей деятельности фирм ATI.SU: перевозчик, экспедитор, грузовладелец и другие.

Каждый элемент содержит идентификатор dictionary_item_id и объект attributes с полями профиля деятельности. Значения атрибутов — строки. Язык значений задаёт параметр locale.

Авторизация

Получение профилей деятельности фирм Справочник профилей деятельности фирм ATI.SU.

get /gw/marshak/v1/dictionaries/frm_types

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/marshak/v1/dictionaries/frm_types");

Ответ

200 Элементы словаря frm_types

Модель

[{...}]

Справочник профилей деятельности фирм ATI.SU.

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

description: string

Описание профиля деятельности фирмы.

enable_for_registration: string

Доступность профиля деятельности для выбора при регистрации: строка "1" — доступен, "0" — недоступен.

firm_type: string

Название профиля деятельности фирмы.

firm_type_abbreviation: string

Аббревиатура профиля деятельности фирмы.

short_name: string

Сокращённое название профиля деятельности фирмы.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

"description":"Ищу грузы для перевозки, у меня есть транспорт",

"enable_for_registration":"1",

"firm_type":"Перевозчик",

"firm_type_abbreviation":"П",

"short_name":"перев."

}

]

Получение профилей деятельности фирм Справочник профилей деятельности фирм ATI.SU.

get /gw/oauth2/marshak/v1/dictionaries/frm_types

Тестирование запросов возможно только с авторизацией Bearer

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/oauth2/marshak/v1/dictionaries/frm_types");

Ответ

200 Элементы словаря frm_types

Модель

[{...}]

Справочник профилей деятельности фирм ATI.SU.

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

description: string

Описание профиля деятельности фирмы.

enable_for_registration: string

Доступность профиля деятельности для выбора при регистрации: строка "1" — доступен, "0" — недоступен.

firm_type: string

Название профиля деятельности фирмы.

firm_type_abbreviation: string

Аббревиатура профиля деятельности фирмы.

short_name: string

Сокращённое название профиля деятельности фирмы.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

"description":"Ищу грузы для перевозки, у меня есть транспорт",

"enable_for_registration":"1",

"firm_type":"Перевозчик",

"firm_type_abbreviation":"П",

"short_name":"перев."

}

]

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

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

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

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`id` обязательный	integer (int32)	`path`	Идентификатор профиля деятельности (поле `id` из метода `GET /v1.0/firms/dictionaries/account/firmtypes`). Пример: `5`

Запрос

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

CURL
1C

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

Процедура Выполнить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 Профиль деятельности

Модель

{...}

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

id: int32

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

Название профиля. Сейчас не заполняется и в ответе отсутствует: используйте russian_name и english_name.

russian_name: null,string

Название профиля на русском языке.

english_name: null,string

Название профиля на английском языке.

enable_for_registration: boolean

Можно ли выбрать профиль при регистрации фирмы.

}

Пример

{...}

"id":5,

"name":null,

"russian_name":"Экспедитор-перевозчик",

"english_name":"Forwarder-Carrier",

"enable_for_registration":true

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"invalid_input_data",

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

}

401 Не авторизован

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"un_authorized",

"reason":"Не авторизован"

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"not_found",

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

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"internal_error",

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

}

504 Сервер не ответил во время.

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"timeout",

"reason":"Сервер не ответил во время."

}

Системы налогообложения

Системы налогообложения фирмы: ОСНО, УСН, НПД и другие. Поле taxation_type фирмы содержит dictionary_item_id этого словаря.

Названия зависят от локали. На русском в taxation_type_name приходит сокращение, например «УСН», а в full_taxation_type_name — полное название. На английском и казахском полное название приходит в taxation_type_name, а full_taxation_type_name не переведено и приходит на русском.

Метод отдаёт плоский список: у каждого элемента идентификатор и набор атрибутов. Состав полей и их описания смотрите в схеме ответа ниже.

Авторизация

Получение систем налогообложения Системы налогообложения фирмы: ОСНО, УСН, НПД и другие. Поле taxation_type фирмы содержит dictionary_item_id этого словаря.

get /gw/marshak/v1/dictionaries/taxation_types

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/marshak/v1/dictionaries/taxation_types");

Ответ

200 Элементы словаря taxation_types

Модель

[{...}]

Системы налогообложения фирмы: ОСНО, УСН, НПД и другие. Поле taxation_type фирмы содержит dictionary_item_id этого словаря.

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

full_taxation_type_name: string

Полное название системы налогообложения.

taxation_type_name: string

Название системы налогообложения.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

"full_taxation_type_name":"Упрощенная система налогообложения",

"taxation_type_name":"УСН"

}

]

get /gw/oauth2/marshak/v1/dictionaries/taxation_types

Тестирование запросов возможно только с авторизацией Bearer

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/oauth2/marshak/v1/dictionaries/taxation_types");

Ответ

200 Элементы словаря taxation_types

Модель

[{...}]

Системы налогообложения фирмы: ОСНО, УСН, НПД и другие. Поле taxation_type фирмы содержит dictionary_item_id этого словаря.

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

full_taxation_type_name: string

Полное название системы налогообложения.

taxation_type_name: string

Название системы налогообложения.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

"full_taxation_type_name":"Упрощенная система налогообложения",

"taxation_type_name":"УСН"

}

]

Права контактов

Права контакта

Права контакта фирмы: работа с грузами и машинами, администрирование, подписание документов и другие. Поле user_rights контакта — сумма значений user_right его прав, а не dictionary_item_id.

Идентификатор элемента и значение права не совпадают: например, у элемента с dictionary_item_id 3 значение user_right равно 4.

Авторизация

Получение прав контакта Права контакта фирмы: работа с грузами и машинами, администрирование, подписание документов и другие. Поле user_rights контакта — сумма значений user_right его прав, а не dictionary_item_id.

get /gw/marshak/v1/dictionaries/user_rights

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/marshak/v1/dictionaries/user_rights");

Ответ

200 Элементы словаря user_rights

Модель

[{...}]

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

Короткая подпись права: действие или объект, к которому право даёт доступ.

user_right: string

Значение права — степень двойки, приходит строкой.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

"name":"администрировать контакты и подразделения",

"user_right":"4"

}

]

get /gw/oauth2/marshak/v1/dictionaries/user_rights

Тестирование запросов возможно только с авторизацией Bearer

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`locale`	string	`query`	Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: `ru`

Запрос

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

CURL
1C

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

Процедура Выполнить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", "/gw/oauth2/marshak/v1/dictionaries/user_rights");

Ответ

200 Элементы словаря user_rights

Модель

[{...}]

dictionary_item_id: integer

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

attributes:{...}

Поля элемента: ключ — имя поля, значение — строка

Короткая подпись права: действие или объект, к которому право даёт доступ.

user_right: string

Значение права — степень двойки, приходит строкой.

}

}]

Пример

[...]

{...}

"dictionary_item_id":1,

"attributes":{...}

"name":"администрировать контакты и подразделения",

"user_right":"4"

}

]

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

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

get /v1.0/firms/requisites/countries

Модель и примеры
Консоль

Параметры

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

Запрос

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

CURL
1C

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

Процедура Выполнить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

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

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

short_name: null,string

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

default_ownership:{...}

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

id: int32

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

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

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

]

"ownerships":[...]

{...}

"id":1,

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

"name_eng":"Limited Liability Company",

"short_name":"ООО",

"short_name_eng":"LLC",

"ownership_type":"LegalPerson",

"ownership_type_name":"LegalPerson",

"requisite_types":[...]

]

}

]

}

]

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
1C

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

Процедура Выполнить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

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

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

short_name: null,string

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

}]

building_types:[{...}]

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

id: int32

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

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

short_name: null,string

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

}]

building_part_types:[{...}]

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

id: int32

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

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

short_name: null,string

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

}]

room_types:[{...}]

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

id: int32

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

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

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}

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`countryId` обязательный	integer (int32)	`path`	Идентификатор страны (из `GET /v1.0/firms/requisites/countries`). Пример: `1`

Запрос

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

CURL
1C

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

Процедура Выполнить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_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":[...]

]

}

]

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":"Произошла ошибка во время выполнения запроса."

}