Task

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

POST /task/create

Create a task. attached_to selects which FK array is required (trade_uuids/trade_ids, order_ids, customer_ids, supplier_ids, employee_ids).

Тело запроса

Поле	Тип	Обязательно	Описание
`organization_id`	`string`	Нет
`type_id`	`string`	Да	Task-type id (see /task-type/get-paging)
`date`	`string (date-time)`	Да	Date the task is scheduled for. When time_type=range, the value is rewritten to start_of_day(date)+start_time using the boss's UTC offset.
`time_type`	`string`	Нет	Допустимые значения: `full_day`, `range`. По умолчанию: `"full_day"`
`start_time`	`string`	Нет	Required when time_type=range. 24h HH:MM.
`end_time`	`string`	Нет	Required when time_type=range. 24h HH:MM.
`responsible_id`	`string`	Да
`description`	`string`	Нет
`attached_to`	`string`	Нет	Допустимые значения: `trade`, `order`, `customer`, `supplier`, `employee`
`trade_uuids`	`string[]`	Нет	Used when attached_to=trade. Preferred over trade_ids; first non-empty wins.
`trade_ids`	`string[]`	Нет	Used when attached_to=trade.
`order_ids`	`string[]`	Нет	Required when attached_to=order.
`customer_ids`	`string[]`	Нет	Required when attached_to=customer.
`supplier_ids`	`string[]`	Нет	Required when attached_to=supplier.
`employee_ids`	`string[]`	Нет	Required when attached_to=employee.

json

{
  "organization_id": "67b486d242ed76693cd2cc59",
  "type_id": "67b486d242ed76693cd2cc59",
  "date": "2023-10-01T12:00:00Z",
  "time_type": "full_day",
  "start_time": "09:00",
  "end_time": "10:30",
  "responsible_id": "67b486d242ed76693cd2cc59",
  "description": "string",
  "attached_to": "trade",
  "trade_uuids": [
    "string"
  ],
  "trade_ids": [
    "67b486d242ed76693cd2cc59"
  ],
  "order_ids": [
    "67b486d242ed76693cd2cc59"
  ],
  "customer_ids": [
    "67b486d242ed76693cd2cc59"
  ],
  "supplier_ids": [
    "67b486d242ed76693cd2cc59"
  ],
  "employee_ids": [
    "67b486d242ed76693cd2cc59"
  ]
}

Ответ

Поле	Тип	Описание
`_id`	`string`
`created_at`	`string (date-time)`
`updated_at`	`string (date-time)`
`type_id`	`string`
`type`	`object`
`type._id`	`string`
`type.name`	`string`
`type.icon`	`string`
`type.svg`	`string`
`type.color`	`string`
`organization_id`	`string`
`date`	`string (date-time)`
`time_type`	`string`	Допустимые значения: `full_day`, `range`
`start_time`	`string`
`end_time`	`string`
`created_by`	`string`
`created_by_info`	`object`
`created_by_info._id`	`string`
`created_by_info.full_name`	`string`
`created_by_info.phone_number`	`string`
`responsible_id`	`string`
`responsible`	`object`
`responsible._id`	`string`
`responsible.full_name`	`string`
`responsible.phone_number`	`string`
`description`	`string`
`attached_to`	`string`	Допустимые значения: `trade`, `order`, `customer`, `supplier`, `employee`
`trade_ids`	`string[]`
`order_ids`	`string[]`
`customer_ids`	`string[]`
`supplier_ids`	`string[]`
`employee_ids`	`string[]`
`purchase_ids`	`string[]`
`state`	`string`	Допустимые значения: `created`, `completed`
`result_comment`	`string`
`is_postponed`	`boolean`
`postponed_id`	`string`	On a postponed clone, points back to the original task.
`completed_at`	`string (date-time)`

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "67b486d242ed76693cd2cc59",
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": "2025-05-01T12:00:00Z",
    "type_id": "67b486d242ed76693cd2cc59",
    "type": {
      "_id": "string",
      "name": "string",
      "icon": "string",
      "svg": "string",
      "color": "string"
    },
    "organization_id": "67b486d242ed76693cd2cc59",
    "date": "2025-05-01T12:00:00Z",
    "time_type": "full_day",
    "start_time": "09:00",
    "end_time": "10:30",
    "created_by": "67b486d242ed76693cd2cc59",
    "created_by_info": {
      "_id": "string",
      "full_name": "string",
      "phone_number": "string"
    },
    "responsible_id": "67b486d242ed76693cd2cc59",
    "responsible": {
      "_id": "string",
      "full_name": "string",
      "phone_number": "string"
    },
    "description": "string",
    "attached_to": "trade",
    "trade_ids": [
      "string"
    ],
    "order_ids": [
      "string"
    ],
    "customer_ids": [
      "string"
    ],
    "supplier_ids": [
      "string"
    ],
    "employee_ids": [
      "string"
    ],
    "purchase_ids": [
      "string"
    ],
    "state": "created",
    "result_comment": "string",
    "is_postponed": false,
    "postponed_id": "67b486d242ed76693cd2cc59",
    "completed_at": "2025-05-01T12:00:00Z"
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /task/update

Update a task. Rejects when state=completed. Only the creator or boss/additional-boss can update.

Тело запроса

Поле	Тип	Обязательно	Описание
`_id`	`string`	Да
`organization_id`	`string`	Нет
`type_id`	`string`	Нет
`date`	`string (date-time)`	Нет
`time_type`	`string`	Нет	Допустимые значения: `full_day`, `range`
`start_time`	`string`	Нет
`end_time`	`string`	Нет
`responsible_id`	`string`	Нет
`description`	`string`	Нет
`attached_to`	`string`	Нет	Допустимые значения: `trade`, `order`, `customer`, `supplier`, `employee`
`trade_uuids`	`string[]`	Нет
`trade_ids`	`string[]`	Нет
`order_ids`	`string[]`	Нет
`customer_ids`	`string[]`	Нет
`supplier_ids`	`string[]`	Нет
`employee_ids`	`string[]`	Нет

json

{
  "_id": "67b486d242ed76693cd2cc59",
  "organization_id": "67b486d242ed76693cd2cc59",
  "type_id": "67b486d242ed76693cd2cc59",
  "date": "2023-10-01T12:00:00Z",
  "time_type": "full_day",
  "start_time": "09:00",
  "end_time": "10:30",
  "responsible_id": "67b486d242ed76693cd2cc59",
  "description": "string",
  "attached_to": "trade",
  "trade_uuids": [
    "string"
  ],
  "trade_ids": [
    "string"
  ],
  "order_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "employee_ids": [
    "string"
  ]
}

Ответ

Структура ответа совпадает с POST /task/create.

GET /task/get-by-id/{id}

Get a task by _id.

Параметры пути

Параметр	Тип	Обязательно	Описание
`id`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /task/create.

GET /task/paging

Paginated task list. By default hides completed tasks unless state is set or date_type=completed_at. time and times filter by date-buckets (overdue/today/tomorrow/week/month/future) using the boss's UTC offset.

Параметры запроса

Параметр	Тип	Обязательно	Описание
`page`	`integer`	Да	По умолчанию: `1`
`limit`	`integer`	Да	По умолчанию: `20`
`updated_at`	`string (date-time)`	Нет	Sync cursor — only returns rows with updated_at >= this value.
`search`	`string`	Нет
`time`	`string`	Нет	Допустимые значения: `overdue`, `today`, `tomorrow`, `week`, `month`, `future`
`times`	`string[]`	Нет
`date_type`	`string`	Нет	Допустимые значения: `created_at`, `date`, `completed_at`
`responsible_id`	`string`	Нет
`type_id`	`string`	Нет
`type_ids`	`string[]`	Нет
`attached_to`	`string`	Нет	Допустимые значения: `trade`, `order`, `customer`, `supplier`, `employee`
`state`	`string`	Нет	Допустимые значения: `created`, `completed`
`trade_id`	`string`	Нет
`order_id`	`string`	Нет
`customer_id`	`string`	Нет
`supplier_id`	`string`	Нет
`employee_id`	`string`	Нет
`purchase_id`	`string`	Нет
`organization_id`	`string`	Нет

Тело запроса

Тело запроса не требуется.

Ответ

data.total — общее количество записей, data.data[] — записи текущей страницы. Таблица ниже описывает одну запись.

Поле	Тип	Описание
`_id`	`string`
`created_at`	`string (date-time)`
`updated_at`	`string (date-time)`
`type_id`	`string`
`type`	`object`
`type._id`	`string`
`type.name`	`string`
`type.icon`	`string`
`type.svg`	`string`
`type.color`	`string`
`organization_id`	`string`
`date`	`string (date-time)`
`time_type`	`string`	Допустимые значения: `full_day`, `range`
`start_time`	`string`
`end_time`	`string`
`created_by`	`string`
`created_by_info`	`object`
`created_by_info._id`	`string`
`created_by_info.full_name`	`string`
`created_by_info.phone_number`	`string`
`responsible_id`	`string`
`responsible`	`object`
`responsible._id`	`string`
`responsible.full_name`	`string`
`responsible.phone_number`	`string`
`description`	`string`
`attached_to`	`string`	Допустимые значения: `trade`, `order`, `customer`, `supplier`, `employee`
`trade_ids`	`string[]`
`order_ids`	`string[]`
`customer_ids`	`string[]`
`supplier_ids`	`string[]`
`employee_ids`	`string[]`
`purchase_ids`	`string[]`
`state`	`string`	Допустимые значения: `created`, `completed`
`result_comment`	`string`
`is_postponed`	`boolean`
`postponed_id`	`string`	On a postponed clone, points back to the original task.
`completed_at`	`string (date-time)`

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "_id": "67b486d242ed76693cd2cc59",
        "created_at": "2025-05-01T12:00:00Z",
        "updated_at": "2025-05-01T12:00:00Z",
        "type_id": "67b486d242ed76693cd2cc59",
        "type": {
          "_id": "string",
          "name": "string",
          "icon": "string",
          "svg": "string",
          "color": "string"
        },
        "organization_id": "67b486d242ed76693cd2cc59",
        "date": "2025-05-01T12:00:00Z",
        "time_type": "full_day",
        "start_time": "09:00",
        "end_time": "10:30",
        "created_by": "67b486d242ed76693cd2cc59",
        "created_by_info": {
          "_id": "string",
          "full_name": "string",
          "phone_number": "string"
        },
        "responsible_id": "67b486d242ed76693cd2cc59",
        "responsible": {
          "_id": "string",
          "full_name": "string",
          "phone_number": "string"
        },
        "description": "string",
        "attached_to": "trade",
        "trade_ids": [
          "string"
        ],
        "order_ids": [
          "string"
        ],
        "customer_ids": [
          "string"
        ],
        "supplier_ids": [
          "string"
        ],
        "employee_ids": [
          "string"
        ],
        "purchase_ids": [
          "string"
        ],
        "state": "created",
        "result_comment": "string",
        "is_postponed": false,
        "postponed_id": "67b486d242ed76693cd2cc59",
        "completed_at": "2025-05-01T12:00:00Z"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

DELETE /task/delete/{id}

Soft-delete a task (sets is_deleted=true). Rejects when state=completed.

Параметры пути

Параметр	Тип	Обязательно	Описание
`id`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "67b486d242ed76693cd2cc59",
  "time": "2025-05-01T12:00:00Z"
}

GET /task/get-deleted

Returns ids of tasks deleted on or after deleted_at (also matches updated_at >= deleted_at).

Параметры запроса

Параметр	Тип	Обязательно	Описание
`deleted_at`	`string (date-time)`	Да

Тело запроса

Тело запроса не требуется.

Ответ

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

PUT /task/complete

Mark a task as completed. Set is_postponed=true with postponed_date to clone the task at a future date (the original is marked completed; the clone has postponed_id pointing back to it).

Тело запроса

Поле	Тип	Обязательно	Описание
`_id`	`string`	Да
`result_comment`	`string`	Нет
`is_postponed`	`boolean`	Нет	По умолчанию: `false`
`postponed_date`	`string (date-time)`	Нет	Required when is_postponed=true. Must be in the future. The original task is marked completed and a clone with postponed_id pointing to the original is created at this date.

json

{
  "_id": "67b486d242ed76693cd2cc59",
  "result_comment": "string",
  "is_postponed": false,
  "postponed_date": "2023-10-01T12:00:00Z"
}

Ответ

Структура ответа совпадает с POST /task/create.

PUT /task/move

Move a task into a time-frame bucket. Sets date to the bucket's start (today/tomorrow/week/month) or month_end+1s for future. overdue is rejected.

Тело запроса

Поле	Тип	Обязательно	Описание
`_id`	`string`	Да
`time`	`string`	Да	Target time-frame bucket. overdue is rejected.. Допустимые значения: `today`, `tomorrow`, `week`, `month`, `future`

json

{
  "_id": "67b486d242ed76693cd2cc59",
  "time": "today"
}

Ответ

Структура ответа совпадает с POST /task/create.

Эта страница сгенерирована из спецификации OpenAPI.

Task ​

POST /task/create ​

PUT /task/update ​

GET /task/get-by-id/{id} ​

GET /task/paging ​

DELETE /task/delete/{id} ​

GET /task/get-deleted ​

PUT /task/complete ​

PUT /task/move ​

Task

POST /task/create

PUT /task/update

GET /task/get-by-id/{id}

GET /task/paging

DELETE /task/delete/{id}

GET /task/get-deleted

PUT /task/complete

PUT /task/move