6 бизнес-инструментов от Kassa24 для успешного предпринимателя

Операции

Запросы на создание чековых операций отличаются от прочих запросов. Подробнее о формате запросов прочитайте в описании Общих требований и соглашений.

Автономный режим работы

Автономный режим работы доступен всем клиентам и включается и отключается автоматически.

При автономной работе для операций продажи, покупки, возврата продажи и возврата покупки может быть добавлено поле AFP, предназначенное для обозначения номера автономной операции. Поле AFP не является обязательным. Если автономный режим включен и имеется очередь операций, при отсутствии AFP автономный номер будет сгенерирован автоматически. При использовании поля AFP, оно должно быть в формате uint32: неотрицательное целое число от 0 до 4 294 967 295.

Поле ReceiptDate также является необязательным и предназначено для обозначения времени пробития чека. Если поле ReceiptDate отсутствует, будет автоматически создана текущая дата операции. Если ReceiptDate присутствует, он должен быть в формате RFC3339, который может быть прочитан пакетом time в Golang.

Необходимо сохранять очередность операций. Дата текущей операции не должна быть ранее даты предыдущей операции. В противном случае возвращается ошибка 400: Нарушена очередность операций.

Операция продажи

Чековая операция. Принимает Uid в заголовке запроса и возвращает новый в заголовке ответа.

Ожидает в теле запроса предчек со списком позиций и данными о внесенных суммах. Возвращает измененные счетчики балансов, изображение с чеком и номер чека.

1
POST /kkms/:IdKkm/sales

Данные на вход:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "IdDomain": 1,
  "Cash": 85,
  "NonCash": 0,
  "Positions": [
    {
      "Name": "Универсальный товар",
      "IdSection": 76635,
      "IdUnit": 1,
      "Price": 100,
      "Markup": 0,
      "Discount": 15,
      "Qty": 1,
      "Storno": false,
      "ProductCode": "",
      "IsFixedDiscountOrMarkup": false
    }
  ],
  "Total": 85,
  "Mobile": 0,
  "GenerateCheck": true,
  "CustomerIin": ""
}

Описание переменных

Название переменной	Тип переменной	Описание переменной	Обязательно
IdDomain	int	Идентификатор вида деятельности	Да
Cash	int	Сумма оплаты наличными	Да
NonCash	int	Сумма оплаты безналичными	Да
Mobile	int	Сумма платежей через мобильные устройства	Да
Total	float	Итоговая сумма	Да
SN	string	Серийный номер операции	Нет
GenerateCheck	bool	Генерация чека	Нет
AFP	int	Идентификатор наличия/отсутствия автономного режима работы	Нет
ReceiptDate	string	Время пробития чека при автономном режиме работы в формате ISO 8601. Например: "2006-01-02T15:04:05+06:00"	Нет
CustomerIin	string	ИИН/БИН покупателя	Нет
Positions	object	Список позиций товаров или услуг	Да
Name	string	Наименование позиции	Да
IdSection	int	Идентификатор отдела (секции)	Да
IdUnit	int	Единица измерения товара	Да
ProductCode	string	Артикул товара	Нет
Price	int	Цена позиции	Да
Markup	int	Сумма наценки	Нет
Discount	int	Сумма скидки	Нет
Qty	float	Количество товара	Да
Storno	bool	Позиция была сторнирована	Нет
IsFixedDiscountOrMarkup	bool	Флаг фиксированной наценки/скидки	Нет

Возвращает данные:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Balances": [ object ],
    "FiscalNumber": 1836733025,
    "AutonomousNumber": 0,
    "IdDocument": 1234567,    
    "Reciept": "123RECEIPT123",
    "Check": {
      "Host": "https://fiscal2.kassa24.kz",
      "Path": "/www/showcheck?datetime=2024-12-24T14:57:58\u0026znm=547756\u0026fn=585922312\u0026total=100.00"
    }
  }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Balances	object	Актуальные данные по балансам кассы (см. /kkms/:IdKk/balances)
FiscalNumber	int	Фискальный признак
AutonomousNumber	int	Автономный номер
IdDocument	int	Номер чека
Receipt	string	Картинка с чеком в base64
Host	string	Хост сервиса, предоставляющего доступ к информации о чеке
Path	string	Путь на сервере для доступа к информации о чеке. Содержит параметры, такие как дата и идентификаторы

Получение списка единиц измерения

1
GET/kkms/:IdKkm/units

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "Status": 200,
  "Message": "OK",
  "Data": [
    {
      "Id": 1,
      "Code": 796,
      "NameRU": "штука",
      "NameKAZ": "дана",
      "ShortName": "шт"
    }
  ]
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
id	int	Идентификатор единицы измерения
Code	int	Идентификатор в справочнике информационной системы электронных счетов-фактур
NameRU	string	Название единицы измерения на русском языке
NameKAZ	string	Название единицы измерения на казахском языке
ShortName	string	Сокращенное название единицы измерения

Ошибки

Status	Message	Способ устранения	Примечание
400	Некорректный запрос. Поле IdSection не должно быть пустым
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
402	Полученная сумма меньше стоимости
402	402: сумма операции не может быть равна нулю
402	Некорректный запрос. Поле Cash/NonCash должно быть положительным
403	Forbidden: Доступ к указанному ресурсу закрыт.	Проверить IdKkm кассы, выбрать IdKkm кассы
403	Forbidden: касса заблокирована	Связаться с тех. поддержкой	Если касса была заблокирована из-за проблем отправки данных в ОФД
423	Смена просрочена	Закрыть текущую смену и открыть смену заново	Смена длится 24 часа
452	Некорректный Uid	Запросить новый Uid
500	Internal Server Error	Обратиться в тех. поддержку

Блок-схема

Служебный приход

Чековая операция. Принимает Uid в заголовке запроса и возвращает новый в заголовке ответа.

Ожидает в теле запроса сумму наличных средств, которые нужно внести в кассу. Возвращает измененные счетчики балансов, изображение с чеком и номер чека.

Приход можно осуществить в автономном режиме, если у клиента есть лицензия нац. банка на такой режим. При автономном режиме работы в тело запроса добавляется поле Date. Если поле есть, то операция автономная, и если поля нет, то обычная.

1
POST /kkms/:IdKkm/incomes

Данные на вход:

1
2
3
4
{ 
  "Amount": 100,
  "Date": "2020-12-20T06:34:46+00:00"
}

Описание переменных

Название переменной	Тип переменной	Описание переменной	Обязательно
Amount	int	Сумма наличных	Да
Date	string	Дата при автономном режиме работы	Нет

Возвращает данные:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Balances": [ object ],
    "IdDocument": 1234568,
    "FiscalNumber": 0,
    "AutonomousNumber": 0,    
    "Receipt": "123RECEIPT123",
    "Check": {
      "Host": "https://fiscal2.kassa24.kz",
      "Path": "/www/showcheck?datetime=2024-12-24T20:14:02\u0026znm=547756\u0026fn=0\u0026total=500.00"
    }
  }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Balances	object	Актуальные данные по балансам кассы (см. /kkms/:IdKk/balances)
FiscalNumber	int	Фискальный признак
AutonomousNumber	int	Автономный номер
IdDocument	int	Номер чека
Receipt	string	Картинка с чеком в base64
Host	string	Хост сервиса, предоставляющего доступ к информации о чеке
Path	string	Путь на сервере для доступа к информации о чеке. Содержит параметры, такие как дата и идентификаторы

Ошибки

Status	Message	Способ устранения	Примечание
400	Некорректный запрос. Поле Amount не должно быть пустым
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
402	402: сумма операции не может быть равна нулю
403	Forbidden: Доступ к указанному ресурсу закрыт.	Проверить IdKkm кассы, выбрать IdKkm кассы
403	Forbidden: касса заблокирована	Связаться с тех. поддержкой	Если касса была заблокирована из-за проблем отправки данных в ОФД
423	Смена просрочена	Закрыть текущую смену и открыть смену заново	Смена длится 24 часа
452	Некорректный Uid	Запросить новый Uid
500	Internal Server Error	Обратиться в тех. поддержку

Блок-схема

Служебный расход

Чековая операция. Принимает Uid в заголовке запроса и возвращает новый в заголовке ответа.

Расход или инкассация. Ожидает в теле запроса сумму наличных средств, которые нужно забрать из кассы. Возвращает измененные счетчики балансов, изображение с чеком и номер чека.

Сумма не может быть больше счетчика баланса наличных в кассе.

Расход можно осуществить в автономном режиме, если у клиента есть лицензия нац. банка на такой режим. При автономном режиме работы в тело запроса добавляется поле Date. Если поле есть, то операция автономная, и если поля нет, то обычная.

1
POST /kkms/:IdKkm/expenses

Данные на вход:

1
2
3
4
{ 
  "Amount": 100,
  "Date": "2020-12-20T06:34:46+00:00"
}

Описание переменных

Название переменной	Тип переменной	Описание переменной	Обязательно
Amount	int	Сумма наличных	Да
Date	string	Дата при автономном режиме работы	Нет

Возвращает данные:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Balances": [ object ],
    "IdDocument": 1234569,
    "FiscalNumber": 0,
    "AutonomousNumber": 0,   
    "Receipt": "123RECEIPT123",
    "Check": {
      "Host": "https://fiscal2.kassa24.kz",
      "Path": "/www/showcheck?datetime=2024-12-24T20:17:06\u0026znm=547756\u0026fn=0\u0026total=500.00"
    }
  }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Balances	object	Актуальные данные по балансам кассы (см. /kkms/:IdKk/balances)
FiscalNumber	int	Фискальный признак
AutonomousNumber	int	Автономный номер
IdDocument	int	Номер чека
Receipt	string	Картинка с чеком в base64
Host	string	Хост сервиса, предоставляющего доступ к информации о чеке
Path	string	Путь на сервере для доступа к информации о чеке. Содержит параметры, такие как дата и идентификаторы

Ошибки

Status	Message	Способ устранения	Примечание
400	Некорректный запрос. Поле Amount не должно быть отрицательным
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
402	402: сумма операции не может быть равна нулю
402	Сумма операции превышает баланс кассы
403	Forbidden: Доступ к указанному ресурсу закрыт.	Проверить IdKkm кассы, выбрать IdKkm кассы
403	Forbidden: касса заблокирована	Связаться с тех. поддержкой	Если касса была заблокирована из-за проблем отправки данных в ОФД
423	Смена просрочена	Закрыть текущую смену и открыть смену заново	Смена длится 24 часа
452	Некорректный Uid	Запросить новый Uid
500	Internal Server Error	Обратиться в тех. поддержку

Блок-схема

Операция покупки

Чековая операция. Принимает Uid в заголовке запроса и возвращает новый в заголовке ответа.

Ожидает в теле запроса предчек со списком покупаемых товаров или услуг, которые нужно оплатить из кассы. Возвращает измененные счетчики балансов, изображение с чеком и номер чека.

1
POST /kkms/:IdKkm/purchases

Данные на вход:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "IdDomain": 1,
  "Cash": 100,
  "NonCash": 0,
  "Positions": [
    {
      "Name": "Универсальный товар",
      "IdSection": 76635,
      "IdUnit": 1,
      "Price": 100,
      "Markup": 0,
      "Discount": 0,
      "Qty": 1,
      "Storno": false
    }
  ],
  "Total": 100,
  "Mobile": 0,
  "GenerateCheck": true,
  "CustomerIin": ""
}

Описание переменных

Название переменной	Тип переменной	Описание переменной	Обязательно
IdDomain	int	Идентификатор вида деятельности	Да
Cash	int	Сумма оплаты наличными	Да
NonCash	int	Сумма оплаты безналичными	Да
Mobile	int	Сумма платежей через мобильные устройства	Да
Total	float	Итоговая сумма	Да
SN	string	Серийный номер операции	Нет
GenerateCheck	bool	Генерация чека	Нет
AFP	int	Идентификатор наличия/отсутствия автономного режима работы	Нет
ReceiptDate	string	Время пробития чека при автономном режиме работы в формате ISO 8601. Например: "2006-01-02T15:04:05+06:00"	Нет
CustomerIin	string	ИИН/БИН покупателя	Нет
Positions	object	Список позиций товаров или услуг	Да
Name	string	Наименование позиции	Да
IdSection	int	Идентификатор отдела (секции)	Да
IdUnit	int	Единица измерения товара	Да
ProductCode	string	Артикул товара	Нет
Price	int	Цена позиции	Да
Markup	int	Сумма наценки	Нет
Discount	int	Сумма скидки	Нет
Qty	float	Количество товара	Да
Storno	bool	Позиция была сторнирована	Нет
IsFixedDiscountOrMarkup	bool	Флаг фиксированной наценки/скидки	Нет

Возвращает данные:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Balances": [ object ],
    "FiscalNumber": 1836733025,
    "AutonomousNumber": 0,
    "IdDocument": 1234570,    
    "Receipt": "123RECEIPT123",
    "Check": {
      "Host": "https://fiscal2.kassa24.kz",
      "Path": "/www/showcheck?datetime=2024-12-24T20:20:12\u0026znm=547756\u0026fn=648226565\u0026total=100.00"
    }
  }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Balances	object	Актуальные данные по балансам кассы (см. /kkms/:IdKk/balances)
FiscalNumber	int	Фискальный признак
AutonomousNumber	int	Автономный номер
IdDocument	int	Номер чека
Receipt	string	Картинка с чеком в base64
Host	string	Хост сервиса, предоставляющего доступ к информации о чеке
Path	string	Путь на сервере для доступа к информации о чеке. Содержит параметры, такие как дата и идентификаторы

Получение списка единиц измерения

1
GET/kkms/:IdKkm/units

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "Status": 200,
  "Message": "OK",
  "Data": [
    {
      "Id": 1,
      "Code": 796,
      "NameRU": "штука",
      "NameKAZ": "дана",
      "ShortName": "шт"
    }
  ]
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
id	int	Идентификатор единицы измерения
Code	int	Идентификатор в справочнике информационной системы электронных счетов-фактур
NameRU	string	Название единицы измерения на русском языке
NameKAZ	string	Название единицы измерения на казахском языке
ShortName	string	Сокращенное название единицы измерения

Ошибки

Status	Message	Способ устранения	Примечание
400	Некорректный запрос. Поле IdSection не должно быть пустым
400	Некорректный запрос. Поле Cash/NonCash должно быть положительным
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
402	402: сумма операции не может быть равна нулю
402	Полученная сумма меньше стоимости
403	Forbidden: Доступ к указанному ресурсу закрыт.	Проверить IdKkm кассы, выбрать IdKkm кассы
403	Forbidden: касса заблокирована	Связаться с тех. поддержкой	Если касса была заблокирована из-за проблем отправки данных в ОФД
423	Смена просрочена	Закрыть текущую смену и открыть смену заново	Смена длится 24 часа
452	Некорректный Uid	Запросить новый Uid
500	Internal Server Error	Обратиться в тех. поддержку

Блок-схема

Операция возврата продажи

Чековая операция. Принимает Uid в заголовке запроса и возвращает новый Uid в заголовке ответа.

Ожидает в теле запроса предчек со списком позиций, на которые необходимо оформить возврат. Обязательно укажите серийный номер операции (SN). Возвращает обновленные счетчики балансов, изображение чека и номер чека.

1
POST /kkms/:IdKkm/refunds

Данные на вход:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "IdDomain": 1,
  "Cash": 100,
  "NonCash": 0,
  "Positions": [
    {
      "Name": "Универсальный товар",
      "IdSection": 76635,
      "IdUnit": 1,
      "Price": 100,
      "Markup": 0,
      "Discount": 0,
      "Qty": 1,
      "Storno": false
    }
  ],
  "Total": 100,
  "Mobile": 0,
  "GenerateCheck": true,
  "CustomerIin": "",
  "SN": "284886" 
}

Описание переменных

Название переменной	Тип переменной	Описание переменной	Обязательно
IdDomain	int	Идентификатор вида деятельности	Да
Cash	int	Сумма оплаты наличными	Да
NonCash	int	Сумма оплаты безналичными	Да
Mobile	int	Сумма платежей через мобильные устройства	Да
Total	float	Итоговая сумма	Да
SN	string	Серийный номер операции	Да
GenerateCheck	bool	Генерация чека	Нет
AFP	int	Идентификатор наличия/отсутствия автономного режима работы	Нет
ReceiptDate	string	Время пробития чека при автономном режиме работы в формате ISO 8601. Например: "2006-01-02T15:04:05+06:00"	Нет
CustomerIin	string	ИИН/БИН покупателя	Нет
Positions	object	Список позиций товаров или услуг	Да
Name	string	Наименование позиции	Да
IdSection	int	Идентификатор отдела (секции)	Да
IdUnit	int	Единица измерения товара	Да
ProductCode	string	Артикул товара	Нет
Price	int	Цена позиции	Да
Markup	int	Сумма наценки	Нет
Discount	int	Сумма скидки	Нет
Qty	float	Количество товара	Да
Storno	bool	Позиция была сторнирована	Нет
IsFixedDiscountOrMarkup	bool	Флаг фиксированной наценки/скидки	Нет

Возвращает данные:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Balances": [ object ],
    "FiscalNumber": 1836733025,
    "AutonomousNumber": 0,
    "IdDocument": 1234571,    
    "Reciept": "123RECEIPT123",
    "Check": {
      "Host": "https://fiscal2.kassa24.kz",
      "Path": "/www/showcheck?datetime=2024-12-24T14:57:58\u0026znm=547756\u0026fn=585922312\u0026total=100.00"
    }
  }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Balances	object	Актуальные данные по балансам кассы (см. /kkms/:IdKk/balances)
FiscalNumber	int	Фискальный признак
AutonomousNumber	int	Автономный номер
IdDocument	int	Номер чека
Receipt	string	Картинка с чеком в base64
Host	string	Хост сервиса, предоставляющего доступ к информации о чеке
Path	string	Путь на сервере для доступа к информации о чеке. Содержит параметры, такие как дата и идентификаторы

Получение списка единиц измерения

1
GET/kkms/:IdKkm/units

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "Status": 200,
  "Message": "OK",
  "Data": [
    {
      "Id": 1,
      "Code": 796,
      "NameRU": "штука",
      "NameKAZ": "дана",
      "ShortName": "шт"
    }
  ]
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
id	int	Идентификатор единицы измерения
Code	int	Идентификатор в справочнике информационной системы электронных счетов-фактур
NameRU	string	Название единицы измерения на русском языке
NameKAZ	string	Название единицы измерения на казахском языке
ShortName	string	Сокращенное название единицы измерения

Ошибки

Status	Message	Способ устранения	Примечание
400	Некорректный запрос. Поле IdSection не должно быть пустым
400	Некорректный запрос. Поле Cash/NonCash должно быть положительным
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
402	402: сумма операции не может быть равна нулю
402	Полученная сумма меньше стоимости
403	Forbidden: Доступ к указанному ресурсу закрыт.	Проверить IdKkm кассы, выбрать IdKkm кассы
403	Forbidden: касса заблокирована	Связаться с тех. поддержкой	Если касса была заблокирована из-за проблем отправки данных в ОФД
423	Смена просрочена	Закрыть текущую смену и открыть смену заново	Смена длится 24 часа
452	Некорректный Uid	Запросить новый Uid
500	Internal Server Error	Обратиться в тех. поддержку

Блок-схема

Операция возврата покупки

Чековая операция. Принимает Uid в заголовке запроса и возвращает новый Uid в заголовке ответа.

1
POST /kkms/:IdKkm/purchase_refunds

Данные на вход:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "IdDomain": 1,
  "Cash": 100,
  "NonCash": 0,
  "Positions": [
    {
      "Name": "Универсальный товар",
      "IdSection": 76635,
      "IdUnit": 1,
      "Price": 100,
      "Markup": 0,
      "Discount": 0,
      "Qty": 1,
      "Storno": false
    }
  ],
  "Total": 100,
  "Mobile": 0,
  "GenerateCheck": true,
  "CustomerIin": "",
  "SN": "284894"
}

Описание переменных

Название переменной	Тип переменной	Описание переменной	Обязательно
IdDomain	int	Идентификатор вида деятельности	Да
Cash	int	Сумма оплаты наличными	Да
NonCash	int	Сумма оплаты безналичными	Да
Mobile	int	Сумма платежей через мобильные устройства	Да
Total	float	Итоговая сумма	Да
SN	string	Серийный номер операции	Да
GenerateCheck	bool	Генерация чека	Нет
AFP	int	Идентификатор наличия/отсутствия автономного режима работы	Нет
ReceiptDate	string	Время пробития чека при автономном режиме работы в формате ISO 8601. Например: "2006-01-02T15:04:05+06:00"	Нет
CustomerIin	string	ИИН/БИН покупателя	Нет
Positions	object	Список позиций товаров или услуг	Да
Name	string	Наименование позиции	Да
IdSection	int	Идентификатор отдела (секции)	Да
IdUnit	int	Единица измерения товара	Да
ProductCode	string	Артикул товара	Нет
Price	int	Цена позиции	Да
Markup	int	Сумма наценки	Нет
Discount	int	Сумма скидки	Нет
Qty	float	Количество товара	Да
Storno	bool	Позиция была сторнирована	Нет
IsFixedDiscountOrMarkup	bool	Флаг фиксированной наценки/скидки	Нет

Возвращает данные:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
 "Status": 200,
 "Message": "OK",
 "Data": {
 "Balances": [ object ],
 "FiscalNumber": 1102294106,
 "AutonomousNumber": 0,
 "IdDocument": 1234567,
 "Reciept": "123RECEIPT123",
 "Check": {
      "Host": "https://fiscal2.kassa24.kz",
      "Path": "/www/showcheck?datetime=2024-12-24T15:08:49\u0026znm=547756\u0026fn=990855315\u0026total=100.00"
    }
 }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Balances	object	Актуальные данные по балансам кассы (см. /kkms/:IdKk/balances)
FiscalNumber	int	Фискальный признак
AutonomousNumber	int	Автономный номер
IdDocument	int	Номер чека
Receipt	string	Картинка с чеком в base64
Host	string	Хост сервиса, предоставляющего доступ к информации о чеке
Path	string	Путь на сервере для доступа к информации о чеке. Содержит параметры, такие как дата и идентификаторы

Получение списка единиц измерения

1
GET/kkms/:IdKkm/units

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "Status": 200,
  "Message": "OK",
  "Data": [
    {
      "Id": 1,
      "Code": 796,
      "NameRU": "штука",
      "NameKAZ": "дана",
      "ShortName": "шт"
    }
  ]
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
id	int	Идентификатор единицы измерения
Code	int	Идентификатор в справочнике информационной системы электронных счетов-фактур
NameRU	string	Название единицы измерения на русском языке
NameKAZ	string	Название единицы измерения на казахском языке
ShortName	string	Сокращенное название единицы измерения

Получить данные об операции

1
GET /operations/:IdDocument

Возвращает данные:

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Document": {
      "Id": 284922,
      "IdShift": 68608,
      "IdUser": 46541,
      "IdTypeDocument": 4,
      "IdKkm": 47756,
      "IdCompany": 26689,
      "DateDocument": "2024-12-24T20:20:12.70749+06:00",
      "NumberDoc": "04775617350500127",
      "Checksum": "123CHECKSUM123",
      "SN": "",
      "IdDomain": 1,
      "Value": 100.00,
      "Cash": 100.00,
      "NonCash": 0.00,
      "Mobile": 0.00,
      "Coins": 0,
      "Change": 0.00,
      "FiscalNumber": 0,
      "AutonomousNumber": 648226565,
      "CustomerIIN": "",
      "Offline": true,
      "Domain": {
        "Id": 1,
        "Name": "DOMAIN_TRADING"
      },
      "TypeDocument": {
        "Id": 4,
        "Name": "Покупка",
        "NameKaz": "Сатып алу"
      },
      "KKM": { object },
      "User": {
        "Id": 1032,
        "PhoneLogin": "77078385387",
        "Name": "first cashier",
        "Lock": false,
        "IdShift": 13327
      },
      "Shift": {
        "Id": 68608,
        "IdUser": 46541,
        "IdKkm": 47756,
        "IdStatusShift": 1,
        "IdCompany": 26689,
        "DateOpen": "2024-12-24T19:34:40+06:00",
        "DateClose": "0001-01-01T00:00:00Z",
        "BalanceOpen": 125476.73,
        "BalanceClose": 0,
        "BalanceCloseNonCash": 0,
        "ShiftIndex": 194
      },
      "ReceiptDate": "2024-12-24T20:20:12.70749+06:00",
      "Positions": [
        {
          "Id": 168172,
          "IdDocument": 284922,
          "IdArticle": 0,
          "IdSection": 76635,
          "IdCompany": 0,
          "IdUnit": 1,
          "Number": 0,
          "Name": "Универсальный товар",
          "Price": 100.00,
          "Nds": 10.71,
          "NdsDiscount": 0.00,
          "NdsMarkup": 0.00,
          "Discount": 0.00,
          "Markup": 0.00,
          "Qty": 1.00,
          "Total": 100.00,
          "Storno": false,
          "ProductCode": "",
          "Article": {
            "Id": 0,
            "Name": "",
            "Qr": "",
            "IdGroupArticle": 0,
            "IdSection": 0,
            "IdCompany": 0,
            "IdUnit": 0,
            "IdKkm": 0,
            "Price": 0.00,
            "Discount": 0.00,
            "Markup": 0.00,
            "Active": false
          },
          "Section": {
            "Id": 76635,
            "Name": "Без НДС",
            "IdKkm": 47756,
            "IdCompany": 26689,
            "Nds": 0,
            "Active": true,
            "SectionType": 0
          },
          "Unit": {
            "Id": 1,
            "Code": 796,
            "NameRU": "штука",
            "NameKAZ": "дана",
            "ShortName": "шт"
          }
        }
      ]
    },
    "Receipt": "123RECEIPT123",
    "Check": {
      "Host": "https://fiscal2.kassa24.kz",
      "Path": "/www/showcheck?datetime=2024-12-24T20:20:12\u0026znm=547756\u0026fn=648226565\u0026total=100.00"
    }
  }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Document	object	объект с информацией о документе
AutonomousNumber	int	Автономный фискальный признак
Cash	int	Сумма наличными
Change	int	Сумма сдачи
Checksum	string	Хэш с контрольной суммой
Coins	int	Копейки
DateDocument	string	Дата документа
Domain	object	Вид деятельности
Id	int	Идентификатор вида деятельности
Name	string	Название идентификатора вида деятельности
SN	string	Серийный номер операции
ReceiptDate	string	Время пробития чека при автономном режиме работы в формате ISO 8601
Positions	object	Список позиций товаров или услуг
FiscalNumber	int	Фискальный признак
Id	int	Идентификатор документа
IdCompany	int	Идентификатор компании
IdDomain	int	Идентификатор вида деятельности
IdKkm	int	Идентификатор ККМ
IdShift	int	Идентификатор смены
IdUser	int	Идентификатор пользователя (кассира)
KKM	object	Данные о ККМ, включая вложенный документ о юр. лице (см. GET /kkms/:IdKkm)
NonCash	int	Сумма безналичными
NumberDoc	string	Номер документа (чека)
TypeDocument	object	Тип документа
Id	int	Идентификатор типа документа
Name	string	Название идентификатора типа документа
User	object	Документ с данными о пользователе
Id	int	Идентификатор пользователя
IdShift	int	Идентификатор смены открытой или последней открытой смены
Lock	bool	Признак блокировки сменой
Name	string	Имя пользователя
PhoneLogin	string	Номер пользователя
Value	int	Сумма документа
Receipt	string	Картинка с чеком в base64
Host	string	Хост сервиса, предоставляющего доступ к информации о чеке
Path	string	Путь на сервере для доступа к информации о чеке. Содержит параметры, такие как дата и идентификаторы

Ошибки

Status	Message	Способ устранения	Примечание
400	Bad request		Если идентификатор операции некорректный
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
403	Вы не имеете доступ к указанному объекту		Если документ был создан в другой компании, в которой пользователь не зарегистрирован
500	Internal Server Error	Обратиться в тех. поддержку
402	Полученная сумма меньше стоимости
403	Forbidden: Доступ к указанному ресурсу закрыт.	Проверить IdKkm кассы, выбрать IdKkm кассы
403	Forbidden: касса заблокирована	Связаться с тех. поддержкой	Если касса была заблокирована из-за проблем отправки данных в ОФД

Блок-схема

Получить дубликат чека

1
GET /receipt?datetime=2024-12-24T20:20:12&znm=547756&fn=648226565&total=100.00

Описание querystring параметров

Название переменной	Тип переменной	Описание переменной
datetime	ISO 8601 date(YYYY-MM-DDThh:mm:ss)	Обязательный. querystring-параметр дата и время покупки
znm	int	Обязательный. querystring-параметр заводской номер машины (ЗНМ) кассы
fn	int	Обязательный. querystring-параметр фискальный признак
total	int	Обязательный. querystring-параметр итого

Возвращает данные:

1
2
3
4
5
{
  "Status": 200,
  "Message": "OK",
  "Data": "123RECEIPT123"
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Data	string	Картинка с чеком в base64

Ошибки

Status	Message	Способ устранения	Примечание
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
500	Internal Server Error	Обратиться в тех. поддержку