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

crm.deal.recurring.fields

crm.deal.recurring.fields()

Возвращает список полей настройки шаблона регулярной сделки c описанием.

Параметры

Без параметров.

Поля

Поле ОписаниеТипПримечание
ID Идентификатор записи в таблице настроек регулярной сделкиintegerТолько для чтения
DEAL_ID ID шаблона сделкиintegerНеизменяемое
BASED_ID ID сделки, на основании которой был создан шаблонintegerНеизменяемое
ACTIVE Флаг активности. Значения: Y/Nchar
NEXT_EXECUTION Дата следующего создания новой сделки из шаблона. Рассчитывается системой по указанным параметрам. Если значение пустое, новые сделки не создаютсяdateТолько для чтения.
LAST_EXECUTION Дата последнего создания новой сделки из шаблонаdateТолько для чтения
COUNTER_REPEAT Количество созданных из шаблона сделокintegerТолько для чтения
START_DATE Дата начала отсчета при расчете даты следующего создания новой сделки. Если значение пустое, рассчитывается от текущей датыdate
CATEGORY_ID Категория, которая будет задана у сделки, созданной из шаблонаchar
IS_LIMIT Есть ли ограничения по созданию новых сделок. Значения: N - без ограничений, D - установлено ограничение по дате, T - установлено ограничение по количеству новых сделокchar
LIMIT_REPEAT Максимальное число сделок, которое можно создать из этого шаблонаintegerУчитывается, если IS_LIMIT равно T
LIMIT_DATE Дата, до достижения которой можно создавать сделки из этого шаблонаdateУчитывается, если IS_LIMIT равно D
PARAMS Набор параметров для расчета - recurring_params:
  • MODE - режим повторения:
    • single - единичный (будет создана одна сделка из шаблона, смещение рассчитывается до значения START_DATE);
    • multiple - множественный
  • MULTIPLE_TYPE - тип повторения в множественном режиме [MODE равен multiple]:
    • day - день
    • week - неделя
    • month - месяц
    • year - год
  • MULTIPLE_INTERVAL - значение смещения [MODE равен multiple]
  • SINGLE_BEFORE_START_DATE_TYPE - тип смещения до даты начала [MODE равен single]:
    • day - день
    • week - неделя
    • month - месяц
    • year - год
  • SINGLE_BEFORE_START_DATE_VALUE - значение смещения до даты начала, если не установлено - смещения нет [MODE равен single]
  • OFFSET_BEGINDATE_TYPE - тип смещения для расчета поля "даты начала сделки", расчет ведется от момента создания новой сделки из шаблона:
    • day - день
    • week - неделя
    • month - месяц
    • year - год
  • OFFSET_BEGINDATE_VALUE - значение смещения для расчета поля "даты начала сделки", расчет ведется от момента создания новой сделки из шаблона
  • OFFSET_CLOSEDATE_TYPE - значение смещения для расчета поля "даты завершения сделки", расчет ведется от момента создания новой сделки из шаблона:
    • day - день
    • week - неделя
    • month - месяц
    • year - год
  • OFFSET_CLOSEDATE_VALUE - значение смещения для расчета поля "даты завершения сделки", расчет ведется от момента создания новой сделки из шаблона

Пример:

    BX24.callMethod(
       "crm.deal.recurring.fields",
       {},
       function(result)
       {
           if(result.error())
               console.error(result.error());
           else
               console.dir(result.data());
       }
   );


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх