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

crm.invoice.recurring.fields

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

crm.invoice.recurring.fields()

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

Параметры

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

Пример

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

Поля

Поле ОписаниеТипПримечание
ID Идентификатор записи в таблице настроек регулярного счетаintegerТолько для чтения
INVOICE_ID ID шаблона счетаintegerНеизменяемое
ACTIVE Флаг активности. Значения: Y/Nchar
NEXT_EXECUTION Дата следующего создания нового счета из шаблона. Рассчитывается системой по указанным параметрам. Если значение пустое, новые счета не создаютсяdateТолько для чтения.
LAST_EXECUTION Дата последнего создания нового счета из шаблонаdateТолько для чтения
COUNTER_REPEAT Количество созданных из шаблона счетовintegerТолько для чтения
START_DATE Дата начала отсчета при расчете даты следующего создания нового счета - date - Если значние пустое, рассчитывается от текущей даты date
SEND_BILL Отправлять счет на почту, привязанную к плательщику. Значения: Y/Nchar
EMAIL_ID ID поля, содержащего email плательщикаinteger
IS_LIMIT Есть ли ограничения по созданию новых счетов. Значения: N - без ограничений, D - установлено ограничение по дате, T - установлено ограничение по количеству новых счетовchar
LIMIT_REPEAT Максимальное число счетов, которое можно создать из этого шаблонаintegerУчитывается, если IS_LIMIT равно T
LIMIT_DATE Дата, до достижения которой можно создавать счета из этого шаблонаdateУчитывается, если IS_LIMIT равно D
PARAMS Набор параметров для расчета - recurring_params:
  • PERIOD - период повторения:
    • day - день
    • week - неделя
    • month - месяц
    • year - год
  • TYPE - тип повторения для месяца и года:
    • если PERIOD равен month
      • 1 - расчет по порядковому номеру дня в месяце
      • 2 - расчет по номерам дней недели в месяце
    • если PERIOD равен year
      • 1 - расчет по порядковому номеру дня в заданном месяце
      • 2 - расчет по номерам дней недели в заданном месяце
  • INTERVAL - смещение при расчете
  • IS_WORKING_ONLY - учитываются только рабочие дни (Y/N)
  • WEEKDAY - полное наименование дня недели (согласно форматирования PHP метода date())
  • NUM_DAY_IN_MONTH - порядковый номер даты в месяце (PERIOD равен month или year)
  • NUM_WEEKDAY_IN_MONTH - номер дня недели в месяце (PERIOD равен month или year)
  • FIELD_YEARLY_INTERVAL_MONTH_NAME - номер дня недели в месяце (PERIOD равен month или year)
  • DATE_PAY_BEFORE_OFFSET_TYPE - значение смещения для расчета срока оплаты, расчет ведется от момента создания нового счета из шаблона:
    • day - день
    • week - неделя
    • month - месяц
    • year - год
  • DATE_PAY_BEFORE_OFFSET_VALUE - значение смещения для расчета срока оплаты, расчет ведется от момента создания нового счета из шаблона


© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх