Термины

Данные термины встречаются в описании api.

Наша программа:

Программный продукт "J2:Производство и продажа компонентных систем" - центральная разработка нашей компании. Предоставляет api, описываемое в данной документации.

Внешний пользователь:

Пользователь, имеющий доступ к нашей программе только через api, например, пользователь нашего мобильного приложения или личного кабинета.

Аккаунт:

Совокупность данных внешнего пользователя.

Постраничный список:

Список, разделенный на страницы с заданным количеством элементов в каждой. Все методы, результат которых подразумевает получение большого объема однотипных данных (например, остатки номенклатуры) возвращают данные только одной страницы. Номер страницы и размер страницы регулируется параметрами запроса page и max соответственно. Одни и те же данные можно получить одним "тяжелым" запросом (1 страница размером в 50 элементов списка) или несколькими "легкими" запросами (5 страниц по 10 элементов списка). Если метод предполагает большой объём данных (например, остатки номенклатуры), рекомендуемый размер страницы - 20-25 элементов (например, список значений у опции в модели), и напротив, если возможных данных заведомо менее 50 элементов, следует использовать максимальный размер в 50 элементов, либо не передавать параметр max совсем.

Запись рабочего журнала:

Строка с любой текстовой информацией относительно какого-либо объекта (номенклатура, контрагент, заказ покупателя и т.п.) в нашей программе.

Основная валюта:

Валютой ведения учета в нашей программе. Обычно Российский рубль.