Претензии

Претензия — это информация, которую участник размещает на ATI.SU, о нарушении его прав или условий договорённостей другим участником. Опубликованная Претензия видна участникам ATI.SU и попадает в Паспорт фирмы-ответчика.

Интеграционное API позволяет выставить претензию от имени пользователя вашей фирмы: загрузить документы, уточнить наименование юр. лица ответчика и создать саму претензию.

Все запросы выполняются с заголовком Authorization: Bearer <access_token>, токен выпускается по инструкции по авторизации. Один токен соответствует одному пользователю: претензия публикуется от его имени и от имени его фирмы.

Идентификаторы в запросах и ответах — значения словарей претензий: типы претензий, типы документов, статусы, уровни. Списки значений отдают методы на странице Словари для работы с претензиями.

Порядок добавления претензии

Загрузите каждый документ отдельным запросом и соберите полученные file_key.
Если ответчик известен по коду ATI.SU, получите варианты наименования его юр. лица.
Создайте претензию, передав тип, стороны, сумму и собранные документы.

Загрузка документа претензии

Загружает один файл документа претензии и возвращает его file_key для последующего создания претензии.

За один запрос загружается ровно один файл. Для каждого документа вызывайте метод отдельно и собирайте file_key в массив документов создаваемой претензии.

Загрузка документа претензии

post /gw/claims/integration/v1/claims/documents/upload

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

Параметры

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

Запрос

Модель

{...}

File*: binary

Прикрепленный файл

ClaimDocTypeId*: int32

>=0 and <= 2147483647

Тип прикрепленного файла из ClaimDocTypes

}

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

CURL
1C

curl 'https://api.ati.su/gw/claims/integration/v1/claims/documents/upload' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'File=@{File}' \
  -F 'ClaimDocTypeId={ClaimDocTypeId}'

Процедура Выполнить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Запрос("POST", "https://api.ati.su", "/gw/claims/integration/v1/claims/documents/upload");

Ответ

200 OK

Модель

{...}

Результат загрузки файла в плюшкин для внешних интеграторов.

file_key: null,string

Ключ файла в плюшкине

}

Пример

{...}

"file_key":"string"

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"invalid_input_data",

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

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"un_authorized",

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

}

402 Метод доступен только платным пользователям.

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"payment_required",

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

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"timeout",

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

}

Наименования юр. лиц ответчика

Возвращает известные наименования юр. лиц, связанных с указанным кодом фирмы в ATI.SU.

Метод вспомогательный: он помогает выбрать то наименование ответчика, которое затем передаётся при создании претензии.

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

get /gw/claims/integration/v1/claims/defendants

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

Параметры

Параметр	Тип	Расположение	Описание
`atiId`	string	`query`	Код фирмы ответчика в ATI.SU Пример: `string`

Запрос

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

CURL
1C

curl 'https://api.ati.su/gw/claims/integration/v1/claims/defendants' \
  -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/claims/integration/v1/claims/defendants");

Ответ

200 OK

Модель

{...}

Список связанных фирм ответчика для внешних интеграторов.

defendant_firms:[{...}]

Список связанных фирм ответчика

name: null,string

Наименование связанной фирмы с формой собственности

inn: null,string

ИНН связанной фирмы

}]

}

Пример

{...}

"defendant_firms":[...]

{...}

"name":"string",

"inn":"string"

}

]

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"invalid_input_data",

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

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"un_authorized",

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

}

402 Метод доступен только платным пользователям.

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"payment_required",

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

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"timeout",

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

}

Создание претензии

Создаёт претензию с приложенными документами и публикует её от имени пользователя, которому принадлежит токен.

Набор обязательных документов зависит от типа претензии. Список обязательных документов для каждого типа Претензии определяется «Положением о Претензиях». Уровень созданной претензии система определяет сама по набору приложенных документов и возвращает в поле claim_level.

Создание претензии

post /gw/claims/integration/v1/claims/add

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

Параметры

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

Запрос

Модель

{...}

Тело запроса на добавление претензии для внешних интеграторов.

claim_type:{...}

DTO типа претензии

type_id: int32

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

user_type: enum

[0, 1, 2]

Тип, определяющий на кого выставлена претензия

0 = None
1 = Customer (Претензия как к заказчику)
2 = Executor (Претензии как к исполнителю)

}

owner_firm:{...}

Фирма истец

inn: null,string

ИНН фирмы истца

}

currency_id: int32

ID валюты выставляемой претензии

total_sum: double

Сумма разногласий

fail_to_pay_date: date-time

Дата наступления просрочки

substantiation: null,string

Обоснование суммы претензии

defendant_firm:{...}

Фирма ответчик

ati_id: null,string

ATI ID фирмы ответчика

inn: null,string

ИНН фирмы ответчика

city_name: null,string

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

ownership_id: int32

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

firm_name: null,string

Наименование фирмы ответчика

}

document_files:[{...}]

Прикрепленные документы претензии

file_key*: string

Минимальное количество символов: 1

Ключ загруженного файла

}]

}

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

CURL
1C

curl 'https://api.ati.su/gw/claims/integration/v1/claims/add' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"claim_type":{"claim_type":{"type_id":0,"user_type":0},"owner_firm":{"inn":"string"},"currency_id":0,"total_sum":0,"fail_to_pay_date":"1970-01-01T00:00:00Z","substantiation":"string","defendant_firm":{"ati_id":"string","inn":"string","city_name":"string","ownership_id":0,"firm_name":"string"},"document_files":[{"file_key":"string"}]},"owner_firm":{"claim_type":{"type_id":0,"user_type":0},"owner_firm":{"inn":"string"},"currency_id":0,"total_sum":0,"fail_to_pay_date":"1970-01-01T00:00:00Z","substantiation":"string","defendant_firm":{"ati_id":"string","inn":"string","city_name":"string","ownership_id":0,"firm_name":"string"},"document_files":[{"file_key":"string"}]},"currency_id":{"claim_type":{"type_id":0,"user_type":0},"owner_firm":{"inn":"string"},"currency_id":0,"total_sum":0,"fail_to_pay_date":"1970-01-01T00:00:00Z","substantiation":"string","defendant_firm":{"ati_id":"string","inn":"string","city_name":"string","ownership_id":0,"firm_name":"string"},"document_files":[{"file_key":"string"}]},"total_sum":{"claim_type":{"type_id":0,"user_type":0},"owner_firm":{"inn":"string"},"currency_id":0,"total_sum":0,"fail_to_pay_date":"1970-01-01T00:00:00Z","substantiation":"string","defendant_firm":{"ati_id":"string","inn":"string","city_name":"string","ownership_id":0,"firm_name":"string"},"document_files":[{"file_key":"string"}]},"fail_to_pay_date":{"claim_type":{"type_id":0,"user_type":0},"owner_firm":{"inn":"string"},"currency_id":0,"total_sum":0,"fail_to_pay_date":"1970-01-01T00:00:00Z","substantiation":"string","defendant_firm":{"ati_id":"string","inn":"string","city_name":"string","ownership_id":0,"firm_name":"string"},"document_files":[{"file_key":"string"}]},"substantiation":{"claim_type":{"type_id":0,"user_type":0},"owner_firm":{"inn":"string"},"currency_id":0,"total_sum":0,"fail_to_pay_date":"1970-01-01T00:00:00Z","substantiation":"string","defendant_firm":{"ati_id":"string","inn":"string","city_name":"string","ownership_id":0,"firm_name":"string"},"document_files":[{"file_key":"string"}]},"defendant_firm":{"claim_type":{"type_id":0,"user_type":0},"owner_firm":{"inn":"string"},"currency_id":0,"total_sum":0,"fail_to_pay_date":"1970-01-01T00:00:00Z","substantiation":"string","defendant_firm":{"ati_id":"string","inn":"string","city_name":"string","ownership_id":0,"firm_name":"string"},"document_files":[{"file_key":"string"}]},"document_files":[{"file_key":"string"}]}'

Процедура Выполнить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Запрос("POST", "https://api.ati.su", "/gw/claims/integration/v1/claims/add", "{""claim_type"":{""claim_type"":{""type_id"":0,""user_type"":0},""owner_firm"":{""inn"":""string""},""currency_id"":0,""total_sum"":0,""fail_to_pay_date"":""1970-01-01T00:00:00Z"",""substantiation"":""string"",""defendant_firm"":{""ati_id"":""string"",""inn"":""string"",""city_name"":""string"",""ownership_id"":0,""firm_name"":""string""},""document_files"":[{""file_key"":""string""}]},""owner_firm"":{""claim_type"":{""type_id"":0,""user_type"":0},""owner_firm"":{""inn"":""string""},""currency_id"":0,""total_sum"":0,""fail_to_pay_date"":""1970-01-01T00:00:00Z"",""substantiation"":""string"",""defendant_firm"":{""ati_id"":""string"",""inn"":""string"",""city_name"":""string"",""ownership_id"":0,""firm_name"":""string""},""document_files"":[{""file_key"":""string""}]},""currency_id"":{""claim_type"":{""type_id"":0,""user_type"":0},""owner_firm"":{""inn"":""string""},""currency_id"":0,""total_sum"":0,""fail_to_pay_date"":""1970-01-01T00:00:00Z"",""substantiation"":""string"",""defendant_firm"":{""ati_id"":""string"",""inn"":""string"",""city_name"":""string"",""ownership_id"":0,""firm_name"":""string""},""document_files"":[{""file_key"":""string""}]},""total_sum"":{""claim_type"":{""type_id"":0,""user_type"":0},""owner_firm"":{""inn"":""string""},""currency_id"":0,""total_sum"":0,""fail_to_pay_date"":""1970-01-01T00:00:00Z"",""substantiation"":""string"",""defendant_firm"":{""ati_id"":""string"",""inn"":""string"",""city_name"":""string"",""ownership_id"":0,""firm_name"":""string""},""document_files"":[{""file_key"":""string""}]},""fail_to_pay_date"":{""claim_type"":{""type_id"":0,""user_type"":0},""owner_firm"":{""inn"":""string""},""currency_id"":0,""total_sum"":0,""fail_to_pay_date"":""1970-01-01T00:00:00Z"",""substantiation"":""string"",""defendant_firm"":{""ati_id"":""string"",""inn"":""string"",""city_name"":""string"",""ownership_id"":0,""firm_name"":""string""},""document_files"":[{""file_key"":""string""}]},""substantiation"":{""claim_type"":{""type_id"":0,""user_type"":0},""owner_firm"":{""inn"":""string""},""currency_id"":0,""total_sum"":0,""fail_to_pay_date"":""1970-01-01T00:00:00Z"",""substantiation"":""string"",""defendant_firm"":{""ati_id"":""string"",""inn"":""string"",""city_name"":""string"",""ownership_id"":0,""firm_name"":""string""},""document_files"":[{""file_key"":""string""}]},""defendant_firm"":{""claim_type"":{""type_id"":0,""user_type"":0},""owner_firm"":{""inn"":""string""},""currency_id"":0,""total_sum"":0,""fail_to_pay_date"":""1970-01-01T00:00:00Z"",""substantiation"":""string"",""defendant_firm"":{""ati_id"":""string"",""inn"":""string"",""city_name"":""string"",""ownership_id"":0,""firm_name"":""string""},""document_files"":[{""file_key"":""string""}]},""document_files"":[{""file_key"":""string""}]}");

Ответ

200 OK

Модель

{...}

Плоский результат добавления претензии для внешних интеграторов (все поля на одном уровне, без наследования).

id: uuid

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

claim_level: enum

[0, 1]

Уровень Претензии

0 = ClaimLite (Претензия-Лайт)
1 = Claim (Претензия-Про)

}

Пример

{...}

"id":"00000000-0000-0000-0000-000000000000",

"claim_level":0

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"invalid_input_data",

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

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"un_authorized",

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

}

402 Метод доступен только платным пользователям.

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"payment_required",

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

}

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

Модель

{...}

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

error: null,string

Код ошибки

reason: null,string

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

}

Пример

{...}

"error":"timeout",

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

}