Srážka

GET

/docks

Získá kolekci BO Srážka

GET

/docks/meta/dataprotection

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

GET

/docks/views/{view}

Získá pohled nad BO Srážka

GET

/docks/{id}

Získá daný BO Srážka

GET

/docks/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Srážka

GET

/docks/{id}/meta/dataprotection

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

GET

/docks/{id}/userparameters

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

POST

/docks

Vytvoří nový BO Srážka

POST

/docks/query

Vyhodnotí query dotaz nad BO Srážka

PUT

/docks/{id}

Modifikuje daný BO Srážka

PUT

/docks/{id}/editlock

Vytvoří editační zámek na daném BO Srážka

PUT

/docks/{id}/editunlock

Zruší editační zámek na daném BO Srážka

DELETE

/docks/{id}

Smaže BO Srážka

Metadata - Perzistentní položky

agreementdock boolean

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

allowedmaxtorealize number

Maximálně povoleno srazit., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje částku v lokální měně

basetype integer

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

busorder_id string (busorder) relace

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

busproject_id string (busproject) relace

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

bustransaction_id string (bustransaction) relace

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

clsidforpercent string (26)

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

constsymbol_id string (constantsymbol) relace

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

correctedby_id string (securityuser) relace

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

createdby_id string (securityuser) relace

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

debtcorrect boolean

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

definition_id string (dockdefinition) relace

Definice, pole vlastněné tabulkou, možné řadit a filtrovat

description string (40)

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

destination string (42)

Cílový účet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

division_id string (division) relace

Středisko, 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

docktype_id string (docktype) relace

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

duedate$date string

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

employee_id string (employee) relace

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

execauthority string (200)

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

execrecipient string (200)

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

execrefnumber string (100)

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

firstdeliverydate$date string

Datum doručení prvnímu plátci, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

flag string

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

internal boolean

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

isdebt boolean

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

ispercent boolean

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

itisgenerateddebt boolean

Generovaný dluh, pole vlastněné tabulkou, možné řadit a filtrovat

objversion integer

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

ofminimum boolean

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

partial boolean

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

percentofcode integer

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

printgroup string (2)

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

priority integer

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

realized number

Realizováno, pole vlastněné tabulkou, možné řadit a filtrovat, pole obsahuje částku v lokální měně

required number

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

requiredamount number

Předepsaná částka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje částku v lokální měně

source_id string (bankaccount) relace

Zdrojový účet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

specsymbol string (12)

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

swiftcode string (20)

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

targetbankcountry_id string (country) relace

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

validfromdate$date string

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

varsymbol string (10)

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

wageperiod_id string (wageperiod) relace

Mzdové období, 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

basetype_text string (40)

Zákl.typ, pouze pro čtení

classid string (26)

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

deponated boolean

Deponovaná

displayname string (100)

Název, pouze pro čtení

id string (10)

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

itisgenerated boolean

Generovaná srážka

nonrecoverableamount number

Nezabavitelná částka

numpersonalnumber integer

Os.číslo numericky, pouze pro čtení

paid boolean

Zaplacená

pdocumentdisplayname string (100)

Platební doklad

per_personalnumber string (10)

Os.číslo, pouze pro čtení

percentoflabel string (40)

Položka - popis

percentofname string (40)

Položka - jméno, pole je duplikováno při klonování objektu

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/docks?take=1
GET
https://atd.abra.eu/demodata/docks/{id}
Response 
{
    "objversion": 4,
    "definition_id": "2100000101",
    "employee_id": "4200000101",
    "wageperiod_id": "R700000101",
    "docktype_id": "4000000000",
    "description": "Spoření externí",
    "basetype": 4,
    "internal": false,
    "debtcorrect": false,
    "ofminimum": false,
    "partial": true,
    "priority": 0,
    "printgroup": "S",
    "destination": "2019590302\/2600",
    "swiftcode": "",
    "execauthority": "",
    "execrefnumber": "",
    "execrecipient": "",
    "source_id": "2200000101",
    "varsymbol": "5434",
    "specsymbol": "",
    "constsymbol_id": "0000498000",
    "required": 3500,
    "ispercent": false,
    "realized": 3500,
    "percentofcode": 0,
    "createdby_id": "1200000101",
    "correctedby_id": "1200000101",
    "clsidforpercent": "00000000000000000000000000",
    "isdebt": false,
    "duedate$date": "2014-02-06T23:00:00.000Z",
    "requiredamount": 3500,
    "itisgenerateddebt": false,
    "busorder_id": null,
    "bustransaction_id": null,
    "flag": "",
    "division_id": "2100000101",
    "allowedmaxtorealize": 0,
    "busproject_id": null,
    "agreementdock": false,
    "targetbankcountry_id": null,
    "dockfromagreements": false,
    "validfromdate$date": "2005-12-31T23:00:00.000Z",
    "firstdeliverydate$date": null,
    "youngchilddock": false
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "docks", "take": "1"}
POST
https://atd.abra.eu/demodata/docks/query
{"take": "1"}
Response 
{
    "objversion": 4,
    "definition_id": "2100000101",
    "employee_id": "4200000101",
    "wageperiod_id": "R700000101",
    "docktype_id": "4000000000",
    "description": "Spoření externí",
    "basetype": 4,
    "internal": false,
    "debtcorrect": false,
    "ofminimum": false,
    "partial": true,
    "priority": 0,
    "printgroup": "S",
    "destination": "2019590302\/2600",
    "swiftcode": "",
    "execauthority": "",
    "execrefnumber": "",
    "execrecipient": "",
    "source_id": "2200000101",
    "varsymbol": "5434",
    "specsymbol": "",
    "constsymbol_id": "0000498000",
    "required": 3500,
    "ispercent": false,
    "realized": 3500,
    "percentofcode": 0,
    "createdby_id": "1200000101",
    "correctedby_id": "1200000101",
    "clsidforpercent": "00000000000000000000000000",
    "isdebt": false,
    "duedate$date": "2014-02-06T23:00:00.000Z",
    "requiredamount": 3500,
    "itisgenerateddebt": false,
    "busorder_id": null,
    "bustransaction_id": null,
    "flag": "",
    "division_id": "2100000101",
    "allowedmaxtorealize": 0,
    "busproject_id": null,
    "agreementdock": false,
    "targetbankcountry_id": null,
    "dockfromagreements": false,
    "validfromdate$date": "2005-12-31T23:00:00.000Z",
    "firstdeliverydate$date": null,
    "youngchilddock": false
}
Request 
POST
https://atd.abra.eu/demodata/docks?select=id
Body 
{
    "agreementdock": false,
    "allowedmaxtorealize": 0,
    "basetype": 4,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "clsidforpercent": "00000000000000000000000000",
    "constsymbol_id": "0000498000",
    "correctedby_id": "1200000101",
    "createdby_id": "1200000101",
    "debtcorrect": false,
    "definition_id": "2100000101",
    "description": "Spoření externí",
    "destination": "2019590302\/2600",
    "division_id": "2100000101",
    "dockfromagreements": false,
    "docktype_id": "4000000000",
    "duedate$date": "2014-02-06T23:00:00.000Z",
    "employee_id": "4200000101",
    "execauthority": "",
    "execrecipient": "",
    "execrefnumber": "",
    "firstdeliverydate$date": null,
    "flag": "",
    "internal": false,
    "isdebt": false,
    "ispercent": false,
    "itisgenerateddebt": false,
    "ofminimum": false,
    "partial": true,
    "percentofcode": 0,
    "printgroup": "S",
    "priority": 0,
    "realized": 3500,
    "required": 3500,
    "requiredamount": 3500,
    "source_id": "2200000101",
    "specsymbol": "",
    "swiftcode": "",
    "targetbankcountry_id": null,
    "validfromdate$date": "2005-12-31T23:00:00.000Z",
    "varsymbol": "5434",
    "wageperiod_id": "R700000101",
    "youngchilddock": false
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/docks/{id}?select=id
Body 
{
    "agreementdock": false,
    "allowedmaxtorealize": 0,
    "basetype": 4,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "clsidforpercent": "00000000000000000000000000",
    "constsymbol_id": "0000498000",
    "correctedby_id": "1200000101",
    "createdby_id": "1200000101",
    "debtcorrect": false,
    "definition_id": "2100000101",
    "description": "Spoření externí",
    "destination": "2019590302\/2600",
    "division_id": "2100000101",
    "dockfromagreements": false,
    "docktype_id": "4000000000",
    "duedate$date": "2014-02-06T23:00:00.000Z",
    "employee_id": "4200000101",
    "execauthority": "",
    "execrecipient": "",
    "execrefnumber": "",
    "firstdeliverydate$date": null,
    "flag": "",
    "internal": false,
    "isdebt": false,
    "ispercent": false,
    "itisgenerateddebt": false,
    "ofminimum": false,
    "partial": true,
    "percentofcode": 0,
    "printgroup": "S",
    "priority": 0,
    "realized": 3500,
    "required": 3500,
    "requiredamount": 3500,
    "source_id": "2200000101",
    "specsymbol": "",
    "swiftcode": "",
    "targetbankcountry_id": null,
    "validfromdate$date": "2005-12-31T23:00:00.000Z",
    "varsymbol": "5434",
    "wageperiod_id": "R700000101",
    "youngchilddock": false
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/docks/{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": "docks",
                "object_data": {
                    "agreementdock": false,
                    "allowedmaxtorealize": 0,
                    "basetype": 4,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "clsidforpercent": "00000000000000000000000000",
                    "constsymbol_id": "0000498000",
                    "correctedby_id": "1200000101",
                    "createdby_id": "1200000101",
                    "debtcorrect": false,
                    "definition_id": "2100000101",
                    "description": "Spoření externí",
                    "destination": "2019590302\/2600",
                    "division_id": "2100000101",
                    "dockfromagreements": false,
                    "docktype_id": "4000000000",
                    "duedate$date": "2014-02-06T23:00:00.000Z",
                    "employee_id": "4200000101",
                    "execauthority": "",
                    "execrecipient": "",
                    "execrefnumber": "",
                    "firstdeliverydate$date": null,
                    "flag": "",
                    "internal": false,
                    "isdebt": false,
                    "ispercent": false,
                    "itisgenerateddebt": false,
                    "ofminimum": false,
                    "partial": true,
                    "percentofcode": 0,
                    "printgroup": "S",
                    "priority": 0,
                    "realized": 3500,
                    "required": 3500,
                    "requiredamount": 3500,
                    "source_id": "2200000101",
                    "specsymbol": "",
                    "swiftcode": "",
                    "targetbankcountry_id": null,
                    "validfromdate$date": "2005-12-31T23:00:00.000Z",
                    "varsymbol": "5434",
                    "wageperiod_id": "R700000101",
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "docks",
                "object_data": {
                    "agreementdock": false,
                    "allowedmaxtorealize": 0,
                    "basetype": 4,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "clsidforpercent": "00000000000000000000000000",
                    "constsymbol_id": "0000498000",
                    "correctedby_id": "1200000101",
                    "createdby_id": "1200000101",
                    "debtcorrect": false,
                    "definition_id": "2100000101",
                    "description": "Spoření externí",
                    "destination": "2019590302\/2600",
                    "division_id": "2100000101",
                    "dockfromagreements": false,
                    "docktype_id": "4000000000",
                    "duedate$date": "2014-02-06T23:00:00.000Z",
                    "employee_id": "4200000101",
                    "execauthority": "",
                    "execrecipient": "",
                    "execrefnumber": "",
                    "firstdeliverydate$date": null,
                    "flag": "",
                    "internal": false,
                    "isdebt": false,
                    "ispercent": false,
                    "itisgenerateddebt": false,
                    "ofminimum": false,
                    "partial": true,
                    "percentofcode": 0,
                    "printgroup": "S",
                    "priority": 0,
                    "realized": 3500,
                    "required": 3500,
                    "requiredamount": 3500,
                    "source_id": "2200000101",
                    "specsymbol": "",
                    "swiftcode": "",
                    "targetbankcountry_id": null,
                    "validfromdate$date": "2005-12-31T23:00:00.000Z",
                    "varsymbol": "5434",
                    "wageperiod_id": "R700000101",
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "docks",
                "obj_id": "1600000100",
                "object_data": {
                    "agreementdock": false,
                    "allowedmaxtorealize": 0,
                    "basetype": 4,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "clsidforpercent": "00000000000000000000000000",
                    "constsymbol_id": "0000498000",
                    "correctedby_id": "1200000101",
                    "createdby_id": "1200000101",
                    "debtcorrect": false,
                    "definition_id": "2100000101",
                    "description": "Spoření externí",
                    "destination": "2019590302\/2600",
                    "division_id": "2100000101",
                    "dockfromagreements": false,
                    "docktype_id": "4000000000",
                    "duedate$date": "2014-02-06T23:00:00.000Z",
                    "employee_id": "4200000101",
                    "execauthority": "",
                    "execrecipient": "",
                    "execrefnumber": "",
                    "firstdeliverydate$date": null,
                    "flag": "",
                    "internal": false,
                    "isdebt": false,
                    "ispercent": false,
                    "itisgenerateddebt": false,
                    "ofminimum": false,
                    "partial": true,
                    "percentofcode": 0,
                    "printgroup": "S",
                    "priority": 0,
                    "realized": 3500,
                    "required": 3500,
                    "requiredamount": 3500,
                    "source_id": "2200000101",
                    "specsymbol": "",
                    "swiftcode": "",
                    "targetbankcountry_id": null,
                    "validfromdate$date": "2005-12-31T23:00:00.000Z",
                    "varsymbol": "5434",
                    "wageperiod_id": "R700000101",
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "docks",
                "obj_id": "1600000101",
                "object_data": {
                    "agreementdock": false,
                    "allowedmaxtorealize": 0,
                    "basetype": 4,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "clsidforpercent": "00000000000000000000000000",
                    "constsymbol_id": "0000498000",
                    "correctedby_id": "1200000101",
                    "createdby_id": "1200000101",
                    "debtcorrect": false,
                    "definition_id": "2100000101",
                    "description": "Spoření externí",
                    "destination": "2019590302\/2600",
                    "division_id": "2100000101",
                    "dockfromagreements": false,
                    "docktype_id": "4000000000",
                    "duedate$date": "2014-02-06T23:00:00.000Z",
                    "employee_id": "4200000101",
                    "execauthority": "",
                    "execrecipient": "",
                    "execrefnumber": "",
                    "firstdeliverydate$date": null,
                    "flag": "",
                    "internal": false,
                    "isdebt": false,
                    "ispercent": false,
                    "itisgenerateddebt": false,
                    "ofminimum": false,
                    "partial": true,
                    "percentofcode": 0,
                    "printgroup": "S",
                    "priority": 0,
                    "realized": 3500,
                    "required": 3500,
                    "requiredamount": 3500,
                    "source_id": "2200000101",
                    "specsymbol": "",
                    "swiftcode": "",
                    "targetbankcountry_id": null,
                    "validfromdate$date": "2005-12-31T23:00:00.000Z",
                    "varsymbol": "5434",
                    "wageperiod_id": "R700000101",
                    "youngchilddock": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "docks",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "docks",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "docks",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "docks",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "docks",
                "obj_id": "1600000104"
            }
        }
    ]
}