ShGetEDocs

Назначение	Получение списка документов EDocs
PluggetSystemType	StoreHouse

Получение списка документов EDocs

Формат запроса

{
  "taskType": "ShGetEDocs",
  "params": {
    "sync": {
      "objectId": 199990377,
       "timeout": 120
    },

    "dateFrom": "2025-01-01",
    "dateTo": "2025-10-28",
    "rid": 1,
    "kppRid": 1
   }
}

taskType	string	+	Тип задачи
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
dateFrom	string	+	Дата с в формате yyyy-MM-dd
dateTo	string	+	Дата по в формате yyyy-MM-dd
rid	int	+	Собственное Юр лицо Rid
kppRid	int	+	Rid Код спецификаций контрагента
mask	int	-	Бинарная маска типов накладных: 1-подтверждение, 2-расхождение, 4-отказ, 8-отменено ,16-не обработано. Null - Всё

Формат ответа

// Успешный ответ
{
  "taskResponse":{
   "filter": {
    "fsRarId": "string",
    "attributes": "string"
   },
   "invoices": [
     {
      "rid": number,
      "invoiceDate": "yyyy-MM-dd",
      "shipmentDate": "yyyy-MM-dd",
      "packedFlag": number,
      "wayBillRegId": "string",
      "identityEgais": "string",
      "numberEgais": "string",
      "comment": string,
      "xmlVersion": number,
      "options": null,
      "wbTypeEgais": number,
      "docType": number,
      "supplierEgais": {
        "rid": number,
        "type": number,
        "codeEgais": "string",
        "fullName": "string",
        "shortName": "string,
        "inn": "string",
        "kpp": "string",
        "countryCode": "string",
        "regionCode": "string",
        "attributes": "string"
      },
      "recipientEgais": {
        "rid": number,
        "type": number,
        "codeEgais": "string",
        "fullName": "string,
        "shortName": "string,
        "inn": "string",
        "kpp": "strnig",
        "countryCode": "string",
        "regionCode": "strnig",
        "attributes": "strnig"
      },
      "recipientRid": number,
      "recipientKpp": "string",
      "recipientFsRarId": "string",
      "recipientAttribute1": "string",
      "recipientAttribute2": "string",
      "recipientAttribute3": "strnig,
      "recipientAttribute4": "strnig",
      "linkInvoice": {
        "dateString": "string",
        "options": number,
        "supplierRid": number,
        "receiverRid": number,
        "rid": number
      },
      "shipmentType": number,
      "changeOwnership": "string",
      "tranType": "string",
      "companyName": "string",
      "tranNumer": "string",
      "trailer": "string",
      "customer": "string",
      "driver": "string",
      "forwarder": "string",
      "loadingLocation": "string",
      "unloadingLocation": "string",
      "redirection": "string",
      "parentRid": number,
      "parentNumber": "string",
      "withoutConfirmation": nubmer,
      "ticketOptions": number,
      "ttn": number
     }
   ],
   "receipts": [
    {
      "rid": number,
      "result": "string",
      "message": "string",
      "date": "string",
      "typeEgais": "string",
      "type": number,
      "textEgais": "string",
      "egaisRequestRid": number,
      "replyId": "string",
      "egaisRid": number,
      "wbRegId": "string"
     }
   ]
},
"responseCommon":{
      "taskGuid":"string",
      "taskType":"ShGetEDocs",
      "objectId":"number"
   }
}

// Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShGetEDocs",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

invocies	array	Список заголовков накладных
\|-rid	number	Rid накладной
\|-invoiceDate	string (yyyy-MM-dd)	Дата документа
\|-shipmentDate	string (yyyy-MM-dd)	Дата отгрузки
\|-packedFlag	number	Товар упакован . Для 1-й версии XML ( значение поля "18"==0) : 0-Packed, 1-Unpacked . Для последующих версий XML :всегда 0. Для Rec_Type == 0: 2 - сверка прошла,
\|-wayBillRegId	string	WayBillRegId в ЕГАИС
\|-identityEgais	string	Identity в ЕГАИС
\|-numberEgais	string	Number в ЕГАИС
\|-comment	string	Комментарии
\|-xmlVersion	number	Xml версия: 0-первая, 1-вторая 2-третья
\|-options	null	Опции накладной 0-подтверждение, 1 - расхожд, 2-отказ, 3 отмена провед.,4 накл
\|-wbTypeEgais	number	Тип WBType ЕГАИС : 0- WBInvoiceFromMe,1-WBReturnToMe, 2-WBInvouceToMe,3-WBReturnFromMe
\|-docType	number	Тип документа : 0-приход, 4 расх, 5 возврат, 11 внутреннее перемещение, 100 -акты,
\|-supplierEgais	object	Поставщик ЕГАИС
\|--rid	number	Контрагент ЕГАИС: Rid
\|--type	number	Для 1-й версии XML: всегда-0 ,вторая версия (0-UL 1-FL 2-FO Иностранец 3-TS таможенный союз)
\|--codeEgais	string	Код ЕГАИС
\|--fullName	string	Полное наименование
\|--shortName	string	Короткое наименование
\|--inn	string	ИНН
\|--kpp	string	КПП
\|--countryCode	string	Код страны
\|--regionCode	string	Код Региона
\|--attributes	string	Описание
\|-recipientEgais	object	Получатель ЕГАИС
\|--rid	number	Контрагент ЕГАИС: Rid
\|--type	number	Для 1-й версии XML: всегда-0 ,вторая версия (0-UL 1-FL 2-FO Иностранец 3-TS таможенный союз)
\|--codeEgais	string	Код ЕГАИС
\|--fullName	string	Полное наименование
\|--shortName	string	Короткое наименование
\|--inn	string	ИНН
\|--kpp	string	КПП
\|--countryCode	string	Код страны
\|--regionCode	string	Код Региона
\|--attributes	string	Описание
\|-recipientRid	number	Rid контрагента
\|-recipientKpp	string	КПП получателя
\|-recipientFsRarId	string	FSRAR_ID получателя
\|-recipientAttribute1	string	Атрибуты
\|-recipientAttribute2	string	Дополнительные атрибуты
\|-recipientAttribute3	string	Атрибуты
\|-recipientAttribute4	string	Атрибуты
\|-linkInvoice	object	Связанная накладная SH
\|--dateString	string	Накладная: DateStamp
\|--options	number	Накладная: Опции
\|--supplierRid	number	Поставщик SH Rid
\|--receiverRid	number	Получатель SH Rid
\|--rid	number	Накладная: Rid
\|--number	string	Накладная: Номер
\|--typeMask	number	Накладная: Тип
\|-shipmentType	number	Тип перевозки
\|-changeOwnership	string	ChangeOwnership
\|-tranType	string	TRAN_TYPE
\|-companyName	string	Название компании
\|-tranNumer	string	Номер транспорта
\|-trailer	string	Прицеп
\|-customer	string	Заказчики
\|-driver	string	Водитель
\|-forwarder	string	Экспедитор
\|-loadingLocation	string	Место погрузки
\|-unloadingLocation	string	Место разгрузки
\|-redirection	string	Перенаправление
\|-parentRid	number	Родительская ТТН Rid
\|-parentNumber	string	Родительская ТТН Number
\|-withoutConfirmation	number	Битовая маска: 1-"Без подтверждения"
\|-ticketOptions	number	Опции тикетов: ,битовая маска: 1 - есть WayBillTicket Rejected, 2 - есть RequestRepealWB Rejected
\|-ttn	number	ТТН: Сверка: 1-сверка прошла
receipts	array	Список квитанций
\|-rid	number	Тикет: Rid
\|-result	string	Тикет: Результат
\|-message	string	Тикет: Сообщение
\|-date	string	Тикет: Дата тикета
\|-typeEgais	string	Тикет: Тип документа ЕГАИС
\|-type	number	Тип тикета : 0-Ticket0, 1-Ticket1, 2-WayBillAct,3-WayBillTicket,4-ConfirmTicket
\|-textEgais	string	Текст от ЕГАИС
\|-egaisRequestRid	number	Запрос в ЕГАИС Rid запроса
\|-replyId	string	Запрос в ЕГАИС ReplyId
\|-egaisRid	number	Ссылка на накладную ЕГАИС Rid
\|-wbRegId	string	Ссылка на накладную ЕГАИС WBRegId

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

{
  "taskType": "ShGetEDocs",
  "params": {
  "sync": {
  "objectId": 199990377,
"timeout": 120
},

  "dateFrom": "2025-01-01",
  "dateTo": "2025-10-28",
  "rid": 1,
  "kppRid": 1
}
}