Огляд сутності
Угода
Передавайте метадані контрактів у зовнішні системи, щоб бюджетування, закупівлі та HR працювали з одним джерелом правди.
Ендпоїнти
https://api.flowtly.eu/agreements
Список угод
Отримуйте Hydra-колекції угод із пагінацією та фільтрацією за типом, співробітником і прапорцями активності.
https://api.flowtly.eu/agreements/action-needed
Список угод, що потребують дії
Отримуйте угоди, позначені як такі, що потребують погодження або мають відкриті задачі.
https://api.flowtly.eu/agreements
Створити угоду
Створіть нову угоду з даними постачальника/клієнта, циклом білінгу та сумою.
https://api.flowtly.eu/agreements/{id}
Отримати угоду за ID
Отримайте одну угоду, щоб перевірити статус, вартість та повʼязаних співробітників.
https://api.flowtly.eu/agreements/{id}
Оновити угоду
Патчте статус угоди, дати або власників після ревʼю.
https://api.flowtly.eu/agreements/without-file
Retrieves the collection of Agreement resources.
Retrieves the collection of Agreement resources.
https://api.flowtly.eu/agreements/without-file/active
Retrieves the collection of Agreement resources.
Retrieves the collection of Agreement resources.
Сценарії використання
Поля схеми
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. |
Приклади
https://api.flowtly.eu/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"
}