Przegląd encji
Umowa
Udostępniaj metadane kontraktów innym systemom, aby budżety, zakupy i HR działały na jednym źródle prawdy.
Endpointy
/api/agreements
Lista umów
Pobierz kolekcję Hydra z możliwością filtrowania po typie, pracowniku i statusie aktywności.
/api/agreements/action-needed
Lista umów wymagających akcji
Pobierz umowy oznaczone brakującymi akceptacjami lub danymi.
/api/agreements
Utwórz umowę
Prześlij nową umowę z metadanymi o kontrahencie, rozliczeniach i kwotach.
/api/agreements/{id}
Pobierz umowę po ID
Odczytaj pojedynczą umowę, aby sprawdzić status, wartość i powiązanego pracownika.
/api/agreements/{id}
Zaktualizuj umowę
Zmień status, daty lub właściciela umowy.
Przypadki użycia
Pola schematu
Agreement-agreement.read| Pole | Typ | Opis |
|---|---|---|
id |
integer | Wewnętrzny identyfikator umowy w Flowtly. |
employee |
string | null | IRI pracownika odpowiedzialnego za umowę. |
type |
string | Typ umowy, np. vendor, klient lub zatrudnienie. |
variant |
string | Własny podtyp wykorzystywany w automatyzacjach. |
amount |
number | Kwota netto/brutto przypisana do umowy. |
minutesPerWeek |
integer | Zakładana liczba minut pracy tygodniowo. |
jobSize |
integer | Parametr wielkości etatu używany w prognozach. |
amountType |
string | Określa, czy kwota jest netto czy brutto. |
billingType |
string | Częstotliwość rozliczeń (np. miesięcznie). |
positionName |
string | null | Wolny opis stanowiska związany z kontraktem. |
position |
string | null | IRI odnoszące się do słownikowego stanowiska. |
dateFrom |
string | Data rozpoczęcia obowiązywania umowy. |
dateTo |
string | null | Data zakończenia (może być pusta). |
currency |
string | Waluta referencyjna dla kwot. |
cost |
string | null | IRI powiązanego kosztu. |
active |
boolean | Czy umowa jest aktywna w Flowtly. |
hoursPerWeek |
integer | Liczba godzin w tygodniu wynikająca z umowy. |
status |
string | Status workflow (np. draft, active). |
Przykłady
/api/agreements
Rejestracja umowy z dostawcą
Tworzy umowę subskrypcyjną z dostawcą i wiąże ją z właściwym pracownikiem oraz odniesieniem waluty w 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"
}