Печатный шаблон

> СерверККМ V4 > REST API > Работа с ККМ
Дата обновления: 15 июня 2026 г.

POST `template`

Запрос: /template

URL: {{HTTPRoot}}/template

Создание печатного шаблона

Тело запроса

{
    "Name": "name120",
    "Type": 1,
    "TemplateItems": [
        {
            "PrintLine": {
                "Type": 1,
                "Line": "Текст",
                "LineRight": "",
                "Alignment": 1,
                "Font": 5,
                "Wrap": true
            }
        },
        {
            "PrintLine": {
                "Type": 1,
                "Line": "Сумма",
                "LineRight": "1 250,00",
                "Alignment": 0,
                "Font": 0,
                "Wrap": false
            }
        },
        {
            "PrintLine": {
                "Type": 4,
                "SeparatorLine": {
                    "LineStyle": 0
                }
            }
        },
        {
            "PrintLine": {
                "Type": 2,
                "Alignment": 1,
                "Barcode": {
                    "Type": "QR",
                    "Value": "https://www.rbsoft.ru/",
                    "PrintText": 0,
                    "Height": 30,
                    "BarWidth": 6
                }
            }
        },
        {
            "PrintLine": {
                "Type": 3,
                "Alignment": 1,
                "Scale": 100,
                "Picture": {
                    "PictureBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
                    "Alignment": 2,
                    "Width": 200,
                    "Height": 80
                }
            }
        }
    ]
}

Имя поля	Тип	Обяз	Назначение	Пример
Name	string	+	название шаблона	“name120”
Type	enum	+	0 — Реклама; 1 — Строки чека; 2 — Шапка или подвал чека	1
TemplateItems	array	+	Массив строк шаблона	[…]

Поле PrintLine

Имя поля	Тип	Назначение	Пример
Type	int	Тип строки. 0, Fiscal — фискальная строка; 1, TextString — строка; 2, Barcode — штрихкод; 3, Picture — изображение; 4, Line — линия	1
Width	int	Ширина	0
Scale	int	Масштаб	100
Line	string	Текст строки (левая часть)	“Кассовый чек”
LineRight	string	Текст строки (правая часть)	”“
Alignment	int	Выравнивание. 0 — выравнивание по левому краю; 1 — Выравнивание по центру; 2 — Выравнивание по правому краю; 3 — По ширине	1
Font	int	Шрифт. 0, Normal — Шрифт для обычных строк; 1, Bold — Жирный шрифт для обычных строк; 2, Small — Мелкий шрифт для обычных строк; 3, Medium — Средний шрифт (применятся в шаблоне копий чеков); 4, Big — Крупный шрифт (применяется в шалоне копий чекой); 5, H1 — Шрифт заголовков (для шаблонов рекламных чеков); 6, H2 — Шрифт заголовков (для шаблонов рекламных чеков); 7, H3 — Шрифт заголовков (для шаблонов рекламных чеков); 8, H4 — Шрифт заголовков (для шаблонов рекламных чеков); 9, H5 — Шрифт заголовков (для шаблонов рекламных чеков);	0
Wrap	bool	Признак переноса строк. false - строка обрезается; true - строка переносится	true
Barcode	object	Штрихкод
SeparatorLine	object	Разделительная линия
IsCreateFromTemplate	bool	Создано из шаблона. true - создано из печатного шаблона; false — не создан из печатного шаблона	false

Barcode

Имя поля	Тип	Назначение	Пример
Type	string	Тип штрихкода. Возможные значения: UPCA; CODE39; EAN13; EAN8; UPCE; ITF; CODABAR; CODE93; CODE128; PDF417; CODE32; QR	“QR”
Value	string	Значение штрихкода	“t=20260522T1506&s=50.00&fn=9999078902010507&i=343&fp=1352614355&n=1”
PictureBase64	string	Изображение barcode закодированное в строке	“iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAA…”
PrintText	int	Задает способ печати текста штрихкода(только для одномерных штрихкодов). 0 — не печатать; 1 — печатать снизу; 2 — печатать сверху; 3 — печатать сверху и снизу	1
Height	int	Высота штрихкода в точках. Допустимые значения свойства: 0..1199	100
BarWidth	int	Ширина штриха в точках. Допустимые значения свойства: 0..1199; Рекомендуемое значение – 2.	100

Picture

Имя поля	Тип	Назначение	Пример
Base64	string	Изображение закодированное в Base64	“iVBORw0KGgoAAAANSUhEUgA…”
Alignment	int	1 left - по левому краю; 2 center - по центру(по умолчанию); 3 right - по правому краю	2
Height	int	Высота	80

SeparatorLine

Имя поля	Тип	Назначение	Пример
LineStyle	int	Стиль разделительной линии: 0, Solid — сплошная; 1, Bold — жирная; 2, Dashed — штриховая; 3, Dotted — пунктирная; 4, Double — двойная	1

Тело ответа

Успешный ответ (200 OK)

{
    "Result": "name120",
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Имя поля	Тип	Назначение	Пример
Result	string	название шаблона	“name7”

Примеры ошибок

72 — Имя шаблона не указано

{
    "Code": 72,
    "Description": "Имя шаблона не указано.",
    "Success": false
}

72 — Имя шаблона уже используется

{
    "Code": 72,
    "Description": "Не удалось создать шаблон:  Имя шаблона '{name}' уже используется..",
    "Success": false
}

PUT `template`

Запрос: /template

URL: {{HTTPRoot}}/template

Редактирование печатного шаблона по его уникальному названию

Тело запроса

{
    "Name": "name120",
    "Type": 0,
    "TemplateItems": [
        {
            "PrintLine": {
                "Type": 1,
                "Line": "Текс222т",
                "LineRight": "",
                "Alignment": 1,
                "Font": 5,
                "Wrap": true
            }
        },
        {
            "PrintLine": {
                "Type": 1,
                "Line": "Сумма",
                "LineRight": "1 250,00",
                "Alignment": 0,
                "Font": 0,
                "Wrap": false
            }
        },
        {
            "PrintLine": {
                "Type": 4,
                "SeparatorLine": {
                    "LineStyle": 0
                }
            }
        },
        {
            "PrintLine": {
                "Type": 2,
                "Alignment": 1,
                "Barcode": {
                    "Type": "QR",
                    "Value": "https://www.rbsoft.ru/",
                    "PrintText": 0,
                    "Height": 30,
                    "BarWidth": 6
                }
            }
        },
        {
            "PrintLine": {
                "Type": 3,
                "Alignment": 1,
                "Scale": 100,
                "Picture": {
                    "PictureBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
                    "Alignment": 2,
                    "Width": 200,
                    "Height": 80
                }
            }
        }
    ]
}

Имя поля	Тип	Обяз	Назначение	Пример
Name	string	+	название шаблона	“name120”
Type	enum	+	0 — Реклама; 1 — Строки чека; 2 — Шапка или подвал чека	1
TemplateItems	array	+	Массив строк шаблона	[…]

Поле PrintLine

Имя поля	Тип	Назначение	Пример
Type	int	Тип строки. 0, Fiscal — фискальная строка; 1, TextString — строка; 2, Barcode — штрихкод; 3, Picture — изображение; 4, Line — линия	1
Width	int	Ширина	0
Scale	int	Масштаб	100
Line	string	Текст строки (левая часть)	“Кассовый чек”
LineRight	string	Текст строки (правая часть)	”“
Alignment	int	Выравнивание. 0 — выравнивание по левому краю; 1 — Выравнивание по центру; 2 — Выравнивание по правому краю; 3 — По ширине	1
Font	int	Шрифт. 0, Normal — Шрифт для обычных строк; 1, Bold — Жирный шрифт для обычных строк; 2, Small — Мелкий шрифт для обычных строк; 3, Medium — Средний шрифт (применятся в шаблоне копий чеков); 4, Big — Крупный шрифт (применяется в шалоне копий чекой); 5, H1 — Шрифт заголовков (для шаблонов рекламных чеков); 6, H2 — Шрифт заголовков (для шаблонов рекламных чеков); 7, H3 — Шрифт заголовков (для шаблонов рекламных чеков); 8, H4 — Шрифт заголовков (для шаблонов рекламных чеков); 9, H5 — Шрифт заголовков (для шаблонов рекламных чеков);	0
Wrap	bool	Признак переноса строк. false - строка обрезается; true - строка переносится	true
Barcode	object	Штрихкод
SeparatorLine	object	Разделительная линия
IsCreateFromTemplate	bool	Создано из шаблона. true - создано из печатного шаблона; false — не создан из печатного шаблона	false

Barcode

Имя поля	Тип	Назначение	Пример
Type	string	Тип штрихкода. Возможные значения: UPCA; CODE39; EAN13; EAN8; UPCE; ITF; CODABAR; CODE93; CODE128; PDF417; CODE32; QR	“QR”
Value	string	Значение штрихкода	“t=20260522T1506&s=50.00&fn=9999078902010507&i=343&fp=1352614355&n=1”
PictureBase64	string	Изображение barcode закодированное в строке	“iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAA…”
PrintText	int	Задает способ печати текста штрихкода(только для одномерных штрихкодов). 0 — не печатать; 1 — печатать снизу; 2 — печатать сверху; 3 — печатать сверху и снизу	1
Height	int	Высота штрихкода в точках. Допустимые значения свойства: 0..1199	100
BarWidth	int	Ширина штриха в точках. Допустимые значения свойства: 0..1199; Рекомендуемое значение – 2.	100

Picture

Имя поля	Тип	Назначение	Пример
Base64	string	Изображение закодированное в Base64	“iVBORw0KGgoAAAANSUhEUgA…”
Alignment	int	1 left - по левому краю; 2 center - по центру(по умолчанию); 3 right - по правому краю	2
Height	int	Высота	80

SeparatorLine

Имя поля	Тип	Назначение	Пример
LineStyle	int	Стиль разделительной линии: 0, Solid — сплошная; 1, Bold — жирная; 2, Dashed — штриховая; 3, Dotted — пунктирная; 4, Double — двойная	1

Тело ответа

Успешный ответ (200 OK)

{
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Примеры ошибок

72 — Имя шаблона не указано

{
    "Code": 72,
    "Description": "Имя шаблона не указано.",
    "Success": false
}

DELETE `template?id={id}`

Запрос: /template

URL: {{HTTPRoot}}/template?id={id}

Удаление шаблона по названию

Параметры запроса

Параметр	Обяз	Пример	Описание
`id`	+	name1221212121220	Название шаблона

Тело ответа

Успешный ответ (200 OK)

{
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Примеры ошибок

72 — Файл шаблона не найден

{
    "Code": 72,
    "Description": "Не удалось удалить шаблон: Файл шаблона '{name}' не найден.",
    "Success": false
}

72 — Имя шаблона не указано

{
    "Code": 72,
    "Description": "Имя шаблона не указано.",
    "Success": false
}

GET `template/list`

Запрос: /template/list

URL: {{HTTPRoot}}/template/list

Получение списка печатных шаблонов

Тело ответа

Успешный ответ (200 OK)

{
    "Result": [
        "base_advertisement",
        "base_check_lines",
        "base_header",
        "name3",
        "name7",
        "test"
    ],
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Имя поля	Тип	Назначение	Пример
Result	array	Массив с названиями шаблонов	“base_advertisement”, “base_check_lines”, “base_header”, “name3”, “name7”, “test”

GET `template?name={name}`

Запрос: /template

URL: {{HTTPRoot}}/template?name={name}

Параметры запроса

Параметр	Обяз	Пример	Описание
`name`	+	base_header	Название печатного шаблона

Тело ответа

Успешный ответ (200 OK)

{
    "Result": {
        "Name": "base_header",
        "TemplateItems": [
            {
                "PrintLine": {
                    "Type": 1,
                    "Width": 0,
                    "Scale": 0,
                    "Line": "Шаблон шапки чека",
                    "LineRight": "",
                    "Alignment": 1,
                    "Font": 5,
                    "Wrap": false,
                    "IsCreateFromTemplate": true
                }
            },
            {
                "PrintLine": {
                    "Type": 1,
                    "Width": 0,
                    "Scale": 0,
                    "Line": "Товар",
                    "LineRight": "100.00",
                    "Alignment": 0,
                    "Font": 0,
                    "Wrap": false,
                    "IsCreateFromTemplate": true
                }
            },
            {
                "PrintLine": {
                    "Type": 4,
                    "Width": 0,
                    "Scale": 0,
                    "Line": "",
                    "LineRight": "",
                    "Alignment": 0,
                    "Font": 0,
                    "Wrap": false,
                    "SeparatorLine": {
                        "LineStyle": 0
                    },
                    "IsCreateFromTemplate": true
                }
            }
        ],
        "Type": 2
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: объект TemplateParameters

TemplateParameters

Имя поля	Тип	Назначение	Пример
Name	string	Уникальное имя шаблона.	”“
TemplateItems	array	Строки шаблона в виде упрощённых элементов (только нефискальные поля)	[…]
Type	enum	Тип печатной формы (реклама, строки чека, шапка/подвал).	2

Поле PrintLine

Имя поля	Тип	Назначение	Пример
Type	int	Тип строки. 0, Fiscal — фискальная строка; 1, TextString — строка; 2, Barcode — штрихкод; 3, Picture — изображение; 4, Line — линия	1
Width	int	Ширина	0
Scale	int	Масштаб	100
Line	string	Текст строки (левая часть)	“Кассовый чек”
LineRight	string	Текст строки (правая часть)	”“
Alignment	int	Выравнивание. 0 — выравнивание по левому краю; 1 — Выравнивание по центру; 2 — Выравнивание по правому краю; 3 — По ширине	1
Font	int	Шрифт. 0, Normal — Шрифт для обычных строк; 1, Bold — Жирный шрифт для обычных строк; 2, Small — Мелкий шрифт для обычных строк; 3, Medium — Средний шрифт (применятся в шаблоне копий чеков); 4, Big — Крупный шрифт (применяется в шалоне копий чекой); 5, H1 — Шрифт заголовков (для шаблонов рекламных чеков); 6, H2 — Шрифт заголовков (для шаблонов рекламных чеков); 7, H3 — Шрифт заголовков (для шаблонов рекламных чеков); 8, H4 — Шрифт заголовков (для шаблонов рекламных чеков); 9, H5 — Шрифт заголовков (для шаблонов рекламных чеков);	0
Wrap	bool	Признак переноса строк. false - строка обрезается; true - строка переносится	true
Barcode	object	Штрихкод
SeparatorLine	object	Разделительная линия
IsCreateFromTemplate	bool	Создано из шаблона. true - создано из печатного шаблона; false — не создан из печатного шаблона	false

Barcode

Имя поля	Тип	Назначение	Пример
Type	string	Тип штрихкода. Возможные значения: UPCA; CODE39; EAN13; EAN8; UPCE; ITF; CODABAR; CODE93; CODE128; PDF417; CODE32; QR	“QR”
Value	string	Значение штрихкода	“t=20260522T1506&s=50.00&fn=9999078902010507&i=343&fp=1352614355&n=1”
PictureBase64	string	Изображение barcode закодированное в строке	“iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAA…”
PrintText	int	Задает способ печати текста штрихкода(только для одномерных штрихкодов). 0 — не печатать; 1 — печатать снизу; 2 — печатать сверху; 3 — печатать сверху и снизу	1
Height	int	Высота штрихкода в точках. Допустимые значения свойства: 0..1199	100
BarWidth	int	Ширина штриха в точках. Допустимые значения свойства: 0..1199; Рекомендуемое значение – 2.	100

Picture

Имя поля	Тип	Назначение	Пример
Base64	string	Изображение закодированное в Base64	“iVBORw0KGgoAAAANSUhEUgA…”
Alignment	int	1 left - по левому краю; 2 center - по центру(по умолчанию); 3 right - по правому краю	2
Height	int	Высота	80

SeparatorLine

Имя поля	Тип	Назначение	Пример
LineStyle	int	Стиль разделительной линии: 0, Solid — сплошная; 1, Bold — жирная; 2, Dashed — штриховая; 3, Dotted — пунктирная; 4, Double — двойная	1

Примеры ошибок

72 — Не указано имя шаблона

{
    "Code": 72,
    "Description": "Не указано имя шаблона",
    "Success": false
}

704 — Файл шаблона не найден

{
    "Code": 704,
    "Description": "Файл шаблона '{name}' не найден.",
    "Success": false
}

Печатный шаблон

POST template

Тело запроса

Поле PrintLine

Barcode

Picture

SeparatorLine

Тело ответа

Успешный ответ (200 OK)

Поле Result

Примеры ошибок

72 — Имя шаблона не указано

72 — Имя шаблона уже используется

PUT template

Тело запроса

Поле PrintLine

Barcode

Picture

SeparatorLine

Тело ответа

Успешный ответ (200 OK)

Примеры ошибок

72 — Имя шаблона не указано

DELETE template?id={id}

Параметры запроса

Тело ответа

Успешный ответ (200 OK)

Примеры ошибок

72 — Файл шаблона не найден

72 — Имя шаблона не указано

GET template/list

Тело ответа

Успешный ответ (200 OK)

Поле Result

GET template?name={name}

Параметры запроса

Тело ответа

Успешный ответ (200 OK)

Поле Result

TemplateParameters

Поле PrintLine

Barcode

Picture

SeparatorLine

Примеры ошибок

72 — Не указано имя шаблона

704 — Файл шаблона не найден

POST `template`

PUT `template`

DELETE `template?id={id}`

GET `template/list`

GET `template?name={name}`