Entity overview
Agreement
Expose contract metadata to downstream systems so budgeting, procurement, and HR workflows always reference the same source of truth.
Endpoints
https://api.flowtly.eu/agreements
List agreements
Retrieve Hydra collections of agreements with pagination and filtering over type, employee, and activity flags.
https://api.flowtly.eu/agreements/action-needed
List agreements needing action
Retrieve agreements flagged for missing approvals or open tasks.
https://api.flowtly.eu/agreements
Create agreement
Post a new agreement with vendor/client metadata, billing cadence, and amount information.
https://api.flowtly.eu/agreements/{id}
Get agreement by ID
Fetch a single agreement resource to inspect status, value, and related employees.
https://api.flowtly.eu/agreements/{id}
Update agreement
Patch agreement status, dates, or owners after review.
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.
Use cases
Schema fields
Agreement-agreement.read| Field | Type | Description |
|---|---|---|
id |
integer | Internal Flowtly identifier assigned to the agreement. |
employee |
string | null | IRI of the employee responsible for the contract. |
type |
string | High-level classification such as vendor, customer, or employment. |
variant |
string | Custom subtype used to drive automation and reporting. |
amount |
number | Net or gross monetary value captured for the agreement. |
minutesPerWeek |
integer | Expected number of working minutes per week. |
jobSize |
integer | Job size metric used for scheduling forecasts. |
amountType |
string | Defines whether the amount is stored as netto or brutto. |
billingType |
string | Billing cadence (per-month, per-hour, etc.). |
positionName |
string | null | Free-text position label tied to the agreement. |
position |
string | null | IRI reference to the standardized position record. |
dateFrom |
string | Start date/time of the contract validity. |
dateTo |
string | null | End date/time of the contract (nullable for open-ended). |
currency |
string | Currency IRI used for monetary values. |
cost |
string | null | IRI pointing to the associated cost record. |
active |
boolean | Indicates whether Flowtly currently treats the agreement as active. |
hoursPerWeek |
integer | Expected working hours per week. |
status |
string | Flowtly workflow status such as draft or active. |
Examples
https://api.flowtly.eu/agreements
Register a vendor agreement
Creates a vendor subscription agreement, tying it to the responsible employee and currency reference used inside 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"
}