Отправка черновика¶
Для работы с этим методом пользователь должен быть авторизированным .
С помощью метода /api/eds/doc/send возможна отправка черновика в определенную цепочку.
Метод запроса | HTTP PATCH |
---|---|
Content-Type | application/json (тело запроса/ответа в json формате в теле HTTP запроса |
URL запроса | https://edo-v2.edi-n.com/api/eds/doc/send |
Параметры, передаваемые в URL (вместе с адресом метода) | В строке заголовка (Header) «Set-Cookie» обязательно передается SID - токен полученный при авторизации Обязательные url-параметры: gln - строка(13); номер GLN организации, которая связана с авторизированным пользователем платформы EDIN 2.0 на уровне аккаунта doc_uuid - строка; UUID документа doc_hash - строка; хэш документа chain_hash - строка; хэш цепочки chain_uuid - строка; ID цепочки partner_id - число; ID ритейлера или 0 если не ритейлер |
Внимание: В запросе в теле json присутствуют обязательные (должны передаваться) и опциональные параметры (колонка Тип).
Подсказка
Также возможно выполнить запрос в виде curl-строки:
curl -X PATCH „https://edo-v2.edi-n.com/api/eds/doc/send?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&doc_hash=704DD5F0A71FCB730D2B1AEA84FEE3FB&chain_hash=704DD5F0A71FCB730D2B1AEA84FEE3FB&chain_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&partner_id=11“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“
Спецификация для расшифровки ключей curl запроса: https://curl.haxx.se/docs/manpage.html
JSON-параметры в теле HTTP запроса/ответа
REQUEST
Таблица 1 - Описание json-параметров (фильтр) запроса метода API
Наименование | Тип | Формат | Описание |
---|---|---|---|
extra_fields | Map<String, String> | массив объектов; набор индексов | |
multi_extra_fields | Map<String, List<String>> | массив объектов; мультииндекс. Может быть использован для индексирования элементов строки |
Таблица 2 - Описание extra_fields параметров
id параметра | Наименование параметра | Тип | Формат | Описание параметра |
---|---|---|---|---|
1 | created_from | UUID | идентификатор документа или цепочки | |
2 | is_signed | TINYINT | отметка о подписании | |
3 | encrypted | TINYINT | отметка о шифровании | |
4 | comdoc_reestr_id | INT | id факторингового Реестра на основании коммерческого документа | |
5 | comdoc_reestr_is_active | TINYINT | отметка об активности факторингового договора | |
6 | ftpex_file_name | VARCHAR |
|
|
7 | ftpex_file_date | INT | дата/время отправки документа по FTP | |
8 | inv_date | INT | дата документа invrpt (Отчет об инвентаризации) | |
9 | inv_num | VARCHAR | номер документа invrpt (Отчет об инвентаризации) | |
11 | sub_doc_type_id | INT | id подтипа документа | |
12 | sub_status_id | INT | id статуса документа (состояние цепочки документов) | |
13 | action | VARCHAR | статус документа по осуществленным действиям пользователя | |
14 | buyer_uuid | VARCHAR | отправитель документа | |
15 | consignee_uuid | VARCHAR | грузопполучатель | |
16 | consignor_uuid | VARCHAR | грузоотправитель | |
17 | customer_uuid | VARCHAR | покупатель | |
18 | performer_uuid | VARCHAR | исполнитель | |
19 | supplier_uuid | VARCHAR | поставщик | |
20 | delivery_place_uuid | VARCHAR | место доставки | |
21 | contract_date | VARCHAR | дата договора | |
22 | contract_number | VARCHAR | номер договора | |
23 | delivery_date | M | INT | дата доставки |
24 | order_number | M | VARCHAR | номер заказа |
25 | order_date | INT | дата заказа | |
26 | return_date | INT | дата возврата | |
27 | summ | VARCHAR | сумма с НДС | |
28 | parent_chain_hash | MD5 | хэш цепочки | |
29 | period | VARCHAR | крайняя дата подписи документа | |
31 | trans_id | VARCHAR | id транзакции | |
32 | ttn | VARCHAR | номер накладной | |
33 | doc_start_date | VARCHAR | начало срока подписания документа | |
34 | doc_end_date | VARCHAR | окончание срока подписания документа | |
35 | delivery_note_number | VARCHAR | номер накладной | |
42 | contract_gln | VARCHAR | GLN место доставки при товарном согласовании (Agreem->Comdoc) | |
43 | doc_date | INT | дата из документа | |
44 | delivery_agreement_number | VARCHAR | количество согласований | |
45 | delivery_agreement_date | INT | дата согласования | |
46 | varn | VARCHAR | юзд id документа | |
47 | other_info | TEXT | дополнительные данные | |
48 | sub_doc_date | INT | дата подтипа документа | |
49 | sub_doc_number | VARCHAR | номер подтипа документа | |
50 | doc_error | TEXT | шибка при работе с документом | |
51 | doc_info | TEXT | комментарий к документу | |
52 | old_doc_id | INT | id документа | |
53 | sub_status_date | INT | дата статуса документа (состояние цепочки документов) | |
54 | from_doc_id | INT | порядковый номер документа в цепочке | |
56 | doc_num | VARCHAR | номер документа | |
57 | sender | VARCHAR | GLN отправителя | |
58 | recipient | VARCHAR | GLN получателя | |
59 | file_name | VARCHAR | наименование прикладываемого (вложение) файла | |
60 | xml_hash | VARCHAR | хеш содержания документа | |
61 | answer_doc_id | INT | id ответного COMDOC документа | |
80 | identifier | VARCHAR | идентификатор документа в системе клиента | |
82 | compound_number | VARCHAR | составной номер | |
85 | doc_process | TINYINT | ||
87 | users | VARCHAR |
Тип поля: M - mandatory (обязательное к заполнению), O - optional (опциональное)
RESPONSE
В этом методе json-тело ответа отсутствует.
Примеры
Пример тела запроса (json):
{
"extra_fields": {
"sender": "4820128010004",
"doc_num": "ORG00000014",
"buyer_uuid": "4820128010004",
"delivery_date": "1551477600",
"order_number": "6422722fb78c4509b06eac43758e1545",
"supplier_uuid": "9864065702429",
"contract_number": "334455",
"delivery_place_uuid": "4820128019007",
"order_date": "1550181600",
"doc_date": "1555432208",
"action": "29"
}
}
Пример тела ответа (json):
В этом методе json-тело ответа отсутствует.
Возвращаемый текст – «OK»