Помощь
Чат для вопросов по API
Мгновенно ответим на ваши вопросы
api@ati.su
Электронная почта техподдержки
Тикетная система
Оставить заявку на отдел
«Консультанты по интеграции (API)»
api.ati.su - заказы, торги, площадки
Наш телеграм-канал
Код в АТИ:
Выход

АТИ-Доки

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 
Список всех документов пользователя
get
/documents/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
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]
}
401 Ошибка авторизации
Развернуть все Свернуть все
Пример Модель
{...}
"error":"invalid_request",
"error_description":"The access token is missing"
}
{...}

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

error: string

Код ошибки

error_description: string

Описание

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Создание и/или сохранение документа
post
/documents/
Развернуть все Свернуть все
{...}

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

date: date

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

doc_recipient_contact: string

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

doc_recipient_id: string

Код пользователя в АТИ

doc_request: boolean

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

doc_sender_contact: string

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

doctype: string

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

id: string

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

number: string

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

xmlBody: string

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

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Прикрепление вложения к документу
post
/documents/{doc_id}/attachments/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка загрузки файла.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Отправка документа
put
/documents/{doc_id}/send/
Развернуть все Свернуть все
{...}
doc_recipient_contact: string

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

doc_recipient_id: string

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

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат отправки документа
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть отправлен
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Экспорт документа для подписи
get
/documents/{doc_id}/export/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"TG9yZW0gaW1wc3VtIGRvbG9yIHNpdCBhbWV0Lg=="
}
{...}
ok: enum
[true]
result: string

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

}
400 Ошибка при экспорте документа.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

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

 
Подписание документа
put
/documents/{doc_id}/sign/
Развернуть все Свернуть все
{...}
sign: string

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

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка при подписании документа.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Добавление комментария к документу
post
/documents/{doc_id}/comments/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка добавления комментария.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Отозвать документ
put
/documents/{doc_id}/revoke/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть отклонен.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

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

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

 
Список всех документов пользователя
get
/documents/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
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]
}
401 Ошибка авторизации
Развернуть все Свернуть все
Пример Модель
{...}
"error":"invalid_request",
"error_description":"The access token is missing"
}
{...}

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

error: string

Код ошибки

error_description: string

Описание

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Получение документа
get
/documents/{doc_id}/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Сведения о документа
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":{...}
"access_key":"",
"changes":{...},
"SENT":{...}
"account":0,
"text":"",
"timestamp":"2018-07-26T18:46:33Z",
"user":"0",
"username":"Имя контакта"
}
},
"child_id":"",
"comments":{...},
"1533022609750248":{...}
"account":"00000000",
"text":"Текст комментария",
"timestamp":"2018-07-31T07:36:49Z",
"user":"0",
"username":"Пользователь 1"
}
},
"date":"2018-07-01",
"description":"",
"doctype":"заказ (договор-заявка)",
"editable":false,
"file":"1234567890",
"files":{...},
"1234567890":{...}
"checksum":"",
"id":"1234567890",
"mimetype":"application/vnd.ati-docs.xml",
"name":"document.xml",
"signs":{},
"size":7169,
"timestamp":"2018-07-26T18:43:10Z",
"xml_template":""
}
},
"fingerprints":[],
"id":"0000000",
"number":"A-01",
"receiver":{...},
"account":{...}
"ati_code":"000000000000",
"changes":0,
"comments":0,
"history":{},
"last_view":"2018-07-26T18:46:41Z",
"name":"Название фирмы",
"signee":{...},
"act_upon":"приказа",
"full_name":"Ивана Петровича Сидорова",
"position":"директора",
"requisite_id":"00000000-00000-0000-000000000",
"signee_id":"000000-0000-0000-000-0000000000"
},
"status":"APPROVED",
"unread":false,
"user":{...}
"id":"0",
"name":"Имя пользователя"
}
}
},
"sender":{...},
"account":{...}
"ati_code":"000000000000",
"changes":0,
"comments":0,
"history":{},
"last_view":"2018-07-26T18:46:41Z",
"name":"Название фирмы 2",
"signee":{...},
"act_upon":"устава",
"full_name":"Сидора Петровича Иванова",
"position":"директора",
"requisite_id":"00000000-00000-0000-000000000",
"signee_id":"000000-0000-0000-000-0000000000"
},
"status":"APPROVED",
"unread":false,
"user":{...}
"id":"0",
"name":"Имя пользователя"
}
}
},
"source_id":"",
"stats":{...},
"comments":0,
"downloads":0,
"files":0,
"signees":0,
"views":0
},
"template_name":"",
"updated":"2018-07-31T07:36:49Z"
}
}
{...}
ok: enum
[true]
}
404 Документ не найден
Развернуть все Свернуть все
Пример Модель
{...}
"error":false,
"reason":"Документ не найден"
}
{...}

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

error: enum
[true]
reason: enum
[Документ не найден]
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

После одобрения документ перемещается в папку «Одобренные». Одобрить можно только документ, ожидающий решения.

 
Одобрить документ
put
/documents/{doc_id}/approve/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть одобрен.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

После отклонения документ перемещается в папку «Отклоненные». Отклонить можно только документ, ожидающий решения.

 
Отклонить документ
put
/documents/{doc_id}/decline/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть отклонен.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Скачать вложение к документу (тело документа)
get
/documents/{doc_id}/attachments/{attachment_id}/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Тело вложения
Развернуть все Свернуть все
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Скачать zip-архив документа с вложениями и подписями
get
/documents/{doc_id}/zip_archive/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 ZIP-архив
Развернуть все Свернуть все
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Экспорт документа для подписи
get
/documents/{doc_id}/export/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"TG9yZW0gaW1wc3VtIGRvbG9yIHNpdCBhbWV0Lg=="
}
{...}
ok: enum
[true]
result: string

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

}
400 Ошибка при экспорте документа.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

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

 
Подписание документа
put
/documents/{doc_id}/sign/
Развернуть все Свернуть все
{...}
sign: string

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

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка при подписании документа.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Добавление комментария к документу
post
/documents/{doc_id}/comments/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка добавления комментария.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

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

 
Список всех документов пользователя
get
/documents/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
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]
}
401 Ошибка авторизации
Развернуть все Свернуть все
Пример Модель
{...}
"error":"invalid_request",
"error_description":"The access token is missing"
}
{...}

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

error: string

Код ошибки

error_description: string

Описание

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

Возвращает документы, отправленные или полученные за указанный период По умолчанию документы из папок «Черновики», «Архив», и «Корзина» не возвращаются. Для получения документов из конкретной папки нужно использовать параметр строки запроса folder. Для пагинации используются параметры строки запроса offset и limit. По умолчанию возвращается 15 документов.

 
Поиск документов за указанный период
get
/documents_by_date/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результаты поиска
Развернуть все Свернуть все
Пример Модель
{...}
"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]
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Перенос документа в папку «Архив»

Переносит указанный документ в папку «Архив».

 
Перенести документ в папку "Архив"
put
/documents/{doc_id}/archive/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть перенесен в архив.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Перенос документа в папку «Корзина»

Переносит указанный документ в папку «Корзина».

 
Перенести документ в "Корзину"
put
/documents/{doc_id}/delete/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть перенесен в “Корзину”.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Восстановление документа из папки «Архив»

Восстанавливает указанный документ из «Архива» и переносит его в папку, в которой он был ранее.

 
Восстановить документ из "Архива"
put
/documents/{doc_id}/unarchive/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть восстановлен.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Восстановление документа из папки «Корзина»

Восстанавливает указанный документ из «Корзины» и переносит его в папку, в которой он был ранее.

 
Восстановить документ из "Корзины"
put
/documents/{doc_id}/undelete/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Результат запроса
Развернуть все Свернуть все
Пример Модель
{...}
"ok":true,
"result":"12345676554321"
}
{...}

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

ok: enum
[true]
result: string

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

}
400 Ошибка запроса, документ не может быть восстановлен.
Развернуть все Свернуть все
Пример Модель
{...}
"error":"bad_request",
"reason":"Ошибка в запросе"
}
{...}

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

error*: string

Код ошибки

reason*: string

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

Доступны групповые операции над документами:

  • перемещение в «Архив»/восстановление из «Архива»
  • перемещение в «Корзину»/восстановление из «Корзины»

Перенос группы документов в «Архив»

Перемещает группу документов в «Архив».

 
Перенос группы документов в "Архив"
post
/documents/batch/archive/
Развернуть все Свернуть все
[string]
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список идентификаторов документов, помещенных в “Архив”
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Перенос группы документов в «Корзину»

Перемещает группу документов в «Корзину».

 
Перенос группы документов в "Корзину"
post
/documents/batch/delete/
Развернуть все Свернуть все
[string]
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список идентификаторов документов, помещенных в “Корзину”
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Восстановление группы документов из «Архива»

Восстанавливает документы из «Архива» и переносит их в папку, в которой они был ранее.

 
Восстановление группы документов из "Архива"
post
/documents/batch/unarchive/
Развернуть все Свернуть все
[string]
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список идентификаторов восстановленных документов
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Восстановление группы документов из «Корзины»

Восстанавливает документы из «Корзины» и переносит их в папку, в которой они был ранее.

 
Восстановление группы документов из "Корзины"
post
/documents/batch/undelete/
Развернуть все Свернуть все
[string]
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список идентификаторов восстановленных документов
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...