Mzdové období

GET

/wageperiods

Získá kolekci BO Mzdové období

GET

/wageperiods/{id}

Získá konkrétní BO Mzdové období

POST

/wageperiods

Vytvoří nový BO Mzdové období a vrátí jeho kompletní reprezentaci

PUT

/wageperiods/{id}

Provede aktualizaci BO Mzdové období a vrátí jeho kompletní, aktualizovanou reprezentaci. Operaci PUT je možné využívat i k částečným aktualizacím zdrojů (PATCH).

DELETE

/wageperiods/{id}

Smaže BO Mzdové období na základě jeho ID

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í; ID objektu 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
{
    "ID": "1900000101",
    "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
{
    "ID": "1900000101",
    "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": "1900000101"
}
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": "1900000101"
}

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": "1900000100",
                "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": "1900000101",
                "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": "1900000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1900000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1900000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1900000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "wageperiods",
                "obj_id": "1900000104"
            }
        }
    ]
}