АТИ-Доки

«АТИ-Доки» — сервис электронного документооборота.

Используя API можно:

отправлять документы контрагентам
получать доступ к отправленным документам, в том числе, прикрепленным к Заказам
менять статус документов
скачивать полученные документы

Возможности АТИ-Доков

С помощью API грузовладелец и перевозчик могут:

Создать и отправить разные типы документов
Подписать документы КЭП
Создать документы на перевозку, связанные с Заказами
Создать шаблоны документов
Одобрять и отклонять документы
Комментировать исходящие и входящие документы

Используемые термины

Отправитель - контакт фирмы, которая создала и отправила документ.

Получатель - контакт фирмы, которой пришел документ.

Список документов- список всех документов входящих и исходящих фирмы. По умолчанию документы из папок «Черновики», «Архив», и «Корзина» не возвращаются (для их получения нужно передать отдельные параметры).

Тип документа- тип документа, который указан при создании документа в поле doctype

Идентификатор документа- при создании документа ему назначается уникальный идентификатор id, который одинаков для отправителя и получателя и не изменяется при действиях над документом

Статус документа - текущее состояние документа: отправлен, подписан, ожидает решения, одобрен, отклонен, отозван. Обновляется, когда любая из сторон совершила какие-то действия над документом. Актуальный статус можно посмотреть в поле status

Документ, связанный с Заказом- создается из Заказа, имеет ссылку на заказ в поле link

Типичный сценарии использования АТИ-Доков

Получение списка документов
Создание документа
Отправка и подпись документа
Скачивание документа

Доступные через API этапы работы с АТИ-Доками:

Создание, отправка и подпись документов
Работа с полученными документами
Работа с папками
Групповые операции над документами

API для работы с АТИ-Доками

Раздел находится в процессе доработки.
Данное API скоро будет обновлено. Появятся новые методы для работы с документами в системе электронного документооборота. Следите за обновлениями, чтобы избежать сбоев в работе. Информация об обновлениях в нашем телеграм канале.

Методы для отправителя документа

Отправитель может создать, отправить и подписать разные типы документов.

Получение списка всех документов пользователя

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

Для версии 3.0: Необходимо указывать в теле запроса фильтры, например, по лимиту и/или нахождению документа в определенном разделе (например, во «Входящих»).

Список всех документов пользователя

Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.

get

/v1.0/atidocs/documents/

offset

integer

Сдвиг от начала списка документов в результате запроса

limit

integer

Количиество документов в возвращаемом списке документов

folder

string

Вернуть только документы из указанной папки

CURL

Копировать

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

Ответ

200 Список документов

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

Пример

Модель

{...}

"ok":false,

"result":{...}

"docs":[...],

{...}

"access_key":"string",

"body":null,

"can_be_approved":false,

"can_be_archived":false,

"can_be_commented":false,

"can_be_declined":false,

"can_be_deleted":false,

"can_be_edited":false,

"can_be_revoked":false,

"can_be_saved":false,

"can_be_sent":false,

"can_be_set_to_edition":false,

"can_be_signed":false,

"can_be_templated":false,

"can_be_unarchived":false,

"can_be_undeleted":false,

"child_doc":"string",

"comments":[...],

{}

"contract_date":"string",

"contract_number":"string",

"contragent":{...},

"account":{...},

"ati_code":"string",

"contacts":[...],

{...}

"fn":"string",

"name":"string"

}

"name":"string"

"contact":{...}

"ati_id":"string",

"company":"string",

"name":"string"

}

"created":"1970-01-01T00:00:00.000Z",

"date":"1970-01-01",

"decline_reason":"string",

"description":"string",

"direction":"inbox",

"doctype":"string",

"file":{...},

"checksum":null,

"id":null,

"mimetype":null,

"name":null,

"signs":null,

"size":null,

"timestamp":null,

"xml_template":null

"file_diff":null,

"fix_price":{...},

"id":"string",

"link":"string"

"from":"string",

"has_attachments":false,

"has_contragent":false,

"has_linked_documents":false,

"history":[...],

{...}

"change":"created",

"is_new":false,

"text":"string",

"timestamp":"1970-01-01T00:00:00.000Z"

}

"id":"ed33cf27775347838422ab930dba92e2",

"is_approved":false,

"is_archived":false,

"is_asked_resolution":false,

"is_blocked_by_revoke":false,

"is_cancelled":false,

"is_declined":false,

"is_declined_by_current_acc":false,

"is_deleted":false,

"is_draft":false,

"is_formal":false,

"is_locked_resolution":false,

"is_need_attention":false,

"is_new":false,

"is_new_edition":false,

"is_owner":false,

"is_revoked":false,

"is_revoked_by_current_acc":false,

"is_sent":false,

"is_signed":false,

"is_template":false,

"is_waiting":false,

"linked_documents":null,

"number":"string",

"receiver_inn":"string",

"sender_inn":"string",

"signers":"?",

"source_doc":"string",

"state":"draft",

"status":"string",

"template_name":"string",

"to":"string",

"updated":"1970-01-01T00:00:00.000Z",

"version":"1"

}

"num_found":{...}

"docs":[...],

{...}

"access_key":"",

"body":{},

"can_be_approved":false,

"can_be_archived":false,

"can_be_commented":true,

"can_be_declined":false,

"can_be_deleted":true,

"can_be_edited":true,

"can_be_invoiced":false,

"can_be_revoked":false,

"can_be_saved":true,

"can_be_sent":true,

"can_be_set_to_edition":false,

"can_be_signed":true,

"can_be_templated":true,

"can_be_unarchived":false,

"can_be_undeleted":false,

"child_doc":"",

"comments":[],

"contract_date":"",

"contract_number":"",

"contragent":{...},

"account":{...},

"ati_code":"000000",

"contacts":[...],

{...}

"name":"Имя контакта"

}

"fn":"Наименование фирмы, ООО",

"name":"Наименование фирмы"

"contact":{...}

"ati_id":0,

"company":"000000",

"name":"Имя контакта"

}

"created":"2018-05-15T11:30:07Z",

"date":"2018-07-03",

"decline_reason":"",

"description":"",

"direction":"outbox",

"doctype":"акт",

"file":{...},

"id":"1234567898765421",

"mimetype":"application/vnd.ati-docs.xml",

"name":"12345676543.xml",

"signs":{},

"size":12345,

"timestamp":"2018-06-01T13:16:35Z"

"file_diff":[],

"fix_price":{...},

"id":"",

"link":""

"from":0,

"has_attachments":false,

"has_contragent":false,

"has_linked_documents":false,

"history":[...],

{...}

"change":"created",

"is_new":false,

"seen":[],

"text":"Создан",

"timestamp":"2018-05-23T13:22:38Z",

"user":{...}

"fn":"Имя контакта",

"id":0

}

"id":"123445678987655",

"is_approved":false,

"is_archived":false,

"is_asked_resolution":false,

"is_blocked_by_revoke":false,

"is_cancelled":false,

"is_declined":false,

"is_declined_by_current_acc":false,

"is_deleted":false,

"is_draft":true,

"is_formal":false,

"is_locked_resolution":false,

"is_need_attention":false,

"is_new":false,

"is_new_edition":false,

"is_owner":true,

"is_revoked":false,

"is_revoked_by_current_acc":false,

"is_sent":false,

"is_signed":false,

"is_template":false,

"is_waiting":false,

"linked_documents":[],

"number":"",

"receiver_inn":"",

"sender_inn":"",

"signers":[],

"source_doc":"",

"state":"draft",

"status":"Черновик",

"template_name":"",

"to":"",

"updated":"2018-06-01T10:34:35Z",

"version":"1"

}

"num_found":1

}

{...}

ok: enum

[true]

result:{...}

docs:[{...}]

Объект, с метаданными документа и его состоянием

access_key: string

Ключ для доступа по ссылке третьим лицам

body: {missing-type-info}

can_be_approved: boolean

Может ли документ быть одобренным пользователем

can_be_archived: boolean

Можно ли документ переместить в архив

can_be_commented: boolean

Можно ли добавить комментарий к документу

can_be_declined: boolean

Можно ли отклонить документ

can_be_deleted: boolean

Можно ли переместить документ в корзину

can_be_edited: boolean

Можно ли отредактировать документ

can_be_revoked: boolean

Можно ли отозвать документ

can_be_saved: boolean

Можно ли сохранить документ

can_be_sent: boolean

Можно ли отправить документ

can_be_set_to_edition: boolean

Можно ли создать новую редакцию

can_be_signed: boolean

Можно ли подписать документ

can_be_templated: boolean

Можно ли создать шаблон из этого документа

can_be_unarchived: boolean

Можно ли восстановить документ из архива

can_be_undeleted: boolean

Можно ли восстановить документ из корзины

child_doc: string

Идентификатор документа, являющегося новой редакцией подписанного документа

comments:[{}]

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

contract_date: string

Дата договора

contract_number: string

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

contragent:{...}

Контрагент по документу (может быть как получателем, так и отправителем документа)

account:{...}

Информация о фирме

ati_code: string

Код фирмы в АТИ

contacts:[{...}]

Контакты фирмы

fn: string

}]

Наименование фирмы

}

contact:{...}

Информация о пользователе (контакте)

ati_id: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

company: string

Код фирмы в АТИ

Имя контакта

}

created: date-time

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

date: date

Дата документа в формате ГГГГ-ММ-ДД

decline_reason: string

Причина отклонения документа

description: string

Описание документа (для документов, создаваемых из файла)

direction: enum

[inbox, outbox]

"Направление" документа, inbox - для входящих, outbox - для отправленных

doctype: string

Тип документа

file:{...}

Информация о файле документа

checksum: {missing-type-info}

id: {missing-type-info}

mimetype: {missing-type-info}

signs: {missing-type-info}

size: {missing-type-info}

timestamp: {missing-type-info}

xml_template: {missing-type-info}

}

file_diff: {missing-type-info}

fix_price:{...}

Связанный с документов заказ на перевозку

id: string

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

link: string

Ссылка на страницу с заказом в АТИ

}

from: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

has_attachments: boolean

Есть ли документа вложения для скачивания

has_contragent: boolean

"Указан ли контрагент для документа (т. е. true для отправленных)"

has_linked_documents: boolean

Есть ли связанные с этим документом связанные

history:[{...}]

"История изменений документа"

change: enum

[created, sent, waiting, opened, approved, declined, signed, archived, deleted]

Тип события. Возможные варианты:

created - создан;
sent - отправлен;
waiting- помечен как ожидающий решения;
opened - просмотрен другой стороной;
approved - одобрен;
declined - отклонен;
signed - подписан;
archived - помещен в папку «Архив»;
deleted - помещен в папку «Корзина».

is_new: boolean

Просмотрена ли эта запись в истории

text: string

Текстовое описание изменений

timestamp: date-time

Метка времени в формате ГГГГ-ММ-ДДTЧЧ:ММ:ССZ

}]

id: string

Идентификатор документа

is_approved: boolean

Документ одобрен

is_archived: boolean

Документ в папке Архив

is_asked_resolution: boolean

По документу запрошено решение

is_blocked_by_revoke: boolean

is_cancelled: boolean

Документ отменен

is_declined: boolean

Документ отклонен

is_declined_by_current_acc: boolean

Документ отклонен текущим пользователем

is_deleted: boolean

Документ в папке Корзина

is_draft: boolean

Документ в папке Черновики

is_formal: boolean

Документ форрмализованный

is_locked_resolution: boolean

is_need_attention: boolean

Документ требует внимания

is_new: boolean

Документ еще не был просмотрен

is_new_edition: boolean

Новая редакция документа

is_owner: boolean

Текущий пользователь - владелец документа

is_revoked: boolean

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

is_revoked_by_current_acc: boolean

Документ отозван текущим пользователем

is_sent: boolean

Документ отправлен

is_signed: boolean

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

is_template: boolean

Документ сохранен как шаблон

is_waiting: boolean

Документ ожидает решения

linked_documents: {missing-type-info}

number: string

Номер документа

receiver_inn: string

ИНН получателя

sender_inn: string

ИНН отправителя

signers: {missing-type-info}

Контакты, которые подписали докумемнт

source_doc: string

Идентификатор документа, из которого создан текущий

state: enum

[draft, created, sent, unread, opened, waiting, approved, declined, signed, archived, deleted, revoked, template, changed, cancelled]

Текущее состояние документооборота

status: string

Текстовое описание состояния документооборота

template_name: string

Шаблон, из которого был создан документ или его тип

to: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

updated: date-time

Дата обновления документа

version: enum

[1]

Версия формата

}]

num_found: integer

Общее количество найденных по запросу документов

}

401 Ошибка авторизации

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

Пример

Модель

{...}

"error":"invalid_request",

"error_description":"The access token is missing"

}

{...}

Ошибка авторизации

error: string

Код ошибки

error_description: string

Описание

}

Загрузка...

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

Загрузка...

Поиск по документам

post

/gw/tokugawa/v1/common_api/documents/search

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

body

{...}

limit: integer

>=1 and <= 100

updated_at__lt: date-time

filters:{...}

query: string

type: enum

[СЧФ, СЧФДОППродавец, СЧФДОППокупатель, ДОППродавец, ДОППокупатель, КорСЧФ, КорСЧФДИСПродавец, КорСЧФДИСПокупатель, КорДИСПродавец, КорДИСПокупатель, ИзвещениеОПолучении, ПодтверждениеОператораОбОтправке, ПодтверждениеОператораОПолучении, УведомлениеОбУточнении, ЗапросНаАннулирование, заказ, заявка (к договору), заявка, поручение экспедитору, договор, акт, заказ услуги по оформлению пропусков в г. москва, договор-заявка, заказ (договор-заявка), заказ (табличный вид), заявка к договору (табличный вид), счет, счет-фактура, УПД (счет-фактура), уведомление об отказе от исполнения, уведомление о расторжении в двустороннем порядке, акт о срыве, уведомление о составлении акта о непредъявлении груза для перевозки, уведомление о составлении акта о непредъявлении транспортного средства под погрузку, доверенность, информационное письмо, другой, акт сверки, доп. соглашение (к договору), накладная, товарная накладная, транспортная накладная, товарно-транспортная накладная, поздравительная открытка, unknown]

An enumeration.

status: enum

[AWAITING_CONFIRMATION_SIGN, WAITING_FOR_REVOKE, CORRECTION_REQUESTED, AWAITING_DECISION, REVOKED, EDO_DONE, APPROVED, DECLINED, SIGNED, NEW_EDITION, CANCELLED, DRAFT]

An enumeration.

contragent_ati_code: string

edo_user: string

ID участника ЭДО(текущего пользователя)

number: string

Номер документа

date_from: date

date_to: date

direction: enum

[incoming, outgoing]

An enumeration.

is_deleted: boolean

is_archived: boolean

is_template: boolean

}

CURL

Копировать

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

Ответ

200 Successful Response

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

Пример

Модель

{...}

"total":0,

"total_remaining":0,

"result":[...]

{...}

"id":"string",

"is_riak":false,

"direction":"incoming",

"number":"string",

"date":"1970-01-01",

"type":"УПД. Счет-фактура",

"status":"string",

"is_read":false,

"updated_at":"1970-01-01T00:00:00.000Z",

"contragent":{...},

"ati_code":"string",

"name":"string"

"comments":{...},

"count":0,

"tail":{...}

"name":"string",

"text":"string",

"timestamp":"1970-01-01T00:00:00.000Z"

}

"flags":[...],

"string"

"highlight":"failure",

"signs":{...},

"user":{...},

"title":"string",

"valid_from":"string",

"valid_until":"string"

"contragent":{...}

"title":"string",

"valid_from":"string",

"valid_until":"string"

}

"template_name":"string"

}

]

}

{...}

total*: integer

total_remaining*: integer

result*:[{...}]

id*: string

is_riak: boolean

direction*: enum

[incoming, outgoing]

An enumeration.

number: string

date: date

type*: enum

[УПД. Счет-фактура, УПД. Счет-фактура и акт, УПД. Акт, УКД. Корректировочный счет-фактура, УКД. Корректировочный счет-фактура и акт, УКД. Корректировочный акт, заказ, заявка (к договору), заявка, поручение экспедитору, договор, акт, заказ услуги по оформлению пропусков в г. москва, договор-заявка, заказ (договор-заявка), заказ (табличный вид), заявка к договору (табличный вид), счет, счет-фактура, УПД (счет-фактура), уведомление об отказе от исполнения, уведомление о расторжении в двустороннем порядке, акт о срыве, уведомление о составлении акта о непредъявлении груза для перевозки, уведомление о составлении акта о непредъявлении транспортного средства под погрузку, доверенность, информационное письмо, другой, акт сверки, доп. соглашение (к договору), накладная, товарная накладная, транспортная накладная, товарно-транспортная накладная, поздравительная открытка, unknown]

An enumeration.

status*: string

is_read*: boolean

updated_at*: date-time

contragent:{...}

ati_code*: string

name*: string

}

comments*:{...}

count*: integer

tail:{...}

name*: string

text*: string

timestamp*: date-time

}

flags*: [string]

highlight: enum

[failure, success, ]

An enumeration.

signs*:{...}

user:{...}

title*: string

valid_from*: string

valid_until*: string

}

contragent:{...}

title*: string

valid_from*: string

valid_until*: string

}

template_name: string

}]

}

422 Validation Error

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

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

msg*: string

type*: string

}]

}

Загрузка...

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

Загрузка...

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

Позволяет создать черновик документа или сохранить документ. При создании документа можно сразу указать получателя

Создание и/или сохранение документа

post

/v1.0/atidocs/documents/

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

body

object

{...}

Данные для создания документа

date: date

Дата документа

doc_recipient_contact: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

doc_request: boolean

Флаг запроса решения для документа. Если это поле не передается, то для новых документов запрос решения остается без изменений. Если это передается, то в документе для флага будет использовано переданное значение.

doc_sender_contact: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

doctype: string

Тип документа

id: string

Идентификатор документа

number: string

Номер документа

xmlBody: string

Тело документа в формате xml, в виде строки

}

doc_sender_contact

string

number

string

xmlBody

string

doc_request

boolean

doctype

string

doc_recipient_contact

string

date

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

Загрузка...

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

Загрузка...

Прикрепление вложения к документу

Позволяет прикрепить вложение к уже созданному документу.

Прикрепление вложения к документу

post

/v1.0/atidocs/documents/{doc_id}/attachments/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка загрузки файла.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Сохранить вложение

post

/gw/atidocs/api/2.0/documents/{doc_id}/attachments/

doc_id

string

id документа

file_upload

binary

CURL

Копировать

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

Ответ

200 Данные получены

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

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: boolean

result: string

id документа

}

404 Документ не найден

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

Пример

Модель

{...}

"error":"not_found",

"reason":"Объект не найден"

}

{...}

error: string

reason: string

}

Загрузка...

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

Загрузка...

Отправка документа

Предполагается, что документ уже сохранен и имеет приложенное вложение.

Отправка документа

put

/v1.0/atidocs/documents/{doc_id}/send/

doc_id

string

Идентификатор документа

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

body

object

{...}

doc_recipient_contact: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

doc_recipient_id: string

Код фирмы в АТИ

}

doc_recipient_id

string

doc_recipient_contact

string

CURL

Копировать

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

Ответ

200 Результат отправки документа

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка запроса, документ не может быть отправлен

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Отправить документ

put

/gw/atidocs/api/2.0/documents/{doc_id}/send/

doc_id

string

id документа

receiver

string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

CURL

Копировать

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

Ответ

200 Документ отправлен

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

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: boolean

result: string

id документа

}

400 Не найден аккаунт получателя

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

Пример

Модель

{...}

"error":"document_no_receiver",

"reason":"Не найден аккаунт получателя"

}

{...}

error: string

reason: string

}

404 Объект не найден

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

Пример

Модель

{...}

"error":"not_found",

"reason":"Документ не найден"

}

{...}

error: string

reason: string

}

Загрузка...

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

Загрузка...

Экспорт документа для подписи

Перед тем как подписать документ, необходимо произвести его экспорт.

Экспорт документа для подписи

get

/v1.0/atidocs/documents/{doc_id}/export/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"TG9yZW0gaW1wc3VtIGRvbG9yIHNpdCBhbWV0Lg=="

}

{...}

ok: enum

[true]

result: string

Документ в виде base64-закодированной строки для подписи

}

400 Ошибка при экспорте документа.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Экспорт документа для подписи

post

/gw/atidocs/api/2.0/documents/{doc_id}/export/

doc_id

string

id документа

CURL

Копировать

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

Ответ

200 Документ экспортирован

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

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: boolean

result: string

id документа

}

404 Документ не найден

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

Пример

Модель

{...}

"error":true,

"reason":"Документ не найден"

}

{...}

error: boolean

reason: string

}

Загрузка...

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

Загрузка...

Подпись документа

Для подписания документа следует использовать строку, которую вернул метод экспорта документа. При подписании сервер выполняет проверку подписи: сертификат клиента должен быть выдан доверенным УЦ.

Если документ требовал решения, то документ автоматически одобряется.

Подписание документа

put

/v1.0/atidocs/documents/{doc_id}/sign/

doc_id

string

Идентификатор документа

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

body

object

Объект с подписью документа в виде строки, кодированной в base64.

{...}

sign: string

Подпись документа в виде base64-строки

}

sign

string

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка при подписании документа.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Добавление комментария к документу

Позволяет загрузить как текст, так и файл. Обязательное условие: текст/файл должен пересылаться как «multipart/form-data». При загрузке файлов применяются общие ограничения по типу поддерживаемых файлов. Размер файла не должен превышать 10 Мб.

Добавление комментария к документу

post

/v1.0/atidocs/documents/{doc_id}/comments/

doc_id

string

Идентификатор документа

comment-text

string

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка добавления комментария.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Оставить комментарий к документу

post

/gw/atidocs/api/2.0/documents/{doc_id}/comments/

doc_id

string

id документа

comment-text

string

CURL

Копировать

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

Ответ

200 Список комментариев

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

Пример

Модель

{...}

"timestamp":"2020-02-26T15:24:00.000Z",

"text":"string",

"has_attachments":false,

"attachment":{...},

"id":"95a971edb0994372aa6b76a9e1be8bdb",

"size":429939,

"name":"Книга новичка АТИ.pdf",

"mimetype":"application/pdf"

"user":{...}

"id":"765044.0",

"fn":"wefwef_1!"

}

{...}

timestamp: string

text: string

Текст сообщения

has_attachments: boolean

attachment:{...}

Данные вложения

id: string

size: integer

Размер файла

Название файла

mimetype: string

}

user:{...}

Данные пользователя

id: string

ati id

fn: string

Имя юзера

}

400 Ошибка запроса

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Нельзя отправить пустой комментарий"

}

{...}

error: string

reason: string

}

404 Объект не найден

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

not_found

reason: string

Документ не найден

}

Загрузка...

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

Загрузка...

Отзыв документа

После отзыва документ «пропадает» у получателя и переносится в папку «Черновики». Отозвать можно только отправленный документ.

Отозвать документ

put

/v1.0/atidocs/documents/{doc_id}/revoke/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка запроса, документ не может быть отклонен.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Отозвать отправленный документ и сделать его черновиком

put

/gw/atidocs/api/2.0/documents/{doc_id}/revoke/

doc_id

string

id документа

CURL

Копировать

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

Ответ

200 Документ отозван

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

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: boolean

result: string

id документа

}

400 Не указана причина отзыва документа

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

Пример

Модель

{...}

"error":true,

"reason":"Не указана причина отзыва документа"

}

{...}

error: boolean

reason: string

}

404 Документ не найден

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

Пример

Модель

{...}

"error":true,

"reason":"Документ не найден"

}

{...}

error: boolean

reason: string

}

Загрузка...

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

Загрузка...

Методы для получателя документа

При получении документа получатель может принять решение по документу, оставить комментарии, скачать, распечатать документ.

Получение списка всех документов пользователя

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

Список всех документов пользователя

get

/v1.0/atidocs/documents/

offset

integer

Сдвиг от начала списка документов в результате запроса

limit

integer

Количиество документов в возвращаемом списке документов

folder

string

Вернуть только документы из указанной папки

CURL

Копировать

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

Ответ

200 Список документов

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

Пример

Модель

{...}

"ok":false,

"result":{...}

"docs":[...],

{...}

"access_key":"string",

"body":null,

"can_be_approved":false,

"can_be_archived":false,

"can_be_commented":false,

"can_be_declined":false,

"can_be_deleted":false,

"can_be_edited":false,

"can_be_revoked":false,

"can_be_saved":false,

"can_be_sent":false,

"can_be_set_to_edition":false,

"can_be_signed":false,

"can_be_templated":false,

"can_be_unarchived":false,

"can_be_undeleted":false,

"child_doc":"string",

"comments":[...],

{}

"contract_date":"string",

"contract_number":"string",

"contragent":{...},

"account":{...},

"ati_code":"string",

"contacts":[...],

{...}

"fn":"string",

"name":"string"

}

"name":"string"

"contact":{...}

"ati_id":"string",

"company":"string",

"name":"string"

}

"created":"1970-01-01T00:00:00.000Z",

"date":"1970-01-01",

"decline_reason":"string",

"description":"string",

"direction":"inbox",

"doctype":"string",

"file":{...},

"checksum":null,

"id":null,

"mimetype":null,

"name":null,

"signs":null,

"size":null,

"timestamp":null,

"xml_template":null

"file_diff":null,

"fix_price":{...},

"id":"string",

"link":"string"

"from":"string",

"has_attachments":false,

"has_contragent":false,

"has_linked_documents":false,

"history":[...],

{...}

"change":"created",

"is_new":false,

"text":"string",

"timestamp":"1970-01-01T00:00:00.000Z"

}

"id":"ed33cf27775347838422ab930dba92e2",

"is_approved":false,

"is_archived":false,

"is_asked_resolution":false,

"is_blocked_by_revoke":false,

"is_cancelled":false,

"is_declined":false,

"is_declined_by_current_acc":false,

"is_deleted":false,

"is_draft":false,

"is_formal":false,

"is_locked_resolution":false,

"is_need_attention":false,

"is_new":false,

"is_new_edition":false,

"is_owner":false,

"is_revoked":false,

"is_revoked_by_current_acc":false,

"is_sent":false,

"is_signed":false,

"is_template":false,

"is_waiting":false,

"linked_documents":null,

"number":"string",

"receiver_inn":"string",

"sender_inn":"string",

"signers":"?",

"source_doc":"string",

"state":"draft",

"status":"string",

"template_name":"string",

"to":"string",

"updated":"1970-01-01T00:00:00.000Z",

"version":"1"

}

"num_found":{...}

"docs":[...],

{...}

"access_key":"",

"body":{},

"can_be_approved":false,

"can_be_archived":false,

"can_be_commented":true,

"can_be_declined":false,

"can_be_deleted":true,

"can_be_edited":true,

"can_be_invoiced":false,

"can_be_revoked":false,

"can_be_saved":true,

"can_be_sent":true,

"can_be_set_to_edition":false,

"can_be_signed":true,

"can_be_templated":true,

"can_be_unarchived":false,

"can_be_undeleted":false,

"child_doc":"",

"comments":[],

"contract_date":"",

"contract_number":"",

"contragent":{...},

"account":{...},

"ati_code":"000000",

"contacts":[...],

{...}

"name":"Имя контакта"

}

"fn":"Наименование фирмы, ООО",

"name":"Наименование фирмы"

"contact":{...}

"ati_id":0,

"company":"000000",

"name":"Имя контакта"

}

"created":"2018-05-15T11:30:07Z",

"date":"2018-07-03",

"decline_reason":"",

"description":"",

"direction":"outbox",

"doctype":"акт",

"file":{...},

"id":"1234567898765421",

"mimetype":"application/vnd.ati-docs.xml",

"name":"12345676543.xml",

"signs":{},

"size":12345,

"timestamp":"2018-06-01T13:16:35Z"

"file_diff":[],

"fix_price":{...},

"id":"",

"link":""

"from":0,

"has_attachments":false,

"has_contragent":false,

"has_linked_documents":false,

"history":[...],

{...}

"change":"created",

"is_new":false,

"seen":[],

"text":"Создан",

"timestamp":"2018-05-23T13:22:38Z",

"user":{...}

"fn":"Имя контакта",

"id":0

}

"id":"123445678987655",

"is_approved":false,

"is_archived":false,

"is_asked_resolution":false,

"is_blocked_by_revoke":false,

"is_cancelled":false,

"is_declined":false,

"is_declined_by_current_acc":false,

"is_deleted":false,

"is_draft":true,

"is_formal":false,

"is_locked_resolution":false,

"is_need_attention":false,

"is_new":false,

"is_new_edition":false,

"is_owner":true,

"is_revoked":false,

"is_revoked_by_current_acc":false,

"is_sent":false,

"is_signed":false,

"is_template":false,

"is_waiting":false,

"linked_documents":[],

"number":"",

"receiver_inn":"",

"sender_inn":"",

"signers":[],

"source_doc":"",

"state":"draft",

"status":"Черновик",

"template_name":"",

"to":"",

"updated":"2018-06-01T10:34:35Z",

"version":"1"

}

"num_found":1

}

{...}

ok: enum

[true]

result:{...}

docs:[{...}]

Объект, с метаданными документа и его состоянием

access_key: string

Ключ для доступа по ссылке третьим лицам

body: {missing-type-info}

can_be_approved: boolean

Может ли документ быть одобренным пользователем

can_be_archived: boolean

Можно ли документ переместить в архив

can_be_commented: boolean

Можно ли добавить комментарий к документу

can_be_declined: boolean

Можно ли отклонить документ

can_be_deleted: boolean

Можно ли переместить документ в корзину

can_be_edited: boolean

Можно ли отредактировать документ

can_be_revoked: boolean

Можно ли отозвать документ

can_be_saved: boolean

Можно ли сохранить документ

can_be_sent: boolean

Можно ли отправить документ

can_be_set_to_edition: boolean

Можно ли создать новую редакцию

can_be_signed: boolean

Можно ли подписать документ

can_be_templated: boolean

Можно ли создать шаблон из этого документа

can_be_unarchived: boolean

Можно ли восстановить документ из архива

can_be_undeleted: boolean

Можно ли восстановить документ из корзины

child_doc: string

Идентификатор документа, являющегося новой редакцией подписанного документа

comments:[{}]

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

contract_date: string

Дата договора

contract_number: string

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

contragent:{...}

Контрагент по документу (может быть как получателем, так и отправителем документа)

account:{...}

Информация о фирме

ati_code: string

Код фирмы в АТИ

contacts:[{...}]

Контакты фирмы

fn: string

}]

Наименование фирмы

}

contact:{...}

Информация о пользователе (контакте)

ati_id: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

company: string

Код фирмы в АТИ

Имя контакта

}

created: date-time

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

date: date

Дата документа в формате ГГГГ-ММ-ДД

decline_reason: string

Причина отклонения документа

description: string

Описание документа (для документов, создаваемых из файла)

direction: enum

[inbox, outbox]

"Направление" документа, inbox - для входящих, outbox - для отправленных

doctype: string

Тип документа

file:{...}

Информация о файле документа

checksum: {missing-type-info}

id: {missing-type-info}

mimetype: {missing-type-info}

signs: {missing-type-info}

size: {missing-type-info}

timestamp: {missing-type-info}

xml_template: {missing-type-info}

}

file_diff: {missing-type-info}

fix_price:{...}

Связанный с документов заказ на перевозку

id: string

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

link: string

Ссылка на страницу с заказом в АТИ

}

from: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

has_attachments: boolean

Есть ли документа вложения для скачивания

has_contragent: boolean

"Указан ли контрагент для документа (т. е. true для отправленных)"

has_linked_documents: boolean

Есть ли связанные с этим документом связанные

history:[{...}]

"История изменений документа"

change: enum

[created, sent, waiting, opened, approved, declined, signed, archived, deleted]

Тип события. Возможные варианты:

created - создан;
sent - отправлен;
waiting- помечен как ожидающий решения;
opened - просмотрен другой стороной;
approved - одобрен;
declined - отклонен;
signed - подписан;
archived - помещен в папку «Архив»;
deleted - помещен в папку «Корзина».

is_new: boolean

Просмотрена ли эта запись в истории

text: string

Текстовое описание изменений

timestamp: date-time

Метка времени в формате ГГГГ-ММ-ДДTЧЧ:ММ:ССZ

}]

id: string

Идентификатор документа

is_approved: boolean

Документ одобрен

is_archived: boolean

Документ в папке Архив

is_asked_resolution: boolean

По документу запрошено решение

is_blocked_by_revoke: boolean

is_cancelled: boolean

Документ отменен

is_declined: boolean

Документ отклонен

is_declined_by_current_acc: boolean

Документ отклонен текущим пользователем

is_deleted: boolean

Документ в папке Корзина

is_draft: boolean

Документ в папке Черновики

is_formal: boolean

Документ форрмализованный

is_locked_resolution: boolean

is_need_attention: boolean

Документ требует внимания

is_new: boolean

Документ еще не был просмотрен

is_new_edition: boolean

Новая редакция документа

is_owner: boolean

Текущий пользователь - владелец документа

is_revoked: boolean

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

is_revoked_by_current_acc: boolean

Документ отозван текущим пользователем

is_sent: boolean

Документ отправлен

is_signed: boolean

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

is_template: boolean

Документ сохранен как шаблон

is_waiting: boolean

Документ ожидает решения

linked_documents: {missing-type-info}

number: string

Номер документа

receiver_inn: string

ИНН получателя

sender_inn: string

ИНН отправителя

signers: {missing-type-info}

Контакты, которые подписали докумемнт

source_doc: string

Идентификатор документа, из которого создан текущий

state: enum

[draft, created, sent, unread, opened, waiting, approved, declined, signed, archived, deleted, revoked, template, changed, cancelled]

Текущее состояние документооборота

status: string

Текстовое описание состояния документооборота

template_name: string

Шаблон, из которого был создан документ или его тип

to: string

Код пользователя в АТИ в формате <код фирмы>.<id контакта>

updated: date-time

Дата обновления документа

version: enum

[1]

Версия формата

}]

num_found: integer

Общее количество найденных по запросу документов

}

401 Ошибка авторизации

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

Пример

Модель

{...}

"error":"invalid_request",

"error_description":"The access token is missing"

}

{...}

Ошибка авторизации

error: string

Код ошибки

error_description: string

Описание

}

Загрузка...

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

Загрузка...

Поиск по документам

post

/gw/tokugawa/v1/common_api/documents/search

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

body

{...}

limit: integer

>=1 and <= 100

updated_at__lt: date-time

filters:{...}

query: string

type: enum

An enumeration.

status: enum

[AWAITING_CONFIRMATION_SIGN, WAITING_FOR_REVOKE, CORRECTION_REQUESTED, AWAITING_DECISION, REVOKED, EDO_DONE, APPROVED, DECLINED, SIGNED, NEW_EDITION, CANCELLED, DRAFT]

An enumeration.

contragent_ati_code: string

edo_user: string

ID участника ЭДО(текущего пользователя)

number: string

Номер документа

date_from: date

date_to: date

direction: enum

[incoming, outgoing]

An enumeration.

is_deleted: boolean

is_archived: boolean

is_template: boolean

}

CURL

Копировать

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

Ответ

200 Successful Response

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

Пример

Модель

{...}

"total":0,

"total_remaining":0,

"result":[...]

{...}

"id":"string",

"is_riak":false,

"direction":"incoming",

"number":"string",

"date":"1970-01-01",

"type":"УПД. Счет-фактура",

"status":"string",

"is_read":false,

"updated_at":"1970-01-01T00:00:00.000Z",

"contragent":{...},

"ati_code":"string",

"name":"string"

"comments":{...},

"count":0,

"tail":{...}

"name":"string",

"text":"string",

"timestamp":"1970-01-01T00:00:00.000Z"

}

"flags":[...],

"string"

"highlight":"failure",

"signs":{...},

"user":{...},

"title":"string",

"valid_from":"string",

"valid_until":"string"

"contragent":{...}

"title":"string",

"valid_from":"string",

"valid_until":"string"

}

"template_name":"string"

}

]

}

{...}

total*: integer

total_remaining*: integer

result*:[{...}]

id*: string

is_riak: boolean

direction*: enum

[incoming, outgoing]

An enumeration.

number: string

date: date

type*: enum

An enumeration.

status*: string

is_read*: boolean

updated_at*: date-time

contragent:{...}

ati_code*: string

name*: string

}

comments*:{...}

count*: integer

tail:{...}

name*: string

text*: string

timestamp*: date-time

}

flags*: [string]

highlight: enum

[failure, success, ]

An enumeration.

signs*:{...}

user:{...}

title*: string

valid_from*: string

valid_until*: string

}

contragent:{...}

title*: string

valid_from*: string

valid_until*: string

}

template_name: string

}]

}

422 Validation Error

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

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

msg*: string

type*: string

}]

}

Загрузка...

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

Загрузка...

Получение документа

Позволяет получить документ по его идентификатору doc_id.

Получение документа

get

/v1.0/atidocs/documents/{doc_id}/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Сведения о документе

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

Пример

Модель

{...}

"ok":true,

"result":{...}

"version":"1",

"id":"f1234546654",

"from":"0",

"to":"0",

"doctype":"акт",

"date":"2022-05-19",

"number":"56343434343",

"template_name":"",

"description":"",

"source_doc":"",

"child_doc":"",

"contract_number":"",

"contract_date":"",

"direction":"inbox",

"state":"declined",

"status":"Отклонен",

"created":"2021-01-30T08:48:02Z",

"updated":"2021-01-30T08:48:18Z",

"is_need_attention":false,

"is_approved":false,

"is_declined":true,

"is_declined_by_current_acc":true,

"decline_reason":"",

"is_revoked":false,

"is_revoked_by_current_acc":false,

"is_draft":false,

"is_template":false,

"is_deleted":false,

"is_archived":false,

"is_owner":false,

"is_original_owner":false,

"is_new":false,

"is_sent":true,

"is_signed":false,

"is_asked_resolution":true,

"is_locked_resolution":false,

"is_waiting":false,

"is_cancelled":false,

"is_new_edition":false,

"has_attachments":true,

"has_contragent":true,

"can_be_deleted":true,

"can_be_archived":true,

"can_be_undeleted":false,

"can_be_unarchived":false,

"can_be_signed":false,

"can_be_approved":false,

"can_be_declined":false,

"can_be_revoked":false,

"is_blocked_by_revoke":false,

"can_be_commented":true,

"can_be_saved":false,

"can_be_sent":false,

"can_be_edited":false,

"can_be_templated":true,

"can_be_set_to_edition":"",

"can_be_invoiced":false,

"fix_price":{...},

"id":"",

"link":""

"file":{...},

"mimetype":"application/vnd.ati-docs.xml",

"xml_template":"act",

"size":917,

"checksum":"",

"id":"123123123123",

"timestamp":"2021-01-30T08:48:01Z",

"name":"1233212343534435.xml",

"signs":{}

"signers":[],

"body":{},

"contragent":{...},

"account":{...},

"ati_id":"0",

"ati_code":"0",

"id":"0",

"fn":"ООО",

"name":"ООО",

"contacts":[...]

{...}

"fn":"",

"name":"",

"is_default":true

}

]

"contact":{...}

"company":"0",

"ati_id":"0",

"name":"",

"is_default":true

}

"comments":[...],

{...}

"timestamp":"2021-01-30T08:48:18Z",

"text":"",

"is_new":false,

"seen":[],

"has_attachments":false,

"attachment":{...},

"mimetype":"",

"size":0,

"name":"",

"checksum":"",

"id":""

"user":{...}

"id":"0",

"fn":"ОДО"

}

"file_diff":[],

"sender_inn":0,

"receiver_inn":0,

"access_key":"",

"history":[...]

{...},

"change":"declined",

"text":"Отклонен",

"seen":[],

"timestamp":"2021-01-30T08:48:18Z",

"is_new":false,

"user":{...}

"id":"0",

"fn":"ОДО"

}

{...}

"change":"sent",

"text":"Отправлен",

"seen":[],

"timestamp":"2021-01-30T08:48:02Z",

"is_new":false,

"user":{...}

"id":"0",

"fn":""

}

]

}

{}

404 Документ не найден

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

Пример

Модель

{...}

"error":false,

"reason":"Документ не найден"

}

{...}

Документ не найден

error: enum

[true]

reason: enum

[Документ не найден]

}

Загрузка...

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

Загрузка...

Получение документа

get

/gw/atidocs/api/2.0/documents/{doc_id}/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Сведения о документе

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

Пример

Модель

{...}

"ok":true,

"result":{...}

"doctype":"Тип документа",

"sender":{...},

"ati_id":"0",

"name":"Имя",

"user":{...},

"ati_id":"0",

"name":"Имя пользователя",

"department_id":"0"

"status":"Статус документа",

"inn":""

"receiver":{...},

"ati_id":"0",

"name":"Имя",

"user":{...},

"ati_id":"0",

"name":"Имя пользователя",

"department_id":"0"

"status":"Статус документа"

"file":{...},

"mimetype":"application/vnd.ati-docs.xml",

"name":"000.xml",

"xml_template":"order",

"timestamp":"2022-06-30T12:44:30Z",

"size":9659,

"id":"00000"

"id":"00000",

"date":"2022-06-30",

"number":"1",

"updated":"2022-06-30T12:44:28Z",

"fix_price":{...},

"id":"00000",

"link":"",

"original_owner":"0",

"contact_1":"0",

"contact_2":"",

"document_creator":"0"

"flags":[...]

"is_sent",

"is_waiting",

"can_be_deleted",

"can_be_archived",

"can_be_signed",

"can_be_declined",

"can_be_revoked",

"can_be_templated"

]

}

{...}

ok: enum

[true]

result:{...}

id: string

file:{...}

id: string

timestamp: string

mimetype: string

xml_template: string

size: string

}

number: string

date: string

doctype: string

updated: string

sender:{...}

ati_id: string

user:{...}

ati_id: string

}

status: string

inn: string

}

receiver:{...}

ati_id: string

user:{...}

ati_id: string

}

status: string

inn: string

}

comments:{...}

last: string

}

fix_price:{...}

id: string

link: string

original_owner: string

contact_1: string

contact_2: string

document_creator: string

}

flags: [string]

}

404 Документ не найден

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

Пример

Модель

{...}

"error":false,

"reason":"Документ не найден"

}

{...}

Документ не найден

error: enum

[true]

reason: enum

[Документ не найден]

}

Загрузка...

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

Загрузка...

Одобрить документ

Одобрить можно только документ, ожидающий решения.

Одобрить документ

put

/v1.0/atidocs/documents/{doc_id}/approve/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка запроса, документ не может быть одобрен.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Одобрить документ

put

/gw/atidocs/api/2.0/documents/{doc_id}/approve/

doc_id

string

id документа

CURL

Копировать

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

Ответ

200 Документ одобрен

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

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: boolean

result: string

id документа

}

400 Документ не может быть одобрен

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

Пример

Модель

{...}

"error":"document_can_not_be_approved",

"reason":"Документ не может быть одобрен"

}

{...}

error: string

reason: string

}

404 Документ не найден

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

not_found

reason: string

Объект не найден

}

Загрузка...

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

Загрузка...

Отклонить документ

Отклонить можно только документ, ожидающий решения.

Отклонить документ

put

/v1.0/atidocs/documents/{doc_id}/decline/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка запроса, документ не может быть отклонен.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Отклонить документ

put

/gw/atidocs/api/2.0/documents/{doc_id}/decline/

doc_id

string

id документа

reason

string

CURL

Копировать

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

Ответ

200 Документ отклонен

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

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: boolean

result: string

id документа

}

400 Документ не может быть одобрен

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

Пример

Модель

{...}

"error":"document_can_not_be_changed",

"reason":"Документ невозможно изменить, так как вторая сторона приняла по нему решение. Обновите страницу, чтобы продолжить работу"

}

{...}

error: string

reason: string

}

404 Документ не найден

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

not_found

reason: string

Объект не найден

}

Загрузка...

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

Загрузка...

Скачать вложение к документу (тело документа)

При скачивании в заголовке отдается mimetype документа, если его удалось определить.

Скачать вложение к документу (тело документа)

get

/v1.0/atidocs/documents/{doc_id}/attachments/{attachment_id}/

doc_id

string

Идентификатор документа

attachment_id

string

Идентификатор вложения

CURL

Копировать

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

Ответ

200 Тело вложения

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

Загрузка...

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

Загрузка...

Получить вложение по id документа

get

/gw/atidocs/api/2.0/documents/{doc_id}/attachments/{attachment_id}/

doc_id

string

id документа

attachment_id

string

id вложения

CURL

Копировать

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

Ответ

200 Данные получены

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

Пример

Модель

"binary"

binary

404 Объект не найден

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

Пример

Модель

{...}

"error":"not_found",

"reason":"Документ не найден"

}

{...}

error: string

reason: string

}

Загрузка...

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

Загрузка...

Скачать zip-архив документа с вложениями и подписями

Позволяет скачать zip-архив документа, только если у документа есть подпись хотя бы с одной стороны.

Скачать zip-архив документа с вложениями и подписями

get

/v1.0/atidocs/documents/{doc_id}/zip_archive/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 ZIP-архив

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

Загрузка...

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

Загрузка...

Экспорт документа для подписи

Перед тем как подписать документ, необходимо произвести его экспорт.

Экспорт документа для подписи

get

/v1.0/atidocs/documents/{doc_id}/export/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"TG9yZW0gaW1wc3VtIGRvbG9yIHNpdCBhbWV0Lg=="

}

{...}

ok: enum

[true]

result: string

Документ в виде base64-закодированной строки для подписи

}

400 Ошибка при экспорте документа.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Подпись документа

Если документ требовал решения, то документ автоматически одобряется.

Подписание документа

put

/v1.0/atidocs/documents/{doc_id}/sign/

doc_id

string

Идентификатор документа

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

body

object

Объект с подписью документа в виде строки, кодированной в base64.

{...}

sign: string

Подпись документа в виде base64-строки

}

sign

string

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка при подписании документа.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Подписать документ

put

/gw/atidocs/api/2.0/documents/{doc_id}/sign/

doc_id

string

id документа

sign

string

Подпись

CURL

Копировать

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

Ответ

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

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

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: boolean

result: string

id документа

}

400 Отсутствует подпись документа

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

402 Недостаточно атисов на виртуальном счете

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

404 Not found

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

500 Ошибка списания атисов с виртуального счета

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

Загрузка...

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

Загрузка...

Добавление комментария к документу

Позволяет загрузить как текст, так и файл. Обязательное условие: текст/файл должен пересылаться как “multipart/form-data”. При загрузке файлов применяются общие ограничения по типу поддерживаемых файлов. Размер файла не должен превышать 10 Мб.

Добавление комментария к документу

post

/v1.0/atidocs/documents/{doc_id}/comments/

doc_id

string

Идентификатор документа

comment-text

string

CURL

Копировать

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

Ответ

200 Результат запроса

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

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка добавления комментария.

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

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

Загрузка...

Оставить комментарий к документу

post

/gw/atidocs/api/2.0/documents/{doc_id}/comments/

doc_id

string

id документа

comment-text

string

CURL

Копировать

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

Ответ

200 Список комментариев

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

Пример

Модель

{...}

"timestamp":"2020-02-26T15:24:00.000Z",

"text":"string",

"has_attachments":false,

"attachment":{...},

"id":"95a971edb0994372aa6b76a9e1be8bdb",

"size":429939,

"name":"Книга новичка АТИ.pdf",

"mimetype":"application/pdf"

"user":{...}

"id":"765044.0",

"fn":"wefwef_1!"

}

{...}

timestamp: string

text: string

Текст сообщения

has_attachments: boolean

attachment:{...}

Данные вложения

id: string

size: integer

Размер файла

Название файла

mimetype: string

}

user:{...}

Данные пользователя

id: string

ati id

fn: string

Имя юзера

}

400 Ошибка запроса

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

Пример

Модель

{...}

"error":"bad_request",

"reason":"Нельзя отправить пустой комментарий"

}

{...}

error: string

reason: string

}

404 Объект не найден

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}