Documentation

crm.deal.recurring.fields

crm.deal.recurring.fields()

The method returns list of settings for recurring deal template with description.

Parameters

No parameters.

Fields

Field DescriptionTypeNote
ID Record ID in the recurring deal settings tableintegerRead only
DEAL_ID deal template IDintegerUnmodifiable
BASED_ID deal ID used to create the templateintegerUnmodifiable
ACTIVE Activity flag. Values: Y/Nchar
NEXT_EXECUTION Date when the next new deal is created from a template. Calculated by the system based on specified parameters. If value is empty, new deals are not createddateRead only.
LAST_EXECUTION Date when the last new deal was created from a templatedateRead only
COUNTER_REPEAT Number of deals created from a templateintegerRead only
START_DATE Start date when calculating the next deal creation date. If value is empty, new deals are not createddate
CATEGORY_ID Category that is specified for a deal, created from a templatechar
IS_LIMIT Set limit to creating new deals. Values: N - no limits, D - specified limit by date, T - specified limit by the number of new dealschar
LIMIT_REPEAT Maximum number of deals that can be created from this templateintegerConsidered if IS_LIMIT equals T
LIMIT_DATE limit date, after which deals can be created from this templatedate Considered if IS_LIMIT equals D
PARAMS Set of calculation parameters - recurring_params:
  • MODE - recurring mode:
    • single: one template deal is created, offset is calculated up to value START_DATE);
    • multiple
  • MULTIPLE_TYPE - type of recurrence in the multiple mode [MODE equals multiple]:
    • day
    • week
    • month
    • year
  • MULTIPLE_INTERVAL - offset value [MODE equals multiple]
  • SINGLE_BEFORE_START_DATE_TYPE - offset type before start date [MODE equals single]:
    • day
    • week
    • month
    • year
  • SINGLE_BEFORE_START_DATE_VALUE - offset value before start date. If not specified - there is no offset [MODE equals single]
  • OFFSET_BEGINDATE_TYPE - offset type for calculation of "deal start date" field. Calculation is performed when new deal is created from a template:
    • day
    • week
    • month
    • year
  • OFFSET_BEGINDATE_VALUE - offset value for calculation of "deal start" field. Calculation is performed from the moment when new deal is created from a template
  • OFFSET_CLOSEDATE_TYPE - offset value for calculation of "deal closed" field. Calculation is performed from the moment when new deal is created from a template:
    • day
    • week
    • month
    • year
  • OFFSET_CLOSEDATE_VALUE - offset value for calculation of "deal close date" field. Calculation is performed when new deal is created from a template

Example:

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


User Comments

User comments are not part of official documentation. Use information provided by other users in the comments at your own risk.

The User Comments section is not to be used as a feature discussion board. Only registered users can post comments. Your comment will be visible once it has been approved by the moderator.
© «Bitrix Inc.», 2001-2019, «Bitrix Inc.», 2019