Add

[POST] …/v1/Target/Add

Создаёт новую цель.

Входные параметры

Название Тип данных Обязательность Описание
name String Необязательный Наименование цели. Если не указано то формируется так: Наименование типа ели + ID созданной цели
type Enum Обязательный Тип цели: <ReceiptCount | 1> - количество чеков, <UnitCount | 2> - количество единиц, <AverageReceipt | 3> - средний чек, <SalesAmount | 4> - сумма продаж
owner Enum Обязательный Владелец цели: <Firm | 1> - Предприятие, <User | 2> - Пользователь
period_type Enum Обязательный Тип периода: <Day | 1> - день, <Week | 2> - неделя, <Month | 3> - месяц
period Int32 Необязательный Значение периода
value Decimal Обязательный Значение цели
repeateable Boolean Необязательный Повторяемость цели: true - повторяемая, false - не повторяемая
firm_id Int64 Обязательный ID предприятия
stock_id Int64 Необязательный ID Склада
user_id Int64 Обязательный ID Пользователя

Пример запроса

{
    "name": "Target Example",
    "type": "SalesAmount",
    "owner": "Firm",
    "period_type": "Day",
    "period": 1,
    "value": 1.1,
    "repeateable": false,
    "firm_id": 1,
    "stock_id": 1,
    "user_id": 1
}

Выходные параметры

Название Тип данных Описание
new_id Int64 ID созданной цели

Пример ответа

{
    "ok": true,
    "result": {
        "new_id": 1
    }
}