Rajapinnassa voidaan lisätä työntekijöiden palkkatapahtumat ja poissaolot sekä noutaa Fennoaan luodut laskentakohteet.

Pilottivaiheessa rajapinta vastaa palkkatapahtumien CSV tuontia, toivommekin teiltä kommentteja mitä rajapintaan olisi tarvetta saada laajemmin.

Tekninen dokumentaatio löytyy sivun alaosasta.

Huomioitavia asioita:

  • Tapahtumat kohdistetaan työntekijän henkilönumerolla sekä palkkalajin koodilla.
  • Tuotavien kirjausten tulee kuulua työntekijän palkkaryhmän mukaiselle palkkajaksolle.
  • Mikäli palkka-ajo on käynnistetty Fennoassa, palkkatapahtumia ei voi enää lisätä ao jaksolle
  • Jo tuotuja palkkatapahtumia ei tällä hetkellä pysty muokkaamaan tai poistamaan rajapinnassa, mikäli samalle päivälle tuodaan uudelleen sama palkkatapahtuma, tulee tapahtuma tuplana ko päivälle.
  • Poissaoloa ei voi tuoda uudelleen päivälle johon poissaolo on jo kirjattu”error”: ”Can’t save overlapping absence for employee P0001, 2025-01-26 – 2025-01-26.”

Kuukausipalkkalaiset:

Mikäli työntekijän kuukausipalkka on tallennettu Fennoaan

  • tuodaan rajapinnassa vain työntekijän muut mahdolliset palkkatapahtumat esim. ylityölisät, muut lisät

Mikäli työntekijän kuukausipalkkaa ei ole tallennettu Fennoaan

  • tuodaan rajapinnassa kuukausipalkka määrä 1 x hinta = kk-palkka.
  • tuodaan muut mahdolliset esim. ylityölisät, muut lisät

Kaikissa tuotavissa palkkatapahtumissa tulee olla määrä ja tarvittaessa hinta.

Rajapinnassa luodut palkkatapahtumat löytyvät Fennoasta Palkat – palkkatapahtumien syöttö.

Rajapinta

Rajapinnan yhteyden muodostaminen:

Lisää API käyttäjä yläpalkin Fennoa -> Käyttäjät -> Luo uusi API-käyttäjä  -> Yleinen API-käyttäjä.

Anna nimeksi TEST [yrityksen tai ohjelman nimi]

Valitse API käyttäjän rooliksi Palkat-palkanlaskija

API-Käyttäjän luomisen jälkeen saat API-käyttäjätunnuksen ja API-avaimen. Kopio API-käyttäjä ja API-avain talteen, sillä sitä ei näytetä uusiksi!

Rajanpinnan tunnistauminen:

  • Basic auth
    • User
    • Password
  • Headers osiossa tulee olla Accept-header annettuna esim:
    • Accept */*

Testaa yhteys noutamalla laskentakohde kutsumalla https://app.fennoa.com/api/v2/dimensionTypes/1/dimensions

Vastaus:

[
{
”id”: ”1”,
”dimension_type_id”: ”1”,
”code”: ”Hki”,
”name”: ”Helsinki”
}
]

Rajapintakutsut:

API URL app.fennoa.com/api/v2/

application/json

Content:

app.fennoa.com/api/v2/payroll/payrollEmploymentWorklogs

Parameters

  • approveWorklogs=true
  • approveWorklogs=true&markPayrollPeriodAsReady=true

Request body payrollEmploymentWorklogs

NameData typeReq’dExample
person_numberstringyesP0001
payroll_salary_category_codestringyes2011
datedateyes2025-01-02
amountnumberyes7.5
pricenumber13.50
multipliernumber1.5
descriptionstringKotihoito
Dimensionsinteger
* dimension_type_id, dimension_id[ { ”dimension_type_id”: 1, ”dimension_id”: 1 } ]

Request body Absence

NameData typeReq’dExample
person_numberstringyesP0001
payroll_salary_category_codestringyest201101
descriptionstring
absence_startdateyes2025-01-03
absence_enddateyes2025-0-03
absence_daysintegeryes1
Dimensionsinteger
* dimension_type_id, dimension_id[ { ”dimension_type_id”: 1, ”dimension_id”: 1 } ]

Example worklogs & abcence

[
{
”person_number”: ”P0001”,
”payroll_salary_category_code”: ”2011”,
”date”: ”2025-01-02”,
”amount”: 7.5,
”Dimensions”: [
{
”dimension_type_id”: 1,
”dimension_id”: 1
}
]
},
{
”person_number”: ”P0001”,
”payroll_salary_category_code”: ”t201101”,
”absence_start”: ”2025-01-03”,
”absence_end”: ”2025-01-03”,
”absence_days”: 1

}
]

Parametrien merkitys käyttöliittymässä

POST/ payroll/payrollEmploymentWorklogs (hyväksymätön palkkatapahtuma)

POST/payroll/payrollEmploymentWorklogs?approveWorklogs=true (hyväksytty palkkatapahtumarivi)

POST/payroll/payrollEmploymentWorklogs?approveWorklogs=true&markPayrollPeriodAsReady=true

(Hyväksytty ja valmiina palkka-ajoa varten)

Hyväksytyt ja palkka-ajoa varten valmiit palkkatapahtumat näkyvät palkanlaskijalle Palkat etusivulla

Responses – status 400 virheiden kuvauksia tullaan vielä tarkentamaan