ePalkat API: AccountingEntries

AccountingEntries API Metodi (accountingentries)

AccountingEntries (AccountingEntries) -metodi tarjoaa pääsyn palkkarivien kirjanpitotietoihin ePalkoissa. Metodi tukee suodatusta palkkakausittain (periodnumber) sekä sivutusta (maxrecords, skiprecords).

Authentikaatio

• Basic Authentication vaaditaan.

• Otsake: Authorization: Basic base64(username:password)

• Tyypilliset otsakkeet:

  • Accept: application/json

  • Content-Type: application/json (POST)

Endpointit

Kolme kutsutapaa:

• POST JSON: https://phantasos.heeros.com:9005/AccountingEntries

• GET JSON: https://phantasos.heeros.com:9005/AccountingEntries?parameters

• REST GET JSON (reports): https://phantasos.heeros.com:9005/reports/AccountingEntries?parameters

Huom: esimerkeissä host on phantasos.heeros.com:9005 ja polku on isolla alkukirjaimella AccountingEntries. On hyvin mahdollista että olette saaneet toisenlaisen enpointin (url tai metodi), nämä ovat vain esimerkkejä-

Kutsun parametrit

Kaikki parametrit ovat valinnaisia, ellei toisin mainita.

• periodnumber (int) — Palkkakausi / periodi (numero) Pakollinen

• maxrecords (int) — Maksimi palautettavien rivien määrä

• skiprecords (int) — Ohitettavien rivien määrä (sivutus)

Vastauksen rakenne

Onnistunut vastaus sisältää yläobjektin accountingentries_response, jossa:

• accentries — lista kirjanpitovientiriveistä

• skippedrecords — int

• resultcomplete — int

AccountingEntry kentät (accentries)

Jokainen accentries[]-alkio voi sisältää seuraavat kentät (dokumentaation huomioilla):

• account (string) — Tilinumero

• accountname (string) — Tilin nimi

• paytype (string) — Palkkalaji

• paytypename (string) — Palkkalajin nimi

• amount (int) — Summa (plus tai miinus)

• paymentdate (string) — Maksupäivämäärä

• postingdate (string) — Kaudelle merkitty tositepäivänmäärä

• dimension1 (string) — Dimensio 1 (Yleensä kustannuspaikka) koodi

• dimension1name (string) — Dimensio 1 selväkielinen nimi

• dimension2 (string) — Dimensio 2 (Yleensä projekti) koodi

• dimension2name (string) — Dimensio 2 selväkielinen nimi

• dimension3 (string) — Dimensio 3 (Yleensä "työvaihe") koodi

• dimension3name (string) — Dimensio 3 selväkielinen nimi

• dimension4 (string) — Dimensio 4 koodi

• dimension4name (string) — Dimensio 4 selväkielinen nimi

• personnumber (int) — Henkilönumero

• employeename (string) — Henkilön nimi

• periodnumber (int) — Kausinumero

• quantity (int) — Lukumäärä

• id (string) — Tietueen id