Mzdové období

GET

/wageperiods

Získá kolekci BO Mzdové období

GET

/wageperiods/actual

Aktivní mzdové období

GET

/wageperiods/lastclosed

Poslední uzavřené mzdové období

GET

/wageperiods/meta/dataprotection

Získá seznam položek BO, které mohou být chráněny na BO Mzdové období

GET

/wageperiods/mindateofchange

Nejnižší datum úprav položek mezd

GET

/wageperiods/views/{view}

Získá pohled nad BO Mzdové období

GET

/wageperiods/{id}

Získá daný BO Mzdové období

GET

/wageperiods/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Mzdové období

GET

/wageperiods/{id}/meta/dataprotection

Získá seznam chráněných položek, které jsou na BO Mzdové období aktuálnímu uživateli znepřístupněny

GET

/wageperiods/{id}/userparameters

Získá seznam uživatelských parametrů včetně jejich hodnot k danému BO Mzdové období

POST

/wageperiods

Vytvoří nový BO Mzdové období

POST

/wageperiods/query

Vyhodnotí query dotaz nad BO Mzdové období

PUT

/wageperiods/generatewageperiods

Vygeneruje všechna mzdová období na základě vybraného fiskálního období

PUT

/wageperiods/{id}

Modifikuje daný BO Mzdové období

PUT

/wageperiods/{id}/carrysickbenefitrow

Vytvoření řádků nemocenských dávek pro aktuální mzdové období

PUT

/wageperiods/{id}/deleteclosing

Zrušení mzdové uzávěrky

PUT

/wageperiods/{id}/editlock

Vytvoří editační zámek na daném BO Mzdové období

PUT

/wageperiods/{id}/editunlock

Zruší editační zámek na daném BO Mzdové období

PUT

/wageperiods/{id}/generateclosing

Provedení mzdové uzávěrky daného mzdového období

PUT

/wageperiods/{id}/initwageperiod

Provede inicializaci mzdového období

PUT

/wageperiods/{id}/softdeleteclosing

Částečné zrušení mzdové uzávěrky (přepnutí aktivního mzdového období bez možnosti editace)

DELETE

/wageperiods/{id}

Smaže BO Mzdové období

Metadata - Perzistentní položky

code string (10)

Kód, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

datefrom$date string

Od, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

dateto$date string

Do, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

firstwperiod boolean

První, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

name string (40)

Název, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

objversion integer

Verze objektu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

period_id string (period) relace

Fisk.období, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

terminator boolean

Term., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

wperiodclosed boolean

Uzav., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

wperiodinitialized boolean

Init., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Metadata - Neperzistentní položky

classid string (26)

ID třídy, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

displayname string (100)

Název, pouze pro čtení

id string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

statetext string (20)

Stav

wperiodisactual boolean

Aktivní

wperiodmonth integer

Měsíc

wperiodyear integer

Rok

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/wageperiods?take=1
GET
https://atd.abra.eu/demodata/wageperiods/{id}
Response 
{
    "objversion": 4,
    "datefrom$date": "2015-12-31T23:00:00.000Z",
    "dateto$date": "2016-01-30T23:00:00.000Z",
    "period_id": "2K00000101",
    "code": "2016\/01",
    "name": "Leden 2016",
    "wperiodclosed": true,
    "wperiodinitialized": true,
    "terminator": false,
    "firstwperiod": true
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "wageperiods", "take": "1"}
POST
https://atd.abra.eu/demodata/wageperiods/query
{"take": "1"}
Response 
{
    "objversion": 4,
    "datefrom$date": "2015-12-31T23:00:00.000Z",
    "dateto$date": "2016-01-30T23:00:00.000Z",
    "period_id": "2K00000101",
    "code": "2016\/01",
    "name": "Leden 2016",
    "wperiodclosed": true,
    "wperiodinitialized": true,
    "terminator": false,
    "firstwperiod": true
}
Request 
POST
https://atd.abra.eu/demodata/wageperiods?select=id
Body 
{
    "code": "2016\/01",
    "datefrom$date": "2015-12-31T23:00:00.000Z",
    "dateto$date": "2016-01-30T23:00:00.000Z",
    "firstwperiod": true,
    "name": "Leden 2016",
    "period_id": "2K00000101",
    "terminator": false,
    "wperiodclosed": true,
    "wperiodinitialized": true
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/wageperiods/{id}?select=id
Body 
{
    "code": "2016\/01",
    "datefrom$date": "2015-12-31T23:00:00.000Z",
    "dateto$date": "2016-01-30T23:00:00.000Z",
    "firstwperiod": true,
    "name": "Leden 2016",
    "period_id": "2K00000101",
    "terminator": false,
    "wperiodclosed": true,
    "wperiodinitialized": true
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/wageperiods/{id}
Response 
200 - OK Everything worked as expected.
Dávkové zprocování záznamů Request 
PUT
https://atd.abra.eu/demodata//batch
  • CREATE
  • UPDATE
  • DELETE
Body - Create 
{
    "items": [
        {
            "type": "create",
            "id": "id0",
            "data": {
                "class_id": "wageperiods",
                "object_data": {
                    "code": "2016\/01",
                    "datefrom$date": "2015-12-31T23:00:00.000Z",
                    "dateto$date": "2016-01-30T23:00:00.000Z",
                    "firstwperiod": true,
                    "name": "Leden 2016",
                    "period_id": "2K00000101",
                    "terminator": false,
                    "wperiodclosed": true,
                    "wperiodinitialized": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "wageperiods",
                "object_data": {
                    "code": "2016\/01",
                    "datefrom$date": "2015-12-31T23:00:00.000Z",
                    "dateto$date": "2016-01-30T23:00:00.000Z",
                    "firstwperiod": true,
                    "name": "Leden 2016",
                    "period_id": "2K00000101",
                    "terminator": false,
                    "wperiodclosed": true,
                    "wperiodinitialized": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1600000100",
                "object_data": {
                    "code": "2016\/01",
                    "datefrom$date": "2015-12-31T23:00:00.000Z",
                    "dateto$date": "2016-01-30T23:00:00.000Z",
                    "firstwperiod": true,
                    "name": "Leden 2016",
                    "period_id": "2K00000101",
                    "terminator": false,
                    "wperiodclosed": true,
                    "wperiodinitialized": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1600000101",
                "object_data": {
                    "code": "2016\/01",
                    "datefrom$date": "2015-12-31T23:00:00.000Z",
                    "dateto$date": "2016-01-30T23:00:00.000Z",
                    "firstwperiod": true,
                    "name": "Leden 2016",
                    "period_id": "2K00000101",
                    "terminator": false,
                    "wperiodclosed": true,
                    "wperiodinitialized": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1600000104"
            }
        }
    ]
}