docs (GET)

Тип метода

GET

Назначение

• Порционное получение массива объектов документов с сервера - до 10 документов в одной порции

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

• АРМ.Диспетчера / Документы - кнопка "Обновить"

Запрос

http://dmd.data-mobile.ru/api/erp/docs  

Content-Type: application/json  
Authorization: Bearer <TOKEN>

Ответ

Тело

Наименование	Тип	Описание
data	object array	Список документов в порции
page	object	Объект информации о порции документов

Описание объекта data

Наименование	Тип	Описание
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	Координаты доставки в формате "широта,долгота"
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	Описание поручения

Описание объекта page

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

Пример ответа #1

Порционное получение массива объектов документов с сервера

{
    "page": {
        "size": 10,
        "number": 1,
        "total_pages": 1
    },
    "data": [
        {
            "out_id": "f65590a9-0fb3-11f0-bab4-c8b29b632b7a",
            "type_id": 0,
            "number": "ТД00-000044",
            "date": 1743592669,
            "barcode": "327434366257465913423909310513765624698",
            "comment": "",
            "priority": 1,
            "client_name": "Алхимов А.А.",
            "recipient": {
                "name": "Сидоренко Петр Константинович ",
                "phone": "(495) 5679080"
            },
            "manager": {
                "name": "Гладилина Вера Михайловна"
            },
            "address": "Новороссийск, улица Советов, д. 24",
            "address_location": "",
            "date_from": 1743541200,
            "date_to": 1743541200,
            "fiscal_tags": "{\"TAG_1227\":\"ОАО \\\"Алхимов А.А.\\\"\",\"TAG_1228\":\"7726661966\"}",
            "inn": "9999115007",
            "is_payment_not_required": false,
            "payment_preferred_type_id": 2,
            "client_notification": {
                "type_id": 0,
                "email": "alh@mail.ru",
                "phone": "(495) 809-90-90"
            },
            "receipts": [],
            "created_at": 1743677178,
            "payments": [],
            "details": [
                {
                    "out_id": "8U-e8a71fd6-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000",
                    "source_qty": 1.0,
                    "actual_qty": 1.0,
                    "price": 0.0,
                    "nds_type_id": 2,
                    "fiscal_tags": "{\"TAG_1227\":\"ОАО \\\"Алхимов А.А.\\\"\",\"TAG_1228\":\"7726661966\"}",
                    "article": {
                        "out_id": "8U-e8a71fd6-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000",
                        "name": "Молоко \"Останкинское\" 3.2% ",
                        "short_name": "Молоко \"Останкинское\" 3.2% ",
                        "attr_1": "Арт-879000",
                        "attr_2": "000000067  ",
                        "attr_3": "",
                        "attr_4": "",
                        "attr_5": "",
                        "attr_6": "",
                        "attr_7": "",
                        "attr_8": "",
                        "attr_9": "",
                        "attr_10": "",
                        "measure_type_id": 0,
                        "mark_type_id": 0,
                        "subject_type_id": 0,
                        "barcodes": [
                            {
                                "barcode": "2000000036588",
                                "unit_coef": 1.0,
                                "unit_name": "шт"
                            },
                            {
                                "barcode": "2000000036595",
                                "unit_coef": 8.0,
                                "unit_name": "упак (8 шт)"
                            }
                        ]
                    },
                    "marking_codes": []
                }
            ]
        },
        {
            "out_id": "f65590a5-0fb3-11f0-bab4-c8b29b632b7a",
            "type_id": 0,
            "number": "ЧП00-000003",
            "date": 1743592606,
            "barcode": "327434365940553263366851960139589823354",
            "comment": "",
            "priority": 1,
            "client_name": "АВИКА",
            "recipient": {
                "name": ""
            },
            "manager": {
                "name": "Ковальков Николай Федорович"
            },
            "address": "Новороссийск, ул. Толстого, д. 1",
            "address_location": "",
            "date_from": 1743541200,
            "date_to": 1743541200,
            "fiscal_tags": "{\"TAG_1227\":\"АВИКА\",\"TAG_1228\":\"4825005381\"}",
            "inn": "054302743481",
            "is_payment_not_required": false,
            "payment_preferred_type_id": 2,
            "client_notification": {
                "type_id": 0,
                "email": "",
                "phone": ""
            },
            "receipts": [],
            "created_at": 1743677178,
            "payments": [],
            "details": [
                {
                    "out_id": "8U-e8a71fd6-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000",
                    "source_qty": 1.0,
                    "actual_qty": 1.0,
                    "price": 40.0,
                    "nds_type_id": 0,
                    "fiscal_tags": "{\"TAG_1227\":\"АВИКА\",\"TAG_1228\":\"4825005381\"}",
                    "article": {
                        "out_id": "8U-e8a71fd6-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000",
                        "name": "Молоко \"Останкинское\" 3.2% ",
                        "short_name": "Молоко \"Останкинское\" 3.2% ",
                        "attr_1": "Арт-879000",
                        "attr_2": "000000067  ",
                        "attr_3": "",
                        "attr_4": "",
                        "attr_5": "",
                        "attr_6": "",
                        "attr_7": "",
                        "attr_8": "",
                        "attr_9": "",
                        "attr_10": "",
                        "measure_type_id": 0,
                        "mark_type_id": 0,
                        "subject_type_id": 0,
                        "barcodes": [
                            {
                                "barcode": "2000000036588",
                                "unit_coef": 1.0,
                                "unit_name": "шт"
                            },
                            {
                                "barcode": "2000000036595",
                                "unit_coef": 8.0,
                                "unit_name": "упак (8 шт)"
                            }
                        ]
                    },
                    "marking_codes": []
                }
            ]
        },
        {
            "out_id": "fae3afea-0bb4-11f0-bab4-c8b29b632b7a",
            "type_id": 0,
            "number": "ЧП00-000002",
            "date": 1743153386,
            "barcode": "333489218297809067954275189533058476922",
            "comment": "",
            "priority": 1,
            "client_name": "АВИКА",
            "recipient": {
                "name": "Добренко Борис Михайлович"
            },
            "manager": {
                "name": "Ковальков Николай Федорович"
            },
            "address": "Новороссийск, пр-кт. Ленина 104, д. 1",
            "address_location": "",
            "date_from": 1743109200,
            "date_to": 1743109200,
            "fiscal_tags": "{\"TAG_1227\":\"АВИКА\",\"TAG_1228\":\"4825005381\"}",
            "inn": "054302743481",
            "is_payment_not_required": false,
            "payment_preferred_type_id": 2,
            "client_notification": {
                "type_id": 0,
                "email": "",
                "phone": ""
            },
            "receipts": [],
            "created_at": 1743677178,
            "payments": [],
            "details": [
                {
                    "out_id": "8U-27c286ec-e507-11e4-92f1-0050568b35ac00000000-0000-0000-0000-000000000000",
                    "source_qty": 3.0,
                    "actual_qty": 3.0,
                    "price": 200.0,
                    "nds_type_id": 0,
                    "fiscal_tags": "{\"TAG_1227\":\"АВИКА\",\"TAG_1228\":\"4825005381\"}",
                    "article": {
                        "out_id": "8U-27c286ec-e507-11e4-92f1-0050568b35ac00000000-0000-0000-0000-000000000000",
                        "name": "Сок апельсиновый 2 л ",
                        "short_name": "Сок апельсиновый 2 л ",
                        "attr_1": "",
                        "attr_2": "00-00000063",
                        "attr_3": "",
                        "attr_4": "",
                        "attr_5": "",
                        "attr_6": "",
                        "attr_7": "",
                        "attr_8": "",
                        "attr_9": "",
                        "attr_10": "",
                        "measure_type_id": 0,
                        "mark_type_id": 0,
                        "subject_type_id": 0,
                        "barcodes": []
                    },
                    "marking_codes": []
                }
            ]
        },
        {
            "out_id": "fae3afe3-0bb4-11f0-bab4-c8b29b632b7a",
            "type_id": 0,
            "number": "ТД00-000042",
            "date": 1743153360,
            "barcode": "333489217743211930354424826378250824570",
            "comment": "",
            "priority": 1,
            "client_name": "Алхимов А.А.",
            "recipient": {
                "name": "Сидоренко Петр Константинович ",
                "phone": "(495) 5679080"
            },
            "manager": {
                "name": "Федоров Борис Михайлович",
                "phone": "(495) 5671111"
            },
            "address": "Новороссийск, улица Советов, д. 1",
            "address_location": "",
            "date_from": 1743109200,
            "date_to": 1743109200,
            "fiscal_tags": "{\"TAG_1227\":\"ОАО \\\"Алхимов А.А.\\\"\",\"TAG_1228\":\"7726661966\"}",
            "inn": "9999115007",
            "is_payment_not_required": false,
            "payment_preferred_type_id": 2,
            "client_notification": {
                "type_id": 0,
                "email": "alh@mail.ru",
                "phone": "(495) 809-90-90"
            },
            "receipts": [],
            "created_at": 1743677178,
            "payments": [],
            "details": [
                {
                    "out_id": "8U-0c6013db-ea5e-11e0-a7cd-e0cb4ed5f6e400000000-0000-0000-0000-000000000000",
                    "source_qty": 10.0,
                    "actual_qty": 10.0,
                    "price": 3.56,
                    "nds_type_id": 6,
                    "fiscal_tags": "{\"TAG_1227\":\"ОАО \\\"Алхимов А.А.\\\"\",\"TAG_1228\":\"7726661966\"}",
                    "article": {
                        "out_id": "8U-0c6013db-ea5e-11e0-a7cd-e0cb4ed5f6e400000000-0000-0000-0000-000000000000",
                        "name": "Кабель NYM (Севкабель) 1х6 ",
                        "short_name": "Кабель NYM (Севкабель) 1х6 ",
                        "attr_1": "NYM 1х6",
                        "attr_2": "ЦУ-00000032",
                        "attr_3": "",
                        "attr_4": "",
                        "attr_5": "",
                        "attr_6": "",
                        "attr_7": "",
                        "attr_8": "",
                        "attr_9": "",
                        "attr_10": "",
                        "measure_type_id": 0,
                        "mark_type_id": 0,
                        "subject_type_id": 0,
                        "barcodes": [
                            {
                                "barcode": "2000000058436",
                                "unit_coef": 1.0,
                                "unit_name": "шт (1 шт)"
                            },
                            {
                                "barcode": "2100000058443",
                                "unit_coef": 1.0,
                                "unit_name": "шт (1 шт)"
                            },
                            {
                                "barcode": "E2002064860C025818405548",
                                "unit_coef": 1.0,
                                "unit_name": "шт (1 шт)"
                            }
                        ]
                    },
                    "marking_codes": []
                }
            ]
        }
    ]
}