Документы в заказах

Методы для работы с документами

Создание счета

Позволяет перевозчику и грузовладельцу создать счет для Заказа, оформленного через систему АТИ-Доки, для сделки в статусах: исполнение, документы и оплата, в архиве

Создание счета

post /v1.2/orders/documents/{parentDocumentId}/invoice

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

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1.2/orders/documents/{parentDocumentId}/invoice' \
  -X 'POST' \
  -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Запрос("POST", "https://api.ati.su", "/v1.2/orders/documents/{parentDocumentId}/invoice");

Ответ

200 Возвращает информацию по счету

Модель

{...}

document_id: string

ID документа

url: string

Адрес просмотра договора

}

Пример

{...}

"document_id":"string",

"url":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Создание акта

Позволяет перевозчику и грузовладельцу создать двухсторонний акт для Заказа, оформленного через систему АТИ-Доки, для сделки в статусах: исполнение, документы и оплата, в архиве

Создание акта

post /v1.2/orders/documents/{parentDocumentId}/act

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

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1.2/orders/documents/{parentDocumentId}/act' \
  -X 'POST' \
  -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Запрос("POST", "https://api.ati.su", "/v1.2/orders/documents/{parentDocumentId}/act");

Ответ

200 Возвращает информацию по акту

Модель

{...}

document_id: string

ID документа

url: string

Адрес просмотра договора

}

Пример

{...}

"document_id":"string",

"url":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Создание уведомления о расторжении

Позволяет перевозчику и грузовладельцу создать уведомление об отклонении Заказа, оформленного через систему АТИ-Доки, для сделки в исполнении

Создание уведомления о расторжении

post /v1.2/orders/documents/{parentDocumentId}/unilateral_dissolution

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

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1.2/orders/documents/{parentDocumentId}/unilateral_dissolution' \
  -X 'POST' \
  -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Запрос("POST", "https://api.ati.su", "/v1.2/orders/documents/{parentDocumentId}/unilateral_dissolution");

Ответ

200 Возвращает информацию по уведомлению

Модель

{...}

document_id: string

ID документа

url: string

Адрес просмотра договора

}

Пример

{...}

"document_id":"string",

"url":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Настройка доступа к документу заказа

put /v1.2/orders/docs/{documentId}/access

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

Запрос

Модель

{...}

access: enum

[0, 1]

Доступ к документу

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к документу

}

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

CURL
1C

curl 'https://api.ati.su/v1.2/orders/docs/{documentId}/access' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"access":0,"timeslots_warehouse_ids":[0]}'

Процедура Выполнить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Запрос("PUT", "https://api.ati.su", "/v1.2/orders/docs/{documentId}/access", "{""access"":0,""timeslots_warehouse_ids"":[0]}");

Ответ

200 Успешное изменение доступа

Модель

binary

Пример

"binary"

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}