For AI agents: markdown of this page — /docs-content-en/entities/recurring-deals/fields.md documentation index — /llms.txt

Recurring deal fields

GET /v1/recurring-deals/fields

Returns field definitions for deal recurrence settings. Use it to check types, required fields and whether a field can be written.

Parameters

Parameter	Type	Default	Description
Parameter`refresh` (query)	Typestring	Default`false`	DescriptionSupply `true` to refresh field metadata, for example `?refresh=true`

Examples

curl — personal key

Terminal

curl -X GET "https://vibecode.bitrix24.com/v1/recurring-deals/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal

curl -X GET "https://vibecode.bitrix24.com/v1/recurring-deals/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript

const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals/fields', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const result = await response.json()
if (!result.success) throw new Error(result.error.message)
console.log(result.data)

JavaScript — OAuth application

javascript

const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals/fields', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN' },
})
const result = await response.json()
if (!result.success) throw new Error(result.error.message)
console.log(result.data)

Response fields

Field	Type	Description
Field`success`	Typeboolean	DescriptionWhether the request succeeded
Field`data.fields`	Typeobject	DescriptionComplete field definitions: type, `readonly`, `required`, `createOnly`, `nullable`, `enum`, `properties` when present
Field`data.batch`	Typestring[]	DescriptionEntity operations listed for batch processing: `create`, `update`, `delete`
Field`meta.warnings`	Typeobject[]	DescriptionA `fields_partial` warning may be returned when field definitions are partially loaded

Field	Type	RO	Description
Field`id`	Typenumber	ROYes	DescriptionSetting ID. See get a setting.
Field`dealId`	Typenumber	RONo	DescriptionTemplate deal ID. Required and writable only on creation. A regular source deal is copied. See the deal.
Field`basedId`	Typenumber	ROYes	DescriptionSource deal ID. See the deal. May be `null`.
Field`active`	Typeboolean	RONo	DescriptionWhether automatic recurrence is active
Field`nextExecution`	Typedatetime	ROYes	DescriptionNext execution date. May be `null`.
Field`lastExecution`	Typedatetime	ROYes	DescriptionLast execution date. May be `null`.
Field`counterRepeat`	Typenumber	ROYes	DescriptionExecution count. May be `null`.
Field`startDate`	Typedate	RONo	DescriptionSchedule start date. May be `null`.
Field`categoryId`	Typenumber	RONo	DescriptionPipeline for created deals. See the pipeline. May be `null`.
Field`isLimit`	Typestring	RONo	DescriptionLimit mode: `N` — unlimited, `T` — repetition count, `D` — end date
Field`limitRepeat`	Typenumber	RONo	DescriptionMaximum repetitions in mode `T`. May be `null`.
Field`limitDate`	Typedate	RONo	DescriptionLast allowed date in mode `D`. May be `null`.
Field`params`	Typeobject	RONo	DescriptionComplete schedule parameters. Replaced in full on update
Field`params.mode`	Typestring	RONo	DescriptionSchedule mode. May be `null`.
Field`params.singleBeforeStartDateValue`	Typenumber	RONo	DescriptionSingle execution offset value
Field`params.singleBeforeStartDateType`	Typestring	RONo	DescriptionSingle execution offset type. May be `null`.
Field`params.multipleType`	Typestring	RONo	DescriptionRecurrence period type. May be `null`.
Field`params.multipleInterval`	Typenumber	RONo	DescriptionRecurrence interval
Field`params.offsetBeginDateType`	Typestring	RONo	DescriptionStart date offset type. May be `null`.
Field`params.offsetBeginDateValue`	Typenumber	RONo	DescriptionStart date offset value
Field`params.offsetCloseDateType`	Typestring	RONo	DescriptionEnd date offset type. May be `null`.
Field`params.offsetCloseDateValue`	Typenumber	RONo	DescriptionEnd date offset value

RO means the field is read-only.

Response example

JSON

{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "Recurring settings ID",
        "description": "Recurring settings ID."
      },
      "dealId": {
        "type": "number",
        "readonly": false,
        "createOnly": true,
        "required": true,
        "label": "Template deal ID; ordinary source deals are copied on creation",
        "description": "Template deal ID; ordinary source deals are copied on creation."
      },
      "basedId": {
        "type": "number",
        "readonly": true,
        "nullable": true,
        "label": "Source deal ID",
        "description": "Source deal ID."
      },
      "active": {
        "type": "boolean",
        "readonly": false,
        "label": "Whether automatic repetition is active",
        "description": "Whether automatic repetition is active."
      },
      "nextExecution": {
        "type": "datetime",
        "readonly": true,
        "nullable": true,
        "label": "Next execution date",
        "description": "Next execution date."
      },
      "lastExecution": {
        "type": "datetime",
        "readonly": true,
        "nullable": true,
        "label": "Last execution date",
        "description": "Last execution date."
      },
      "counterRepeat": {
        "type": "number",
        "readonly": true,
        "nullable": true,
        "label": "Executed repetitions",
        "description": "Executed repetitions."
      },
      "startDate": {
        "type": "date",
        "readonly": false,
        "nullable": true,
        "label": "Schedule start date",
        "description": "Schedule start date."
      },
      "categoryId": {
        "type": "number",
        "readonly": false,
        "nullable": true,
        "label": "Pipeline for newly generated deals",
        "description": "Pipeline for newly generated deals."
      },
      "isLimit": {
        "type": "string",
        "readonly": false,
        "label": "Repetition limit mode",
        "description": "Repetition limit mode.",
        "enum": [
          {
            "value": "N",
            "label": "Unlimited"
          },
          {
            "value": "T",
            "label": "Repetition count"
          },
          {
            "value": "D",
            "label": "End date"
          }
        ]
      },
      "limitRepeat": {
        "type": "number",
        "readonly": false,
        "nullable": true,
        "label": "Maximum repetition count for T",
        "description": "Maximum repetition count for T."
      },
      "limitDate": {
        "type": "date",
        "readonly": false,
        "nullable": true,
        "label": "Last allowed date for D",
        "description": "Last allowed date for D."
      },
      "params": {
        "type": "object",
        "readonly": false,
        "label": "Complete schedule parameters; replace as a whole on update",
        "description": "Complete schedule parameters; replace as a whole on update.",
        "properties": {
          "mode": {
            "type": "string",
            "nullable": true
          },
          "singleBeforeStartDateValue": {
            "type": "number"
          },
          "singleBeforeStartDateType": {
            "type": "string",
            "nullable": true
          },
          "multipleType": {
            "type": "string",
            "nullable": true
          },
          "multipleInterval": {
            "type": "number"
          },
          "offsetBeginDateType": {
            "type": "string",
            "nullable": true
          },
          "offsetBeginDateValue": {
            "type": "number"
          },
          "offsetCloseDateType": {
            "type": "string",
            "nullable": true
          },
          "offsetCloseDateValue": {
            "type": "number"
          }
        }
      }
    },
    "batch": [
      "create",
      "update",
      "delete"
    ]
  }
}

Error response example

401 — API key missing: