[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-entities\u002Frecurring-deals\u002Ffields":3,"docs-tabs-entities\u002Frecurring-deals\u002Ffields":6},{"content":4,"lastmod":5},"## Recurring deal fields\n\n`GET \u002Fv1\u002Frecurring-deals\u002Ffields`\n\nReturns field definitions for deal recurrence settings. Use it to check types, required fields and whether a field can be written.\n\n## Parameters\n\n| Parameter | Type | Default | Description |\n|---|---|---|---|\n| `refresh` (query) | string | `false` | Supply `true` to refresh field metadata, for example `?refresh=true` |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X GET \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frecurring-deals\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X GET \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frecurring-deals\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frecurring-deals\u002Ffields', {\n  method: 'GET',\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\nconst result = await response.json()\nif (!result.success) throw new Error(result.error.message)\nconsole.log(result.data)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frecurring-deals\u002Ffields', {\n  method: 'GET',\n  headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN' },\n})\nconst result = await response.json()\nif (!result.success) throw new Error(result.error.message)\nconsole.log(result.data)\n```\n\n## Response fields\n\n| Field | Type | Description |\n|---|---|---|\n| `success` | boolean | Whether the request succeeded |\n| `data.fields` | object | Complete field definitions: type, `readonly`, `required`, `createOnly`, `nullable`, `enum`, `properties` when present |\n| `data.batch` | string[] | Entity operations listed for batch processing: `create`, `update`, `delete` |\n| `meta.warnings` | object[] | A `fields_partial` warning may be returned when field definitions are partially loaded |\n\n| Field | Type | RO | Description |\n|---|---|---|---|\n| `id` | number | Yes | Setting ID. See [get a setting](.\u002Fget.md). |\n| `dealId` | number | No | Template deal ID. Required and writable only on creation. A regular source deal is copied. See the [deal](\u002Fdocs\u002Fentities\u002Fdeals\u002Fget). |\n| `basedId` | number | Yes | Source deal ID. See the [deal](\u002Fdocs\u002Fentities\u002Fdeals\u002Fget). May be `null`. |\n| `active` | boolean | No | Whether automatic recurrence is active |\n| `nextExecution` | datetime | Yes | Next execution date. May be `null`. |\n| `lastExecution` | datetime | Yes | Last execution date. May be `null`. |\n| `counterRepeat` | number | Yes | Execution count. May be `null`. |\n| `startDate` | date | No | Schedule start date. May be `null`. |\n| `categoryId` | number | No | Pipeline for created deals. See the [pipeline](\u002Fdocs\u002Fentities\u002Fdeal-categories\u002Fget). May be `null`. |\n| `isLimit` | string | No | Limit mode: `N` — unlimited, `T` — repetition count, `D` — end date |\n| `limitRepeat` | number | No | Maximum repetitions in mode `T`. May be `null`. |\n| `limitDate` | date | No | Last allowed date in mode `D`. May be `null`. |\n| `params` | object | No | Complete schedule parameters. Replaced in full on update |\n| `params.mode` | string | No | Schedule mode. May be `null`. |\n| `params.singleBeforeStartDateValue` | number | No | Single execution offset value |\n| `params.singleBeforeStartDateType` | string | No | Single execution offset type. May be `null`. |\n| `params.multipleType` | string | No | Recurrence period type. May be `null`. |\n| `params.multipleInterval` | number | No | Recurrence interval |\n| `params.offsetBeginDateType` | string | No | Start date offset type. May be `null`. |\n| `params.offsetBeginDateValue` | number | No | Start date offset value |\n| `params.offsetCloseDateType` | string | No | End date offset type. May be `null`. |\n| `params.offsetCloseDateValue` | number | No | End date offset value |\n\n`RO` means the field is read-only.\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"fields\": {\n      \"id\": {\n        \"type\": \"number\",\n        \"readonly\": true,\n        \"label\": \"Recurring settings ID\",\n        \"description\": \"Recurring settings ID.\"\n      },\n      \"dealId\": {\n        \"type\": \"number\",\n        \"readonly\": false,\n        \"createOnly\": true,\n        \"required\": true,\n        \"label\": \"Template deal ID; ordinary source deals are copied on creation\",\n        \"description\": \"Template deal ID; ordinary source deals are copied on creation.\"\n      },\n      \"basedId\": {\n        \"type\": \"number\",\n        \"readonly\": true,\n        \"nullable\": true,\n        \"label\": \"Source deal ID\",\n        \"description\": \"Source deal ID.\"\n      },\n      \"active\": {\n        \"type\": \"boolean\",\n        \"readonly\": false,\n        \"label\": \"Whether automatic repetition is active\",\n        \"description\": \"Whether automatic repetition is active.\"\n      },\n      \"nextExecution\": {\n        \"type\": \"datetime\",\n        \"readonly\": true,\n        \"nullable\": true,\n        \"label\": \"Next execution date\",\n        \"description\": \"Next execution date.\"\n      },\n      \"lastExecution\": {\n        \"type\": \"datetime\",\n        \"readonly\": true,\n        \"nullable\": true,\n        \"label\": \"Last execution date\",\n        \"description\": \"Last execution date.\"\n      },\n      \"counterRepeat\": {\n        \"type\": \"number\",\n        \"readonly\": true,\n        \"nullable\": true,\n        \"label\": \"Executed repetitions\",\n        \"description\": \"Executed repetitions.\"\n      },\n      \"startDate\": {\n        \"type\": \"date\",\n        \"readonly\": false,\n        \"nullable\": true,\n        \"label\": \"Schedule start date\",\n        \"description\": \"Schedule start date.\"\n      },\n      \"categoryId\": {\n        \"type\": \"number\",\n        \"readonly\": false,\n        \"nullable\": true,\n        \"label\": \"Pipeline for newly generated deals\",\n        \"description\": \"Pipeline for newly generated deals.\"\n      },\n      \"isLimit\": {\n        \"type\": \"string\",\n        \"readonly\": false,\n        \"label\": \"Repetition limit mode\",\n        \"description\": \"Repetition limit mode.\",\n        \"enum\": [\n          {\n            \"value\": \"N\",\n            \"label\": \"Unlimited\"\n          },\n          {\n            \"value\": \"T\",\n            \"label\": \"Repetition count\"\n          },\n          {\n            \"value\": \"D\",\n            \"label\": \"End date\"\n          }\n        ]\n      },\n      \"limitRepeat\": {\n        \"type\": \"number\",\n        \"readonly\": false,\n        \"nullable\": true,\n        \"label\": \"Maximum repetition count for T\",\n        \"description\": \"Maximum repetition count for T.\"\n      },\n      \"limitDate\": {\n        \"type\": \"date\",\n        \"readonly\": false,\n        \"nullable\": true,\n        \"label\": \"Last allowed date for D\",\n        \"description\": \"Last allowed date for D.\"\n      },\n      \"params\": {\n        \"type\": \"object\",\n        \"readonly\": false,\n        \"label\": \"Complete schedule parameters; replace as a whole on update\",\n        \"description\": \"Complete schedule parameters; replace as a whole on update.\",\n        \"properties\": {\n          \"mode\": {\n            \"type\": \"string\",\n            \"nullable\": true\n          },\n          \"singleBeforeStartDateValue\": {\n            \"type\": \"number\"\n          },\n          \"singleBeforeStartDateType\": {\n            \"type\": \"string\",\n            \"nullable\": true\n          },\n          \"multipleType\": {\n            \"type\": \"string\",\n            \"nullable\": true\n          },\n          \"multipleInterval\": {\n            \"type\": \"number\"\n          },\n          \"offsetBeginDateType\": {\n            \"type\": \"string\",\n            \"nullable\": true\n          },\n          \"offsetBeginDateValue\": {\n            \"type\": \"number\"\n          },\n          \"offsetCloseDateType\": {\n            \"type\": \"string\",\n            \"nullable\": true\n          },\n          \"offsetCloseDateValue\": {\n            \"type\": \"number\"\n          }\n        }\n      }\n    },\n    \"batch\": [\n      \"create\",\n      \"update\",\n      \"delete\"\n    ]\n  }\n}\n```\n\n## Error response example\n\n401 — API key missing:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"MISSING_API_KEY\",\n    \"message\": \"API key required. Pass via X-Api-Key header.\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|---|---|---|\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |\n| 401 | `TOKEN_MISSING` | No Bitrix24 access tokens are configured |\n| 403 | `SCOPE_DENIED` | The API key lacks the `crm` scope |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access, including a missing required scope |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation or a plan restriction applies. See `error.message` |\n| 503 | `BITRIX_TIMEOUT` | Bitrix24 did not respond in time. Retry after the interval in `Retry-After` |\n| 502 | `BITRIX_UNAVAILABLE` | A connection to Bitrix24 could not be established |\n| 429 | `RATE_LIMITED` | The request rate limit was exceeded. The effective limit is in the `x-ratelimit-limit` header. Retry after the interval in the `Retry-After` header |\n\nFor the full list of common API errors, see [Error codes](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [List recurring deals](.\u002Flist.md)\n- [Get a recurring deal](.\u002Fget.md)\n- [Search recurring deals](.\u002Fsearch.md)\n- [Aggregate recurring deals](.\u002Faggregate.md)\n- [Recurring deals](..\u002Frecurring-deals.md)\n- [Filtering syntax](\u002Fdocs\u002Ffiltering)\n","2026-10-13",{},1795000370543]