Druh srážky

GET

/docktypes

Získá kolekci BO Druh srážky

GET

/docktypes/{id}

Získá konkrétní BO Druh srážky

POST

/docktypes

Vytvoří nový BO Druh srážky a vrátí jeho kompletní reprezentaci

PUT

/docktypes/{id}

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

DELETE

/docktypes/{id}

Smaže BO Druh srážky na základě jeho ID

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

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 
{
    "ID": "1000000000",
    "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
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "docktypes", "take": "1"}
POST
https://atd.abra.eu/demodata/docktypes/query
{"take": "1"}
Response 
{
    "ID": "1000000000",
    "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
}
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
}
Response 
{
    "id": "1000000000"
}
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
}
Response 
{
    "id": "1000000000"
}
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
                },
                "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
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1000000000",
                "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
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1000000001",
                "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
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1000000000"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1000000001"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1000000002"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1000000003"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "docktypes",
                "obj_id": "1000000004"
            }
        }
    ]
}