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

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

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

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

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

post

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

parentDocumentId

string

Id документа

CURL

Копировать

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

Ответ

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

Развернуть все Свернуть все

Пример

Модель

{...}

"document_id":"string",

"url":"string"

}

{...}

document_id: string

ID документа

url: string

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

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

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

post

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

parentDocumentId

string

Id документа

CURL

Копировать

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

Ответ

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

Развернуть все Свернуть все

Пример

Модель

{...}

"document_id":"string",

"url":"string"

}

{...}

document_id: string

ID документа

url: string

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

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

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

post

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

parentDocumentId

string

Id документа

CURL

Копировать

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

Ответ

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

Развернуть все Свернуть все

Пример

Модель

{...}

"document_id":"string",

"url":"string"

}

{...}

document_id: string

ID документа

url: string

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

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

put

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

documentId

guid

Id документа

Развернуть все Свернуть все

body

object

Настройка доступа

{...}

access: enum

[0, 1]

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

timeslots_warehouse_ids: [int32]

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

}

CURL

Копировать

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

Ответ

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

Развернуть все Свернуть все

Пример

Модель

"binary"

binary

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...