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

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

POST `template`

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

URL: {{HTTPRoot}}/template

Тело запроса

{
  "Name": "Template",
  "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	+	Имя шаблона. Используется как уникальный идентификатор шаблона на сервере. Имя должно быть уникальным — создание шаблона с уже существующим именем не допускается. Поле является обязательным и не может быть пустым. Разрешённые символы: a-zA-Z0-9_-(). Использование пробелов не допускается.	“name120”
Type	int	+	Тип шаблона: 0 — Реклама; 1 — Строки чека; 2 — Шапка или подвал чека	1
TemplateItems	Список типа данных	+	Строки шаблона (только нефискальные поля)	“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 } } } ]

Тип: TemplateItems

Имя поля	Тип	Обяз	Назначение	Пример
PrintLine	Тип данных	+	Строка печати	“PrintLine”:

Тип: PrintLine

Имя поля	Тип	Обяз	Назначение	Пример
Type	int	+	Тип строки. 0, Fiscal — фискальная строка; 1, TextString — строка; 2, Barcode — штрихкод; 3, Picture — изображение; 4, Line — линия. Если не указано — принимается значение 1 (TextString).	1
Width	int	-	Ширина. Если не указано — 0 (ширина по содержимому).	0
Scale	int	-	Масштаб. Если не указано — применяется масштаб 100%.	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 (Normal).	0
Wrap	bool	-	Признак переноса строк. false - строка обрезается; true - строка переносится. Если не указано — принимается значение true.	true
Barcode	Тип данных	-	Штрихкод	“Barcode”: { “Type”: “QR”, “Value”: “https://www.rbsoft.ru/”, “PrintText”: 0, “Height”: 30, “BarWidth”: 6 }
SeparatorLine	Тип данных	-	Разделительная линия	“SeparatorLine”:

Тип: 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”
PrintText	int	-	Задает способ печати текста штрихкода(только для одномерных штрихкодов). 0 — не печатать 1 — печатать снизу 2 — печатать сверху 3 — печатать сверху и снизу. Если не указано — 0.	1
Height	int	-	Высота штрихкода в точках. Допустимые значения свойства: 0..1199	100
BarWidth	int	-	Ширина штриха в точках Допустимые значения свойства: 0..1199 Рекомендуемое значение – 2.	100

Тип: Picture

Имя поля	Тип	Обяз	Назначение	Пример
PictureBase64	string	+	Изображение закодированное в Base64	“iVBORw0KGgoAAAANSUhEUgA…”
Alignment	int	-	Выравнивание: 1 - по левому краю; 2 - по центру(по умолчанию); 3 - по правому краю. Если не указано — 2 (по центру).	2
Width	int	-	Ширина изображения при печати, в точках	200
Height	int	-	Высота изображения при печати, в точках	80

Тип: SeparatorLine

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

Тело ответа

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

{
    "Result": "Template",
    "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`

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

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
                }
            }
        }
    ]
}

Смотрите документацию POST-запроса template

Тело ответа

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

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

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

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

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

DELETE `template?id={id}`

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

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

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

Имя параметра	Тип	Обяз	Назначение	Пример
id	string	+	Название печатного щаблона	base_header

Тело ответа

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

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

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

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

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

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

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

GET `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	Список строк	Массив с названиями шаблонов	“base_advertisement”, “base_check_lines”, “base_header”, “name3”, “name7”, “test”

GET `template?name={name}`

Получение печатного шаблона

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

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

Имя параметра	Тип	Обяз	Назначение	Пример
name	string	+	Название шаблона.	base_header

Тело ответа

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

{
  "Result": {
    "Name": "Template",
    "TemplateItems": [
      {
        "PrintLine": {
          "Type": 1,
          "Width": 0,
          "Scale": 100,
          "Line": "Текст",
          "LineRight": "Информация",
          "Alignment": 1,
          "Font": 5,
          "IsFontSpecified": false,
          "Wrap": true,
          "IsCreateFromTemplate": false
        }
      },
      {
        "PrintLine": {
          "Type": 1,
          "Width": 0,
          "Scale": 100,
          "Line": "Сумма",
          "LineRight": "1 250,00",
          "Alignment": 0,
          "Font": 0,
          "IsFontSpecified": false,
          "Wrap": false,
          "IsCreateFromTemplate": false
        }
      },
      {
        "PrintLine": {
          "Type": 4,
          "Width": 0,
          "Scale": 100,
          "Line": "",
          "LineRight": "",
          "Alignment": 0,
          "Font": 0,
          "IsFontSpecified": false,
          "Wrap": true,
          "SeparatorLine": {
            "LineStyle": 0
          },
          "IsCreateFromTemplate": false
        }
      },
      {
        "PrintLine": {
          "Type": 2,
          "Width": 0,
          "Scale": 100,
          "Line": "",
          "LineRight": "",
          "Alignment": 1,
          "Font": 0,
          "IsFontSpecified": false,
          "Wrap": true,
          "Barcode": {
            "Type": "QR",
            "Value": "https://www.rbsoft.ru/",
            "PictureBase64": "iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIA...",
            "PrintText": 0,
            "Height": 30,
            "BarWidth": 6
          },
          "IsCreateFromTemplate": false
        }
      },
      {
        "PrintLine": {
          "Type": 3,
          "Width": 0,
          "Scale": 100,
          "Line": "",
          "LineRight": "",
          "Alignment": 1,
          "Font": 0,
          "IsFontSpecified": false,
          "Wrap": true,
          "Picture": {
            "PictureBase64": "iVBORw0KGgoAAAANSUhEUgAAASwAAAFJCAYAAAAhRBCcAAAAAX...",
            "Width": 200,
            "Height": 80,
            "StartLineNumber": 0,
            "EndLineNumber": 0,
            "Alignment": 2,
            "IsUploaded": false,
            "Override": false
          },
          "IsCreateFromTemplate": false
        }
      }
    ],
    "Type": 1
  },
  "Code": 0,
  "Description": "OK",
  "Success": true
}

Поле Result

Тип: TemplateParameters

Имя поля	Тип	Назначение	Пример
Name	string	Уникальное имя шаблона.	”“
TemplateItems	Список типа данных	+	Строки шаблона (только нефискальные поля)
Type	int	+	Тип шаблона: 0 — Реклама; 1 — Строки чека; 2 — Шапка или подвал чека

Тип: TemplateItems

Имя поля	Тип	Обяз	Назначение	Пример
PrintLine	Тип данных	Строка печати	“PrintLine”:

Тип: 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	Тип данных	Штрихкод	“Barcode”: { “Type”: “QR”, “Value”: “https://www.rbsoft.ru/”, “PrintText”: 0, “Height”: 30, “BarWidth”: 6 }
SeparatorLine	Тип данных	Разделительная линия	“SeparatorLine”:
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 закодированное в строке в кодировке base64	“iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAA…”
PrintText	int	Задает способ печати текста штрихкода(только для одномерных штрихкодов). 0 — не печатать; 1 — печатать снизу; 2 — печатать сверху; 3 — печатать сверху и снизу	1
Height	int	Высота штрихкода в точках. Допустимые значения свойства: 0..1199	100
BarWidth	int	Ширина штриха в точках. Допустимые значения свойства: 0..1199.	100

Тип: Picture

Имя поля	Тип	Назначение	Пример
PictureBase64	string	Изображение закодированное в Base64	“iVBORw0KGgoAAAANSUhEUgA…”
Alignment	int	Выравнивание: 1 - по левому краю; 2 - по центру; 3 - по правому краю.	2
Width	int	Ширина изображения при печати, в точках	200
Height	int	Высота изображения при печати, в точках	80
StartLineNumber	int	Номер первой строки печати изображения	0
EndLineNumber	int	Номер последней строки печати изображения	0
IsUploaded	bool	Признак загрузки изображения в память ККТ	false
Override	bool	Признак перезаписи изображения в памяти ККТ	false

Тип: 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

Тело запроса

Тип: TemplateItems

Тип: PrintLine

Тип: Barcode

Тип: Picture

Тип: SeparatorLine

Тело ответа

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

Поле Result

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

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

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

PUT template

Тело запроса

Тело ответа

Успешный ответ (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

Тип: TemplateItems

Тип: PrintLine

Тип: Barcode

Тип: Picture

Тип: SeparatorLine

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

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

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

POST `template`

PUT `template`

DELETE `template?id={id}`

GET `template/list`

GET `template?name={name}`