Upomínka

GET

/paymentreminders

Získá kolekci BO Upomínka

GET

/paymentreminders/meta/dataprotection

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

GET

/paymentreminders/views/{view}

Získá pohled nad BO Upomínka

GET

/paymentreminders/{id}

Získá daný BO Upomínka

GET

/paymentreminders/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Upomínka

GET

/paymentreminders/{id}/meta/dataprotection

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

GET

/paymentreminders/{id}/rows

Získá řádky kolekce Upomínka - řádek

GET

/paymentreminders/{id}/rows/{id1}

Získá daný řádek kolekce Upomínka - řádek

GET

/paymentreminders/{id}/userparameters

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

POST

/paymentreminders

Vytvoří nový BO Upomínka

POST

/paymentreminders/query

Vyhodnotí query dotaz nad BO Upomínka

POST

/paymentreminders/{id}/rows

Vytvoří nový řádek v kolekci Upomínka - řádek

PUT

/paymentreminders/{id}

Modifikuje daný BO Upomínka

PUT

/paymentreminders/{id}/editlock

Vytvoří editační zámek na daném BO Upomínka

PUT

/paymentreminders/{id}/editunlock

Zruší editační zámek na daném BO Upomínka

PUT

/paymentreminders/{id}/rows/{id1}

Modifikuje řádek v kolekci Upomínka - řádek

DELETE

/paymentreminders/{id}

Smaže BO Upomínka

DELETE

/paymentreminders/{id}/rows/{id1}

Smaže řádek z kolekce Upomínka - řádek

Metadata - Perzistentní položky

address_id string (address) relace

Vlastní adresa, pole vlastněné tabulkou, možné řadit a filtrovat

amount number

Celkem, pole vlastněné tabulkou, možné řadit a filtrovat, pole obsahuje částku v libovolné měně

coef integer

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

correctedat$date string

Opraveno, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

correctedby_id string (securityuser) relace

Opravil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

country_id string (country) relace

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

createdat$date string

Vytvořeno, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

createdby_id string (securityuser) relace

Vytvořil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

currency_id string (currency) relace

Měna, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje odkaz na měnu

currrate number

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

description string (50)

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

docdate$date string

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

docorder integer

Pořadové číslo dokl. k fak., pole vlastněné tabulkou, možné řadit a filtrovat

docqueue_id string (docqueue) relace

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

emailsent_id string (emailsent) relace

Odeslaný e-mail, pole vlastněné tabulkou, možné řadit a filtrovat

firm_id string (firm) relace

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

firmoffice_id string (firmoffice) relace

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

ispenaltyfromratetable boolean

Úrok z prodlení na řádku, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

issuedinvoice_id string (issuedinvoice) relace

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

localamount number

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

localcoef integer

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

localroundingamount number

Hal.vyr.lok., 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ě

localzone_id string (currency) relace

Lokální zóna, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje odkaz na měnu

objversion integer

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

ordnumber integer

Pořadové číslo, pole vlastněné tabulkou, možné řadit a filtrovat

penaltypercent number

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

period_id string (period) relace

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

person_id string (person) relace

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

refcurrrate number

Kurz vztažný, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole vztažný kurz měny

roundingamount number

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

rows array (paymentreminderrow) relace

kolekce BO Upomínka - řádek, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

sendingstatus boolean

Odesláno, pole vlastněné tabulkou, možné řadit a filtrovat

totalrounding integer

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

zone_id string (currency) relace

Zóna, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje odkaz na měnu

Metadata - Neperzistentní položky

accountingtype integer

Jak účtovat

calculating boolean

Probíhá přepočet

classid string (26)

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

currrateinfo string (30)

Kurz měny textově, pouze pro čtení

dirty boolean

Zakázané přepočítání

displayname string (24)

Číslo dok., pouze pro čtení

id string (10)

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

isaccounted boolean

Účtováno, pouze pro čtení

lastpenaltyinvoice string (penaltyinvoice) relace

Poslední sankční faktura

localrefcurrency_id string (currency) relace

Lok.ref.měna, pouze pro čtení, pole obsahuje odkaz na měnu

newrelateddocument_id string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

newrelatedtype integer

Typ relace

refcurrency_id string (currency) relace

Ref.měna, pouze pro čtení, pole obsahuje odkaz na měnu

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/paymentreminders?take=1
GET
https://atd.abra.eu/demodata/paymentreminders/{id}
Response 
{
    "address_id": null,
    "amount": null,
    "coef": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "country_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "currency_id": null,
    "currrate": null,
    "description": null,
    "docdate$date": null,
    "docorder": null,
    "docqueue_id": null,
    "emailsent_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "ispenaltyfromratetable": null,
    "issuedinvoice_id": null,
    "localamount": null,
    "localcoef": null,
    "localroundingamount": null,
    "localzone_id": null,
    "objversion": null,
    "ordnumber": null,
    "penaltypercent": null,
    "period_id": null,
    "person_id": null,
    "refcurrrate": null,
    "roundingamount": null,
    "rows": null,
    "sendingstatus": null,
    "totalrounding": null,
    "zone_id": null
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "paymentreminders", "take": "1"}
POST
https://atd.abra.eu/demodata/paymentreminders/query
{"take": "1"}
Response 
{
    "address_id": null,
    "amount": null,
    "coef": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "country_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "currency_id": null,
    "currrate": null,
    "description": null,
    "docdate$date": null,
    "docorder": null,
    "docqueue_id": null,
    "emailsent_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "ispenaltyfromratetable": null,
    "issuedinvoice_id": null,
    "localamount": null,
    "localcoef": null,
    "localroundingamount": null,
    "localzone_id": null,
    "objversion": null,
    "ordnumber": null,
    "penaltypercent": null,
    "period_id": null,
    "person_id": null,
    "refcurrrate": null,
    "roundingamount": null,
    "rows": null,
    "sendingstatus": null,
    "totalrounding": null,
    "zone_id": null
}
Request 
POST
https://atd.abra.eu/demodata/paymentreminders?select=id
Body 
{
    "address_id": null,
    "amount": null,
    "coef": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "country_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "currency_id": null,
    "currrate": null,
    "description": null,
    "docdate$date": null,
    "docorder": null,
    "docqueue_id": null,
    "emailsent_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "ispenaltyfromratetable": null,
    "issuedinvoice_id": null,
    "localamount": null,
    "localcoef": null,
    "localroundingamount": null,
    "localzone_id": null,
    "ordnumber": null,
    "penaltypercent": null,
    "period_id": null,
    "person_id": null,
    "refcurrrate": null,
    "roundingamount": null,
    "rows": null,
    "sendingstatus": null,
    "totalrounding": null,
    "zone_id": null
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/paymentreminders/{id}?select=id
Body 
{
    "address_id": null,
    "amount": null,
    "coef": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "country_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "currency_id": null,
    "currrate": null,
    "description": null,
    "docdate$date": null,
    "docorder": null,
    "docqueue_id": null,
    "emailsent_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "ispenaltyfromratetable": null,
    "issuedinvoice_id": null,
    "localamount": null,
    "localcoef": null,
    "localroundingamount": null,
    "localzone_id": null,
    "ordnumber": null,
    "penaltypercent": null,
    "period_id": null,
    "person_id": null,
    "refcurrrate": null,
    "roundingamount": null,
    "rows": null,
    "sendingstatus": null,
    "totalrounding": null,
    "zone_id": null
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/paymentreminders/{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": "paymentreminders",
                "object_data": {
                    "address_id": null,
                    "amount": null,
                    "coef": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "country_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "currency_id": null,
                    "currrate": null,
                    "description": null,
                    "docdate$date": null,
                    "docorder": null,
                    "docqueue_id": null,
                    "emailsent_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ispenaltyfromratetable": null,
                    "issuedinvoice_id": null,
                    "localamount": null,
                    "localcoef": null,
                    "localroundingamount": null,
                    "localzone_id": null,
                    "ordnumber": null,
                    "penaltypercent": null,
                    "period_id": null,
                    "person_id": null,
                    "refcurrrate": null,
                    "roundingamount": null,
                    "rows": null,
                    "sendingstatus": null,
                    "totalrounding": null,
                    "zone_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "paymentreminders",
                "object_data": {
                    "address_id": null,
                    "amount": null,
                    "coef": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "country_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "currency_id": null,
                    "currrate": null,
                    "description": null,
                    "docdate$date": null,
                    "docorder": null,
                    "docqueue_id": null,
                    "emailsent_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ispenaltyfromratetable": null,
                    "issuedinvoice_id": null,
                    "localamount": null,
                    "localcoef": null,
                    "localroundingamount": null,
                    "localzone_id": null,
                    "ordnumber": null,
                    "penaltypercent": null,
                    "period_id": null,
                    "person_id": null,
                    "refcurrrate": null,
                    "roundingamount": null,
                    "rows": null,
                    "sendingstatus": null,
                    "totalrounding": null,
                    "zone_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "paymentreminders",
                "obj_id": "1600000100",
                "object_data": {
                    "address_id": null,
                    "amount": null,
                    "coef": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "country_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "currency_id": null,
                    "currrate": null,
                    "description": null,
                    "docdate$date": null,
                    "docorder": null,
                    "docqueue_id": null,
                    "emailsent_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ispenaltyfromratetable": null,
                    "issuedinvoice_id": null,
                    "localamount": null,
                    "localcoef": null,
                    "localroundingamount": null,
                    "localzone_id": null,
                    "ordnumber": null,
                    "penaltypercent": null,
                    "period_id": null,
                    "person_id": null,
                    "refcurrrate": null,
                    "roundingamount": null,
                    "rows": null,
                    "sendingstatus": null,
                    "totalrounding": null,
                    "zone_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "paymentreminders",
                "obj_id": "1600000101",
                "object_data": {
                    "address_id": null,
                    "amount": null,
                    "coef": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "country_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "currency_id": null,
                    "currrate": null,
                    "description": null,
                    "docdate$date": null,
                    "docorder": null,
                    "docqueue_id": null,
                    "emailsent_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ispenaltyfromratetable": null,
                    "issuedinvoice_id": null,
                    "localamount": null,
                    "localcoef": null,
                    "localroundingamount": null,
                    "localzone_id": null,
                    "ordnumber": null,
                    "penaltypercent": null,
                    "period_id": null,
                    "person_id": null,
                    "refcurrrate": null,
                    "roundingamount": null,
                    "rows": null,
                    "sendingstatus": null,
                    "totalrounding": null,
                    "zone_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "paymentreminders",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "paymentreminders",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "paymentreminders",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "paymentreminders",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "paymentreminders",
                "obj_id": "1600000104"
            }
        }
    ]
}