Объекты on База знаний DataMobile

recipient

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Информация о получателе

Где используется

Параметры

Наименование	Тип	Описание
name	string	Имя получателя
phone	string	Номер телефона получателя

Пример


{
 "name": "Иванов Иван",
 "phone": "+7(900)xxx-xx-10"
}

manager

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

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

Где используется

docs (PUT)

docs/headers (GET)

Параметры

Наименование	Тип	Описание
name	string	Имя менеджера
phone	string	Номер телефона менеджера

Пример


{
 "name": "Петров Эдуард",
 "phone": "+7(999)xxx-xx-90"
}

client_notification

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Настройки уведомления для клиента

Где используется

docs (PUT)
docs/headers (GET)

Параметры

Наименование	Тип	Описание
type_id	int	Тип уведомления: 0 - не уведомлять, 1 - SMS, 2 - Email
email	string	Email для уведомления
phone	string	Номер телефона для уведомления

Пример


{ 
 "type_id": 0, 
 "email": "example@scanport.ru", 
 "phone": "+79001005200" 
}

receipt

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Данные по пробитым чекам

Где используется

docs (GET)

Параметры

Наименование	Тип	Описание
status_id	int	Состояние чека: 0 - Fail (ошибка) / Wait (ожидание), 1 - done (готово)
error_message	string	Описание при исключении
external_id	string	Внешний идентификатор
receipt_created_at	timestamp	Время создания чека
fiscal_receipt_number	string	Номер чека в смене
shift_number	string	Номер смены
fn_number	string	Номер фискального накопителя
ecr_registration_number	string	Регистрационный номер ККТ
fiscal_doc_number	string	Номер документа
fiscal_doc_attr	string	Атрибуты документа
total	float	Итоговая сумма чека
uuid	string	Уникальный идентификатор

Пример


{ 
 "status_id": 1, 
 "external_id": "4e7d924af649ade463851d9737c77ebd", 
 "receipt_created_at": 1734099777, 
 "fiscal_receipt_number": "765", 
 "shift_number": "178", 
 "fn_number": "9999078902010421", 
 "ecr_registration_number": "0000000007062953", 
 "fiscal_doc_number": "99315", 
 "fiscal_doc_attr": "2204430728", 
 "total": 1313.68, 
 "uuid": "34906469-5368-43d2-a3bf-ec340184a56b" 
}

payment

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Данные по платежам

Где используется

docs (PUT)

docs (GET)

Параметры

Примечание

Для возвратов объект выглядит так же, но добавляется параметр out_id, плюс из части параметров убирается суффикс _id:

operation_type_id -> operation_type,
type_id -> type,
variant_id -> variant,
status_id -> status

Наименование	Тип	Описание
operation_type_id (обязательно)	int	Тип операции: 0 - оплата, 1 - возврат
type_id (обязательно)	int	Тип платежа: 0 - наличными, 1 - картой, 2 - СБП
variant_id (обязательно)	int	Вариант платежа: 0 - обычный платеж, 1 - предоплата, 2 - постоплата, 3 - другое
value (обязательно)	float	Сумма платежа
status_id (обязательно)	int	Статус платежа: 1 - ожидание платежа/возврата, 2 - платеж/возврат выполнен, 3 - платеж отменен, 4 - ошибка платежа
error_message	string	Сообщение об ошибке
transaction_id	string	Идентификатор транзакции
operation_id	string	Идентификатор операции
auth_code	string	Код авторизации платежа
rrn	string	Номер ссылки на транзакцию
card_number	string	Номер карты
out_id (обязательно)	string	уникальный идентификатор платежа (используется только для возвратов)

Примечание

cancel_reason

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Причина отмены

Где используется

docs (PUT)

docs (GET)

cancel-reasons (GET)

Параметры

Наименование	Тип	Описание
out_id (обязательно)	string	Уникальный идентификатор
type (обязательно)	int	Тип: 0 - для документа, 1 - для позиции документа, 2 - общий
name (обязательно)	string	Наименование причины отмены

Пример


{ 
 "out_id": "9a66294a-3e5f-11df-90e1-000b0d4caf68", 
 "type": 2, 
 "name": "Уже купили нужный товар у другого поставщика" 
}

detail

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

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

Где используется

docs (PUT)

docs (GET)

Параметры

Наименование	Тип	Описание
out_id (обязательно)	string	Уникальный идентификатор строки
source_qty (обязательно)	float	Количество товара по документу
actual_qty	float	Фактическое кол-во товара
price (обязательно)	float	Цена за единицу товара
source_sum	float	Сумма строки документа
nds_type_id (обязательно)	int	Тип НДС: 0 - без НДС, 1 - 0%, 2 - 10%, 3 - 18%, 4 - 10/110, 5 - 18/118, 6 - 20%, 7 - 20/120, 12 - 22%, 13 - 22/122
fiscal_tags	string	Фискальные теги в формате json
cancel_reason_id	string	Идентификатор причины отмены
article (обязательно)	object	Объект карточки товара
marking_codes	object array	Массив объектов кодов маркировки
edit_mode	int	Признак запрета изменения строки: 0 - разрешено изменять, 1 - запрещено изменять

Пример


 {
 "out_id": "e11bf2b4-81b7-11f0-9faa-8a884b81b7da1",
 "source_qty": 6,
 "actual_qty": 6,
 "price": 65,
 "source_sum": 390,
 "nds_type_id": 0,
 "fiscal_tags": "{}",
 "edit_mode": 0,
 "article": {
 "out_id": "8U-3130502e-017a-11ef-865d-f44efc0d0ab300000000-0000-0000-0000-000000000000",
 "name": "Вода с газом ",
 "short_name": "Вода газированная 0.5",
 "attr_1": "321321",
 "attr_2": "Напитки",
 "attr_3": "",
 "attr_4": "",
 "attr_5": "",
 "attr_6": "",
 "attr_7": "",
 "attr_8": "",
 "attr_9": "",
 "attr_10": "",
 "measure_type_id": 0,
 "mark_type_id": 8,
 "subject_type_id": 0,
 "barcodes": [
 {
 "barcode": "4640013510187",
 "unit_coef": 6,
 "unit_name": "упак"
 },
 {
 "barcode": "9780201379808",
 "unit_coef": 1,
 "unit_name": "шт"
 }
 ]
 },
 "marking_codes": [ ]
 }

см. article

article

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Карточка товара

Где используется

detail

Параметры

Примечание

Для PUT запросов объект выглядит так же, но для части параметров убирается суффикс _id:

measure_type_id -> measure_type,
mark_type_id -> mark_type,
subject_type_id -> subject_type

Наименование	Тип	Описание
out_id (обязательно)	string	Уникальный идентификатор товара
name (обязательно)	string	Полное наименование товара
short_name	string	Краткое наименование товара
attr_1 - attr_10	string	Атрибут 1 - Атрибут 10 (доп. инфо о товаре)
measure_type_id	int	Признак весового товара: 0 - поштучный товар, 1 - весовой товар
mark_type_id	int	Тип маркировки: 0 - не используется, 1 – табачная продукция, 2 – обувь, легкпром, шины, духи, велосипеды, 3 – лекарства и медицинские препараты, 4 – фотокамеры, 5 – молочная продукция, 6 – не используется, 7 – алкоголь, 8 – вода, 9 – без КМ (аналог “не используется”), 10 - пиво, 11 - меховая продукция, 12 - безалкогольная (соковая) продукция, 13 - икра, 14 - консервированная продукция, 15 - ветеринарные препараты, 16 - корма для животных, 17 - растительные масла, 18 - игры и игрушки для детей, 19 - строительные материалы, 20 - титановая металлопродукция, 21 - парфюмерные и косметические средства и бытовая химия, 22 - печатная продукция, 23 - отопительные приборы, 24 - оптоволоконная продукция, 25 - радиоэлектронная продукция, 26 - бакалейная продукция, 27 - моторные масла, 28 - пиротехника и огнетушащее оборудование,29 - кабельно-проводниковая продукция, 30 - сладости, 31 - полимерные трубы, 32 - биологически активные добавки (БАДы), 33 - технические средства реабилитации, 34 - кресла-коляски, 35 - антисептики (дезинфицирующие средства), 36 - велосипеды, 37 - духи и туалетная вода, 38 - шины и автопокрышки, 39 - товары легкой промышленности и одежда, 40 – медицинские изделия, 41 – безалкогольное пиво, 42 - фармацевтическое сырье, лекарственные средства, 43 - слабоалкогольные напитки (до 9%), 44 - автозапчасти и комплектующие транспортных средств, 45 - спортивное питание, 46 - растворимые завариваемые напитки, 47 - макароны, крупы и мёд, 48 - мясные изделия, 49 - полуфабрикаты и замороженная продукция, 50 - бритвы и лезвия, 51 - напитки с содержанием молока, какао, прочее, 52 - отдельные товары личной гигиены, 53 - товары для дома и интерьера, 54 - удобрения
subject_type_id	int	Тип товара: 0 - товар, 1 - услуга
barcodes	object array	Массив объектов штрих кодов товара

Пример


{ 
 "out_id": "8U-c34ba7ca-71b0-11ef-a33f-d04c4ac51d4300000000-0000-0000-0000-000000000000", 
 "name": "Молоко сгущенное Рогачев", 
 "short_name": "Сгущенка Рогачев", 
 "attr_1": "", 
 "attr_2": "00-00000320", 
 "attr_3": "", 
 "attr_4": "", 
 "attr_5": "", 
 "attr_6": "", 
 "attr_7": "", 
 "attr_8": "", 
 "attr_9": "", 
 "attr_10": "", 
 "measure_type_id": 0, 
 "mark_type_id": 5, 
 "subject_type_id": 0, 
 "barcodes": [ 
 { 
 "barcode": "4602014010929", 
 "unit_coef": 1.0, 
 "unit_name": "шт" 
 }, 
 { 
 "barcode": "4810065006079", 
 "unit_coef": 1.0, 
 "unit_name": "шт" 
 } 
 ] 
}

см. barcode

barcode

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Штрихкод товара

Где используется

article

Параметры

Наименование	Тип	Описание
barcode	string	Значение штрихкода товара
unit_coef	float	Коэффициент единицы измерения
unit_name	string	Название единицы измерения

Пример


{ 
 "barcode": "4600721055592", 
 "unit_coef": 1.0, 
 "unit_name": "шт" 
}

marking_code

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Код маркировки

Где используется

detail

Параметры

Наименовани	Тип	Описание
barcode_full (обязательно)	string	Полный код маркировки
barcode_raw (обязательно)	float	Код маркировки (в необработанном формате) base64
barcode_gtin	string	GTIN
barcode_kiz	string	Код идентификации (КИ)
crpt_checked	boolean	КМ проверен в ЦРПТ (разрешительный режим)
crpt_req_id	string	Идентификатор запроса (разрешительный режим)
crpt_req_timestamp	int	Дата и время формирования запроса (разрешительный режим)

Пример


{ 
 "barcode_full": "0104600721055592215ARA01/93bzU7", 
 "barcode_raw": "MDEwNDYwMDcyMTA1NTU5MjIxNUFSQTAxLx05M2J6VTc=", 
 "barcode_gtin": "4600721055592", 
 "barcode_kiz": "0104600721055592215ARA01/", 
 "crpt_checked": true 
}

user

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Карточка пользователя

Где используется

users (GET)

users (PUT)

Параметры

Наименование	Тип	Описание
out_id (обязательно)	string	Уникальный идентификатор
login (обязательно)	string	Логин пользователя для авторизации в ПО
name (обязательно)	string	Наименование пользователя для отображения
name_in_receipt (обязательно)	string	Наименование пользователя в чеках
password (обязательно)	string	Пароль закодированный в SHA-256 (hex-строка)
is_allow_settings	int	Доступ в разделу настроек ПО

Пример


{
 "out_id": "6f87e829-722c-11df-b336-0011955cba6b",
 "login": "2",
 "name": "Волков Андрей Иванович",
 "name_in_receipt": "Волков Андрей Иванович",
 "password": "a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3",
 "is_allow_settings": false
}

doc

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

Документ доставки, возврата или поручения

Где используется

docs/headers (GET)

docs (GET)

docs (PUT)

Параметры

Примечание

Для получения документов (метод GET) выглядит так же, но добавляется суффикс _id:

type -> type_id,
payment_preferred_type -> payment_preferred_type_id

Наименование	Тип	Описание
out_id (обязательно)	string	Идентификатор документа в системе учета
type (обязательно)	int	Тип документа: 0 - Заказ, 1 - Возврат, 2 - Поручение
number (обязательно)	string	Номер документа в системе учета
date (обязательно)	timestamp	Дата создания в формате Unix timestamp
barcode	string	Штрихкод документа
comment	string	Комментарий документа
priority	int	Приоритет документа
client_name	string	Наименование клиента
recipient	object	Объект информации о получателе
manager	object	Объект информации о менеджере
address (обязательно)	string	Адрес доставки
address_location	string	Координаты доставки в формате “широта,долгота”
finish_location	string	GPS-координаты завершения документа
date_from	timestamp	Время начала действия документа
date_to	timestamp	Время окончания действия документа
user_id	string	Идентификатор пользователя в системе учета
fiscal_tags	string	Фискальные теги в формате json
inn	string	ИНН
payment_preferred_type_id	int	Предпочтительный тип оплаты для Заказов: 0 - наличный, 1 - безналичный, 2 - смешанный
client_notification	object	Объект настроек уведомления для клиента
receipts	object array	Массив объектов с данными по пробитым чекам
started_at	timestamp	Время начала обработки документа в Unix timestamp
updated_at	timestamp	Время последнего обновления документа в Unix timestamp
created_at	timestamp	Время создания документа в Unix timestamp
canceled_at	timestamp	Время отмены документа в Unix timestamp
finished_at	timestamp	Время завершения документа в Unix timestamp
payments	object array	Массив объектов с данными по оплатам
details	object array	Массив объектов с данными по строкам документа
cancel_reason	object	Объект причины отмены
description (обязательно для “Поручений”)	string	Описание поручения

Примечание

Для получения документов (метод GET) выглядит так же, но добавляется суффикс _id:

page

Mon, 01 Jan 0001 00:00:00 +0000

Назначение

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

Где используется

docs/headers (GET)
docs (GET)

Параметры

Наименование	Тип	Описание
size	string	Максимальная вместимость порции
number	string	Номер порции
total_pages	string	Общее количество порций

Пример


{ "page": { "size": 10, "number": 1, "total_pages": 1 }