Документация для разработчиков
Темная тема

sale.cashbox.list

Scope: sale, cashbox Права на выполнение: для всех

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

Метод возвращает список настроенных касс.

Пример

// выбор всех полей всех касс
BX24.callMethod(
	"sale.cashbox.list",
	{
		
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);
 
// выбор определённых полей
BX24.callMethod(
	"sale.cashbox.list",
	{
		"SELECT": ["ID", "NAME"]
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);
 
// фильтрация элементов
BX24.callMethod(
	"sale.cashbox.list",
	{
		"SELECT": ["ID", "NAME"],
		"FILTER": {">ID": 9}
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);
 
BX24.callMethod(
	"sale.cashbox.list",
	{
		"SELECT": ["ID", "NAME"],
		"FILTER": {"=NAME": "Моя Rest-касса"}
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);
 
// упорядочивание элементов
BX24.callMethod(
	"sale.cashbox.list",
	{
		"SELECT": ["ID", "NAME"],
		"ORDER": {"ID": "DESC"},
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);

Параметры

Параметр Описание С версии
SELECT Список выбираемых полей. Доступные для выбора поля:
  • ID - ID кассы;
  • NAME - название кассы;
  • HANDLER - обработчик;
  • OFD - код обработчика ОФД;
  • EMAIL - email, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков;
  • DATE_CREATE - дата создания;
  • DATE_LAST_CHECK - дата последней проверки;
  • NUMBER_KKM - внешний идентификатор кассы;
  • KKM_ID - марка ККМ;
  • ACTIVE - активность кассы;
  • SORT - сортировка;
  • USE_OFFLINE - используется ли касса офлайн;
  • ENABLED - доступность.
FILTER Список фильтров. Формат такой же, как у фильтров ORM (к примеру, в getList Чтобы новое API выглядело для разработчика менее пугающим и более знакомым, сохранено имя самого популярного метода: getList. Но если раньше каждый getList имел свой набор параметров и зашитое непрозрачное поведение, то теперь этот метод един для всех сущностей и подчиняется одним законам. Даже при желании у разработчика сущности сделать "костыль" в getList ничего не выйдет.

Подробнее...
).
ORDER Параметры сортировки. Формат: {поле: направление (ASC, DESC)}.



© «Битрикс», 2001-2024, «1С-Битрикс», 2024