Описание True API (Версия 72.0) - часть 5

 

  Главная      Книги - Разные     Описание True API (Версия 72.0)

 

поиск по сайту            правообладателям  

 

   

 

    

 

содержание      ..     3      4      5      6     ..

 

 

 

Описание True API (Версия 72.0) - часть 5

 

 

Параметры ответа
Параметр
Тип
Обяз.
Описание
Комментарий
responses
object
+
Сведения о КИ
*cis
string
+
КИ
*owner
boolean
+
Признак
Если параметр "owner" = false, то в
принадлежности
ответе вернётся только "cis"
КИ
*gtin
string
-
Код товара
Параметр не возвращается для КИТУ
*productGroup
string
+
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
*producerInn
string
-
ИНН
Параметр не возвращается для КИТУ
производителя
товара
*status
string
+
Статус КИ
См. "Справочник "Статусы КИ""
*parent
string
-
КИ агрегата
*childs
[string]
-
Список КИ,
входящих в
состав агрегата
*partialSaleInfo
object
-
Объект
Возвращается для ТГ
параметров
"Альтернативная табачная
частичного
продукция" (количество в шт) и
выбытия
"Духи и туалетная вода" (наливная
продукция, объем в мл)
**innerUnitCount
number
-
Общее
Значением параметра является
количество
количество/объём товара в
(объем) товара в
потребительской упаковке/единице
потребительской
товара
упаковке
**soldUnitCount
number
-
Количество
Значением параметра является число
(объем)
выбывших, в том числе от
выведенного из
невладельцев, из оборота единиц
оборота товара по
употребления из всех чеков. УОТ
КИ
отображается информация только по
собственным чекам. ФОИВ доступна
информация по всем чекам
**rest
number
-
Количество
Значением параметра является
(объем) товара,
расчётное количество/объём
доступного к
оставшихся в потребительской
выводу из
упаковке/единице товара единиц
оборота по КИ
употребления/мл товара после
продажи всеми УОТ. УОТ
отображается информация только по
собственным чекам. ФОИВ доступна
информация по всем чекам
400
Параметр
Тип
Обяз.
Описание
Комментарий
**correctRest
boolean
-
Корректность
Показатель корректности остатка
остатка товара
товара после вывода товара из
оборота: false - продано или
возвращено больше допустимого
количества/объема товара; true -
продано или возвращено в пределах
допустимого количества/объема
товара. Для товарной группы "Духи и
туалетная вода" (наливная
продукция) продажа товара в объеме,
превышающем заявленный, а также
превышение остатка товара более
чем на 8% считаются некорректными
errors
[string]
-
Список КИ,
Возвращается в случае наличия
обработанных с
ошибок
ошибкой
*cises
[string]
-
Список КИ
message
string
-
Сообщение об
Возвращается только в случае
ошибке
ошибки
5.7.3. Метод аннулирования подписанного согласия о предоставлении информации
Метод аннулирует последнее успешно сформированное и подписанное согласие о
предоставлении информации.
Тип приватности:
1. Производители/импортёры продукции.
2. Покупатели продукции (Оптовик, Розница).
URL: /agreement-registry/cancellation
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>/agreement-registry/cancellation"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Пример ответа:
1.В случае успеха 201 "Документ успешно создан".
401
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"statusCode": "ESTABLISHED",
"sign": {
"fingerPrint": "string",
"serialNumber": "string",
"inn": "string",
"owner": "string",
"organisationName": "string",
"validityDateFrom": 0,
"validityDateUpTo": 0,
"signingTime": 0
},
"documentRegNumber": "string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа
согласия о
предоставлении
информации
status
string
+
Статус документа
statusCode
string
+
Код статуса
Возможные значения:
документа
ESTABLISHED - сформирован
(присваивается при записи документа
в БД после успешного прохождения
всех проверок);
SIGNED - подписан (присваивается
по факту подписания пользователем);
REJECTED - отклонён
(присваивается, если пользователь
отказывается от подписания
документа);
OUTDATED - устарел (присваивается
в случае, если документ был
подписан ранее, но вместо него был
подписан новый документ);
CANCELLED - аннулирован
(присваивается в случае
аннулирования документа)
sign
object
+
УКЭП
*fingerPrint
string
-
Отпечаток
сертификата
*serialNumber
string
-
Серийный номер
402
Параметр
Тип
Обяз.
Описание
Комментарий
*validityDateFrom
integer($
-
Действителен с
int64)
*validityDateUpTo
integer($
-
Действителен до
int64)
*signingTime
integer($
-
Время
int64)
подписания
документа
documentRegNum
string
+
Регистрационный
ber
номер документа
1.В случае успеха 201 "Документ успешно создан".
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"statusCode": "ESTABLISHED",
"sign": {
"fingerPrint": "string",
"serialNumber": "string",
"inn": "string",
"owner": "string",
"organisationName": "string",
"validityDateFrom": 0,
"validityDateUpTo": 0,
"signingTime": 0
},
"documentRegNumber": "string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа
согласия о
предоставлении
информации
status
string
+
Статус документа
403
Параметр
Тип
Обяз.
Описание
Комментарий
statusCode
string
+
Код статуса
Возможные значения:
документа
ESTABLISHED - сформирован
(присваивается при записи документа
в БД после успешного прохождения
всех проверок);
SIGNED - подписан (присваивается
по факту подписания пользователем);
REJECTED - отклонён
(присваивается, если пользователь
отказывается от подписания
документа);
OUTDATED - устарел (присваивается
в случае, если документ был
подписан ранее, но вместо него был
подписан новый документ);
CANCELLED - аннулирован
(присваивается в случае
аннулирования документа)
sign
object
+
УКЭП
*fingerPrint
string
-
Отпечаток
сертификата
*serialNumber
string
-
Серийный номер
*validityDateFrom
integer($
-
Действителен с
int64)
*validityDateUpTo
integer($
-
Действителен до
int64)
*signingTime
integer($
-
Время
int64)
подписания
документа
documentRegNum
string
+
Регистрационный
ber
номер документа
5.7.4. Метод отображения списка документов согласия о предоставлении
информации
Метод позволяет участнику оборота товаров получить список всех документов согласия о
предоставлении информации.
Тип приватности:
1. Приватный.
2. Оператор.
URL: /agreement-registry/agreement/list
Метод: GET
404
Пример запроса:
curl -X GET "<url стенда>/agreement-registry/agreement/list?expirationDate.from=2021-
06-22T07:04:42.000Z&expirationDate.to=2021-09-
22T07:04:42.000Z&offset=0&limit=10&sort=publicationDate&direction=DESC"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
participantId
integer($
-
ID участника
int64)
оборота товаров
participantInn
string
-
ИНН участника
оборота товаров
documentRegNum
string
-
Регистрационный
ber
номер документа
status
string
-
Статус документа
Возможные значения:
ESTABLISHED - сформирован
(присваивается при записи документа
в БД после успешного прохождения
всех проверок);
SIGNED - подписан (присваивается
по факту подписания пользователем);
REJECTED - отклонён
(присваивается, если пользователь
отказывается от подписания
документа);
OUTDATED - устарел (присваивается
в случае, если документ был
подписан ранее, но вместо него был
подписан новый документ);
CANCELLED - аннулирован
(присваивается в случае
аннулирования документа)
publicationDate
object
-
Фильтр по дате
подписания
документа
*from
string
-
Начало периода
Задаётся в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
*to
string
-
Конец периода
Задаётся в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
createDate
object
-
Фильтр по дате
создания
документа
405
Параметр
Тип
Обяз.
Описание
Комментарий
*from
string
-
Начало периода
Задаётся в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
*to
string
-
Конец периода
Задаётся в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
expirationDate
object
-
Фильтр по дате
истечения срока
действия
документа
*from
string
-
Начало периода
Задаётся в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
*to
string
-
Конец периода
Задаётся в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
offset
integer($
-
Смещение
Значение по умолчанию: 0
int64)
страницы
limit
integer($
-
Предельное
Значение по умолчанию: 0
int32)
количество
записей
sort
string
-
Параметр
Доступные параметры для
фильтрации
фильтрации: "publisherId",
"agreementCancellations", "agreement",
"revisionNumber", "rejectionDate",
"creatorId", "trustedOrganisations",
"id", "publicationDate", "createDate",
"status", "printForm"
direction
string
-
Направление
Возможные значения:
фильтрации
ASC - по возрастанию;
DESC - по убыванию
В запросе должен быть указан хотя бы один параметр, иначе в ответе возвращается ошибка 400
"Bad request" (ошибка в параметрах запроса).
Пример ответа:
1. В случае успеха 200 "Данные успешно получены".
406
{
"results":[
{
"agreementRevisionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createDate":0,
"publicationDate":0,
"expirationDate":"string",
"status":"string",
"creatorId":0,
"publisherId":0,
"cancellation":{
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createDate":"2021-01-31T16:40:48.549Z",
"publicationDate":"2020-01-31T16:40:48.549Z",
"status":"string",
"statusCode":"string",
"creatorId":0,
"publisherId":0,
"documentRegNumber":"string"
},
"documentRegNumber":"string"
}
],
"total":0,
"errorCode":"string",
"last":true
}
2. В случае ошибки 400 "Входные параметры некорректны", ошибки 500 "Ошибка при
выполнении запроса".
{
"error":"string",
"error_description":"string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
result
[array]
+
Результат запроса
*agreementRevisio
string($u
+
Первичный ключ
nId
uid)
(ID документа
согласия о
предоставлении
информации)
407
Параметр
Тип
Обяз.
Описание
Комментарий
*createDate
integer($
+
Дата создания
int64)
документа
*publicationDate
integer($
-
Дата подписания
int64)
документа
*expirationDate
string
+
Дата окончания
Формат: yyyy-MM-
(date-
срока действия
ddTHH:mm:ss.SS’Z
time)
согласия
*status
string
+
Статус документа
Возможные значения:
ESTABLISHED - сформирован
(присваивается при записи документа
в БД после успешного прохождения
всех проверок);
SIGNED - подписан (присваивается
по факту подписания пользователем);
REJECTED - отклонён
(присваивается, если пользователь
отказывается от подписания
документа);
OUTDATED - устарел (присваивается
в случае, если документ был
подписан ранее, но вместо него был
подписан новый документ);
CANCELLED - аннулирован
(присваивается в случае
аннулирования документа)
*creatorId
integer($
+
ID участника
int64)
оборота товаров,
создавшего
документ
*publisherId
integer($
-
ID участника
int64)
оборота товаров,
подписавшего
документ
*cancellation
object
-
Документ
аннулирования
связанный с
редакцией
документа
соглашения
**id
string
-
ID Документа
**createDate
string
+
Дата создания
Формат: yyyy-MM-
(date-
документа
ddTHH:mm:ss.SSS’Z
time)
408
Параметр
Тип
Обяз.
Описание
Комментарий
**publicationDate
string
-
Дата подписания
Формат: yyyy-MM-
(date-
документа
ddTHH:mm:ss.SS’Z
time)
**status
string
+
Статус документа
Возможные значения:
ESTABLISHED - сформирован
(присваивается при записи документа
в БД после успешного прохождения
всех проверок);
SIGNED - подписан (присваивается
по факту подписания пользователем);
REJECTED - отклонён
(присваивается, если пользователь
отказывается от подписания
документа);
OUTDATED - устарел (присваивается
в случае, если документ был
подписан ранее, но вместо него был
подписан новый документ);
CANCELLED - аннулирован
(присваивается в случае
аннулирования документа)
**statusCode
string
+
Код статуса
документа
**creatorId
integer($
+
ID участника
int64)
оборота товаров,
создавшего
документ
**publisherId
integer($
-
ID участника
int64)
оборота товаров,
подписавшего
документ
**documentRegNu
string
-
Регистрационный
mber
номер документа
*documentRegNu
string
-
Регистрационный
mber
номер документа
total
integer($
+
Всего записей
int64)
errorCode
string
-
Описание ошибки
Возвращается в случае ошибки
last
boolean
-
Последняя запись
на странице
error
string
-
Ошибка
Возвращается только в случае
ошибки
409
5.7.5. Метод получения тела документа согласия или документа аннулирования
согласия
Данный метод используется для получения в ответе тела документа согласия или аннулирования
согласия, которое необходимо подписать откреплённой УКЭП и вставить в поле "signature" в
методе "Метод подписания документа согласия или документа аннулирования согласия о
предоставлении информации".
Тип приватности: приватный.
URL: agreement-registry/{id}/print-form
Пример строки запроса:
curl -X GET "<url стенда>/agreement-registry/c9d1c4c6-a045-4205-b142-
c9d5a13155f7/print-form?documentType=AGREEMENT"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа
documentType
string
+
Тип документа
Возможные значения: AGREEMENT
- документ согласия о
предоставлении информации
AGREEMENT_CANCELLATION -
документ отмены согласия
Пример ответа:
1.В случае успеха 200.
{
"documentRegNumber": "AR631208202400074",
"ownerOrganisationName": "ООО \"X\"",
"ownerOrganisationInn": "1234567890",
"ownerOrganisationOgrn": "1234567890123",
"trustedOrganisations": [],
"everyonePermitted": true
}
2.В случае ошибки 400, 500.
{
"error":"string",
"error_description":"string"
}
410
Параметры ответа
Параметр
Тип
Обяз.
Описание
Комментарий
documentRegNum
string
+
Регистрационный
ber
номер документа
ownerOrganisation
string
-
Наименование
Name
владельца
организации
ownerOrganisation
string
-
ОГРН владельца
Ogrn
организации
trustedOrganisation
[string]
+
Доверенные
s
организации
everyonePermitted
boolean
-
Признак
При необходимости подписания
предоставления
согласия для всех контрагентов
согласия для всех
значение параметра должно быть
контрагентов
"true", при этом параметр
"trustedOrganisations" должен быть
пустым. Заполнение обоих
параметров одновременно
недопустимо. При передаче списка
доверенных контрагентов в
параметре "trustedOrganisations"
параметр "everyonePermitted" должен
быть либо пустым, либо иметь
значение "false". Параметр
"everyonePermitted" автоматически
принимает значение "false" при
передаче пустого значения
error
string
-
Ошибка
Возвращается только в случае
ошибки
5.7.6. Метод подписания документа согласия или документа аннулирования
согласия о предоставлении информации
Данный метод используется для подписания документа согласия и аннулирования документа
согласия. Перед подписанием документа согласия, полученного ранее методом "Метод
получения тела документа согласия или документа аннулирования согласия", удалить пробелы и
переносы строк в теле документа согласия.
Тип приватности: приватный.
URL: agreement-registry/publish
Метод: POST
Пример строки запроса:
411
curl -X POST "<url стенда>/agreement-registry/publish"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw "{\"documentId\":\"3fa85f64-5717-4562-b3fc-
2c963f66afa6\",\"documentType\":\"AGREEMENT\",\"signature\":\"string\"}"
Пример тела запроса:
{
"documentId": "string",
"documentType": "AGREEMENT",
"signature": "string"
}
Параметры запроса
Параметр
Тип
Обяз.
Описание
Комментарий
documentId
string
+
ID документа
documentType
string
+
Тип документа
Возможные значения:
"AGREEMENT" - подписание
документа согласия;
"AGREEMENT_CANCELLATION" -
подписание документа
аннулирования согласия.
При отсутствии одного из указанных
значений возвращается ошибка 400
signature
string
+
Откреплённая
УКЭП директора или генерального
УКЭП в
директора, осуществившего
кодировке base64
регистрацию компании в ГИС МТ,
либо сотрудника, который
зарегистрировал компанию на
основании доверенности
Пример ответа:
1.В случае успеха 200.
{
"documentId": "string",
"status": "string"
}
2.В случае ошибки 400.
412
{
"error_message": "Параметры запроса заданы неверно или документ не прошёл проверку"
}
3.В случае ошибки 404.
{
"error_message": "Документ не найден"
}
Параметры ответа
Параметр
Тип
Обяз.
Описание
Комментарий
documentId
string
+
ID документа
status
string
+
Статус документа
Возможные значения:
ESTABLISHED - сформирован
(присваивается при записи документа
в БД после успешного прохождения
всех проверок);
SIGNED - подписан (присваивается
по факту подписания пользователем);
REJECTED - отклонён
(присваивается, если пользователь
отказывается от подписания
документа);
OUTDATED - устарел (присваивается
в случае, если документ был
подписан ранее, но вместо него был
подписан новый документ);
CANCELLED - аннулирован
(присваивается в случае
аннулирования документа)
5.7.7. Метод получения списка ИНН доверенных участников оборота товаров
Для того, чтобы воспользоваться данным методом у участника оборота товаров должно быть
действующее согласие о предоставлении информации.
Тип приватности:
1. Приватный.
2. Оператор.
URL: /agreement-registry/trusted/{ownerInn}/list
Метод: GET
Пример строки запроса:
413
curl -X GET "<url стенда>/agreement-
registry/trusted/1111111111/list?inn=string&name=string&offset=0&limit=0&needTotal=tru
e"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса
Параметр
Тип
Обяз.
Описание
Комментарий
ownerInn
string
+
ИНН доверителя
inn
string
-
ИНН участника
оборота товаров
name
string
-
Наименование
организации
участника
оборота товаров
offset
integer($
-
Смещение
Значение по умолчанию: 0
int64)
страницы
limit
integer($
-
Предельное
Значение по умолчанию: 10
int32)
количество
записей
needTotal
boolean
-
Признак
Значение по умолчанию: "true"
необходимости
подсчёта
суммарного числа
записей
В запросе должен быть указан параметр "ownerInn" ("ИНН доверителя"), иначе в ответе
возвращается ошибка 400 "Bad request" (ошибка в параметрах запроса).
Пример ответа:
1.В случае успеха 200 "Данные успешно получены".
{
"results":[
{
"inn":"string"
}
],
"total":0,
"expirationDate":"string",
"everyonePermitted": true,
"last":true
}
414
Параметры ответа
Параметр
Тип
Обяз.
Описание
Комментарий
results
[array]
+
Список ИНН,
Если у доверителя, участника
возвращаемых в
оборота товаров, подписан договор
запросе
согласия с признаком предоставления
сведений всем контрагентам, то
параметр "results" должен быть
пустым, а параметр
"everyonePermitted" = true
*inn
string
+
ИНН участника
оборота товаров
expirationDate
string
-
Дата окончания
Формат: yyyy-MM-
(date-
срока действия
ddTHH:mm:ss.SSS’Z
time)
согласия,
указанная при
создании
документа
согласия
everyonePermitted
boolean
-
Признак
Если подписанное согласие
предоставления
предоставлено для всех
согласия для всех
контрагентов, то в ответе
контрагентов
"everyonePermitted" = true, и параметр
"inn" возвращается пустым. Если
"everyonePermitted" = false, то
возвращается список ИНН
доверенных контрагентов
total
number
-
Общее
количество
записей
errorCode
string
-
Код ошибки
Параметр возвращается при наличии
ошибки
last
boolean
-
Последняя запись
на странице
Если у доверителя подписан договор согласия с признаком предоставления сведений всем
контрагентам, то параметр "results" возвращается пустым.
5.7.8. Метод проверки ИНН доверенного участника оборота товаров
Метод используется для проверки наличия у ИНН участника оборота товаров признака доверия
в соответствии с согласием о предоставлении информации.
Тип приватности: публичный (с использованием токена).
URL: /agreement-registry/trusted/{ownerInn}
Метод: GET
415
Пример строки запроса:
curl -X GET "<url стенда>/agreement-registry/trusted/00000001?trustedInn=00000002"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса
Параметр
Тип
Обяз.
Описание
Комментарий
ownerInn
string
+
ИНН
предполагаемого
доверителя
trustedInn
string(10
+
ИНН доверенного
-12)
участника
оборота товаров
everyonePermitted
boolean
-
Признак
При необходимости подписания
предоставления
согласия для всех контрагентов
согласия для всех
значение параметра должно быть
контрагентов
"true", при этом параметр "trustedInn"
должен быть пустым. Заполнение
обоих параметров одновременно
недопустимо. При передаче списка
ИНН доверенных контрагентов в
параметре "trustedInn" параметр
"everyonePermitted" должен быть
либо пустым, либо иметь значение
"false". Параметр "everyonePermitted"
автоматически принимает значение
"false" при передаче пустого значения
Пример ответа:
1.В случае успеха 200 "Данные успешно получены".
{
"trusted": true,
"expirationDate": "string"
}
2.В случае ошибки 400 "Входные параметры некорректны".
{
"error": "string",
"error_description": "string"
}
Параметры ответа
416
Параметр
Тип
Обяз.
Описание
Комментарий
trusted
boolean
+
Признак
Параметр принимает значение "true",
предоставленного
если доверия предоставлено, иначе -
доверия
"false"
участнику
expirationDate
string
+
Дата окончания
Формат: yyyy-MM-
(date-
срока действия
ddTHH:mm:ss.SSS’Z
time)
согласия,
указанная при
создании
документа
согласия
error
string
-
Ошибка
Возвращается только в случае
ошибки
5.7.9. Метод получения списка ИНН по идентификатору документа согласия о
предоставлении информации
Метод возвращает список доверенных ИНН по указанному идентификатору согласия. Список
ИНН возможно получить по подписанному/аннулированному согласию.
Тип приватности:
1. Приватный.
2. Оператор.
URL: agreement-registry/agreement/{id}/trusted-inns
Метод: GET
Пример строки запроса:
curl -X GET "<url стенда>/agreement-registry/agreement/9df4ffeb-20ec-4c30-9b2b-
0f3370421cb2/trusted-inns"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа
согласия
Пример ответа:
1.В случае успеха 200 "ИНН получен".
417
{
"trustedInns": [
"string"
],
"everyonePermitted": true,
"expirationDate": 0
}
2.В случае ошибок 400, 404 и 500.
{
"error": "string",
"error_description": "string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
trustedInns
[string]
+
Список
доверенных ИНН
контрагентов
everyonePermitted
boolean
-
Признак
Если подписанное согласие
предоставления
предоставлено для всех
согласия для всех
контрагентов, то в ответе
контрагентов
"everyonePermitted" = true, и параметр
"trustedInns" возвращается пустым.
Если "everyonePermitted" = false, то
возвращается список доверенных
ИНН контрагентов
expirationDate
string
+
Дата окончания
Формат: yyyy-MM-
(date-
срока действия
ddTHH:mm:ss.SSS’Z
time)
согласия,
указанная при
создании
документа
согласия
error
string
-
Ошибка
Возвращается только в случае
ошибки
5.8. Метод получения истории движения КИ ТГ "Табачная
продукция"
Метод является устаревшим и в дальнейшем будет отключён. Вместо него планируется
использовать "Метод получения истории движения КИ"
Метод возвращает информацию о движении (истории) запрашиваемых КИ (в одном запросе
указывается один КИ) по событиям, в которых УОТ принимал участие, чей токен используется
418
при выполнении запроса.
Каждый УОТ видит производителя продукции, своего продавца и текущего владельца. Если
данных УОТ, сформировавшего запрос, нет в цепочке движения, то возвращается только
производитель и текущий владелец. Если КИ выведен из оборота, то вместо текущего владельца
возвращается соответствующая информация.
Тип приватности:
1. Приватный;
2. Для производителей продукции;
3. Для покупателей продукции;
4. Для Оператора;
5. Для ФОИВ;
6. Для Администратора.
URL: /cises/history
Метод: GET
Пример запроса:
curl -X GET <url стенда>/cises/history?cis=(01)04600266012258(21)5n4Jh5D' \
--header 'Authorization: Bearer ' <Токен>
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
array[stri
+
Код
ng]
идентификации
Пример ответа:
1.Код 200. В случае успеха:
419
[
{
"cis": "string",
"gtin": "string",
"packageType": "string",
"ownerInn": "string",
"status": "string",
"maxRetailPrice": 0,
"child": [
"string"
],
"parent": "string",
"producerInn": "string",
"timestamp": 0,
"operationDate": 0,
"emissionDate": 0,
"docId": "string",
"partialSaleInfo": {
"soldUnitCount": 0,
"rest": 0,
"correctRest": true,
"innerUnitCount": 0
},
"turnoverType": "string",
"productGroup": "string"
}
]
2.В случае ошибок:
2.1. Код 401 В случае, когда указан устаревший токен:
<InvalidTokenException>
<error>invalid_token</error>
<error_description>Access token expired:
eyJhbGciOi...zSPUg</error_description>
</InvalidTokenException>
2.2. Код 404 Если указанный КИ не найден:
{
"error_message": "КМ не найдены"
}
2.3. Код 400 При неправильном формате КИ в URL:
420
{
"error_message": "Неверный формат КМ"
}
2.4 Код 400 Если используется КИ из другой ТГ
{
"error_message": "КМ принадлежит ТГ отличной от МОТП"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КИ ГИС МТ
gtin
string
+
Код товара
Если код товара менее 14 символов,
то он дополняется ведущими нулями
packageType
string
+
Код типа
Тип упаковки. см. "Справочник
упаковки
"Типы упаковки""
ownerInn
string
-
ИНН владельца
товара
*maxRetailPrice
number
-
Максимальная
Возвращается для ТГ "Табачная
цена розничной
продукция", "Альтернативная
продажи
табачная продукция" и
"Никотиносодержащая продукция"
только для пачки или блока. Если у
блока или пачки отсутствует МРЦ, то
параметр не возвращается. Для блока
значение =
maxRetailPrice*количество штук в
блоке. При отсутствии информации в
БД выводится значение NULL
5.9. Метод проверки КИ ТГ "Табачная продукция" на
вхождение в "серую зону"
Метод возвращает информацию по заданному списку кодов о принадлежности кодов к серой
зоне, для транспортных и потребительских упаковок - о наличии кодов из серой зоны в их
составе.
Возвращаемые параметры "gzPacks" и "gzBlocks" - это расчётные единицы для агрегатов,
которые считаются на основании разницы физической ёмкости упаковки и указанных при
агрегировании кодов, т.е. это потенциальное число блоков и пачек, которые могут находится в
"Серой зоне" в данной упаковке. Признак "Серой зоны" для пачки/блока проставляется на
основании отчёта от производителя. "gzBlocks" - расчётное суммарное число пачек в серой зоне,
которые находится в серой зоне. Значение для короба считается как сумма всех "gzPacks" и
"gzPacks", умноженное на
10. Отрицательное значение свидетельствует об ошибке в
421
предоставленных данных. Для исправление следует предоставить полные исправленные данные
по агрегату.
Тип приватности: публичный.
URL: /cises/gz/info
Метод: POST
Пример запроса:
curl -X POST "<url стенда>/cises/gz/info"
-H "Authorization: Bearer <ТОКЕН>"
-H "accept: application/json"
-H "Content-Type: application/json"
--data-raw ["000000462106549pJu6lt"]
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
codes
array
+
Массив кодов
Массив не пустой, допускается получение
[string]
идентификации
от 1 до 1000 элементов в массиве
Пример ответа:
[
{
"info": {
"code": "string",
"packageType": "UNIT",
"inGrayZone": true,
"applicationDate": "2020-09-04T08:09:34.484Z",
"containsGrayCodes": true,
"aggCount": 0,
"gzPacks": 0,
"gzBlocks": 0
},
"errorMessage": "string",
"errorCode": "string"
}
]
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
code
string
+
Код
идентификации
packageType
string
+
Тип упаковки
Справочник "Типы упаковки"
422
Параметр
Тип
Обяз.
Описание
Комментарий
inGrayZone
boolean
-
Фактическая
Возможные значения:
принадлежность
true, если пачка в серой зоне;
кода к серой зоне,
false, если пачка не в серой зоне
заполняется
только для пачек
applicationDa
string
-
Дата нанесения
Формат: yyyy-MM-ddTHH:mm:ss.SSS’Z.
te
(date-
Возвращается, если "inGrayZone"
time)
("Фактическая принадлежность кода к
серой зоне") = true
containsGray
boolean
-
Наличие
true - в составе агрегата есть серые коды;
Codes
расчетных серых
false - в составе агрегата нет серых кодов
кодов в составе
агрегата
aggCount
number
-
Количество
Заполняется только для агрегатов, если
вложений
"containsGrayCodes" ("Наличие расчетных
нижестоящего
серых кодов в составе агрегата") = true
уровня в агрегате
gzPacks
number
-
Расчетное
Заполняется только для агрегатов, если
суммарное число
"containsGrayCodes" ("Наличие расчетных
пачек серой зоне
серых кодов в составе агрегата") = true
gzBlocks
number
-
Расчетное
Заполняется только для агрегатов, если
суммарное число
"containsGrayCodes" ("Наличие расчетных
блоков в коробе в
серых кодов в составе агрегата") = true
серой зоне
errorCode
string
-
Код ошибки
См. Справочник "Статусы ответов"
Параметр указывается при наличии
ошибки
errorMessage
string
-
Сообщение об
См. Справочник "Статусы ответов"
ошибке
Параметр указывается при наличии
ошибки
6. Работа с документами и чеками в ГИС МТ
6.1. Метод получения списка загруженных документов в
ГИС МТ
Рекомендуется использовать версию v4, версия v3 в дальнейшем будет снята с поддержки.
Описание версии v3 приведено после описания версии v4.
6.1.1. Версия v4
URL: /doc/list
Тип приватности: приватный
Метод: GET
423
Запрос:
curl "<url стенда v4>/doc/list?dateFrom=2019-06-13T11%3A59%3A53.570Z&dateTo=2021-12-
13T11%3A59%3A53.570Z&did=cc79fbd8-5b12-4d98-b7ca-
c38ee4c92fa9&documentFormat=MANUAL&documentStatus=
IN_PROGRESS%2CCHECKED_OK%2CCHECKED_NOT_OK&documentType=LP_ACCEPT_GOODS%2COST_DESCRIPTI
ON&inputFormat=false&limit=10&number=be1edfc3-9308-4274-8248-
4c91fedc035f&order=ASC&orderColumn=receivedAt&orderedColumnValue=2020-06-
07T15:34:01.980Z&pageDir=PREV&participantInn=1901089824&pg=lp"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
dateFrom
(date-
-
Дата документа,
Задаётся в формате yyyy-MM-
time)
от
ddTHH:mm:ss.SSS’Z
dateTo
(date-
-
Дата документа,
Задаётся в формате yyyy-MM-
time)
до
ddTHH:mm:ss.SSS’Z
did
string
-
Значение номера
Использовать только совместно с
документа, по
параметром "orderedColumnValue"
которому
("Значение столбца, "точки отсчета"
сортируются
(запись, с которой начинается выборка),
записи ("точка
по которому сортируются записи"). При
отсчёта" - запись,
указании данного параметра необходимо
с которой
указать параметр "pg" ("Товарная группа")
начнётся
выборка)
documentFor
string
-
Тип документа
Возможные значения:
mat
"MANUAL" - формат JSON;
"UPD" - ЭДО;
"XML" - формат XML;
"CSV" - формат CSV
documentStat
string
-
Статус документа
См. "Справочник "Статусы документов""
us
documentTyp
[string]
-
Тип документа
Cм. "Справочник "Типы документов""
e
inputFormat
boolean
-
Признак того, что
Возможные значения:
документ
"true" - входящий;
является
"false" - исходящий
входящим/исходя
щим
limit
integer
-
Значение
Не более 10000 записей, по умолчанию 20
устанавливает
записей
количество
записей в ответе
424
Параметр
Тип
Обяз.
Описание
Комментарий
number
string
-
Номер документа
При указании данного параметра,
параметр "did" ("Значение номера
документа, по которому сортируются
записи ("точка отсчёта" - запись, с которой
начнётся выборка)") будет игнорироваться
order
enum
-
Направление
Возможные значения:
сортировки
"ASC" - по возрастанию;
"DESC" - по убыванию
orderColumn
string
-
Название столбца,
Допустимое значение: "receivedAt" ("Дата
по которому будет
эмиссии")
производиться
сортировка
orderedColum
string
-
Значение столбца,
Параметр обязательный при указании
nValue
"точки отсчёта"
параметра "did", в других случаях
(запись, с которой
параметр неприменим
начинается
выборка), по
которому
сортируются
записи
pageDir
enum
-
Выбор
Возможные значения:
направления
"PREV" - предыдущий раздел;
"NEXT" - следующий раздел
participantInn
string
-
ИНН участника,
осуществившего
эмиссию КМ
pg
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп"".
Параметр обязательно указывать при
установке параметров "limit" ("Значение
устанавливает количество записей в
ответе") или "did" ("Значение номера
документа, по которому сортируются
записи ("точка отсчёта" - запись, с которой
начнётся выборка)").
Параметр обязателен для товарных групп:
"milk" - "Молочная продукция";
"water" - "Упакованная вода";
"tobacco" - "Табачная продукция";
"otp" - "Альтернативная табачная
продукция"
senderInn
string
-
ИНН отправителя
Обязательный, если нет "receiverInn"
документа
("ИНН получателя документа")
425
Параметр
Тип
Обяз.
Описание
Комментарий
receiverInn
string
-
ИНН получателя
Обязательный, если нет "senderInn"
документа
("ИНН отправителя документа")
В запросе должен быть указан хотя бы один параметр, иначе в ответе возвращается ошибка 400
"Bad request" (Ошибка в параметрах запроса).
Пример ответа:
{
"results":[
{
"number":"00bec0ce-000b-0ad0-a000-a0ef000000c0",
"docDate":"2021-06-11T08:15:26.748Z",
"receivedAt":"2021-06-11T08:15:26.748Z",
"type":"LP_SHIP_GOODS",
"status":"ACCEPTED",
"senderInn":"0000000000",
"senderName":"string",
"receiverInn":"1111111111",
"receiverName":"string",
"invoiceNumber":null,
"relatedDocId":"b0af00ca-000d-0e00-a0b0-0b000000a0e0",
"downloadDesc":"",
"input":false,
"errors":null,
"productGroup":[
"lp"
],
"productGroupId":[
1
]
}
],
"nextPage":true
}
Пример ответа с ошибкой:
426
{
"results":[
{
"number":"d0f00f00-eed0-0f0f-a00a-0cf0d0cdae0e",
"docDate":"2021-06-11T10:52:41.925Z",
"receivedAt":"2021-06-11T10:52:41.925Z",
"type":"LK_APPLIED_KM_CANCELLATION_XML",
"status":"CHECKED_NOT_OK",
"senderInn":"0000000000",
"senderName":"string",
"receiverInn":null,
"receiverName":null,
"invoiceNumber":null,
"relatedDocId":null,
"downloadDesc":"47: Одновременное заполнение полей [КИТУ, КИ] в документе
\"Списание КМ\" недопустимо.",
"input":false,
"errors":[
"47: Одновременное заполнение полей [КИТУ, КИ] в документе \"Списание КМ\"
недопустимо."
],
"productGroup":[
"lp"
],
"productGroupId":[
1
]
}
],
"nextPage":true
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
object
+
*number
string
+
ID документа
Полное наименование файла УД
*docDate
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
документа
ddTHH:mm:ss.SSS’Z. ДатаСЧФ для УПД,
time)
УПД(и), ДатаКСЧФ для УКД, УКД(и) по
структуре XML-схемы
*receivedAt
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’Z
time)
документа
*type
string
+
Тип документа
См. "Справочник "Типы документов""
427
Параметр
Тип
Обяз.
Описание
Комментарий
*status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
*senderInn
string
+
ИНН отправителя
документа
*senderName
string
-
Наименование
отправителя
документа
*receiverInn
string
-
ИНН получателя
документа
*receiverNam
string
-
Наименование
e
получателя
документа
*invoiceNum
string
-
НомерСЧФ для
ber
УПД, УПД(и),
НомерКСЧФ для
УКД, УКД(и) по
структуре XML-
схемы
*downloadDe
string
+
Описание
При наличии ошибки в загрузке
sc
загрузки
документа. См. "Справочник "Статусы
документа
ответов""
*input
boolean
-
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
*errors
string
-
Ошибки
Значение параметра возвращается при
наличии ошибки
*productGrou
array of
+
Наименование
Наименование товарной группы
p
string
товарной группы
соответствует указанной в запросе (см.
"Справочник "Список поддерживаемых
товарных групп"")
*productGrou
array of
+
Идентификатор
Идентификатор товарной группы
pId
integer
товарной группы
соответствует указанной в запросе (см.
участника
"Справочник "Список поддерживаемых
оборота товаров
товарных групп"")
nextPage
boolean
+
Признак наличия
Возможные значения:
следующей
true - имеется следующая страница;
страницы
false - следующая страница отсутствует
Примечание: в ответе возвращаются все перечисленные параметры. При отсутствии значения
обязательных параметров в ответе возвращается "null".
428
6.1.2. Версия v3
URL: /doc/listV2
Тип приватности: приватный
Метод: GET
Запрос:
curl "<url стенда v3>/doc/listV2?dateFrom=2019-06-13T11%3A59%3A53.570Z&dateTo=2021-12-
13T11%3A59%3A53.570Z&did=cc79fbd8-5b12-4d98-b7ca-
c38ee4c92fa9&documentFormat=MANUAL&documentStatus=
IN_PROGRESS%2CCHECKED_OK%2CCHECKED_NOT_OK&documentType=LP_ACCEPT_GOODS%2COST_DESCRIPTI
ON&inputFormat=false&limit=10&number=be1edfc3-9308-4274-8248-
4c91fedc035f&order=ASC&orderColumn=DATE&orderedColumnValue=2020-06-
07T15:34:01.980Z&pageDir=PREV&pg=lp"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
dateFrom
(date-
-
Дата документа,
Задаётся в формате yyyy-MM-
time)
от
ddTHH:mm:ss.SSS’Z
dateTo
(date-
-
Дата документа,
Задаётся в формате yyyy-MM-
time)
до
ddTHH:mm:ss.SSS’Z
did
string
-
Значение номера
Параметр обязательный при указании
документа, по
параметра "orderedColumnValue"
которому
("Значение столбца, "точки отсчета"
сортируются
(запись, с которой начинается выборка),
записи ("точки
по которому сортируются записи")
отсчёта" - запись,
с которой
начнётся
выборка)
documentFor
string
-
Тип документа
Возможные значения:
mat
MANUAL - формат JSON;
UPD - ЭДО;
XML - формат XML;
CSV - формат CSV
documentStat
[string]
-
Статус документа
См. "Справочник "Статусы документов""
us
documentTyp
[string]
-
Тип документа
Cм. "Справочник "Типы документов""
e
429
Параметр
Тип
Обяз.
Описание
Комментарий
inputFormat
boolean
-
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
limit
integer
-
Значение
Не более 10000 записей, по умолчанию 20
устанавливает
записей. При указании данного параметра
количество
необходимо указать товарную группу
записей в ответе
number
string
-
Номер документа
order
enum
-
Направление
Возможные значения:
сортировки
ASC - по возрастанию;
DESC - по убыванию
orderColumn
string
-
Название столбца,
Допустимые значения:
по которому будет
"receivedAt" - дата приёма/обработки
производиться
документа в ГИС МТ;
сортировка
"docDate" - дата документа ЭДО
orderedColum
string
-
Значение столбца,
nValue
"точки отсчёта"
(запись, с которой
начинается
выборка), по
которому
сортируются
записи
pageDir
enum
-
Выбор
Возможные значения:
направления
PREV - предыдущий раздел;
NEXT - следующий раздел
pg
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп"".
Параметр обязательно указывать при
установке параметра "limit" ("Значение
устанавливает количество записей в
ответе").
Параметр обязателен для товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода";
tobacco - "Табачная продукция";
otp - "Альтернативная табачная
продукция"
senderInn
string
-
ИНН отправителя
Обязательный, если нет "receiverInn"
документа
("ИНН получателя документа")
receiverInn
string
-
ИНН получателя
Обязательный, если нет "senderInn"
документа
("ИНН отправителя документа")
430
В запросе должен быть указан хотя бы один параметр, иначе в ответе возвращается ошибка 400
"Bad request" (Ошибка в параметрах запроса).
Пример ответа:
{
"results":[
{
"number":"string",
"docDate":"2021-11-23T12:07:02.985Z",
"receivedAt":"2021-11-23T12:07:02.985Z",
"type":"string",
"status":"string",
"externalId":"string",
"senderInn":"string",
"senderName":"string",
"receiverInn":"string",
"receiverName":"string",
"invoiceNumber":"string",
"invoiceDate":"2021-11-23T12:07:02.985Z",
"total":0,
"vat":0,
"downloadStatus":"string",
"downloadDesc":"string",
"relatedDocId":"string",
"body":{
"additionalProp1":{},
"additionalProp2":{},
"additionalProp3":{}
},
"content":"string",
"input":true,
"pdfFile":"string",
"errors":[
"string"
],
"docErrors":[
{
"additionalProp1":{},
"additionalProp2":{},
"additionalProp3":{}
}
],
"errorMessage":"string",
"errorMessages":[
"string"
],
"atk":"string",
"sender":{
"name":"string",
"address":"string",
431
"inn":"string",
"kpp":"string"
},
"receiver":{
"name":"string",
"address":"string",
"inn":"string",
"kpp":"string"
},
"productGroup":"string",
"productGroupId":0
}
],
"total":0
}
Примеры ответа в случае ошибок:
1.В случае ошибки 400 (при ошибках в параметрах фильтра):
{
"error_message": "string"
}
2.В случае ошибки 401:
{
"error_message": "Для доступа к этому ресурсу требуется полная аутентификация"
}
3.В случае ошибки 500:
{
"error_message": "Ошибка при выполнении запроса"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
object
+
*number
string
+
ID документа
Полное наименование файла УД
*docDate
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
документа
ddTHH:mm:ss.SSS’Z. ДатаСЧФ для УПД,
time)
УПД(и), ДатаКСЧФ для УКД, УКД(и) по
структуре XML-схемы
432
Параметр
Тип
Обяз.
Описание
Комментарий
*receivedAt
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’Z
time)
документа
*type
string
+
Тип документа
См. "Справочник "Типы документов""
*status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
*externalId
string
+
ID документа во
внешней системе
ЭДО
*senderInn
string
+
ИНН отправителя
документа
*senderName
string
-
Наименование
отправителя
документа
*receiverInn
string
-
ИНН получателя
документа
*receiverNam
string
-
Наименование
e
получателя
документа
*invoiceNum
string
-
НомерСЧФ для
ber
УПД, УПД(и),
НомерКСЧФ для
УКД, УКД(и)
*invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z
time)
*total
number
-
Общая сумма
документа
*vat
number
-
Сумма НДС
документа
*downloadSta
string
+
Статус загрузки
См. "Справочник "Статусы документов""
tus
документа
*downloadDe
string
+
Описание
При наличии ошибки в загрузке
sc
загрузки
документа. См. "Справочник "Статусы
документа
ответов""
*relatedDocId
string
-
ID документа
Возвращается для документа "Приемка"
отгрузки
*body
object
+
Тело документа в
формате json
433
Параметр
Тип
Обяз.
Описание
Комментарий
*content
string
+
Содержимое
документа в
исходном формате
*input
boolean
-
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
*pdfFile
string
-
Ссылка на файл в
формате * .pdf
*errors
[string]
-
Ошибки
Значение параметра возвращается при
наличии ошибки
*docErrors
[string]
-
Список ошибок
обработки
документа
*errorMessag
string
-
Сообщение об
Параметр возвращается при наличии
e
ошибке при
ошибки только для УД документов (общее
обработке
описание ошибки по документу)
документа в
формате JSON,
XML
*errorMessag
[string]
-
Список
Параметр возвращается при наличии
es
сообщений об
ошибок
ошибке при
обработке самого
документа
*atk
string
-
Агрегированный
таможенный код
*sender
string
-
Отправитель
**name
string
-
Наименование
отправителя
**address
string
-
Адрес
отправителя
**inn
string
-
ИНН отправителя
**kpp
string
-
КПП отправителя
*receiver
string
-
Получатель
**name
string
-
Наименование
получателя
**address
string
-
Адрес получателя
**inn
string
-
ИНН получателя
**kpp
string
-
КПП получателя
434
Параметр
Тип
Обяз.
Описание
Комментарий
*productGrou
string
-
Наименование
Наименование товарной группы
p
товарной группы
соответствует указанной в запросе (см.
"Справочник "Список поддерживаемых
товарных групп""). Если в документе
указано несколько товарных групп,
вернётся только одно значение. Если в
документе не указана товарная группа,
данный параметр не возвращается
*productGrou
integer
-
Идентификатор
Идентификатор товарной группы
pId
товарной группы
соответствует указанной в запросе (см.
участника
"Справочник "Список поддерживаемых
оборота товаров
товарных групп""). Если в документе
указано несколько товарных групп,
вернётся только одно значение. Если в
документе не указана товарная группа,
данный параметр не возвращается
Примечание: в ответе возвращаются все перечисленные параметры. При отсутствии значения
обязательных параметров в ответе возвращается "null".
6.2. Метод получения списка загруженных чеков ККТ в ГИС
МТ
Рекомендуется использовать версию v4, версия v3 в дальнейшем будет снята с поддержки.
Описание версии v3 приведено после описания версии v4.
6.2.1. Версия v4
Тип приватности: приватный
URL: /receipt/list
Метод: GET
Пример запроса:
curl -X GET "<url стенда v4>/api/v4/true-
api/receipt/list?dateFrom=string&dateTo=string&did=string&limit=0&order=string&pageDir
=PREV&senderInn=string&pg=string" \
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
435
Параметр
Тип
Обяз.
Описание
Комментарий
number
string
-
Номер чека
При указании данного параметра
параметр "did" ("Значение номера
документа, по которому сортируются
записи") будет игнорироваться
dateFrom
(date-
-
Дата документа,
Формат: yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
от
dateTo
(date-
-
Дата документа,
Формат: yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
до
did
string
-
Идентификатор
Используется только вместе с параметром
чека
"orderedColumnValue" ("Значение столбца,
по которому сортируются записи ("точки
отсчёта" - запись, с которой начинается
выборка)"). При указании данного
параметра необходимо указать параметр
"pg" ("Товарная группа")
limit
integer
-
Значение
Не более 1000 записей, по умолчанию 10
устанавливает
записей. При указании данного параметра
количество
необходимо указать параметр "pg"
записей в ответе
("Товарная группа")
order
enum
-
Направление
Возможные значения:
сортировки
"ASC" - по возрастанию;
"DESC" - по убыванию
orderColumn
string
-
Название столбца,
Возможное значение: "receivedAt" ("Дата
по которому будет
эмиссии")
производиться
сортировка
orderedColum
string
-
Значение столбца,
При указании данного параметра
nValue
по которому
параметр "did" ("Значение номера
сортируются
документа, по которому сортируются
записи ("точки
записи") становится обязательным
отсчёта" - запись,
с которой
начинается
выборка)
pageDir
enum
-
Выбор
Возможные значения:
направления
"PREV" - предыдущий раздел;
"NEXT" - следующий раздел
Данный параметр является обязательным
для товарных групп "Альтернативная
табачная продукция", "Табачная
продукция" при указании параметров
"orderedColumnValue" ("Значение столбца,
по которому сортируются записи"), "did"
("Значение номера документа, по
которому сортируются записи")
436
Параметр
Тип
Обяз.
Описание
Комментарий
senderInn
string
-
ИНН отправителя
чека
pg
string
+
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп"".
Параметр является обязательным при
установке "limit" ("Количество записей в
ответе").
Параметр обязателен для товарных групп:
"milk" - "Молочная продукция";
"water" - "Упакованная вода";
"tobacco" - "Табачная продукция";
"otp" - "Альтернативная табачная
продукция"
В запросе должен быть указан хотя бы один параметр, иначе в ответе возвращается ошибка 400
"Bad request" (Ошибка в параметрах запроса).
Пример ответа:
{
"results":[
{
"did":"000000000000000000",
"receiptDate":"2021-04-01T14:14:26.000Z",
"receivedAt":"2021-04-01T14:14:28.276Z",
"type":"RECEIPT",
"status":"CHECKED_NOT_OK",
"senderInn":"7731369928",
"senderName":"string",
"productGroup":[
"tobacco"
],
"productGroupId":[
3
]
}
],
"nextPage":true
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
array of
+
Результат запроса
objects
437
Параметр
Тип
Обяз.
Описание
Комментарий
did
string
+
Значение номера
документа, по
которому
сортируются
записи ("точки
отсчёта" - запись,
с которой
начнётся
выборка)
receiptDate
string
+
Дата вывода из
Возвращается в формате yyyy-MM-
(date-
оборота
ddTHH:mm:ss.SSS’Z
time)
receivedAt
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’Z
time)
документа
type
string
-
Тип документа
Возможные значения:
RECEIPT - чек;
RECEIPT_RETURN - чек возврата
status
string
-
Статус обработки
Cм. "Справочник "Статусы документов""
документа
senderInn
string
-
ИНН отправителя
документа
senderName
string
-
Наименование
отправителя
receiverInn
string
-
ИНН получателя
receiverName
string
-
Наименование
получателя
productGroup
array of
+
Товарная группа
Наименование товарной группы
string
соответствует указанной в запросе (см.
"Справочник "Список поддерживаемых
товарных групп"")
productGroup
array of
+
Идентификатор
Идентификатор товарной группы
Id
integer
товарной группы
соответствует указанной в запросе (см.
(int64)
участника
"Справочник "Список поддерживаемых
оборота товаров
товарных групп"")
nextPage
boolean
+
Признак наличия
Возможные значения:
следующей
true - имеется следующая страница;
страницы
false - следующая страница отсутствует
Примечание: в ответе возвращаются все перечисленные параметры. При отсутствии значения
обязательных параметров в ответе возвращается "null".
438
6.2.2. Версия v3
URL: /receipt/listV2
Тип приватности: приватный
Метод: GET
Запрос:
curl -X GET "<url стенда v3>/receipt/listV2?dateFrom=2020-03-
01T17%3A47%3A49.000Z&dateTo=2020-07-
31T17%3A47%3A49.000Z&did=111656675222335054&limit=10&order=ASC&pageDir=PREV&senderInn=
7809008119&pg=tobacco"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
dateFrom
string(da
-
Дата документа,
Формат: yyyy-MM-ddTHH:mm:ss.SSS’Z
te-time)
от
dateTo
string(da
-
Дата документа,
Формат: yyyy-MM-ddTHH:mm:ss.SSS’Z
te-time)
до
did
string
-
Значение номера
документа, по
которому
сортируются
записи ("точки
отсчёта" - запись,
с которой
начнётся
выборка)
limit
integer
-
Значение
Не более 10000 записей, по умолчанию 10
устанавливает
записей. При указании данного параметра
количество
необходимо указать товарную группу
записей в ответе
order
enum
-
Направление
Возможные значения:
сортировки
ASC - по возрастанию;
DESC - по убыванию
pageDir
enum
-
Выбор
Возможные значения:
направления
PREV - предыдущий раздел;
NEXT - следующий раздел
senderInn
string
-
ИНН отправителя
документа
439
Параметр
Тип
Обяз.
Описание
Комментарий
pg
string
-
Товарная группа
Параметр обязателен для товарных групп:
milk - Молочная продукция;
water - Упакованная вода;
tobacco - Табачная продукция;
otp - Альтернативная табачная продукция
Пример ответа:
[
{
"did":"string",
"receiptDate":"2020-09-09T16:10:20.538Z",
"type":"string",
"status":"string",
"senderInn":"string",
"senderName":"string",
"total":0
}
]
Примеры ответа в случае ошибок:
1.В случае ошибки 400 (при ошибках в параметрах фильтра):
{
"error_message": "string"
}
2.В случае ошибки 401:
{
"error_message": "Для доступа к этому ресурсу требуется полная аутентификация"
}
3.В случае ошибки 500:
{
"error_message": "Ошибка при выполнении запроса"
}
Параметры ответа:
440
Параметр
Тип
Обяз.
Описание
Комментарий
did
string
-
Значение номера
документа, по
которому
сортируются
записи ("точки
отсчёта" - запись,
с которой
начнётся
выборка)
receiptDate
string
+
Дата вывода из
Возвращается в формате yyyy-MM-
(date-
оборота
ddTHH:mm:ss.SSS’Z
time)
type
string
+
Тип документа
Возможные значения:
RECEIPT - чек;
RECEIPT_RETURN - чек возврата
status
enum
+
Статус обработки
См. "Справочник "Статусы документов""
документа
senderInn
string
-
ИНН отправителя
документа
senderName
string
+
Отправитель
total
integer
+
Общее
количество
значений,
подходящие под
параметры
фильтрации
6.3. Метод получения содержимого документа по
идентификатору
Для товарной группы "Духи и туалетная вода" метод возвращает в ответе только КИ из тела
документа (см. "Справочник "Типы документов"") без отражения информации о КИ дочерних
вложений, входящих в состав агрегирующих КИ: параметры "count_children" и "children" в
ответе остаются скрытыми.
Рекомендуется использовать версию v4, версия v3 в дальнейшем будет снята с поддержки.
Описание версии v3 приведено после описания версии v4.
6.3.1. Версия v4
URL: /doc/{docId}/info
Тип приватности: приватный
Метод: GET
Пример запроса:
441
curl -X GET "<url стенда v4>/doc/f111111e-11fa-11d1-111d-
1cf1c1f1111c/info?pg=3&limit=15"
-H "accept: application/json"
-H "Authorization: Bearer <Токен>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
docId
string
+
ID документа,
формируемый в
ГИС МТ
body
boolean
-
Признак
Возможные значения:
необходимости в
теле ответа
содержимого чека
true - содержимое отправленного чека
возвращается в ответе метода;
false - содержимое отправленного чека не
возвращается в ответе метода. Значение
по умолчанию = false
content
boolean
-
Признак
Возможные значения:
необходимости
контента чека в
теле ответа
true - контент чека возвращается в ответе
метода;
false - контент чека не возвращается в
ответе метода. Значение по умолчанию =
false
limit
integer
-
Значение
При указании данного параметра
устанавливает
необходимо указать товарную группу
количество
записей в ответе
(не более 10 000
записей, по
умолчанию 10
записей)
pg
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
Пример ответа:
442
[
{
"number":"f111111e-11fa-11d1-111d-1cf1c1f1111c",
"docDate":"2021-06-02T09:01:11.265Z",
"receivedAt":"2021-06-02T09:01:11.265Z",
"type":"LP_ACCEPT_GOODS",
"status":"CHECKED_OK",
"senderInn":"0000000000",
"senderName":"string",
"receiverInn":"1111111111",
"receiverName":"string",
"invoiceNumber":null,
"invoiceDate":null,
"relatedDocId":"0000f00c-000f-0bc0-a000-df0d10b1a00d",
"body":{
"additionalProp1":{
},
"additionalProp2":{
},
"additionalProp3":{
}
},
"content":"string",
"errors":null,
"productGroup":[
"shoes"
],
"productGroupId":[
2
]
}
]
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
number
string
+
ID документа
Указывается полное наименование
файла для УД
docDate
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
документа
ddTHH:mm:ss.SSS’Z
time)
receivedAt
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’Z
time)
документа
443
Параметр
Тип
Обяз.
Описание
Комментарий
type
string
+
Тип документа
См. "Справочник "Типы
документов""
status
string
+
Статус обработки
См. "Справочник "Статусы
документа
документов""
senderInn
string
+
ИНН отправителя
документа
senderName
string
+
Наименование
отправителя
документа
receiverInn
string
-
ИНН получателя
документа
receiverName
string
-
Наименование
получателя
документа
invoiceNumber
string
-
Номер счёта-
Если номер отсутствует, то
фактуры, УКД
возвращается значение "null"
invoiceDate
integer(i
-
Дата счёта-
Возвращается в формате yyyy-MM-
nt64)
фактуры, УКД
ddTHH:mm:ss.SSS’Z
relatedDocId
string
-
ID документа
Значение возвращается для
отгрузки или
документов LP_ACCEPT_GOODS
приёмки
("Приёмка") и LP_SHIP_GOODS,
LP_SHIP_GOODS_CSV,
LP_SHIP_GOODS_XML ("Отгрузка")
body
object
-
Содержимое
См. "Справочник "Типы
отправленного
документов""
чека
content
string
-
Контент чека
Содержимое отправленного
документа в формате * .json с
набором полей, специфичных для
каждого типа документа. См.
"Справочник "Типы документов""
errors
array of
-
Ошибки
Значение параметра возвращается
string
при наличии ошибки. Для УД
ошибки в ответе не возвращаются
productGroup
string
+
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп"".
Если товарная группа не была
заполнена, параметр вернётся со
значением "null"
productGroupId
array of
-
ID товарной
См. "Справочник "Список
integer
группы
поддерживаемых товарных групп""
Примечание: в ответе возвращаются все перечисленные параметры. При отсутствии значения
444
обязательных параметров в ответе возвращается "null".
Пример ответа с ошибкой:
{
"number":"0000c000-0f00-0ebb-0cbf-a000bffbcb0d",
"docDate":"2021-06-10T09:58:41.866Z",
"receivedAt":"2021-06-10T09:58:50.182Z",
"type":"LP_RETURN",
"status":"CHECKED_NOT_OK",
"senderInn":"7731376812",
"senderName":"string",
"receiverInn":null,
"receiverName":null,
"invoiceNumber":null,
"invoiceDate":null,
"relatedDocId":null,
"body":{
"return_type":"RETAIL_RETURN",
"primary_document_type":"OTHER",
"primary_document_number":"1",
"trade_participant_inn":"0000000000",
"products_list":[
{
"ki":"000000000000000000o'0E-kyhih-H0",
"primary_document_type":"OTHER",
"primary_document_custom_name":"88888",
"primary_document_number":"5",
"primary_document_date":"2021-06-10T00:00:00Z",
"certificate_date":"2021-06-10T00:00:00Z",
"gtin":"00000000000000"
}
],
"primary_document_custom_name":"1",
"primary_document_date":"2021-06-09T00:00:00Z"
},
"content":"{\"trade_participant_inn\":\"7731376812\",\"return_type\":\"RETAIL_RETURN\"
,\"primary_document_type\":\"OTHER\",\"primary_document_custom_name\":\"1\",\"primary_
document_number\":\"1\",\"primary_document_date\":\"2021-06-
09T21:00:00.000Z\",\"products_list\":[{\"ki\":\"010461605000300021o'6E-kyhih-
H4\",\"primary_document_type\":\"OTHER\",\"primary_document_number\":\"5\",\"primary_d
ocument_date\":\"2021-06-
10\",\"primary_document_custom_name\":\"88888\",\"certificate_date\":\"2021-06-
10\"}]}",
"input":true,
"errors":[
"14: Недопустимый статус кода маркировки 000000000000000000o'0E-kyhih-H0,
указанного в документе \"Возврат в оборот\"."
],
"productGroup":[
445
"shoes"
],
"productGroupId":[
2
]
}
6.3.2. Версия v3
URL: /doc/{docId}/info
Тип приватности: приватный
Метод: GET
Пример запроса:
curl -X GET "<url стенда v3>/doc/f111111e-11fa-11d1-111d-
1cf1c1f1111c/info?pg=<товарная группа>&limit=<значение>"
-H "accept: */*"
-H "Authorization: Bearer <Токен>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
docId
string
+
ID документа,
формируемый в
ГИС МТ
limit
integer
-
Значение
При указании
устанавливает
данного
количество
параметра
записей в ответе
необходимо
(не более 10 000
указать товарную
записей, по
группу
умолчанию 10
записей)
pg
string
-
Товарная группа
См. "Справочник
"Список
поддерживаемых
товарных групп""
Пример ответа:
1. В случае успеха:
1.1. Для всех товарных групп, кроме товарных групп "Альтернативная табачная продукция" и
"Табачная продукция":
{
446
"number":"string",
"docDate":"2020-04-16T09:29:01.120Z",
"receivedAt":"2020-04-16T09:29:01.120Z",
"type":"UNKNOWN",
"status":"string",
"externalId":"string",
"senderInn":"string",
"senderName":"string",
"receiverInn":"string",
"receiverName":"string",
"invoiceNumber":"string",
"invoiceDate":"2020-04-16T09:29:01.120Z",
"total":0,
"vat":0,
"downloadStatus":"string",
"downloadDesc":"string",
"body":{
"additionalProp1":{
},
"additionalProp2":{
},
"additionalProp3":{
}
},
"content":"string",
"input":true,
"pdfFile":"string",
"errors":[
"string"
],
"docErrors":[
{
"additionalProp1":{
},
"additionalProp2":{
},
"additionalProp3":{
}
}
],
"sender":{
"name":"string",
"address":"string",
"inn":"string",
"kpp":"string"
447
},
"receiver":{
"name":"string",
"address":"string",
"inn":"string",
"kpp":"string"
}
}
1.2. Для товарных групп "Альтернативная табачная продукция" и "Табачная продукция":
{
"number":"string",
"docDate":"2020-05-27T17:18:45.144Z",
"receivedAt":"2020-05-27T17:18:45.144Z",
"type":"UNKNOWN",
"status":"IN_PROGRESS",
"externalId":"string",
"senderName":"string",
"receiverName":"string",
"invoiceNumber":"string",
"invoiceDate":"2020-05-27T17:18:45.144Z",
"total":0,
"vat":0,
"downloadStatus":"string",
"downloadDesc":"string",
"body":{
"additionalProp1":{
},
"additionalProp2":{
},
"additionalProp3":{
}
},
"content":"string",
"input":true,
"pdfFile":"string",
"errors":[
"string"
]
}
2. В случае ошибок:
2.1. Код 400:
448
{
"error_message":"Ошибка получения тела документа"
}
2.2. Код 401:
{
"error_message":"Для доступа к этому ресурсу требуется полная аутентификация"
}
2.3. Код 404:
{
"error_message":"Документ с указанным идентификатором не найден"
}
2.4. Код 500:
{
"error_message":"Ошибка при выполнении запроса"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
number
string
-
Номер документа
docDate
string
-
Дата и время
Возвращается в формате yyyy-MM-
(date-
документа
ddTHH:mm:ss.SSS’Z
time)
receivedAt
string
-
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’Z
time)
документа
type
string
-
Тип документа
См. "Справочник "Типы
документов""
status
string
+
Статус обработки
См. "Справочник "Статусы
документа
документов""
externalId
string
-
ID документа во
внешней системе
ЭДО
senderInn
string
-
ИНН отправителя
документа
449
Параметр
Тип
Обяз.
Описание
Комментарий
senderName
string
-
Наименование
отправителя
документа
receiverInn
string
-
ИНН получателя
документа
receiverName
string
-
Наименование
получателя
документа
invoiceNumber
string
-
Номер счёта-
фактуры, УКД
invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z
time)
total
number
-
Общая сумма
документа
vat
number
-
Сумма НДС
документа
downloadStatus
string
-
Статус загрузки
См. "Справочник "Статусы
документа
документов""
downloadDesc
string
-
Описание
загрузки
документа
body
object
+
Тело документа
content
string
+
Содержимое
Содержимое отправленного
документа
документа в формате * .json с
набором полей, специфичных для
каждого типа документа. См.
"Справочник "Типы документов""
input
boolean
-
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
pdfFile
string
-
Ссылка на файл в
формате * .pdf
errors
[string]
-
Ошибки
Значение параметра возвращается
при наличии ошибки. Если ошибки
отсутствуют, то возвращается
значение "null". Для УД ошибки в
ответе не возвращаются
450
Параметр
Тип
Обяз.
Описание
Комментарий
docErrors
[string]
-
Список ошибок
обработки
документа
sender
string
-
Отправитель
Возвращается только для УД
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
receiver
string
-
Получатель
Возвращается только для УД
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
Примечание: в ответе возвращаются все перечисленные параметры. При отсутствии значения
обязательных параметров в ответе возвращается "null".
6.4. Метод получения содержимого чека ККТ по
идентификатору
Получение ошибок по чекам доступно в "Метод получения квитанции результата обработки чека
по идентификатору чека".
Рекомендуется использовать версию v4, версия v3 в дальнейшем будет снята с поддержки.
Описание версии v3 приведено после описания версии v4.
6.4.1. Версия v4
URL: /receipt/{receiptId}/info
Тип приватности: приватный
Метод: GET
Пример запроса:
curl -X GET "<url стенда v4>/receipt/1/info"
-H "accept: */*"
-H "Authorization: Bearer <Токен>"
Параметры запроса:
451
Параметр
Тип
Обяз.
Описание
Комментарий
pg
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
body
boolean
-
Признак
Возможные значения:
необходимости в
теле ответа
содержимого чека
true - содержимое отправленного чека
возвращается в ответе метода;
false - содержимое отправленного чека не
возвращается в ответе метода. Значение
по умолчанию = false
content
boolean
-
Признак
Возможные значения:
необходимости
контента чека в
теле ответа
true - контент чека возвращается в ответе
метода;
false - контент чека не возвращается в
ответе метода. Значение по умолчанию =
false
Пример ответа:
[
{
"documentId":"0000000000000000000",
"docDate":"2021-06-06T19:31:00.000Z",
"receivedAt":"2021-06-06T16:32:13.165Z",
"type":"RECEIPT",
"status":"CHECKED_OK",
"senderInn":"7731376812",
"senderName":"string",
"senderKpp":"888888888",
"total":10000000,
"vat":10000000,
"body":{
"receipt":{
"ofdINN":"0000000000",
"indicationfiscalSign":0,
"code":3,
"retailAddress":"Not Found",
"items":[
{
"productCode":"FSAEYCSvpmxzVylyVnBNWWNlPEgh",
"name":"string",
"price":10000000,
"quantity":1,
"nds":1,
"productType":1,
"paymentType":4,
452
"sum":10000000
}
],
"fiscalDriveNumber":"0000000000000000",
"kktRegId":"0000000001030895
",
"userInn":"0000000000 ",
"fiscalDocumentNumber":240,
"dateTime":1581535860,
"shiftNumber":45,
"requestNumber":3,
"operationType":1,
"totalSum":10000000,
"operator":"Администратор",
"nds18":1666667,
"user":"string",
"taxationType":1,
"fnsSiteUrl":"nalog.ru",
"cashTotalSum":10000000,
"ecashTotalSum":0,
"prepaidSum":0,
"creditSum":0,
"provisionSum":0,
"fiscalDocumentFormatVer":2
}
},
"content":"{\"receipt\":{\"ofdINN\":\"7802870820\",\"indicationfiscalSign\":0,\"code\"
:3,\"retailAddress\":\"Not
Found\",\"items\":[{\"productCode\":\"FSAEYCSvpmxzVylyVnBNWWNlPEgh\",\"name\":\"БОТИНК
И ДЛЯ
ДЕТЕЙ\",\"price\":10000000,\"quantity\":1,\"nds\":1,\"productType\":1,\"paymentType\":
4,\"sum\":10000000}],\"fiscalDriveNumber\":\"9999078902004391\",\"kktRegId\":\"0000000
001030895
\",\"userInn\":\"7731376812
\",\"fiscalDocumentNumber\":240,\"dateTime\":1581535860,\"shiftNumber\":45,\"requestNu
mber\":3,\"operationType\":1,\"totalSum\":10000000,\"operator\":\"Администратор\",\"nd
s18\":1666667,\"user\":\"ООО \\\"ОПЕРАТОР-
ЦРПТ\\\"\",\"taxationType\":1,\"fnsSiteUrl\":\"nalog.ru\",\"cashTotalSum\":10000000,\"
ecashTotalSum\":0,\"prepaidSum\":0,\"creditSum\":0,\"provisionSum\":0,\"fiscalDocument
FormatVer\":2}}",
"productGroup":null,
"productGroupId":null
}
]
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
documentId
string
+
ID чека
453
Параметр
Тип
Обяз.
Описание
Комментарий
docDate
string
+
Дата и время чека
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
receivedAt
string
+
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения чека
ddTHH:mm:ss.SSS’Z
time)
type
string
+
Тип документа
Возможные значения:
RECEIPT - чек;
RECEIPT_RETURN - чек возврата
status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
senderName
string
+
Наименование
отправителя
senderInn
string
+
ИНН отправителя
senderKpp
string
-
КПП отправителя
receiverInn
string
-
ИНН получателя
receiverName
string
-
Наименование
получателя
receiverKpp
string
-
КПП отправителя
total
integer
-
Общая сумма
Значение указывается в копейках
документа
vat
integer
-
Сумма документа
Значение указывается в копейках
с учётом НДС
body
object
-
Содержимое
См. "Справочник "Типы документов""
отправленного
чека
*receipt
object
+
Содержимое чека
**ofdINN
string
+
ИНН ОФД
**indicationfi
number
+
Признак наличия
0 - отсутствует тег 1192 или тег 1192
scalSign
реквизита ФПД
пустой в версии протокола 1.05;
1 - присутствует тег 1192, который не
является пустым.
Признак формируется ОФД и необходим
для однозначной идентификации
корректирующего чека в протоколе 1.05
относительно чека возврата
454
Параметр
Тип
Обяз.
Описание
Комментарий
**code
number
-
Код документа
Возможные значения:
для "receipt"
3 - для онлайн-ККТ;
4 - бланк строгой отчётности;
103 - для автономных ККТ.
Код документа для "bso": 4 - бланк
строгой отчётности
**retailAddre
string
-
Адрес расчётов
Если с ККТ поступил адрес, то передаётся
ss
(по ФИАС)
данный адрес, иначе адрес указывается из
отчёта о регистрации или
перерегистрации ККТ
**items
array of
-
Наименование
objects
товара
***productCo
string
-
Код продукта
de
***name
string
-
Наименование
Параметр может быть пустым (если тег
предмета расчёта
1214 = 3, а также для ИП со значение тега
1055 = {2,3,8,16,32}, при условии, что тег
1212 ≠ 1 до 01.02.2021)
***price
number
-
Цена за единицу с
Параметр может быть пустым. Если
учётом скидок и
отсутствует в ФД, то значение = -1. Если
наценок
ФД не предусматривает наличие тега, то
добавляется со значением -1
***quantity
number
-
Количество
Параметр не может быть пустым. Если
товарных позиций
отсутствует в ФД, то значение = -1
***nds
number
-
Ставка НДС
Возможные значения:
• 1 - НДС 20%;
• 2 - НДС 10%;
• 3 - НДС 20/120;
• 4 - НДС 10/110;
• 5 - НДС 0%;
• 6 - НДС не облагается
***productTy
number
-
Признак предмета
pe
расчёта
***paymentT
number
-
Признак способа
ype
расчёта
***sum
number
+
Стоимость товара
Произведение значения реквизита "Цена
с учётом скидок и
за единицу", помноженное на значение
наценок
реквизита "Количество"
***packageT
string
-
Тип упаковки
ype
***uit
string
-
Код товара
455
Параметр
Тип
Обяз.
Описание
Комментарий
***unitCount
number
-
Количество
товара, шт.
***innerUnit
number
-
Количество
Count
товара в
потребительской
упаковке, шт.
**fiscalDrive
string
-
Заводской номер
Number
фискального
накопителя
**kktRegId
string
-
Регистрационный
номер ККТ
**userInn
string
-
ИНН
(Unicode
пользователя
)
**fiscalDocu
number
-
Порядковый
mentNumber
номер ФД
**fiscalSign
string
-
Фискальный
признак
документа
**dateTime
number
-
Дата и время ФД
Реальное время по месту осуществления
расчётов. Значение возвращается в
формате Unix time
**shiftNumbe
number
-
Номер смены
r
**requestNu
number
-
Номер чека за
mber
смену
**operationT
number
-
Признак расчёта
Возможные значения:
ype
1 - приход;
2 - возврат прихода;
3 - расход;
4 - возврат расхода
**totalSum
number
-
Сумма расчёта в
рублях
**operator
number
-
Оператор
**nds0
number
-
Сумма НДС чека
**nds18
number
-
Сумма НДС чека
по ставке 20%
**user
string
-
Наименование
пользователя
456
Параметр
Тип
Обяз.
Описание
Комментарий
**taxationTy
number
-
Применяемая
Возможные значения:
pe
система
1 - ОСН;
налогообложения
2 - УСН доход;
4 - УСН доход - расход;
8 - ЕНВД;
16 - ЕСХН;
32 - патент
**fnsSiteUrl
string
-
Адрес сайта ФНС
**cashTotalS
number
-
Сумма
Не может быть пустым, если значения нет,
um
уплаченная
то равно 0
наличными в
рублях
**ecashTotal
number
-
Сумма
Не может быть пустым, если значения нет,
Sum
уплаченная
то равно 0
безналичными, в
рублях
**prepaidSu
number
-
Сумма
m
предоплаты
(авансами)
**creditSum
number
-
Сумма
постоплаты
(кредитами)
**provisionS
number
-
Сумма по
um
встречным
предоставлениям
и
**fiscalDocu
number
-
Версия формата
mentFormatV
фискальных
er
данных
content
string
-
Контент чека
productGroup
array of
-
Наименование
Возвращается список для мультитоварных
string
товарных групп
чеков в рамках одного контура (для
товарных групп "Молочная продукция",
"Предметы одежды, бельё постельное,
столовое, туалетное и кухонное",
"Табачная продукция", "Упакованная
вода").
Если товарная группа не была заполнена,
параметр вернётся со значением null
457
Параметр
Тип
Обяз.
Описание
Комментарий
productGroup
array of
-
Идентификатор
Cм. "Справочник "Список
Id
integer
товарной группы
поддерживаемых товарных групп"".
участника
Возвращается список для мультитоварных
оборота товаров
чеков в рамках одного контура (для
товарных групп "Молочная продукция",
"Предметы одежды, бельё постельное,
столовое, туалетное и кухонное",
"Табачная продукция", "Упакованная
вода")
Примечание: в ответе возвращаются все перечисленные параметры. При отсутствии значения
обязательных параметров в ответе возвращается "null".
6.4.2. Версия v3
URL: /receipt/{receiptId}/info
Тип приватности: приватный
Метод: GET
Content-Type: application/json
Пример запроса:
curl -X GET "<url стенда v3>/receipt/41009929078910011255/info?pg=3"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры тела запроса:
Параметр
Тип
Обязательность
Описание
Комментарий
receiptId
string
+
Идентификатор
чека
pg
string
-
Товарная группа
Параметр
обязательный для
товарных групп:
milk - Молочная
продукция;
water -
Упакованная вода;
tobacco -
Табачная
продукция;
otp -
Альтернативная
табачная
продукция
458
Пример ответа:
{
"fiscalDriveNumber":"string",
"kktRegId":"string",
"userInn":"string",
"user":"string",
"fiscalDocumentNumber":"string",
"fiscalSign":"string",
"shiftNumber":"string",
"operationType":"string",
"operator":"string",
"taxationTypes":[
"string"
],
"operatorTransferName":"string",
"senderAddress":"string",
"retailPlaceAddress":"string",
"senderName":"string",
"documentId":"string",
"isCash":true,
"isECash":true,
"products":[
{
"id":0,
"name":"string",
"gtin":"string",
"price":"string",
"count":0,
"packageType":"string",
"sum":"string",
"nds":"string",
"percentage":"string",
"excise":"string",
"producerId":"string",
"cis":"string",
"valid":true
}
],
"receiverInn":"string",
"senderInn":"string",
"status":"string",
"type":"string",
"documentDate":"2021-11-24T11:23:54.203Z",
"receivedAt":"2021-11-24T11:23:54.203Z"
}
Примеры ответа в случае ошибок:
1.В случае ошибки 401:
459
{
"error_message": "Для доступа к этому ресурсу требуется полная аутентификация"
}
2.В случае ошибки 404 (при неверном идентификаторе чека):
{
"error_message": "string"
}
3.В случае ошибки 500:
{
"error_message": "Ошибка при выполнении запроса"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
fiscalDriveNumber
string
-
Заводской номер
фискального
накопителя
kktRegId
string
-
Регистрационный
номер ККТ
userInn
string
-
ИНН отправителя
user
string
-
Отправитель чека
fiscalDocumentNu
string
-
Порядковый
mber
номер ФД
fiscalSign
string
-
Фискальный
признак
документа
shiftNumber
string
-
Номер смены
operationType
string
-
Тип операции
Возможные
значения:
• 1 - Приход;
•
2
- Возврат
прихода;
• 3 - Расход;
•
4
- Возврат
расхода
460
Параметр
Тип
Обяз.
Описание
Комментарий
operator
string
-
Оператор
taxationTypes
[string]
-
Система
налогооблажения
operatorTransferNa
string
-
Наименование
me
оператора по
переводу
денежных средств
senderAddress
string
-
Адрес
отправителя чека
retailPlaceAddress
string
-
Адрес места
продажи
senderName
string
-
Наименование
отправителя чека
documentId
string
-
ID чека
isCash
true
-
Признак
наличного расчета
isECash
true
-
Признак
безналичного
расчета
products
array of object
-
Массив кодов
товаров с
параметрами
*id
integer
-
ID строки
*name
string
-
Наименование
товара
*gtin
string
-
Код товара
*price
string
-
Цена за единицу
товара с учётом
скидок и наценок
*count
integer
-
Количество
товаров
*packageType
string
-
Тип упаковки
*sum
string
-
Сумма товара
461
Параметр
Тип
Обяз.
Описание
Комментарий
*nds
string
-
Ставка НДС
Возможные
значения:
• 1 - НДС 20%;
• 2 - НДС 10%;
•
3
- НДС
20/120;
•
4
- НДС
10/110;
• 5 - НДС 0%;
•
6
- НДС не
облагается
*percentage
string
-
Процент НДС
*excise
string
-
Акциз
*producerId
string
-
ID производителя
*cis
string
-
КИ
*valid
boolean
-
Признак проверки
наличия кода в
системе
receiverInn
string
-
ИНН получателя
senderInn
string
+
ИНН отправителя
status
enum
+
Статус обработки
См. "Справочник
документа
"Статусы
документов""
type
string
+
Тип документа
Cм. "Справочник
"Типы
документов""
documentDate
string (date-time)
+
Дата документа
Возвращается в
формате yyyy-
MM-
ddTHH:mm:ss.SSS
’Z
receivedAt
string (date)
-
Дата загрузки
Возвращается в
документа
формате yyyy-
MM-dd
6.5. Метод отправки документа ЭДО на повторную
обработку
Данный метод используется для отправки документа УПД, УКД, УПД(и) или УКД(и), ранее
загруженного в ГИС МТ, на повторную обработку после исправления ошибки, найденной при
462
предыдущей обработке документа. Возможна повторная загрузка следующих типов документов:
UNIVERSAL_TRANSFER_DOCUMENT,
UNIVERSAL_CORRECTION_DOCUMENT
UNIVERSAL_TRANSFER_DOCUMENT_FIX, UNIVERSAL_CORRECTION_DOCUMENT_FIX
(см. Справочник "Типы документов"). При загрузке иных типов документов будет выдана
ошибка.
После того, как документ будет отправлен и принят на повторную обработку статус документа
изменится на "IN_PROGRESS" - "Проверяется" (см. "Справочник "Статусы документов"").
Повторная обработка недоступна для документов в статусах: CHECKED_OK, CANCELLED,
PROCESSING_ERROR, IN_PROGRESS (см. "Справочник "Статусы документов"").
Документ не будет обработан повторно, если по результату его первой обработки в ГИС МТ
были зафиксированы следующие типы ошибок:
•
4
- Проверка отсутствия регистрации УД (Документ $docId не может быть повторно
обработан);
• 46 - Проверка имени файла и титулов УД (Имя или структура документа некорректны);
•
54 - Проверка заполненной даты исправления (Дата Исправления УПД(и) имеет пустое
значение или имеет неверный формат);
•
69 - Проверка кода итога приёмки товаров (работ, услуг, прав). Поле «КодИтога» Титула
Покупателя (если указан) заполнено некорректным значением;
•
71 - Проверка наличия сведений о маркированных товарах в УД. Проверка валидности УД (В
документе нет сведений о кодах идентификации маркированного товара);
• 72 - Проверка по типу документа (Некорректный тип документа: $docType);
• 76 - Проверка ID документа (Документ с id $id не найден);
•
79 - Коды идентификации имеют длину менее 18 символов либо содержат недопустимые
символы;
• 102 - Документ содержит КИ разных товарных групп;
• 103 - Документ не содержит Кодов Маркировки.
Код ошибки возвращается в параметре "code" Повторная обработка документа возможна не
ранее, чем через 4 часа.
Тип приватности: приватный.
URL: /document/reprocess
Метод: POST
Пример запроса:
curl -X POST "<url стенда>/document/reprocess?pg=2"
Content-Type: application/json
Authorization: Bearer <ТОКЕН>
Пример тела запроса:
463
{
"documentId": "string"
}
Параметры запроса
Параметр
Тип
Обяз.
Описание
Комментарий
documentId
string
+
Идентификатор
универсального
документа
(ИдФайл)
pg
string
+
Товарная группа
См. Справочник "Список
поддерживаемых товарных групп"
Пример ответа
1. В случае успеха 200
{
"code":0,
"description":"Ok",
"resultDocId":"UTXMNGR00000000000000000013-9339",
"sourceDocId":"UUD00000000000000000007-5340",
"nextTimeToReprocess":"2021-02-24T18:33:49.110Z"
}
2.В случае ошибки 401: "Для доступа к этому ресурсу требуется полная аутентификация"
{
"error": "string",
"error_description": "string"
}
Параметры ответа
Параметр
Тип
Обяз.
Описание
Комментарий
code
string
+
Уникальный код
ошибки
description
string
+
Описание кода
ошибки
sourceDocId
string
-
Внутренний
Возвращается при использовании токена с
идентификатор
правами администратора
документа в ГИС
МТ
464
Параметр
Тип
Обяз.
Описание
Комментарий
resultDocId
string
-
Внутренний
Возвращается при использовании токена с
идентификатор
правами администратора
квитанции в ГИС
МТ
nextTimeToR
(date-
-
Следующее время
Возвращается при использовании токена с
eprocess
time)
обработки
правами оператора. Значение
возвращается в UTC.
error
string
-
Код ошибки
error_descript
string
-
Описание кода
ion
ошибки
6.6. Метод подачи УПД на предварительную проверку
После подачи УПД на стороне ГИС МТ выполняются следующие действия:
• проверка регистрации продавца и покупателя УД в ГИС МТ;
• проверка валидности УД и отсутствия дублирования в ГИС МТ;
• проверка корректности КИ УД и наличия сведений о маркированных товарах в ГИС МТ;
• проверка статуса участника оборота товаров;
• проверка полномочий продавца на операции с КИ.
На проверку могут быть отправлены только документы УПД и УПДи до осуществления
приёмки продукции со стороны покупателя.
Данный метод поддерживает два типа аутентификационного токена: участника оборота товаров
и Оператора ЭДО.
Тип приватности: публичный
URL: /doc/validator/create
Метод: POST
Пример запроса:
curl -X POST "<url стенда>/doc/validator/create"
-H "accept: application/json"
-H "Content-Type: application/json"
--data-raw
"{\"id\":\"string\",\"content\":\"string\",\"documentType\":\"string\",\"documentForma
t\":\"string\"}"
Параметры запроса:
465
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа
content
string
+
Документ,
закодированный в
base64
documentType
string
+
Тип документа
Поддерживается только тип UPD
(универсальный передаточный
документ)
documentFormat
string
+
Формат
Поддерживается только формат XML
документа
Пример ответа:
1. В случае успеха.
{
"message":"string"
}
2. В случае ошибок:
2.1. Код 401: "Невалидный токен".
{
"error_message":"Текст ошибки"
}
2.2. Код 409: "Проверяемый документ находится в несуществующем статусе".
{
"error_message":"Текст ошибки"
}
2.3. Код 500: "Внутренняя ошибка сервиса".
{
"error_message":"Текст ошибки"
}
Параметры ответа:
466
Параметр
Тип
Обяз.
Описание
Комментарий
message
string
+
Сообщение о том,
В случае ошибки выводится
что подаваемый
сообщение об ошибке
документ
успешно
отправлен в ГИС
МТ
6.7. Метод получения статуса обработки документа
Метод предназначен для получения текущего статуса проверки документов УПД и УПДи,
направленных в ГИС МТ до проведения первичной отгрузки товаров. Данный метод не
используется для получения статуса проверки УКД и УКДи. В успешном ответе возвращается
параметр "status" ("Статус проверки") со значением одного из приведённых ниже кодов статусов:
Код
Описание
VERIFIED
Проверка завершена успешно
NOT_VALID
Ошибка проверки
NOT_FOUND
Не найден
IN_PROGRESS
В обработке
AWAITING
В ожидании
Данный метод поддерживает два типа аутентификационного токена: участника оборота товаров
и Оператора ЭДО.
Тип приватности: публичный
URL: /doc/validator/status
Метод: POST
Пример запроса:
curl -X POST "/api/v3/true-api/doc/validator/status"
-H "accept: application/json"
-H "Content-Type: application/json"
--data-raw "{\"id\":\"string\"}"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа
Пример ответа:
1. В случае успеха.
467
{
"status":"VERIFIED",
"description":"Успешно проверен"
}
2. В случае ошибок:
2.1. Код 401: "Невалидный токен".
{
"error_message":"Текст ошибки",
"error_description":"Описание ошибки"
}
2.2. Код 404: "Документ не найден".
{
"error_message":"Текст ошибки",
"error_description":"Описание ошибки"
}
2.3. Код 500: "Внутренняя ошибка сервера".
{
"error_message":"Текст ошибки",
"error_description":"Описание ошибки"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
status
string
+
Статус проверки
errors
string
-
Ошибка
Обязательный, если "status" ("Статус
обработки
проверки") принимает значение
документа
"NOT_VALID" ("Ошибка проверки")
*code
number
-
Код ошибки
*description
string
-
Текстовое
сообщение с
результатом
проверки
468
Параметр
Тип
Обяз.
Описание
Комментарий
*cis
string
+
КИ/КИН/КИТУ/К
Проверка вложений в
ИГУ/КИТУ
КИН/КИТ/КИГУ/КИТУ не
осуществляется. Возвращаются
КИ/КИН/КИТ/КИГУ/КИТУ (без
указания вложений), по которым
выявлены ошибки
Выполняется проверка документа на наличие ошибок (см "Описание кодов возвращаемых
ошибок при обработке документов"). Ограничение по количеству возвращаемых ошибок по
документу: 1000.
6.8. Метод получения списка КИ по номеру документа
Метод отражает КИ, которые когда-либо были в документе, включая агрегаты, на которые
повлиял данный документ. В ответе возвращается список КИ по номеру документа, указанному
в запросе.
Метод является устаревшим и в дальнейшем будет отключён. Вместо него планируется
использовать "Метод получения списка кодов идентификации и кодов товара по
идентификатору документа"
Тип приватности:
1. Приватный (только автору заказа);
2. Оператор ЦРПТ;
3. ФОИВ;
4. Администратор.
URL: /cises/doc/{docNum}
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/cises/doc/79b5d681-52af-49cd-9603-4f7a141f4764"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры заголовка запроса: Authorization: Bearer <token>
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
docNum
string
+
Номер документа
pg
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
Пример ответа:
469
{
"gtins":[
"string"
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
gtins
string
+
Список
запрашиваемых
КИ
Примеры ответа в случае ошибок
1.В случае ошибки 400: "Неизвестная товарная группа".
{
"error_message": "string"
}
2.В случае ошибки 401: "Для доступа к данному ресурсу требуется полная аутентификация".
{
"error": "string",
"error_description": "string"
}
3.В случае ошибки 500: "Ошибка при выполнении запроса".
{
"error": "string",
"error_description": "string"
}
6.9. Метод получения списка кодов идентификации и кодов
товара по идентификатору документа
Метод используется для получения списка КИ и кодов товара по ID документа, обработанного
успешно или обработанного с ошибкой. В запросе может быть указан только один ID документа.
Метод не предназначен для запроса информации по УПД и УКД. Метод возвращает до 30000 КИ
(ограничение для документов прямой подачи 30000 КИ в одном документе), верхний уровень
агрегатов не возвращается.
Метод доступен для следующих типов документов: "Списание не нанесённых КИ с/без СИ",
"Отгрузка", "Отгрузка с выводом из оборота", "Приёмка", "Ввод в оборот. Производство РФ",
470
"Ввод в оборот. Контрактное производство РФ", "Ввод в оборот. Трансграничная торговля",
"Ввод в оборот. Производство вне ЕАЭС", "Ввод в оборот. Полученных от физических лиц",
"Ввод в оборот. Импорт с ФТС", "Ввод в оборот. Маркировка остатков", "Перемаркировка",
"Расформирование", "Трансформация, "Формирование АТК", "Расформирование АТК", "Вывод
из оборота", "Возврат в оборот", "Отгрузка при трансграничной торговле", "Отгрузка из ЕАЭС с
признанием КИ", "Приёмка отгрузки из государств-членов ЕАЭС на документ "Отгрузка при
трансграничной торговле"", "Приёмка отгрузки из государств-членов ЕАЭС на документ
"Отгрузка из ЕАЭС с признанием КИ"".
URL: /doc/cises
Тип приватности: приватный
Метод: GET
Пример запроса:
curl -X GET "<url стенда v3>/doc/cises?documentId=1ff1f1f1-1111-1111-1f11-
11111111ff11&productGroup=shoes"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
documentId
string
+
ID документа
productGroup
string
+
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
Пример ответа:
{
"senderInn":"string",
"senderName":"string",
"receiverInn":"string",
"receiverName":"string",
"type":"string",
"status":"string",
"receivedAt":"2021-05-14T09:29:01.120Z",
"documentId":"string",
"turnoverType":"SELLING",
"relatedDocId":null,
"cisList":[
"0000000000000000000000000",
"1111111111111111111111111",
"2222222222222222222222222"
]
}
471
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
senderInn
string
+
ИНН отправителя
документа
senderName
string
+
Наименование
отправителя
документа
receiverInn
string
-
ИНН получателя
документа
receiverName
string
-
Наименование
получателя
документа
type
string
+
Тип документа
См. "Справочник "Типы
документов""
status
string
+
Статус обработки
См. "Справочник "Статусы
документа
документов""
receivedAt
string
+
Дата и время
(date-
получения
time)
документа
documentId
string
+
ID документа
turnoverType
string
-
Код типа отгрузки
Возможные значения:
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент
relatedDocId
string
-
ID документа
Для товарных групп "Альтернативная
"Отгрузка"
табачная продукция",
"Никотиносодержащая продукция",
"Табачная продукция" всегда
возвращается значение "null"
cisList
array of
-
Массив КИ
Если данный массив не возвращается
string
для типа документа, то возвращается
массив "products" ("Массив КИ с
параметрами")
products
array of
-
Массив кодов
Массив возвращается для типа
object
товаров с
документа "Перемаркировка"
параметрами
*cis
string
-
КИ
*prevCis
string
-
Предыдущий КИ
Возвращается только для типа
документа "Перемаркировка"
472
7. Методы получения квитанций результата
обработки документов
7.1. Метод получения квитанций результата обработки
универсального документа по идентификатору документа
Квитанция по результатам обработки документов ЭДО содержит перечень из первых 10 ошибок
по документу. Для получения полного перечня ошибок необходимо использовать "Получение
ошибок по результатам обработки документов".
Метод возвращает квитанцию результата обработки документов (УПД, УПД(и), УКД, УКД(и) и
предложения об аннулировании УД) в ГИС МТ, которые были отправлены с 15 июля 2020 года.
Запрос направляется по одному документу.
URL: /documents/edo/tpr/ud
Метод: GET
Тип приватности: приватный.
Пример запроса:
curl -X GET "<url стенда>/documents/edo/tpr/ud?fileId=ON_NSCHF_...6FA0"
-H "accept: application/json"
-H "Authorization: Bearer <Токен>
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
fileId
string
+
Полное имя из
"ИдФайл" XML
направленного
документа
Примечание: метод возвращает только 10 КИ, имеющих одинаковую ошибку. Для получения
полного списка КИ, содержащих ошибку, в документе используется метод "Получение ошибок
по результатам обработки документов"
Примеры ответа:
Пример положительной квитанции:
473
{
"resultDocId": "UINT04TXMNGR00000000000000000004-0093",
"resultDocDate": 1585320802931,
"sourceDocId": "URCPT00000000000000000005-0031",
"sourceDocDate": 1585320802315,
"state": "SUCCESS",
"code": 0,
"description": "Document was successfully processed",
"operations": [
{
"operationId": "f817bf34-5d7a-4bc0-842e-a06c873e6d8d",
"operationDate": 1585320802352,
"operationType": "DOCUMENT_VALIDATION",
"details": {
"successful": "true",
"tpInternalId": "UCMS00000000000000000018-1476",
"documentType": "UNIVERSAL_TRANSFER_DOCUMENT",
"documentName": "ON_NSCHFDOPPRMARK_2EV-600000555_2EV-
600000749_20200414_051fc5fc-91e7-48c0-a091-f4f3cba39410",
"documentNumber": "тест-1",
"documentDateTime": "14.04.2020"
}
},
{
"operationId": "773e9985-3bfe-476e-b62d-6e00f8e69166",
"operationDate": 1585320802398,
"operationType": "DOCUMENT_ROUTED",
"details": {
"productGroups": ["tobacco"]
}
},
{
"operationId": "a1045297-0cdc-420d-b5e3-b0984ba0e567",
"operationDate": 1585320802696,
"operationType": "DOCUMENT_PROCESSED_AT_PRODUCT_GROUP_TOBACCO",
"details": {"successful": true}
}
]
}
Пример отрицательной квитанции:
{
"resultDocId": "UINT04TXMNGR00000000000000000004-0093",
"resultDocDate": 1585320802931,
"sourceDocId": "URCPT00000000000000000005-0031",
"sourceDocDate": 1585320802315,
"state": "FAILED",
"code": 1,
474
"description": "Document processing was failed",
"operations": [
{
"operationId": "f817bf34-5d7a-4bc0-842e-a06c873e6d8d",
"operationDate": 1585320802352,
"operationType": "DOCUMENT_VALIDATION",
"details": {
"successful": "true",
"tpInternalId": "UCMS00000000000000000018-1477",
"documentType": "UNIVERSAL_TRANSFER_DOCUMENT",
"documentName": "ON_NSCHFDOPPRMARK_2EV-600000555_2EV-
600000749_20200414_051fc5fc-91e7-48c0-a091-f4f3cba39410",
"documentNumber": "тест-1",
"documentDateTime": "14.04.2020"
}
},
{
"operationId": "773e9985-3bfe-476e-b62d-6e00f8e69166",
"operationDate": 1585320802398,
"operationType": "DOCUMENT_ROUTED",
"details": {
"productGroups": ["tobacco"]
}
},
{
"operationId": "a1045297-0cdc-420d-b5e3-b0984ba0e567",
"operationDate": 1585320802696,
"operationType": "DOCUMENT_PROCESSED_AT_PRODUCT_GROUP_TOBACCO",
"details": {
"successful": false,
"errors": [
{
"code": 22,
"text": "Коды маркировки 000000462106543zdK0IB не найдены в
ГИС МТ",
"error": {
"CisNotExists": {},
"details": "Текстовое описание ошибки"
},
"data": {
"cis": ["000000462106543zdK0IB"],
"count": 1,
"tpe": "CisErrorData"
}
}
]
}
}
]
}
475
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
resultDocId
string
+
Идентификатор
Значение соответствует
результирующей
значению из
квитанции (цепочки
атрибута /Квитанция/ГИСМТ/Л
операций)
С/@ИдТК транспортной
квитанции
resultDocDate
number
+
Дата формирования
результирующей
технологической
квитанции
sourceDocId
string
+
Идентификатор
Значение соответствует
логического
значению атрибута
сообщения в ГИС МТ
/Квитанция/ГИСМТ/ЛС/@ИдЛС
Внутренней транспортной
квитанции
sourceDocDate
number
+
Дата получения
Дата формате UnixDataTime (в
входящего логического
миллисекундах)
сообщения
state
string
+
Результат обработки
Возможные значения:
исходного документа
• SUCCESS
-
документ
(УПД, УКД)
обработан успешно, получен
положительный ответ от
всех товарных групп;
• FAILED
-
документ
обработан. Ответ получен от
всех товарных групп, но в
процессе
обработки
возникли ошибки;
• IN_PROGRESS
- документ
находится
в
процессе
обработки;
code
number
+
Код
результата
Возможные значения:
выполнения обработки
• 0 - при state = SUCCESS
• 1 - при state = FAILED
•
2
-
при
state
=
IN_PROGRESS
description
string
+
Текстовое описание
результата обработки
476
Параметр
Тип
Обяз.
Описание
Комментарий
operations
object[]
+
Список операций,
связанных с
обработкой исходного
документа
*operationId
string
+
Идентификатор
операции в ГИС МТ
*operationDate
number
+
Дата совершения
Дата формате UnixDataTime (в
операции в ГИС МТ
миллисекундах)
*operationType
string
+
Тип операции
Возможные значения:
• DOCUMENT_VALIDATION
-
операция
валидации
документа;
• DOCUMENT_ROUTED
-
операция маршрутизации.
Документ отправлен
\ не
отправлен
в
товарную
группу;
•
DOCUMENT_PROCESSED_
AT_PRODUCT_GROUP_<на
именование
товарной
группы> - получен ответ от
товарной
группы
о
результате
обработки
документа
*docId
string
-
Идентификатор
документа (внутренне
й квитанции) в ГИС
МТ
*docDate
number
-
Дата формирования
Дата формате UnixDataTime (в
документа
миллисекундах)
(внутренней
квитанции) в ГИС МТ
*docHash
string
-
Хеш документа
(внутренней
квитанции) в ГИС МТ
*details
object[]
-
Детали
**productGroups
array of
-
Товарные группы
См. справочник "Справочник
string
"Список поддерживаемых
товарных групп""
477
Параметр
Тип
Обяз.
Описание
Комментарий
**successful
string
+
Флаг обработки
Возможные значения:
документа на данной
стадии
• true - обработан успешно;
• false
-
обработка
завершилась с ошибкой
**tpInternalId
string
-
Идентификатор
транспортного пакета
(ТП) в ГИС МТ.
Совпадает со
значением
/Квитанция/ГИСМТ/@
ИдТПВнутренний из
транспортной
квитанции (ТрК)
**documentType
string
-
Тип входящего
Возможные значения:
документа, на который
формируется
•
UNIVERSAL_TRANSFER_D
квитанция
OCUMENT - УПД;
•
UNIVERSAL_CORRECTION
_DOCUMENT - УКД
**documentName
string
-
Имя файла УПД\УКД
Возможные значения:
без расширения
• для УПД
- значение из
атрибута /Файл/@ИдФайл
Титула
продавца
(ON_NSCHFDOPPRMARK);
• для УКД
- значение из
атрибута /Файл/@ИдФайл
Титула
продавца
(ON_KORSCHFDOPPR)
**documentnumbe
string
-
Номер
входящего
Возможные значения:
r
документа
* для УПД - значение из
атрибута /Файл/Документ/СвСч
Факт/@НомерСчФ; * для УКД -
значение из
атрибута /Файл/Документ/СвКС
чФ/@НомерКСчФ
478
Параметр
Тип
Обяз.
Описание
Комментарий
**documentDateTi
string
-
Дата входящего
Возможные значения: * для
me
документа в формате
УПД - значение из атрибута
ДД.ММ.ГГГГ
/Файл/Документ/СвСчФакт/@Да
таСчФ Титула продавца
(ON_NSCHFDOPPRMARK); *
для УКД - значение из
атрибута /Файл/Документ/СвКС
чФ/@ДатаКСчФ Титула
продавца (ON_KORSCHFDOPP
R)
**errors
array of
-
Объект описания
object[]
ошибок обработки
документа
***code
number
+
Код ошибки
***text
string
-
Текстовое описание
кодов ошибок
***error
object[]
+
Содержит внутри себя
текстового значение
кода ошибки
****CisNotExists
array of
-
Значение из столбца
string
"Тестовое описание
кода ошибки" таблицы
"Описание кодов
возвращаемых ошибок
при обработке
документов"
*****details
string
-
Текстовое описание
Поле обязательно для кода
ошибки
ошибки 106 и 107
***data
object[]
+
Содержит внутри себя
Описание ошибок описано в
детали ошибки
таблице "Описание кодов
возвращаемых ошибок при
обработке документов"
****participant
array of
-
ИНН участника
string
оборота товаров. Для
кодов ошибок: 13 и
102
****cis
array of
-
Список кодов
string
идентификации, из-за
которых возникла
ошибка обработки
документа. Для кодов
ошибок: 22, 23, 24 и 79
479
Параметр
Тип
Обяз.
Описание
Комментарий
****pack
array of
-
Список кодов
string
упаковок, из-за
которых возникла
ошибка обработки
документа. Для кодов
ошибок: 22, 23, 24 и 79
****invoice
array of
-
Номер документа. Для
string
кодов ошибок: 16, 63 и
64
**** invoiceDate
array of
-
Дата документа. Для
string
кодов ошибок: 16, 63 и
64
****fixnumber
array of
-
Номер исправления.
string
Для кода ошибки 82
****fixDate
array of
-
Дата исправления. Для
string
кода ошибки 82
****count
number
-
Количество значений в
массиве вышестоящего
поля
****tpe
string
-
Служебная
информация
7.2. Метод получения квитанции результата обработки чека
по идентификатору чека
Метод предназначен для получения квитанции по ID чека, обработанного в ГИС МТ. Получение
квитанции по ID чека мелкооптовой продажи доступно как продавцу, так и покупателю, если
ИНН из токена совпадает с ИНН продавца или покупателя из чека.
Тип приватности: публичный
URL: /receipt/documents
Метод: GET
Пример запроса:
curl -X GET "<url стенда v3>/receipt/documents?id=000000000000000001"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID чека
480
Пример ответа:
1. Код 200: в случае успеха.
{
"resultDocId":"UTXMNGR00000000000000000011-1111",
"resultDocDate":"2021-03-19T09:20:52.105Z",
"sourceDocId":"URCPT00000000000000000022-2222",
"sourceDocDate":"2021-03-18T16:10:57.190Z",
"state":"IN_PROGRESS",
"code":2,
"description":"Document in processing",
"operations":[
{
"operationId":"3dd33333-3333-3333-3333-33d333d33d33",
"operationType":"RECEIPT_VALIDATION",
"operationDate":"2021-03-18T16:10:57.219Z",
"details":{
"ofdInn":"7777777777",
"successful":"true",
"documentType":"TICKET",
"documentNumber":"19",
"documentDateTime":"1564744080"
}
},
{
"operationId":"4aa44444-4444-4444-4444-44a444a44a44",
"operationType":"RECEIPT_ROUTED",
"operationDate":"2021-03-18T16:10:57.411Z",
"details":{
"productGroups":[
"shoes"
],
"successful":"true"
}
}
]
}
2. В случае ошибок.
2.1. Код 401: для доступа к ресурсу требуется полная аутентификация.
<UnauthorizedException>
<error>unauthorized</error>
<error_description>Full authentication is required to access this
resource</error_description>
</UnauthorizedException>
481
2.2. Код 403: документ недоступен.
{
"code":403,
"timestamp":1595487274974,
"error_message":"Отсутствует доступ к ресурсу"
}
2.3. Код 404: запрашиваемая информация не найдена в ГИС МТ либо допущена ошибка в
указании URL метода.
{
"code":404,
"description":"Document with id 123 is missing"
}
2.4. Код 500: внутренняя ошибка сервиса.
{
"code":500,
"timestamp":1595487274974,
"error_message":"Ошибка при выполнении запроса"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
resultDocId
string
+
Уникальный ID
квитанции в ГИС
МТ
resultDocDate
string
+
Дата и время
Формат: yyyy-MM-
окончания
ddTHH:mm:ss.SSS’Z
обработки
документа
sourceDocId
string
+
Уникальный
идентификатор
исходного
документа в ГИС
МТ
sourceDocDate
string
+
Дата и время
Формат: yyyy-MM-
приёма исходного
ddTHH:mm:ss.SSS’Z
документа
482
Параметр
Тип
Обяз.
Описание
Комментарий
state
string
+
Результат
Возможные значения:
обработки
SUCCESS - документ обработан
документа
успешно;
FAILED - документ обработан с
ошибкой;
PARTIALLY - документ обработан
частично
code
number
+
Код обработки
Возможные значения:
документа
0 - документ обработан успешно;
1 - документ обработан с ошибкой;
2 - документ обработан частично
description
string
+
Описание
результата
обработки
документа
operations
array
+
Список операций,
связанных с
обработкой
документа
*operationId
string
+
ID операции,
присвоенный в
ГИС МТ
483
Параметр
Тип
Обяз.
Описание
Комментарий
*operationType
string
+
Тип операции
Возможные значения:
RECEIPT_VALIDATION - операция
валидации документа;
RECEIPT_ROUTED - операция
маршрутизации. Документ
отправлен/не отправлен в товарную
группу;
RECEIPT_SENT_TO_FALLBACK -
операция маршрутизации для
документа не определена товарная
группа. Документ отправлен в
очередь документов с
неопределённой товарной группой
Получен ответ от товарной группы о
результате обработки документа:
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_TOBACCO;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_SHOES;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_LP;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_ELECTRONICS;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_PERFUMERY;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_BICYCLE;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_TIRES;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_WHEELCHAIR;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_WATER;
RECEIPT_PROCESSED_AT_PRODU
CT_GROUP_MILK
*operationDate
string(da
+
Дата и время
Формат: yyyy-MM-
te-time)
операции
ddTHH:mm:ss.SSS’Z
*details
array
-
Дополнительная
Параметры массива изменяются в
информация
зависимости от получаемой
квитанции
**successful
boolean
-
Признак
успешной
обработки
**errors
array
-
Дополнительная
Возвращается в случае ошибки
информация об
ошибке
484
Параметр
Тип
Обяз.
Описание
Комментарий
***code
number
-
Код ошибки
Возвращается в случае ошибки
7.3. Описание кодов возвращаемых ошибок при обработке
документов
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
4
DuplicateDocument
Документ $docId
Документ зарегистрирован
зарегистрирован ранее
в ГИС МТ
7
IncorrectUDHistory
Последний успешный УД
не найден для счёт-фактуры
№: $invoice, дата:
$invoiceDate
10
VendorNotExists
Продавец $vendor не
Продавец не
идентифицирован (не
зарегистрирован в ГИС МТ
зарегистрирован)
12
CustomerNotExists
Покупатель не
зарегистрирован в ГИС МТ
13
ParticipantNotExists
Участник $participant не
Участник <ИНН Продавца
идентифицирован (не
УД> или <ИНН
зарегистрирован)
Покупателя> не
зарегистрирован в ГИС МТ
(проверка регистрации
<ИНН Покупателя> не
осуществляется при
отгрузках для собственных
нужд или в рамках
государственного
контракта) Для всех
товарных групп
проверяется наличие
подписанного договора на
взаимодействие с товарной
группой
14
DuplicateTransferDocument
УПД $docId для счёт-
фактуры №: $invoice, дата:
$invoiceDate
зарегистрирован ранее
485
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
16
UniversalCorrectionDocumen
УКД (УКДи) $docId для
В ГИС МТ ранее был
tNotValid
счёт-фактуры №: $invoice,
успешно обработан
дата: $invoiceDate не
УКД/УКД(и) с такими же
валидный (отсутствует
№ и датой УКД, <ИНН
исходный УПД, либо
Получателя> и <ИНН
документ не является
Отправителя>, № и датой
последним)
исправления (если был
направлен на обработку
УКД(и)), как у текущего
направленного УКД или
УКД(и), либо в ГИС МТ
ранее был успешно
обработан УКД(и) с более
поздней датой
корректировки
18
CisEditedByAnotherDoc
Код Маркировки $cis был
изменен более поздним
документом: $documentId
19
CisHistoryNotExists
Отсутствуют записи в
истории по Коду
Маркировки: $cis
20
CisHistoryNotValid
Последняя запись в
истории Кода Маркировки:
$cis не соответствует
изменению по документу.
ИД документа не указан
21
CisIncorrectAggregation
Код Маркировки $cis с
родителем $currentParent
нельзя агрегировать в
$newParent
22
CisNotExists
Коды Маркировки $cis не
Указанные в документе
найден(ы)
коды идентификации не
найдены в ГИС МТ
486
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
23
InsufficientRights
У участника $participant нет
При обработке документа
полномочий на выполнение
поставщик не является
операции с Кодом
владельцем указанного кода
Маркировки $cis
идентификации.
При обработке
исправлений:
* при возврате на
поставщика кода
идентификации покупатель
не является владельцем
кода идентификации по
данным ГИС МТ; * при
добавлении к перемещению
на покупателя кода
идентификации поставщик
не является владельцем
кода по данным ГИС МТ
24
InvalidStatus
Статус Кода Маркировки
Статус кодов
$cis не соответствует
идентификации или их
выполняемой операции"
состояние («ожидают
приёмку», «ожидают
перемаркировку») не
соответствуют
выполняемой операции
25
InvalidAggregationHistory
Последняя запись в
истории $cis имеет тип
операции, не
соответствующий
агрегации
26
ParticipantDissolved
Участник $participant не
зарегистрирован в
ЕГРИП/ЕГРЮЛ как
действующее лицо
27
CisHistoryForUDNotExists
Для УД (счёт-фактура №:
$invoice, дата: $invoiceDate)
не найдены истории КМ
31
InsufficientRightsGroup
У участника $participant нет
полномочий на выполнение
операций с групповой
упаковкой $pack и Кодом
Маркировки $cis
487
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
33
IncorrectDisaggregationLevel
Групповая упаковка $pack
вложена в групповую
упаковку. Для дезагрегации
используйте идентификатор
верхней групповой
упаковки
44
XsdValidationError
Ошибка валидации
документа $docId по XSD-
схеме
46
InvalidDocumentContent
Содержание или имя
Имя файла не корректно
документа некорректно
или структура XML не
прошла проверку по XSD-
схеме
54
EmptyFixDate
Дата исправления не
Дата исправления УПД(и)
заполнена для документа
имеет пустое значение или
$docId
имеет не верный формат
56
InvalidAggregationParentTyp
Тип упаковки для агрегата
e
$cis - пачка
57
ParticipantAlreadyExists
Участник $participant уже
существует
58
ParticipantNotExistsInEGRU
Участник $participant не
L
зарегистрирован в
ЕГРИП/ЕГРЮЛ
59
OfdNotExists
Оператор фискальных
данных с ИНН $inn не
найден
60
ProductNotExists
Продукция с GTIN $gtin не
найдена
61
ProductInsufficientRights
У участника $participant нет
полномочий на выполнение
операций с продукцией
имеющей GTIN $gtin
62
InvalidAggregationChildType
Тип упаковки $cis нельзя
поместить в упаковку
$parent
488
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
63
UniversalTransferDocument
УПД $docId для счёт-
В ГИС МТ ранее был
NotValid
фактуры №: $invoice, дата:
успешно обработан УПД с
$invoiceDate не валидный
такими же № и датой УПД,
(зарегистрирован ранее,
<ИНН Получателя> и
либо был проведен УПДи)
<ИНН Отправителя>, как у
текущего направленного
УПД, либо в ГИС МТ был
успешно обработан УПД(и)
с более поздней датой
исправления
64
UniversalTransferFixDocume
УПДи №{номер} от {дата}
В ГИС МТ ранее был
ntNotValid
не обработан. Был проведен
успешно обработан УПД(и)
УПДи с более поздними
с № и датой УПД, <ИНН
номером или датой
Получателя> и <ИНН
исправления
Отправителя>, с № и датой
исправления позднее, чем у
текущего направленного
УПД(и)
65
ApiError
Ошибка во время
обращения к $apiName
66
NotEmptyAggregatorError
Агрегат $cis не пустой
67
InvalidAggregationDate
Дата эмиссии/нанесения
новой групповой упаковки
$newParent меньше даты
эмиссии/нанесения старой
$previousParent, либо даты
эмиссии/нанесения
отсутствуют
68
CisNotPaid
Код Маркировки $cis не
По кодам идентификации,
оплачен
указанным в документе, не
произведена оплата
69
DocParsingError
Содержание документа
Поле «КодИтога» титула
некорректно. Некорректные
покупателя (при условии
данные: $reason
его указании) заполнено не
корректным значением
70
DocumentDataFieldsError
Содержание документа
некорректно. Отсутствуют
сведения о маркировке
71
DocumentValidationError
Содержание документа
некорректно. Некорректные
данные: $reason
72
InvalidDocumentType
Некорректный тип
документа: $docType
73
WrongEmissionType
Некорректный тип эмиссии
489
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
74
DifferentChildrenStatus
Статусы приведённых в
документе "Агрегация"
транспортных упаковок
либо товаров не совпадают
75
InvalidEmissionType
Код Маркировки $cis имеет
некорректный тип эмиссии
76
DocumentNotExis
Документ с id $id не найден
77
UniversalCancelDocumentNo
Документ, аннулирующий
tValid
УПД с id $id, невалидный
78
DuplicateCis
Код маркировки $cis
перечислен более одного
раза
79
CisNotValid
Неверный код маркировки
Коды идентификации
$cis
имеют не корректную
длину либо содержат
недопустимые символы
80
InvalidUdContract
Текущий или предыдущий
документ не могут быть
гос. контрактом
81
CisNotInUdChain
Код маркировки $cis
При обработке
отсутствует в цепочке
корректировок: при
универсальных документов
возврате на поставщика
кода идентификации
покупатель не является
владельцем кода
идентификации по данным
ГИС МТ
82
UniversalTransferFixDocume
УПДи №{номер} от {дата}
В ГИС МТ ранее был
ntDuplicate
не обработан. Данный
успешно обработан УПД(и)
документ (№ исправления:
с такими же № и датой
{номер}, дата исправления:
УПД, <ИНН Получателя> и
{дата}) зарегистрирован в
<ИНН Отправителя>, № и
ГИС МТ ранее
датой исправления, как у
текущего направленного
УПД(и)
490
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
83
IncorrectUdChain
Некорректная
Проверка истории
последовательность УД для
перемещения кодов
Кода Маркировки $cis
идентификации при
обработке корректировок:
* указанные без изменений
коды идентификации в
документе по данным ГИС
МТ были ранее
перемещены с поставщика
на покупателя; * для
возвращаемых на
поставщика кодов
идентификации владельцем
является покупатель; * для
добавленных к
перемещению на
покупателя кодов
идентификации владельцем
является отправитель
84
NotAggregatedCis
Неудавшиеся при агрегации
короба и паллеты: $cis
85
InvalidPackageType
Тип упаковки Кода
Маркировки $cis не
соответствует выполняемой
операции
86
CisesIncorrectValueParent
Код маркировки $cis,
указанный в документе
$documentName, содержит
в родителе самого себя
87
InvalidParamFormat
Некорректный формат
параметра $field для КМ
$cis
88
InvalidParamValue
Некорректное значение
параметра $field для КМ
$cis
89
InvalidProductGroup
Продуктовая группа Кода
Маркировки $cis не
соответствует выполняемой
операции
100
DatabaseLoadingError
Ошибка при загрузке из
базы данных
101
SkippedDocumentError
Обработка документа
прервана
491
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
102
MultiCodes
Документ содержит
мультитоварные Коды
Маркировки
103
CodesIsEmpty
Документ не содержит
Кодов Маркировки
104
ProductCodesDecodingError
Код Маркировки
неподдерживаемого
формата
105
ValidationError
Ошибка валидации
дополнительных свойств в
чеке
106
DocumentValidation
Ошибка валидации
документа
107
SignatureError
Ошибка валидации подписи
Если дата формирования
подписи (1. Дата
формирования
открепленной подписи 2.
ДатаИнфПр и ВремяИнфПр
из титула продавца) < даты
отзыва сертификата, то
документ обрабатывается, и
в результирующей
квитанции возвращается
ошибка 107,
неблокирующая ошибку-
предупреждение. Если дата
формирования подписи (1.
дата формирования
открепленной подписи 2.
ДатаИнфПр и ВремяИнфПр
из титула продавца) > даты
отзыва сертификата, то
документ обрабатывается с
блокирующей ошибкой 107
108
ServiceError
Произошла сервисная
ошибка
109
ServiceError
Документ находится в
обработке. Повторное
рассмотрение возможно
после окончания обработки
документа
110
InvalidDocumentStatus
Некорректный статус
документа
492
№
Описание кода
Текстовое описание кода
Комментарий
ошибки
111
RoutingError
Произошла ошибка
маршрутизации документа
116
IntroduceByNotOwner
Участник $participant не
может перемещать Код
маркировки $cis, не
введенный в оборот
117
CisEmitted
Код маркировки $cis
эмитирован
8. Методы формирования выгрузок данных из
ГИС МТ
В данном разделе описана последовательность формирование выгрузки из ГИС МТ сведений
больших объёмов с использованием функциональности "Сервис выгрузок" (далее - СВ).
Участнику оборота товаров предоставляется возможность создания однократных заданий на
выгрузку с возможностью скачивания результата в формате * .csv. В результате успешной
обработки задания на формирования выгрузки на адрес электронной почты, указанный в личном
кабинете участника оборота товаров, приходит уведомление о готовности выгрузки.
Время выполнения задания на выгрузку зависит от объёма выгрузки. В процессе обработки
задание проходит от 1 до 3 очередей:
• 1 очередь: до 5 минут;
• 2 очередь: до 10 минут, если выгрузка выполняется более 5 минут или возникла ошибка;
• 3 очередь: до 60 минут, если выгрузка выполняется более 10 минут или возникла ошибка.
Если выгрузка не сформировалась за 3 очереди или в процессе формирования возникла ошибка,
то будет получено сообщение об ошибке и в параметре "downloadStatus" ("Статус") поменяется
значение с "PREPARATION" ("В обработке") на "FAILED" ("Неуспешно").
Формирование выгрузок из ГИС МТ сведений больших объёмов осуществляется согласно
следующей последовательности:
Шаг 1. Создание нового задания на выгрузку ("Метод создания нового задания на выгрузку").
Далее в документе приведено описание получения сведений по КИ и агрегатам ("Получение
сведений по КИ и агрегатам"), получения ошибок по результатам обработки документов ЭДО
("Получение ошибок по результатам обработки документов") и "Пример ответа для всех
формируемых запросов на выгрузку". В ответе на данный метод возвращается ID формируемой
выгрузки, который используется в последующем запросе проверки статуса задания.
Шаг 2. Проверка статуса готовности задания на выгрузку ("currentStatus") по ID выгрузки
("Метод получения статуса задания на выгрузку по ID выгрузки"). В параметре запроса "task_id"
("Список ID задач") указываются ID запрошенных выгрузок.
Шаг 3. "Метод получения результирующих ID выгрузок данных" возвращает список заданий с
указанием результирующего ID. В параметре запроса "task_ids" ("Список ID задач") указываются
493
ID запрошенных выгрузок. Результирующий идентификатор возвращается только для выгрузок в
статусе "Выполнено" (COMPLETED).
Шаг 4. Получение сформированного файла выгрузки данных по полученному на третьем шаге
результирующему ID ("Метод получения ZIP файла выгрузки"). Получить файл выгрузки можно
только для задачи в статусе "Выполнено" (COMPLETED. Если выгрузка перемещена в архив или
отменена необходимо сформировать выгрузку повторно.
8.1. Метод создания нового задания на выгрузку
Для начала работы с СВ необходимо вызвать "Метод создания нового задания на выгрузку". В
ответе метод возвращает ID выгрузки, который необходим для работы с другими методами СВ.
Формат ответа данного метода имеет единую структуру для всех формируемых заданий на
выгрузку ("Пример ответа для всех формируемых запросов на выгрузку"). Далее описаны
запросы метода для получения сведений по КИ и агрегатам и получения ошибок по результатам
обработки документов ЭДО.
8.1.1. Получение сведений по КИ и агрегатам
Для формирования запроса на получение сведений о КИ в файле формата * .csv необходимо
передать массив КИ. Ограничение по количеству указываемых КИ: 100 000.
У участника оборота товаров, запрашивающего данные о КИ из ГИС МТ, должны быть
подписаны договора по всем товарным группам, по КИ которых запрашивается выгрузка.
В случае отсутствия подписанного договора при запросе данных возвращается ошибка 403
(отсутствует доступ к данным, не подписан договор о предоставлении сведений).
URL: dispenser/tasks
Тип приватности: публичный
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>dispenser/tasks"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
-H "Content-Type: application/json" -d
Пример тела запроса:
{
"format":"CSV",
"periodicity":"SINGLE",
"params": "{\"cises\": [\"(01)00000000000000(00)0IXnkAz\",
\"000000000000000jh00IV\", \"00000000000000XCfdLsNMezPJFDO0yj0Xg0ji\"]}",
"name":"CIS_REPORT"
}
494
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
format
string
+
Формат файла: CSV
name
string
+
Наименование выгрузки:
"CIS_REPORT" - для
получения отчета по
сведениям по КИ и
агрегатам
params
string
+
Строка параметров задания
Заполняется "{\"cises\":
в формате JSON
[\"cis1\", \"cis2\",…]}"
periodicity
string
+
Вид выгрузки: SINGLE
(однократная)
8.1.2. Получение ошибок по результатам обработки документов
В разделе описано формирование запроса на детализированную выгрузку ошибок по
результатам обработки документов ЭДО. Ограничение по количеству запрашиваемых
документов: 1000.
Выгрузка предназначена для запроса сведений по ошибкам обработки документов прямой
подачи сведений и ЭДО. В параметрах запроса необходимо передать массив идентификаторов
документов. Ограничение по количеству запрашиваемых документов: 1000. Для документов
ЭДО передаётся полный идентификатор, равный значению, указываемому в "ИдФайл"
документа
* .xml. Для документов прямой подачи сведений передаётся идентификатор,
присвоенный ГИС МТ.
URL: dispenser/tasks
Тип приватности: публичный
Метод: POST
Пример строки запроса:
curl -X POST '<url стенда>dispenser/tasks"
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer
Пример тела запроса:
{
"format":"CSV",
"name":"DOCUMENTS_ERRORS",
"params":"{\"documentId\": [\"uuid\", \"uuid\"]}",
"periodicity":"SINGLE",
"productGroupCode":"2"
}
495
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
format
string
+
Формат файла: CSV
name
string
+
Наименование выгрузки:
DOCUMENTS_ERRORS -
для получения отчёта по
формированию выгрузки
ошибок по документам
params
string
+
Строка параметров задания
Заполняется
в формате JSON
"{"documentId":[ "uuid"]}"
или "{"cises":["cis1",
"cis2",…]}"
periodicity
string
+
Вид выгрузки: SINGLE
(однократная)
productGroupCode
string
+
Товарная группа
Указывается цифровой код
товарной группы (см.
"Справочник "Список
поддерживаемых товарных
групп"")
8.1.3. Получение списка КИ участника оборота товаров по заданному фильтру
Выгрузка предназначена для получения сведений о КИ, находящихся на балансе у участника
оборота товаров. У участника оборота товаров, запрашивающего данные из ГИС МТ должен
быть подписан договор по товарной группе, указанной в параметре "productGroupCode"
("Товарная группа").
Вывод сведений о КИ осуществляется с учётом установленных фильтров в параметре "params"
("Строка параметров задания в формате JSON").
URL: dispenser/tasks
Тип приватности:
• приватный;
• Оператор.
Метод: POST
Пример строки запроса:
curl -X POST '<url стенда>/dispenser/tasks"
-H 'Authorization: Bearer <ТОКЕН>'
-H "Content-Type: application/json" -d
Пример тела запроса:
496
{
"format": "CSV",
"name": "FILTERED_CIS_REPORT",
"periodicity": "SINGLE",
"productGroupCode": "2",
"params":
"{\"participantInn\":\"1111111111\",\"packageType\":[\"UNIT\",\"LEVEL1\"],\"status\":\
"INTRODUCED\",\"appliedPeriod\":{\"start\": \"2020-01-
01T08:02:30.577395Z\",\"end\":\"2020-12-
09T08:02:30.577395Z\"},\"emissionPeriod\":{\"start\":\"2020-01-
01T08:02:30.577395Z\",\"end\":\"2020-12-09T08:02:30.577395Z\"},\"includeGtin\":
[\"04620074363472\"]}"
}
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
format
string
+
Формат файла: CSV
name
string
+
Наименование выгрузки:
FILTERED_CIS_REPORT -
получения списка КИ,
принадлежащих участнику
оборота товаров
params
string
+
Строка параметров задания
в формате JSON
*participantInn
string
+
ИНН участника
*includeGtin
array[stri
-
Код товара, по которому
ng]
осуществляется поиск
*excludeGtin
array[stri
-
Код товара, по которому
Если параметр
ng]
выполняется исключение из
"includeGtin" ("Код товара,
поиска
по которому
осуществляется поиск")
заполнен, то параметр
"excludeGtin" ("Код товара,
по которому выполняется
исключение из поиска")
может быть пустым
*packageType
array[stri
+
Тип упаковки
См. "Справочник "Типы
ng]
упаковки""
*status
string
+
Статус КМ
См. "Справочник "Статусы
КИ""
*emissionPeriod
string
-
Период отбора по дате
(date-
эмиссии
time)
497
Параметр
Тип
Обяз.
Описание
Комментарий
**start
string
-
Дата начала периода отбора
(date-
по дате эмиссии
time)
**end
string
-
Дата окончания периода
(date-
отбора по дате эмиссии
time)
*appliedPeriod
string
-
Период отбора по дате
(date-
нанесения
time)
**start
string
-
Дата начала периода отбора
(date-
по дате нанесения
time)
**end
string
-
Дата окончания периода
(date-
отбора по дате нанесения
time)
periodicity
string
+
Вид выгрузки: SINGLE
(однократная)
productGroupCode
string
+
Товарная группа
Указывается цифровой код
товарной группы (см.
"Справочник "Список
поддерживаемых товарных
групп"")
8.1.4. Пример ответа для всех формируемых запросов на выгрузку
В ответе возвращается ID выгрузки, необходимый для дальнейше работы с методами сервиса
выгрузок.
Пример ответа:
{
"id":"string",
"name":"string",
"createDate":"2020-06-19T14:44:27.968",
"currentStatus":"PREPARATION",
"orgInn":"string",
"period":"HALF_MIN",
"periodicity":"REGULAR",
"productGroupCode":0,
"timeoutSecs":0
}
Параметры ответа:
498
Параметр
Тип
Обяз.
Описание
createDate
string (date-
+
Дата создания. Возвращается в формате
time)
yyyy-MM-ddTHH:mm:ss.SSS
id
string
+
Идентификатор задания на выгрузку,
необходимый для работы с другими
методами сервиса выгрузок
name
string
+
Наименование задания
currentStatus
string
-
Текущий статус:
PREPARATION - подготовка;
COMPLETED - выполнено;
CANCELED - отменено;
ARCHIVE - архив;
FAILED - ошибка
dataStartDate
string (date)
-
Дата начала периода, по которому
сформирована выгрузка (используется
только для заданий c periodicity=SINGLE).
Возвращается в формате yyyy-MM-dd
dataEndDate
string (date)
-
Дата окончания периода, по которому
сформирована выгрузка (используется
только для заданий c periodicity=SINGLE).
Возвращается в формате yyyy-MM-dd
orgInn
string
+
ИНН организации
period
string
-
Периодичность регулярной выгрузки
(только для periodicity: "REGULAR"):
HALF_MIN - полминуты;
TEN_MINUTES - 10 минут;
DAY - день;
WEEK - неделя;
MONTH - месяц;
QUARTER - квартал;
YEAR - год
periodicity
string
+
Вид периодичности:
SINGLE - однократная;
REGULAR - регулярная
productGroupCode
integer
-
Указывается цифровой код товарной
группы (см. "Справочник "Список
поддерживаемых товарных групп"")
timeoutSecs
integer
-
Таймаут в сек., при наступлении которого
диспетчер считает, что выгрузка по
данному заданию не выполнена
8.2. Метод получения статуса задания на выгрузку по ID
выгрузки
В формируемом запросе указывается ID выгрузки, вернувшийся в ответе на запрос "Метода
499

 

 

 

 

 

 

 

содержание      ..     3      4      5      6     ..