# crm.deal.recurring.add

URL: https://chugunov.pro/api-bitrix24/crm/deals/recurring-deals/crm-deal-recurring-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Создать шаблон регулярной сделки
Scope: `crm`
Кто может выполнять метод: пользователь с правами «добавление» и «изменение» сделок

## Описание

Метод `crm.deal.recurring.add` создает шаблон регулярной сделки на основе сделки.

## Параметры

- `fields` `object` — необязательный. Объект формата:
  ```
  {
      field_1: value_1,
      field_2: value_2,
      ...,
      field_n: value_n,
  }
  ```
  где:
  - `field_n` — название поля настройки
  - `value_n` — значение поля настройки
  Список доступных полей описан [ниже](#fields)

### Параметр fields

- `DEAL_ID` `integer` — необязательный. Идентификатор сделки, на основе которой создается шаблон регулярной сделки.
  Идентификатор сделки можно получить с помощью методов [crm.deal.list](https://chugunov.pro/api-bitrix24/crm/deals/crm-deal-list/) или [crm.deal.add](https://chugunov.pro/api-bitrix24/crm/deals/crm-deal-add/)
- `ACTIVE` `char` — необязательный. Флаг активности настройки. Возможные значения:
  - `Y` — активна
  - `N` — неактивна
- `CATEGORY_ID` `char` — необязательный. id воронки для новых сделок, создаваемых из шаблона.
  Список доступных воронок можно узнать с помощью метода [crm.category.list](https://chugunov.pro/api-bitrix24/crm/universal/category/crm-category-list/), передав `entityTypeId = 2`
- `IS_LIMIT` `char` — необязательный. Ограничение по созданию новых сделок:
  `N` — без ограничений
  `D` — ограничение по дате (`LIMIT_DATE`)
  `T` — ограничение по количеству (`LIMIT_REPEAT`)
  Если передано любое другое значение, оно будет приведено к `N`
- `LIMIT_REPEAT` `integer` — необязательный. Максимальное количество сделок, которые можно создать из шаблона. Используется при `IS_LIMIT = T`
- `LIMIT_DATE` `date` — необязательный. Дата окончания генерации сделок из шаблона в формате `YYYY-MM-DD`. Используется при `IS_LIMIT = D`
- `START_DATE` `date` — необязательный. Дата начала расчета следующего запуска в формате `YYYY-MM-DD`
- `PARAMS` `object` — необязательный. Параметры периодичности [(подробное описание)](#params)

### Параметр PARAMS

- `MODE` `string` — необязательный. Режим повторения:
  `single` — одиночный
  `multiple` — множественный
- `MULTIPLE_TYPE` `string` — необязательный. Тип периода для `MODE = multiple`:
  `day`, `week`, `month`, `year`
- `MULTIPLE_INTERVAL` `integer` — необязательный. Интервал повторения для `MODE = multiple`
- `SINGLE_BEFORE_START_DATE_TYPE` `string` — необязательный. Тип смещения для `MODE = single`:
  `day`, `week`, `month`, `year`
- `SINGLE_BEFORE_START_DATE_VALUE` `integer` — необязательный. Значение смещения для `MODE = single`
- `OFFSET_BEGINDATE_TYPE` `string` — необязательный. Тип смещения даты начала создаваемой сделки:
  `day`, `week`, `month`, `year`
- `OFFSET_BEGINDATE_VALUE` `integer` — необязательный. Значение смещения даты начала создаваемой сделки
- `OFFSET_CLOSEDATE_TYPE` `string` — необязательный. Тип смещения даты завершения создаваемой сделки:
  `day`, `week`, `month`, `year`
- `OFFSET_CLOSEDATE_VALUE` `integer` — необязательный. Значение смещения даты завершения создаваемой сделки

## Ответ

HTTP-статус: 200

```json
{
    "result": 15,
    "time": {
        "start": 1772664456,
        "finish": 1772664457.379632,
        "duration": 1.3796319961547852,
        "processing": 1,
        "date_start": "2026-03-05T01:47:36+03:00",
        "date_finish": "2026-03-05T01:47:37+03:00",
        "operating_reset_at": 1772665056,
        "operating": 0.7352650165557861
    }
}
```

### Возвращаемые данные

- `result` `integer`. Идентификатор созданной настройки шаблона регулярной сделки
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "",
    "error_description": "Deal already have had recurring settings."
}
```

- `Parameter 'fields' must be array` — Параметр `fields` не передан или передан не в формате объекта
- `Parameter 'params' must be array` — Параметр `params` передан не в формате объекта
- `Deal id is empty` — В `fields.DEAL_ID` передано пустое или некорректное значение
- `Access denied` — Недостаточно прав для изменения исходной сделки или создания сделок
- `Deal already have had recurring settings` — Для переданной сделки уже существует настройка регулярности

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"DEAL_ID":45,"CATEGORY_ID":"1","IS_LIMIT":"D","LIMIT_DATE":"2027-03-04","START_DATE":"2026-04-04","PARAMS":{"MODE":"multiple","MULTIPLE_TYPE":"month","MULTIPLE_INTERVAL":1,"OFFSET_BEGINDATE_TYPE":"day","OFFSET_BEGINDATE_VALUE":1,"OFFSET_CLOSEDATE_TYPE":"month","OFFSET_CLOSEDATE_VALUE":2}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.recurring.add
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"DEAL_ID":45,"CATEGORY_ID":"1","IS_LIMIT":"D","LIMIT_DATE":"2027-03-04","START_DATE":"2026-04-04","PARAMS":{"MODE":"multiple","MULTIPLE_TYPE":"month","MULTIPLE_INTERVAL":1,"OFFSET_BEGINDATE_TYPE":"day","OFFSET_BEGINDATE_VALUE":1,"OFFSET_CLOSEDATE_TYPE":"month","OFFSET_CLOSEDATE_VALUE":2}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.recurring.add
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

const current = new Date()
const nextMonth = new Date()
const nextYear = new Date()
nextMonth.setMonth(current.getMonth() + 1)
nextYear.setFullYear(current.getFullYear() + 1)

const padDatePart = (part: number) => (part >= 10 ? part.toString() : `0${part}`)
const date2str = (d: Date) =>
  `${d.getFullYear()}-${padDatePart(1 + d.getMonth())}-${padDatePart(d.getDate())}`

try {
  const response = await $b24.actions.v2.call.make<number>({
    method: 'crm.deal.recurring.add',
    params: {
      fields: {
        DEAL_ID: 45,
        CATEGORY_ID: '1',
        IS_LIMIT: 'D',
        LIMIT_DATE: date2str(nextYear),
        START_DATE: date2str(nextMonth),
        PARAMS: {
          MODE: 'multiple',
          MULTIPLE_TYPE: 'month',
          MULTIPLE_INTERVAL: 1,
          OFFSET_BEGINDATE_TYPE: 'day',
          OFFSET_BEGINDATE_VALUE: 1,
          OFFSET_CLOSEDATE_TYPE: 'month',
          OFFSET_CLOSEDATE_VALUE: 2,
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Recurring deal settings id:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addRecurringDeal() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const current = new Date()
      const nextMonth = new Date()
      const nextYear = new Date()
      nextMonth.setMonth(current.getMonth() + 1)
      nextYear.setFullYear(current.getFullYear() + 1)

      const padDatePart = (part) => (part >= 10 ? part.toString() : `0${part}`)
      const date2str = (d) =>
        `${d.getFullYear()}-${padDatePart(1 + d.getMonth())}-${padDatePart(d.getDate())}`

      const response = await $b24.actions.v2.call.make({
        method: 'crm.deal.recurring.add',
        params: {
          fields: {
            DEAL_ID: 45,
            CATEGORY_ID: '1',
            IS_LIMIT: 'D',
            LIMIT_DATE: date2str(nextYear),
            START_DATE: date2str(nextMonth),
            PARAMS: {
              MODE: 'multiple',
              MULTIPLE_TYPE: 'month',
              MULTIPLE_INTERVAL: 1,
              OFFSET_BEGINDATE_TYPE: 'day',
              OFFSET_BEGINDATE_VALUE: 1,
              OFFSET_CLOSEDATE_TYPE: 'month',
              OFFSET_CLOSEDATE_VALUE: 2,
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Recurring deal settings id:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addRecurringDeal)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
    bitrix_response = client.crm.deal.recurring.add(fields={
        "TITLE": "Monthly Retainer Renewal",
        "CATEGORY_ID": 0,
        "STAGE_ID": "NEW",
        "IS_ACTIVE": "Y",
        "CURRENCY_ID": "USD",
        "OPPORTUNITY": 5000,
        "DEAL_ID": 45,
        "IS_LIMIT": "D",
        "LIMIT_DATE": "2027-03-04",
        "START_DATE": "2026-04-04",
        "PARAMS": {
            "MODE": "multiple",
            "MULTIPLE_TYPE": "month",
            "MULTIPLE_INTERVAL": 1,
            "OFFSET_BEGINDATE_TYPE": "day",
            "OFFSET_BEGINDATE_VALUE": 1,
            "OFFSET_CLOSEDATE_TYPE": "month",
            "OFFSET_CLOSEDATE_VALUE": 2,
        },
    }).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print('Ошибка Bitrix API', f'error: {error.error}', f'error_description: {error.error_description}', sep='\n')
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $current = new DateTime();
    $nextMonth = (clone $current)->modify('+1 month');
    $nextYear = (clone $current)->modify('+1 year');

    $response = $b24Service
        ->core
        ->call(
            'crm.deal.recurring.add',
            [
                'fields' => [
                    'DEAL_ID'     => 45,
                    'CATEGORY_ID' => '1',
                    'IS_LIMIT'    => 'D',
                    'LIMIT_DATE'  => $nextYear->format('Y-m-d'),
                    'START_DATE'  => $nextMonth->format('Y-m-d'),
                    'PARAMS'      => [
                        'MODE'                   => 'multiple',
                        'MULTIPLE_TYPE'          => 'month',
                        'MULTIPLE_INTERVAL'      => 1,
                        'OFFSET_BEGINDATE_TYPE'  => 'day',
                        'OFFSET_BEGINDATE_VALUE' => 1,
                        'OFFSET_CLOSEDATE_TYPE'  => 'month',
                        'OFFSET_CLOSEDATE_VALUE' => 2,
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
        echo 'Error: ' . $result->error();
    } else {
        echo 'Success: id настройки регулярной сделки - ' . $result->data();
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding recurring deal settings: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'crm.deal.recurring.add',
    {
        fields: {
            DEAL_ID: 45,
            CATEGORY_ID: '1',
            IS_LIMIT: 'D',
            LIMIT_DATE: '2027-03-04',
            START_DATE: '2026-04-04',
            PARAMS: {
                MODE: 'multiple',
                MULTIPLE_TYPE: 'month',
                MULTIPLE_INTERVAL: 1,
                OFFSET_BEGINDATE_TYPE: 'day',
                OFFSET_BEGINDATE_VALUE: 1,
                OFFSET_CLOSEDATE_TYPE: 'month',
                OFFSET_CLOSEDATE_VALUE: 2
            }
        }
    },
    function(result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.info('id настройки регулярной сделки:', result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'crm.deal.recurring.add',
    [
        'fields' => [
            'DEAL_ID' => 45,
            'CATEGORY_ID' => '1',
            'IS_LIMIT' => 'D',
            'LIMIT_DATE' => '2027-03-04',
            'START_DATE' => '2026-04-04',
            'PARAMS' => [
                'MODE' => 'multiple',
                'MULTIPLE_TYPE' => 'month',
                'MULTIPLE_INTERVAL' => 1,
                'OFFSET_BEGINDATE_TYPE' => 'day',
                'OFFSET_BEGINDATE_VALUE' => 1,
                'OFFSET_CLOSEDATE_TYPE' => 'month',
                'OFFSET_CLOSEDATE_VALUE' => 2
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.recurring.add", b24.Params{
	"fields": b24.Params{
		"DEAL_ID":     45,
		"CATEGORY_ID": "1",
		"IS_LIMIT":    "D",
		"LIMIT_DATE":  "2027-03-04",
		"START_DATE":  "2026-04-04",
		"PARAMS": b24.Params{
			"MODE":                   "multiple",
			"MULTIPLE_TYPE":          "month",
			"MULTIPLE_INTERVAL":      1,
			"OFFSET_BEGINDATE_TYPE":  "day",
			"OFFSET_BEGINDATE_VALUE": 1,
			"OFFSET_CLOSEDATE_TYPE":  "month",
			"OFFSET_CLOSEDATE_VALUE": 2,
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.deal.recurring.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-add.html