Parametry automatických upomínek

GET

/payreminderpars

Získá kolekci BO Parametry automatických upomínek

GET

/payreminderpars/{id}

Získá konkrétní BO Parametry automatických upomínek

POST

/payreminderpars

Vytvoří nový BO Parametry automatických upomínek a vrátí jeho kompletní reprezentaci

PUT

/payreminderpars/{id}

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

DELETE

/payreminderpars/{id}

Smaže BO Parametry automatických upomínek na základě jeho ID

Metadata - Perzistentní položky

Code string (10)

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

EmailAccount_ID string (emailaccount) relace

E-mail; ID objektu E-mailový účet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

GenerateRemindersWithoutEmail boolean

Generovat i upomínky s nevyplněným e-mailem, 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

InvoiceReports array (payreminderparinvoicereport) relace

Kolekce reportů faktur vydaných; kolekce BO Parametry automatických upomínek - reporty faktur vydaných, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

MinAmount number

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

Name string (50)

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

NumOfDaysRemand integer

Povolený odklad, 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

ReminderExclusionExpr string (0)

Výraz pro vyloučení z upomínek, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Rows array (payreminderparrow) relace

Řádky; kolekce BO Parametry automatických upomínek - upomínky, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

Metadata - Neperzistentní položky

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/payreminderpars?take=1

GET

https://atd.abra.eu/demodata/payreminderpars/{id}
Response
{
    "Code": null,
    "EmailAccount_ID": null,
    "GenerateRemindersWithoutEmail": null,
    "Hidden": null,
    "ID": null,
    "InvoiceReports": null,
    "MinAmount": null,
    "Name": null,
    "NumOfDaysRemand": null,
    "ObjVersion": null,
    "ReminderExclusionExpr": null,
    "Rows": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/payreminderpars/query
{"take": "1"}
Response
{
    "Code": null,
    "EmailAccount_ID": null,
    "GenerateRemindersWithoutEmail": null,
    "Hidden": null,
    "ID": null,
    "InvoiceReports": null,
    "MinAmount": null,
    "Name": null,
    "NumOfDaysRemand": null,
    "ObjVersion": null,
    "ReminderExclusionExpr": null,
    "Rows": null
}
Request

POST

https://atd.abra.eu/demodata/payreminderpars?select=id
Body
{
    "Code": null,
    "EmailAccount_ID": null,
    "GenerateRemindersWithoutEmail": null,
    "Hidden": null,
    "InvoiceReports": null,
    "MinAmount": null,
    "Name": null,
    "NumOfDaysRemand": null,
    "ReminderExclusionExpr": null,
    "Rows": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/payreminderpars/{id}?select=id
Body
{
    "Code": null,
    "EmailAccount_ID": null,
    "GenerateRemindersWithoutEmail": null,
    "Hidden": null,
    "InvoiceReports": null,
    "MinAmount": null,
    "Name": null,
    "NumOfDaysRemand": null,
    "ReminderExclusionExpr": null,
    "Rows": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/payreminderpars/{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": "payreminderpars",
                "object_data": {
                    "Code": null,
                    "EmailAccount_ID": null,
                    "GenerateRemindersWithoutEmail": null,
                    "Hidden": null,
                    "InvoiceReports": null,
                    "MinAmount": null,
                    "Name": null,
                    "NumOfDaysRemand": null,
                    "ReminderExclusionExpr": null,
                    "Rows": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "payreminderpars",
                "object_data": {
                    "Code": null,
                    "EmailAccount_ID": null,
                    "GenerateRemindersWithoutEmail": null,
                    "Hidden": null,
                    "InvoiceReports": null,
                    "MinAmount": null,
                    "Name": null,
                    "NumOfDaysRemand": null,
                    "ReminderExclusionExpr": null,
                    "Rows": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "payreminderpars",
                "obj_id": "1600000100",
                "object_data": {
                    "Code": null,
                    "EmailAccount_ID": null,
                    "GenerateRemindersWithoutEmail": null,
                    "Hidden": null,
                    "InvoiceReports": null,
                    "MinAmount": null,
                    "Name": null,
                    "NumOfDaysRemand": null,
                    "ReminderExclusionExpr": null,
                    "Rows": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "payreminderpars",
                "obj_id": "1600000101",
                "object_data": {
                    "Code": null,
                    "EmailAccount_ID": null,
                    "GenerateRemindersWithoutEmail": null,
                    "Hidden": null,
                    "InvoiceReports": null,
                    "MinAmount": null,
                    "Name": null,
                    "NumOfDaysRemand": null,
                    "ReminderExclusionExpr": null,
                    "Rows": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "payreminderpars",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "payreminderpars",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "payreminderpars",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "payreminderpars",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "payreminderpars",
                "obj_id": "1600000104"
            }
        }
    ]
}