Entitetsöversikt
Avtal
Exponera avtalsmetadata till nedströms system så budget, inköp och HR‑flöden använder samma källa.
API‑slutpunkter
/api/agreements
Lista avtal
Hämta Hydra‑samlingar av avtal med paginering och filtrering på typ, anställd och aktivitetsflaggor.
/api/agreements/action-needed
Lista avtal som kräver åtgärd
Hämta avtal som flaggats för saknade godkännanden eller öppna uppgifter.
/api/agreements
Skapa avtal
Posta ett nytt avtal med leverantörs‑/kundmetadata, faktureringsfrekvens och belopp.
/api/agreements/{id}
Hämta avtal via ID
Hämta ett enskilt avtal för att granska status, värde och kopplade anställda.
/api/agreements/{id}
Uppdatera avtal
Patcha avtalsstatus, datum eller ägare efter genomgång.
Användningsfall
Schemafält
Agreement-agreement.read| Fält | Typ | Beskrivning |
|---|---|---|
id |
integer | Internt Flowtly‑ID som tilldelats avtalet. |
employee |
string | null | IRI för den anställda som ansvarar för avtalet. |
type |
string | Övergripande klassificering som leverantör, kund eller anställning. |
variant |
string | Egen undertyp som styr automation och rapportering. |
amount |
number | Netto‑ eller bruttobelopp som sparas för avtalet. |
minutesPerWeek |
integer | Förväntat antal arbetade minuter per vecka. |
jobSize |
integer | Arbetsmängdsmått för schemaprognoser. |
amountType |
string | Definierar om beloppet lagras som netto eller brutto. |
billingType |
string | Faktureringsfrekvens (per månad, per timme, etc.). |
positionName |
string | null | Fritextetikett för roll kopplad till avtalet. |
position |
string | null | IRI‑referens till standardiserad rollpost. |
dateFrom |
string | Startdatum/tid för avtalets giltighet. |
dateTo |
string | null | Slutdatum/tid för avtalet (valfritt för tills vidare). |
currency |
string | Valuta‑IRI som används för penningvärden. |
cost |
string | null | IRI som pekar på associerad kostnadspost. |
active |
boolean | Anger om Flowtly just nu betraktar avtalet som aktivt. |
hoursPerWeek |
integer | Förväntade arbetstimmar per vecka. |
status |
string | Flowtly‑status som utkast eller aktivt. |
Exempel
/api/agreements
Registrera ett leverantörsavtal
Skapar ett leverantörsabonnemang och kopplar det till ansvarig medarbetare samt valutareferens i 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"
}