Druh srážky

GET

/docktypes

Získá kolekci BO Druh srážky

GET

/docktypes/meta/dataprotection

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

GET

/docktypes/views/{view}

Získá pohled nad BO Druh srážky

GET

/docktypes/{id}

Získá daný BO Druh srážky

GET

/docktypes/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Druh srážky

GET

/docktypes/{id}/meta/dataprotection

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

GET

/docktypes/{id}/userparameters

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

POST

/docktypes

Vytvoří nový BO Druh srážky

POST

/docktypes/query

Vyhodnotí query dotaz nad BO Druh srážky

PUT

/docktypes/{id}

Modifikuje daný BO Druh srážky

PUT

/docktypes/{id}/editlock

Vytvoří editační zámek na daném BO Druh srážky

PUT

/docktypes/{id}/editunlock

Zruší editační zámek na daném BO Druh srážky

DELETE

/docktypes/{id}

Smaže BO Druh srážky

Metadata - Perzistentní položky

agreementdock boolean

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

basetype integer

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

code string (10)

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

comptominimum boolean

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

debtcorrect boolean

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

dockfromagreements boolean

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

hidden boolean

Skrytý, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

internaldock boolean

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

name string (50)

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

partialdock boolean

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

periodicity integer

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

printgroup string (2)

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

uselegaleffectfromdate boolean

Používat datum nabytí právní moci, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

youngchilddock boolean

Srážka na nezletilé dítě, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Metadata - Neperzistentní položky

basetypetext string (30)

Typ

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

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request

GET

https://atd.abra.eu/demodata/docktypes?take=1

GET

https://atd.abra.eu/demodata/docktypes/{id}
Response
{
    "objversion": 2,
    "hidden": false,
    "code": "VYZ",
    "name": "Výživné",
    "basetype": 0,
    "periodicity": 1,
    "internaldock": false,
    "debtcorrect": true,
    "comptominimum": true,
    "partialdock": true,
    "printgroup": "V",
    "agreementdock": false,
    "dockfromagreements": true,
    "uselegaleffectfromdate": true,
    "youngchilddock": false
}
Request POST

POST

https://atd.abra.eu/demodata/query
{"class": "docktypes", "take": "1"}

POST

https://atd.abra.eu/demodata/docktypes/query
{"take": "1"}
Response
{
    "objversion": 2,
    "hidden": false,
    "code": "VYZ",
    "name": "Výživné",
    "basetype": 0,
    "periodicity": 1,
    "internaldock": false,
    "debtcorrect": true,
    "comptominimum": true,
    "partialdock": true,
    "printgroup": "V",
    "agreementdock": false,
    "dockfromagreements": true,
    "uselegaleffectfromdate": true,
    "youngchilddock": false
}
Request

POST

https://atd.abra.eu/demodata/docktypes?select=id
Body
{
    "agreementdock": false,
    "basetype": 0,
    "code": "VYZ",
    "comptominimum": true,
    "debtcorrect": true,
    "dockfromagreements": true,
    "hidden": false,
    "internaldock": false,
    "name": "Výživné",
    "partialdock": true,
    "periodicity": 1,
    "printgroup": "V",
    "uselegaleffectfromdate": true,
    "youngchilddock": false
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/docktypes/{id}?select=id
Body
{
    "agreementdock": false,
    "basetype": 0,
    "code": "VYZ",
    "comptominimum": true,
    "debtcorrect": true,
    "dockfromagreements": true,
    "hidden": false,
    "internaldock": false,
    "name": "Výživné",
    "partialdock": true,
    "periodicity": 1,
    "printgroup": "V",
    "uselegaleffectfromdate": true,
    "youngchilddock": false
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/docktypes/{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": "docktypes",
                "object_data": {
                    "agreementdock": false,
                    "basetype": 0,
                    "code": "VYZ",
                    "comptominimum": true,
                    "debtcorrect": true,
                    "dockfromagreements": true,
                    "hidden": false,
                    "internaldock": false,
                    "name": "Výživné",
                    "partialdock": true,
                    "periodicity": 1,
                    "printgroup": "V",
                    "uselegaleffectfromdate": true,
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "docktypes",
                "object_data": {
                    "agreementdock": false,
                    "basetype": 0,
                    "code": "VYZ",
                    "comptominimum": true,
                    "debtcorrect": true,
                    "dockfromagreements": true,
                    "hidden": false,
                    "internaldock": false,
                    "name": "Výživné",
                    "partialdock": true,
                    "periodicity": 1,
                    "printgroup": "V",
                    "uselegaleffectfromdate": true,
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1600000100",
                "object_data": {
                    "agreementdock": false,
                    "basetype": 0,
                    "code": "VYZ",
                    "comptominimum": true,
                    "debtcorrect": true,
                    "dockfromagreements": true,
                    "hidden": false,
                    "internaldock": false,
                    "name": "Výživné",
                    "partialdock": true,
                    "periodicity": 1,
                    "printgroup": "V",
                    "uselegaleffectfromdate": true,
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1600000101",
                "object_data": {
                    "agreementdock": false,
                    "basetype": 0,
                    "code": "VYZ",
                    "comptominimum": true,
                    "debtcorrect": true,
                    "dockfromagreements": true,
                    "hidden": false,
                    "internaldock": false,
                    "name": "Výživné",
                    "partialdock": true,
                    "periodicity": 1,
                    "printgroup": "V",
                    "uselegaleffectfromdate": true,
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1600000104"
            }
        }
    ]
}