---
# System prepended metadata

title: 'Модули Flowlu (актуальная https://hackmd.io/@flowlu/api-ru)'

---

# Модули Flowlu (актуальная https://hackmd.io/@flowlu/api-ru)

## CRM (module_name: crm)
- Контрагент (entity_name: account)
- Связи контрагентов (entity_name: relation) 
- E-mail адреса контрагентов (entity_name: email)
- Категории (entity_name: account_category)
- Обращения (entity_name: honorific_title)
- Индустрии (entity_name: industry)
- Сделки (entity_name: lead)
- Воронки продаж (entity_name: pipeline)
- Этапы воронок продаж (entity_name: pipeline_stage)
- Источники сделок (entity_name: source)
- Причины отказов (entity_name: loss_reason) 

> Связи контрагентов предоставляют возможность создавать связи между контрагентом.

## Финансы (module_name: fin)

- Организация (entity_name: organization)
- Cчёт организации (entity_name: bank_account)
- Cчёт (entity_name: invoice)
- Товар счета (entity_name: invoice_items)
- Платёжный документ (entity_name: customer_payment)
- Транзакция (entity_name: transaction)
- Предложение (entity_name: estimate)
- Товар предложения (entity_name: estimate_item)

## Акты (module_name: act)

- Акт (entity_name: act)
- Товар акта (entity_name: item)
- Статус (entity_name: status)

## Задачи (module_name: task)

- Задача (entity_name: task)
- Потраченное время задачи (entity_name: time_spent)

## Проекты (module_name: st)

 - Проект (entity_name: project)
 - Доска проектов (entity_name: project_types)


## Тайм трекер (module_name: timetracker)

 - Сущность агрегирующая все временные записи по задаче/agile-задаче (entity_name: timesheet)
 - Детальная запись времени (entity_name: timelog)


## Списки (module_name: customlists)

 - Список (entity_name: lists)
 - Элемент списка (entity_name: items)

> Имена полей списка формируются по шаблону cf_<id поля>
> Для фильтрации по пользовательскому полю имя фильтра нужно формировать по шаблону cf.field_<id поля>

## Core (module_name: core)

 - Пользователь (entity_name: user)

 

## Примеры:

```console
curl -H "application/x-www-form-urlencoded" -X POST -d "type=1&name=String"  https://<account_code>.flowlu.ru/api/v1/module/<module_name>/<entity_name>/create/?api_key=<api_key>
```
```console
curl -H "application/x-www-form-urlencoded" -X POST -d "type=1&name=String" https://<account_code>.flowlu.ru/api/v1/module/<module_name>/<entity_name>/update/<entity_id>?api_key=<api_key>
```
```console
curl -X GET https://<account_code>.flowlu.ru/api/v1/module/<module_name>/<entity_name>/get/<entity_id>?api_key=<api_key>
```
```console
curl -X GET https://<account_code>.flowlu.ru/api/v1/module/<module_name>/<entity_name>/list?search=flowlu&page=1&api_key=<api_key>
```

### Фильтрация по пользовательским полям:
```console
curl -X GET https://<account_code>.flowlu.ru/api/v1/module/<module_name>/<entity_name>/list?search=flowlu&page=1&api_key=<api_key>&filter[cf.field_<field_id>]=<filter_value>
```

### Получение списка айтемов конкретного пользовательского списка
```console
curl -X GET https://<account_code>.flowlu.ru/api/v1/module/customlists/lists/<customlist_id>/items?api_key=<api_key>
```