Srážka

GET

/docks

Získá kolekci BO Srážka

GET

/docks/{id}

Získá konkrétní BO Srážka

POST

/docks

Vytvoří nový BO Srážka a vrátí jeho kompletní reprezentaci

PUT

/docks/{id}

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

DELETE

/docks/{id}

Smaže BO Srážka na základě jeho ID

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; ID objektu Zakázka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

BusProject_ID string (busproject) relace

Projekt; ID objektu 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; ID objektu Obchodní případ, 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; ID objektu Konstantní 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; ID objektu Uživatel, 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; ID objektu Uživatel, 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; ID objektu Opakovaná srážka, 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; ID objektu 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; ID objektu 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; ID objektu 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 (0)

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ě

SWIFTCode string (20)

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

Source_ID string (bankaccount) relace

Zdrojový účet; ID objektu Bankovní úč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

TargetBankCountry_ID string (country) relace

Země banky; ID objektu Země, 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í; ID objektu Mzdové období, 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í

PDocumentDisplayName string (100)

Platební doklad

Paid boolean

Zaplacená

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
{
    "ID": "1400000101",
    "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
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/docks/query
{"take": "1"}
Response
{
    "ID": "1400000101",
    "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
}
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,
    "SWIFTCode": "",
    "Source_ID": "2200000101",
    "SpecSymbol": "",
    "TargetBankCountry_ID": null,
    "ValidFromDate$DATE": "2005-12-31T23:00:00.000Z",
    "VarSymbol": "5434",
    "WagePeriod_ID": "R700000101"
}
Response
{
    "id": "1400000101"
}
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,
    "SWIFTCode": "",
    "Source_ID": "2200000101",
    "SpecSymbol": "",
    "TargetBankCountry_ID": null,
    "ValidFromDate$DATE": "2005-12-31T23:00:00.000Z",
    "VarSymbol": "5434",
    "WagePeriod_ID": "R700000101"
}
Response
{
    "id": "1400000101"
}

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,
                    "SWIFTCode": "",
                    "Source_ID": "2200000101",
                    "SpecSymbol": "",
                    "TargetBankCountry_ID": null,
                    "ValidFromDate$DATE": "2005-12-31T23:00:00.000Z",
                    "VarSymbol": "5434",
                    "WagePeriod_ID": "R700000101"
                },
                "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,
                    "SWIFTCode": "",
                    "Source_ID": "2200000101",
                    "SpecSymbol": "",
                    "TargetBankCountry_ID": null,
                    "ValidFromDate$DATE": "2005-12-31T23:00:00.000Z",
                    "VarSymbol": "5434",
                    "WagePeriod_ID": "R700000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "docks",
                "obj_id": "1400000100",
                "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,
                    "SWIFTCode": "",
                    "Source_ID": "2200000101",
                    "SpecSymbol": "",
                    "TargetBankCountry_ID": null,
                    "ValidFromDate$DATE": "2005-12-31T23:00:00.000Z",
                    "VarSymbol": "5434",
                    "WagePeriod_ID": "R700000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "docks",
                "obj_id": "1400000101",
                "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,
                    "SWIFTCode": "",
                    "Source_ID": "2200000101",
                    "SpecSymbol": "",
                    "TargetBankCountry_ID": null,
                    "ValidFromDate$DATE": "2005-12-31T23:00:00.000Z",
                    "VarSymbol": "5434",
                    "WagePeriod_ID": "R700000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "docks",
                "obj_id": "1400000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "docks",
                "obj_id": "1400000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "docks",
                "obj_id": "1400000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "docks",
                "obj_id": "1400000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "docks",
                "obj_id": "1400000104"
            }
        }
    ]
}