Entity overview
Agreement
Expose contract metadata to downstream systems so budgeting, procurement, and HR workflows always reference the same source of truth.
Endpoints
GET
https://api.flowtly.eu/agreements
List agreements
Retrieves the collection of Agreement resources.
POST
https://api.flowtly.eu/agreements
Create agreement
Creates a Agreement resource.
GET
https://api.flowtly.eu/agreements/action-needed
List action needed
Retrieves the collection of Agreement resources.
GET
https://api.flowtly.eu/agreements/without-file
List without file
Retrieves the collection of Agreement resources.
GET
https://api.flowtly.eu/agreements/without-file/active
List active
Retrieves the collection of Agreement resources.
GET
https://api.flowtly.eu/agreements/{id}
Get agreement by ID
Retrieve a single resource by its identifier.
PATCH
https://api.flowtly.eu/agreements/{id}
Update agreement
Update resource fields using JSON Merge Patch.
Use cases
Sync signed customer contracts from your CLM to keep revenue forecasts and compliance reviews aligned.
Push vendor agreements with spend caps into Flowtly so finance can monitor renewals automatically.
Schema fields
Agreement-agreement.read| Field | Type | Description |
|---|---|---|
id |
integer | id field. |
employee |
string | null | employee field. |
type |
string | type field. |
variant |
string | variant field. |
amount |
number | amount field. |
minutesPerWeek |
integer | minutesPerWeek field. |
jobSize |
integer | jobSize field. |
amountType |
string | amountType field. |
billingType |
string | billingType field. |
positionName |
string | null | positionName field. |
position |
string | null | position field. |
dateFrom |
string | dateFrom field. |
dateTo |
string | null | dateTo field. |
currency |
string | currency field. |
cost |
string | null | cost field. |
active |
boolean | — |
hoursPerWeek |
integer | — |
status |
string | — |
