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

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

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

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

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

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

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

Параметры

Параметр	Тип	Расположение	Описание
parentDocumentId обязательный	string	path	Id документа Пример: 2fb965f2-85e9-4213-90e7-f396e47219e7

Запрос

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

CURL

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

Ответ

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

Модель

{...}

Краткие сведения о документе

document_id: string

ID документа

url: string

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

}

Пример

{...}

"document_id":"2fb965f2-85e9-4213-90e7-f396e47219e7",

"url":"https://docs.ati.su/example"

}

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

Модель

ONE-OF

(nullable)

1:{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"Неизвестная ошибка",

"error":"unknown_server_error"

}

Консоль

Отправить

Параметры

parentDocumentId Id документа

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

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

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

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

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

Параметры

Параметр	Тип	Расположение	Описание
parentDocumentId обязательный	string	path	Id документа Пример: 2fb965f2-85e9-4213-90e7-f396e47219e7

Запрос

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

CURL

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

Ответ

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

Модель

{...}

Краткие сведения о документе

document_id: string

ID документа

url: string

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

}

Пример

{...}

"document_id":"2fb965f2-85e9-4213-90e7-f396e47219e7",

"url":"https://docs.ati.su/example"

}

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

Модель

ONE-OF

(nullable)

1:{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"Неизвестная ошибка",

"error":"unknown_server_error"

}

Консоль

Отправить

Параметры

parentDocumentId Id документа

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

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

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

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

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

Параметры

Параметр	Тип	Расположение	Описание
parentDocumentId обязательный	string	path	Id документа Пример: 2fb965f2-85e9-4213-90e7-f396e47219e7

Запрос

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

CURL

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

Ответ

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

Модель

{...}

Краткие сведения о документе

document_id: string

ID документа

url: string

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

}

Пример

{...}

"document_id":"2fb965f2-85e9-4213-90e7-f396e47219e7",

"url":"https://docs.ati.su/example"

}

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

Модель

ONE-OF

(nullable)

1:{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"Неизвестная ошибка",

"error":"unknown_server_error"

}

Консоль

Отправить

Параметры

parentDocumentId Id документа

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

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

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

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

Параметры

Параметр	Тип	Расположение	Описание
documentId обязательный	string (guid)	path	Id документа Пример: 2fb965f2-85e9-4213-90e7-f396e47219e7

Запрос

Модель

ONE-OF

(nullable)

1:{...}

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

access:

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

* 0 — Обе стороны
* 1 — Водитель

ONE-OF

enum

[0, 1]

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

• 0 — Обе стороны
• 1 — Водитель

timeslots_warehouse_ids: [int32]

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

}

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

CURL

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]}'

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Запрос("PUT", "https://api.ati.su", "/v1.2/orders/docs/{documentId}/access", "{""access"":0,""timeslots_warehouse_ids"":[0]}");

Ответ

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

Успешный ответ

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

Модель

ONE-OF

(nullable)

1:{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"Неизвестная ошибка",

"error":"unknown_server_error"

}

Консоль

Отправить

Параметры

documentId Id документа

{ "access": 0, "timeslots_warehouse_ids": [ 0 ] }