Avtal & regelefterlevnad – bygg på Flowtly

Använd denna kuraterade snapshot av Flowtlys OpenAPI för att planera integrationer, automatisera flöden och synka data teamen behöver.

Dokumentationsstatus

Senast synkad 2025-12-11 09:43 (app‑version 2.0.0)

Endast ett urval av entiteter är publikt. Kör båda sync‑kommandon när Flowtly släpper nytt.

Avtal & regelefterlevnad

Hantera avtal, gallringsregler och inköpsflöden.

Entitetsöversikt

Avtal

Exponera avtalsmetadata till nedströms system så budget, inköp och HR‑flöden använder samma källa.

API‑slutpunkter

GET /api/agreements

Lista avtal

Hämta Hydra‑samlingar av avtal med paginering och filtrering på typ, anställd och aktivitetsflaggor.

GET /api/agreements/action-needed

Lista avtal som kräver åtgärd

Hämta avtal som flaggats för saknade godkännanden eller öppna uppgifter.

POST /api/agreements

Skapa avtal

Posta ett nytt avtal med leverantörs‑/kundmetadata, faktureringsfrekvens och belopp.

GET /api/agreements/{id}

Hämta avtal via ID

Hämta ett enskilt avtal för att granska status, värde och kopplade anställda.

PATCH /api/agreements/{id}

Uppdatera avtal

Patcha avtalsstatus, datum eller ägare efter genomgång.

Användningsfall

Synka signerade kundavtal från ditt CLM så intäktsprognoser och compliance följer samma linje.
Tryck in leverantörsavtal med spend‑tak i Flowtly så finans kan bevaka förnyelser automatiskt.

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

POST /api/agreements

Registrera ett leverantörsavtal

Skapar ett leverantörsabonnemang och kopplar det till ansvarig medarbetare samt valutareferens i Flowtly.

Request‑payload
{
    "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
}
Response‑payload
{
    "@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"
}

Entitetsöversikt

Anställd

Skapa och hantera anställda för tilldelningar, godkännanden och behörigheter.

API‑slutpunkter

GET /api/employees

Lista anställda

Hämta medarbetarprofiler med paginering och filter.

POST /api/employees

Skapa anställd

Lägg till en ny anställd med namn, e‑post och ev. avatar.

GET /api/employees/{id}

Hämta anställd via ID

Läs en specifik medarbetarprofil.

PATCH /api/employees/{id}

Uppdatera anställd

Patcha uppgifter som namn eller e‑post.

DELETE /api/employees/{id}

Radera anställd

Ta bort en medarbetarprofil.

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

Statistik för arbetstid

Hämta aggregerad arbetstidsstatistik för ett datum.

Schemafält

User-user.read
Fält Typ Beskrivning
id integer Internt ID för anställd.
email string | null E‑postadress för anställd.
firstname string Förnamn.
lastname string Efternamn.
interestedInModules array | null
avatarUrl string | null Avatar‑URL för den anställda.
Whatsapp