Контракти та комплаєнс – будуйте на Flowtly

Використовуйте цей добірний знімок OpenAPI-схеми Flowtly, щоб планувати інтеграції, автоматизувати процеси та синхронізувати дані, на які спираються ваші команди.

Статус документації

Остання синхронізація: 2025-12-11 09:43 (версія застосунку 2.0.0)

Публікується лише частина сутностей. Запускайте обидві команди синхронізації, щоб оновити цю документацію після виходу нових можливостей Flowtly.

Контракти та комплаєнс

Керуйте угодами, політиками утримання та процесами закупівель.

Огляд сутності

Угода

Передавайте метадані контрактів у зовнішні системи, щоб бюджетування, закупівлі та HR працювали з одним джерелом правди.

Ендпоїнти

GET /api/agreements

Список угод

Отримуйте Hydra-колекції угод із пагінацією та фільтрацією за типом, співробітником і прапорцями активності.

GET /api/agreements/action-needed

Список угод, що потребують дії

Отримуйте угоди, позначені як такі, що потребують погодження або мають відкриті задачі.

POST /api/agreements

Створити угоду

Створіть нову угоду з даними постачальника/клієнта, циклом білінгу та сумою.

GET /api/agreements/{id}

Отримати угоду за ID

Отримайте одну угоду, щоб перевірити статус, вартість та повʼязаних співробітників.

PATCH /api/agreements/{id}

Оновити угоду

Патчте статус угоди, дати або власників після ревʼю.

Сценарії використання

Синхронізуйте підписані клієнтські договори з вашої CLM, щоб узгодити прогноз виручки та комплаєнс-ревʼю.
Передавайте угоди з постачальниками з лімітами витрат у Flowtly, щоб фінанси автоматично відстежували поновлення.

Поля схеми

Agreement-agreement.read
Поле Тип Опис
id integer Внутрішній ідентифікатор Flowtly, призначений угоді.
employee string | null IRI співробітника, відповідального за контракт.
type string Високорівнева класифікація, наприклад постачальник, клієнт або працевлаштування.
variant string Кастомний підтип для автоматизації та звітності.
amount number Чиста або валова грошова сума, зафіксована для угоди.
minutesPerWeek integer Очікувана кількість робочих хвилин на тиждень.
jobSize integer Метрика обсягу роботи, що використовується для прогнозів планування.
amountType string Визначає, чи зберігається сума як netto або brutto.
billingType string Каденція білінгу (на місяць, на годину тощо).
positionName string | null Вільний текстовий ярлик позиції, повʼязаної з угодою.
position string | null IRI-посилання на стандартизований запис позиції.
dateFrom string Дата/час початку дії контракту.
dateTo string | null Дата/час завершення контракту (може бути null для безстрокових).
currency string IRI валюти, що використовується для грошових значень.
cost string | null IRI, що вказує на повʼязаний запис витрат.
active boolean Вказує, чи Flowtly вважає угоду активною.
hoursPerWeek integer Очікувані робочі години на тиждень.
status string Статус робочого процесу Flowtly, наприклад draft або active.

Приклади

POST /api/agreements

Зареєструвати угоду з постачальником

Створює угоду на підписку постачальника, привʼязуючи її до відповідального співробітника та валюти, що використовується у Flowtly.

Пейлоад запиту 
{
    "employee": "/api/employees/emp_439",
    "type": "vendor",
    "variant": "software",
    "amount": 18500,
    "currency": "/api/currencies/EUR",
    "dateFrom": "2024-07-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "amountType": "netto",
    "billingType": "per-month",
    "positionName": "Implementation partner",
    "hoursPerWeek": 12
}
Пейлоад відповіді 
{
    "@id": "/api/agreements/agr_Y29H",
    "@type": "Agreement",
    "id": 5021,
    "employee": "/api/employees/emp_439",
    "type": "vendor",
    "variant": "software",
    "amount": 18500,
    "currency": "/api/currencies/EUR",
    "dateFrom": "2024-07-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "amountType": "netto",
    "billingType": "per-month",
    "positionName": "Implementation partner",
    "hoursPerWeek": 12,
    "active": true,
    "status": "draft"
}

Огляд сутності

Співробітник

Створюйте та керуйте співробітниками для призначень, погоджень і контролю доступу.

Ендпоїнти

GET /api/employees

Список співробітників

Отримуйте профілі співробітників з пагінацією та фільтрами.

POST /api/employees

Створити співробітника

Додайте нового співробітника з імʼям, email і опціональним аватаром.

GET /api/employees/{id}

Отримати співробітника за ID

Прочитайте конкретний профіль співробітника.

PATCH /api/employees/{id}

Оновити співробітника

Патчте дані співробітника, наприклад імʼя або email.

DELETE /api/employees/{id}

Видалити співробітника

Видаліть профіль співробітника.

GET /api/employees/{id}/working-hours-stats/{date}

Статистика робочих годин

Отримайте агреговану статистику робочих годин за вказану дату.

Поля схеми

User-user.read
Поле Тип Опис
id integer Внутрішній ідентифікатор співробітника.
email string | null Email-адреса співробітника.
firstname string Імʼя співробітника.
lastname string Прізвище співробітника.
interestedInModules array | null —
avatarUrl string | null URL аватара співробітника.
Whatsapp