Documentation

Deal
in package

Класс для работы с объектом Сделка

Class Deal

Tags
author

Vladislav Andreev v@salesman.pro

version
1.0

(06/09/2019)

Example

$Deal  = new Salesman\Deal();
$result = $Deal -> add($params);
$did = $result['data'];

Table of Contents

$db  : mixed
Различные параметры, в основном из GLOBALS
$fpath  : mixed
Различные параметры, в основном из GLOBALS
$identity  : mixed
Различные параметры, в основном из GLOBALS
$iduser1  : mixed
Различные параметры, в основном из GLOBALS
$ivc  : mixed
Различные параметры, в основном из GLOBALS
$opts  : mixed
Различные параметры, в основном из GLOBALS
$otherSettings  : array<string|int, mixed>
$params  : array<string|int, mixed>
Передача различных параметров
$response  : mixed
$rootpath  : string
Абсолютный путь
$settingsUser  : array<string|int, mixed>
$skey  : mixed
Различные параметры, в основном из GLOBALS
$sqlname  : mixed
Различные параметры, в основном из GLOBALS
$tmzone  : mixed
Различные параметры, в основном из GLOBALS
__construct()  : mixed
Работает только с объектом Подключает необходимые файлы, задает первоначальные параметры
add()  : array<string|int, mixed>
Добавление новой сделки
card()  : array<string|int, mixed>
Вывод списка сделок по клиенту для карточки клиента
changeClose()  : array<string|int, mixed>
Закрытие сделки
changeDatumPlan()  : array<string|int, mixed>
Смена плановой даты
changeDostup()  : array<string|int, mixed>
Управление доступом к сделке
changeFreeze()  : array<string|int, mixed>
Заморозка|заморозка сделки
changePeriod()  : array<string|int, mixed>
Изменение периода сделки
changestep()  : array<string|int, mixed>
Смена этапа сделки
changeUnclose()  : array<string|int, mixed>
Восстановление закрытой сделки
changeuser()  : array<string|int, mixed>
Смена ответственного
dealTypes()  : array<string|int, mixed>
Типы сделок (для API)
delete()  : array<string|int, mixed>
Удаление сделки
Direction()  : array<string|int, mixed>
Направления (Для API))
Fields()  : array<string|int, mixed>
fullupdate()  : array<string|int, mixed>
Обновление информации по сделке Обновляет ВСЕ поля по сделке Позволяет очистить не нужные поля
getFiledType()  : string
info()  : array<string|int, mixed>
Возвращает информацию о сделке
list()  : array<string|int, mixed>
Список сделок (для API v.3.0)
Steps()  : array<string|int, mixed>
Этапы (для API)
update()  : array<string|int, mixed>
Обновление информации по сделке. Обновляет только пришедшие поля

Properties

$db

Различные параметры, в основном из GLOBALS

public mixed $db

$fpath

Различные параметры, в основном из GLOBALS

public mixed $fpath

$identity

Различные параметры, в основном из GLOBALS

public mixed $identity

$iduser1

Различные параметры, в основном из GLOBALS

public mixed $iduser1

$ivc

Различные параметры, в основном из GLOBALS

public mixed $ivc

$opts

Различные параметры, в основном из GLOBALS

public mixed $opts

$otherSettings

public array<string|int, mixed> $otherSettings

$params

Передача различных параметров

public array<string|int, mixed> $params = []

$response

public mixed $response = []

$rootpath

Абсолютный путь

public string $rootpath

$settingsUser

public array<string|int, mixed> $settingsUser

$skey

Различные параметры, в основном из GLOBALS

public mixed $skey

$sqlname

Различные параметры, в основном из GLOBALS

public mixed $sqlname

$tmzone

Различные параметры, в основном из GLOBALS

public mixed $tmzone

Methods

__construct()

Работает только с объектом Подключает необходимые файлы, задает первоначальные параметры

public __construct() : mixed
Return values
mixed —

add()

Добавление новой сделки

public add([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
  • параметры - integer uid – уникальный идентификатор во внешней ИС - string title | title_dog – название сделки (обязательное поле) - integer clid – идентификатор клиента, к которому будет привязана сделка (обязательное поле) - integer payer - идентификатор клиента-плательщика - date datum_plan – плановая дата закрытия сделки - date datum_start – период сделки. старт - date datum_end – период сделки. конец - integer direction – направление деятельности. Если не указано, то принимается значение по умолчанию из справочника - integer tip – тип сделки. Если не указано, то принимается значение по умолчанию из справочника - integer idcategory – ID этапа - integer mcid – идентификатор своей компании (можно получить в отдельном запросе). Если mcid всё-таки не указан, то возьмем последний использованный - integer iduser – login пользователя в SalesMan CRM назначаемого Ответственным за клиента - array pid_list - список id контактов, через запятую - string прочие поля ( inputXXX ) – информация для добавления - string calculate = yes/no - признак включения Спецификации. Должно быть "yes", если добавляется Спецификация - array speka - массив данных для добавления продуктов, для каждого добавляемого продукта содержит следующие данные: - integer prid - ID позиции прайса (n_id) - string artikul - артикул позиции прайса (уникальный идентификатор товара/услуги) - string title - наименование позиции - float kol - количество - int tip - тип позиции ( 0 - товар, 1 - услуга, 2 - материал ) - float dop - доп.поле, по умолчанию = 1 - float price - розничная цена (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса) - float price_in - закупочная цена (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса) - string edizm - единица измерения (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса) - float nds - НДС, в % - string comments - комментарий к позиции

Примечание: - параметр datum_plan может быть указан в запросе. Если он отсутствует, то будет принято текущая дата + 2 недели - параметр payer может быть указан в запросе. Если он отсутствует, то будет принято payer = clid - параметр mcid может отсутствовать в запросе. Если не указано, то принимается значение по умолчанию из справочника - при пустом поле iduser Ответственным будет назначен текущий пользователь (из запроса)

Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

card()

Вывод списка сделок по клиенту для карточки клиента

public card([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
  • int clid
  • string dealsSort = DESC|NULL - сортировка списка по дате создания
  • bool bytype = TRUE (default FALSE) - разделять сделки на подмассив с ключами "close"/"active" по признаку активности сделки
Tags
throws
Exception
Return values
array<string|int, mixed> —

changeClose()

Закрытие сделки

public changeClose(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
$params : array<string|int, mixed> = []
  • массив с параметрами
  • date datum_close - дата закрытия
  • int sid - id статуса закрытия
  • str status_close - название статуса закрытия (вместо sid) - win|lose
  • date des_fact - комментарий
  • float kol_fact - факт.сумма сделки
  • float marga - факт.маржа сделки
  • int **coid **- id конкурента,выигравшего сделку
  • float co_kol - сумма конкурента
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

changeDatumPlan()

Смена плановой даты

public changeDatumPlan(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
$params : array<string|int, mixed> = []
  • массив с параметрами
  • date newdate - новая дата
  • str reason - комментарий(причина смены)
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

changeDostup()

Управление доступом к сделке

public changeDostup(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
$params : array<string|int, mixed> = []
  • массив с параметрами - array dostup - int iduser => notify ( on/off )

Примечание: notify - признак того, что пользователя надо подписать на уведомления о изменениях в сделке

Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

changeFreeze()

Заморозка|заморозка сделки

public changeFreeze(int $did[, string $date = '' ]) : array<string|int, mixed>
Parameters
$did : int
$date : string = ''
  • если указана, то замораживаем до этой даты
Tags
throws
Exception
Return values
array<string|int, mixed> —

changePeriod()

Изменение периода сделки

public changePeriod(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
$params : array<string|int, mixed> = []
  • массив с параметрами
  • date datum_start – период сделки. старт
  • date datum_end – период сделки. конец
Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

changestep()

Смена этапа сделки

public changestep(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
$params : array<string|int, mixed> = []
  • массив с параметрами
  • int step - id нового этапа
  • str description - комментарий
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

changeUnclose()

Восстановление закрытой сделки

public changeUnclose(int $did) : array<string|int, mixed>
Parameters
$did : int
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

changeuser()

Смена ответственного

public changeuser(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
$params : array<string|int, mixed> = []
  • массив с параметрами
  • int newuser - id нового
  • str client_send - yes|no - передать клиента
  • str person_send - yes|no - передать контакты
  • str reason - комментарий
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

dealTypes()

Типы сделок (для API)

public dealTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

delete()

Удаление сделки

public delete(int $did) : array<string|int, mixed>
Parameters
$did : int
  • ID сделки
Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

Direction()

Направления (Для API))

public Direction() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Fields()

public Fields([mixed $filter = "" ]) : array<string|int, mixed>
Parameters
$filter : mixed = ""
Return values
array<string|int, mixed> —

fullupdate()

Обновление информации по сделке Обновляет ВСЕ поля по сделке Позволяет очистить не нужные поля

public fullupdate(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
  • ID сделки
$params : array<string|int, mixed> = []
  • массив с параметрами
  • integer uid – уникальный идентификатор во внешней ИС
  • string title | title_dog – название сделки (обязательное поле)
  • integer clid –идентификатор клиента, к которому будет привязана сделка (обязательное поле)
  • integer payer - идентификатор клиента-плательщика
  • date datum_plan – плановая дата закрытия сделки
  • date datum_start – период сделки. старт
  • date datum_end – период сделки. конец
  • integer direction – направление деятельности. Если не указано, то принимается значение по умолчанию из справочника
  • integer tip – тип сделки. Если не указано, то принимается значение по умолчанию из справочника
  • integer idcategory – ID этапа
  • integer mcid – идентификатор своей компании (можно получить в отдельном запросе). Если mcid всё-таки не указан, то возьмем последний использованный
  • integer iduser – login пользователя в SalesMan CRM назначаемого Ответственным за клиента
  • array pid_list - список id контактов, через запятую
  • string прочие поля ( inputXXX ) – информация для добавления
  • string calculate = yes/no - признак включения Спецификации. Должно быть "yes", если добавляется Спецификация
  • array speka - массив данных для добавления продуктов, для каждого добавляемого продукта содержит следующие данные:
  • integer prid - ID позиции прайса (n_id)
  • string artikul - артикул позиции прайса (уникальный идентификатор товара/услуги)
  • string title - наименование позиции
  • int tip - тип позиции ( 0 - товар, 1 - услуга, 2 - материал )
  • float kol - количество
  • float dop - доп.поле, по умолчанию = 1
  • float price - розничная цена (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса)
  • float price_in - закупочная цена (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса)
  • string edizm - единица измерения (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса)
  • float nds - НДС, в %
  • string comments - комментарий к позиции
Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

getFiledType()

public static getFiledType( $field) : string
Parameters
$field :
Return values
string —

info()

Возвращает информацию о сделке

public static info( $did) : array<string|int, mixed>
Parameters
$did :

Возвращает полную информацию по сделке:

  • базовая информация в основном массиве

    • int did - id сделки

    • str dealUID - идентификатор из внешних систем

    • str title - название

    • date datum_plan - плановая дата

    • date date_create - дата создания

    • date date_update - дата изменения

    • date datum_start - период. старт

    • date datum_end - период. конец

    • array step - массив "этап сделки"

      • int stepid - id этапа
      • str steptitle - цифровое обозначение
      • str stepname - название этапа

    • str stepName - название этапа

    • int direction - id направления

    • str directionName - название направления

    • str adres - адрес

    • float summa - плановая сумма

    • float marga - маржа

    • float kol_fact - фактическая сумма

    • int iduser - iduser куратора по сделке

    • str userUID - uid куратора

    • str user - имя куратора

    • int autor - iduser автора сделки

    • str autorName - имя автора сделки

    • str autorUID - uid автора сделки

    • str calculate - = yes

    • int tip - id типа сделки

    • str tipName - название типа сделки

    • str content - описание

    • str inputXXX - доп.поля

  • array contract - список документов по сделке [deid,datum,title,number,datum_start,datum_end,des,clid,did,idtype,crid] - массив "документы"

  • array company - массив "компания" - компания, от которой идет сделка со всеми реквизитами

  • array invoice - массив "счета"

  • array close - массив "статус закрытия", если сделка закрыта - close - статус закрытия = yes|no - date - дата закрытия - summa - сумма конкурента - status - id статуса - statustext - название статуса

  • array speca - массив "спецификация"

  • array client - массив "клиент" - вся информация по клиенту - заказчику, вкл. реквизиты (массив recv)

  • array payer - массив "плательщик" - вся информация по клиенту - плательщику, вкл. реквизиты (массив recv)

  • array person - массив "контакты" - контакты по сделке [pid,title,post,phone,mob,email]

Return values
array<string|int, mixed> —

Example:

$Deal = \Salesman\Deal::info($pid);

list()

Список сделок (для API v.3.0)

public list([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

Steps()

Этапы (для API)

public Steps() : array<string|int, mixed>
Return values
array<string|int, mixed> —

update()

Обновление информации по сделке. Обновляет только пришедшие поля

public update(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$did : int
  • ID сделки
$params : array<string|int, mixed> = []
  • массив с параметрами
  • integer **uid **– уникальный идентификатор во внешней ИС
  • string title | title_dog – название сделки (обязательное поле)
  • integer clid –идентификатор клиента, к которому будет привязана сделка (обязательное поле)
  • integer payer - идентификатор клиента-плательщика
  • date datum_plan – плановая дата закрытия сделки
  • date datum_start – период сделки. старт
  • date datum_end – период сделки. конец
  • integer direction – направление деятельности. Если не указано, то принимается значение по умолчанию из справочника
  • integer tip – тип сделки. Если не указано, то принимается значение по умолчанию из справочника
  • integer idcategory – ID этапа
  • integer mcid – идентификатор своей компании (можно получить в отдельном запросе). Если mcid всё-таки не указан, то возьмем последний использованный
  • integer iduser – login пользователя в SalesMan CRM назначаемого Ответственным за клиента
  • array pid_list - список id контактов, через запятую
  • string прочие поля ( inputXXX ) – информация для добавления
  • string calculate = yes/no - признак включения Спецификации. Должно быть "yes", если добавляется Спецификация
  • array speka - массив данных для добавления продуктов, для каждого добавляемого продукта содержит следующие данные:
  • integer prid - ID позиции прайса (n_id)
  • string artikul - артикул позиции прайса (уникальный идентификатор товара/услуги)
  • string title - наименование позиции
  • int tip - тип позиции ( 0 - товар, 1 - услуга, 2 - материал )
  • float kol - количество
  • float dop - доп.поле, по умолчанию = 1
  • float price - розничная цена (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса)
  • float price_in - закупочная цена (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса)
  • string edizm - единица измерения (не обязателный параметр, при совпадении актикула или названия с позицией в прайсе берется из прайса)
  • float nds - НДС, в %
  • string comments - комментарий к позиции
Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - result = Успешно - data = id - text = Комментарий

error result - result = result - error - code - text

Search results