OpenIntegrations/docs/en/md/Bitrix24/Deals-managment/Get-deal-structure.md

sidebar_position
6

Get deal structure

Gets a structure with field descriptions for creating a deal

Function GetDealStructure(Val URL, Val Token = "") Export

Parameter	CLI option	Type	Description
URL	--url	String	URL of webhook or a Bitrix24 domain, when token used
Token	--token	String	Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

:::tip Method at API documentation: crm.deal.fields :::

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";

    Result = OPI_Bitrix24.GetDealStructure(URL);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "ae6af966006e9f06006b12e400000001000...";

    Result = OPI_Bitrix24.GetDealStructure(URL, Token);

    
  oint bitrix24 GetDealStructure --url "b24-ar17wx.bitrix24.by" --token "6476c766006e9f06006b12e400000001000..."

{
 "result": {
  "ID": {
   "type": "integer",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "ID"
  },
  "TITLE": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Название"
  },
  "TYPE_ID": {
   "type": "crm_status",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "statusType": "DEAL_TYPE",
   "title": "Тип"
  },
  "CATEGORY_ID": {
   "type": "crm_category",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": true,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Воронка"
  },
  "STAGE_ID": {
   "type": "crm_status",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "statusType": "DEAL_STAGE",
   "title": "Стадия сделки"
  },
  "STAGE_SEMANTIC_ID": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Группа стадии"
  },
  "IS_NEW": {
   "type": "char",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Новая сделка"
  },
  "IS_RECURRING": {
   "type": "char",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Регулярная сделка"
  },
  "IS_RETURN_CUSTOMER": {
   "type": "char",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Повторная сделка"
  },
  "IS_REPEATED_APPROACH": {
   "type": "char",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Повторное обращение"
  },
  "PROBABILITY": {
   "type": "integer",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Вероятность"
  },
  "CURRENCY_ID": {
   "type": "crm_currency",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Валюта"
  },
  "OPPORTUNITY": {
   "type": "double",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Сумма"
  },
  "IS_MANUAL_OPPORTUNITY": {
   "type": "char",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "IS_MANUAL_OPPORTUNITY"
  },
  "TAX_VALUE": {
   "type": "double",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Ставка налога"
  },
  "COMPANY_ID": {
   "type": "crm_company",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Компания",
   "settings": {
    "parentEntityTypeId": 4
   }
  },
  "CONTACT_ID": {
   "type": "crm_contact",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "isDeprecated": true,
   "title": "Контакт"
  },
  "CONTACT_IDS": {
   "type": "crm_contact",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": true,
   "isDynamic": false,
   "title": "Контакты"
  },
  "QUOTE_ID": {
   "type": "crm_quote",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Предложение",
   "settings": {
    "parentEntityTypeId": 7
   }
  },
  "BEGINDATE": {
   "type": "date",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Дата начала"
  },
  "CLOSEDATE": {
   "type": "date",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Дата завершения"
  },
  "OPENED": {
   "type": "char",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Доступна для всех"
  },
  "CLOSED": {
   "type": "char",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Закрыта"
  },
  "COMMENTS": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Комментарий"
  },
  "ASSIGNED_BY_ID": {
   "type": "user",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Ответственный"
  },
  "CREATED_BY_ID": {
   "type": "user",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Кем создана"
  },
  "MODIFY_BY_ID": {
   "type": "user",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Кем изменена"
  },
  "MOVED_BY_ID": {
   "type": "user",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "MOVED_BY_ID"
  },
  "DATE_CREATE": {
   "type": "datetime",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Дата создания"
  },
  "DATE_MODIFY": {
   "type": "datetime",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Дата изменения"
  },
  "MOVED_TIME": {
   "type": "datetime",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "MOVED_TIME"
  },
  "SOURCE_ID": {
   "type": "crm_status",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "statusType": "SOURCE",
   "title": "Источник"
  },
  "SOURCE_DESCRIPTION": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Дополнительно об источнике"
  },
  "LEAD_ID": {
   "type": "crm_lead",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Лид",
   "settings": {
    "parentEntityTypeId": 1
   }
  },
  "ADDITIONAL_INFO": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Дополнительная информация"
  },
  "LOCATION_ID": {
   "type": "location",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Местоположение"
  },
  "ORIGINATOR_ID": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Внешний источник"
  },
  "ORIGIN_ID": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Идентификатор элемента во внешнем источнике"
  },
  "UTM_SOURCE": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Рекламная система"
  },
  "UTM_MEDIUM": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Тип трафика"
  },
  "UTM_CAMPAIGN": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Обозначение рекламной кампании"
  },
  "UTM_CONTENT": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Содержание кампании"
  },
  "UTM_TERM": {
   "type": "string",
   "isRequired": false,
   "isReadOnly": false,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "Условие поиска кампании"
  },
  "LAST_ACTIVITY_TIME": {
   "type": "datetime",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "LAST_ACTIVITY_TIME"
  },
  "LAST_ACTIVITY_BY": {
   "type": "user",
   "isRequired": false,
   "isReadOnly": true,
   "isImmutable": false,
   "isMultiple": false,
   "isDynamic": false,
   "title": "LAST_ACTIVITY_BY"
  }
 },
 "time": {
  "start": 1724584042.31272,
  "finish": 1724584042.3535,
  "duration": 0.0407781600952148,
  "processing": 0.0108120441436768,
  "date_start": "2024-08-25T11:07:22+00:00",
  "date_finish": "2024-08-25T11:07:22+00:00",
  "operating_reset_at": 1724584642,
  "operating": 0
 }
}