Параметр используется в методах добавления заявки

{  
   "FilialId": <код филиала>,            
   "AdditionalFilials": [],              
   "DealTypeId":<код услуги>,            
   "Source":"<источник заявки>",         
   "PartnerCode":"<код партнера>", 
   "ClientPhone":"<телефон клиента>", 
   “ClientMail”:”<Email клиента>”,
   “TelegramAccount”:”<аккаунт Telegram>”,
   "ClientName":"<имя клиента>",
   “ClientComment”:”<комментарий клиента>”,
   "Promocode":"<строка промокода для заказа>"
   "Utm_source":"",
   "Utm_campaign":"",
   "Utm_medium":"",
   “Utm_term”:””,
   “Utm_content”:””,
   “Utm_position_type”: “”,
   “Utm_device_type” : “”,
   “Utm_region_name” : “”,
   “SessionId”:””,
   “AdvertClientId_1”:”<код клиента системы аналитики (например, яндрекс.метрика или google.analytics>”,
   “AdvertClientId_2”:”<код клиента системы аналитики (например, яндрекс.метрика или google.analytics>”,
   “RefUrl”:”<адрес, с которого пришел клиент на страницу оформления заявки>”,
   “ExternalImages”:[],
   "Fields": [                                        
      {  
         "Key":"client-summ",
         "Value":"50000"
      },
      {  
         "Key":"auto-marka-model",
         "Value":"Митсубиси асх"
      },
      {  
         "Key":"auto-year",
         "Value":"2009"
      }    ]
}

где:

FilialId: число, код филиала в который должна поступить заявка;

AdditionalFilials: массив кодов филиалов (чисел), сотрудники которых тоже должны иметь доступ к данной заявке

DealTypeId: число, код услуги (числовой код смотрим в конфигураторе для каждого типа услуги на вкладке Базовые справочники);

Source: строка, источник заявки (например адрес сайта без http);

SessionId: строка, код сессии клиента, в рамках которой была создана текущая заявка. Также может быть проинициализировано кодом заявки во внешней системе - например, у лидогенератора;

PartnerCode: число в строковом представлении, код партнера ;

ClientComment: строка, значение добавляется в ленту событий, недоступно для изменения сотрудниками;

ExternalImages: массив ссылок для скачивания изображений, которые необходимо прикрепить к заявке, изображение обязательно должно быть доступно методом Get по http или https. Элементом массива является строка, содержащая полный URL для скачивания изображения;

Fields: набор полей (приведены для примера), соответствующих выбранному DealTypeid

<aside> ☝🏻 Коллекция Fields представляет собой массив объектов следующего формата: Fields:[{"key":<строка>, "value":{<объект>}}], где key:всегда строка (используется для идентификации полей в объекте заявки, value: объект, содержащий необходимый набор значений для инициализации поля в заявке.

</aside>

В простейшем случае value представляется строкой (для строковых и числовых значений), но в ряде случаев необходимо инициализировать "комплексные" поля, такие как ФИО клиента или ПАСПОРТ. Если с сайта передаются комплексные поля, то их формат можно посмотреть в конфигураторе системы.

В конфигурации системы коллекцию Fields можно посмотреть следующим образом:

При этом будет открыть текстовый файл, с уже сформированной коллекцией.