Upomínka

GET

/paymentreminders

Získá kolekci BO Upomínka

GET

/paymentreminders/{id}

Získá konkrétní BO Upomínka

POST

/paymentreminders

Vytvoří nový BO Upomínka a vrátí jeho kompletní reprezentaci

PUT

/paymentreminders/{id}

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

DELETE

/paymentreminders/{id}

Smaže BO Upomínka na základě jeho ID

Metadata - Perzistentní položky

Address_ID string (address) relace

Vlastní adresa; ID objektu 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; ID objektu Uživatel, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

Country_ID string (country) relace

Země; ID objektu 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; ID objektu Uživatel, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

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

Currency_ID string (currency) relace

Měna; ID objektu 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

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; ID objektu Řada dokladů, 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; ID objektu Odeslaný e-mail, pole vlastněné tabulkou, možné řadit a filtrovat

FirmOffice_ID string (firmoffice) relace

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

Firm_ID string (firm) relace

Firma; ID objektu Firma, 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; ID objektu Faktura vydaná, 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; ID objektu 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

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í; ID objektu 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; ID objektu 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

Řádky; 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; ID objektu 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

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; ID objektu Sankční faktura

LocalRefCurrency_ID string (currency) relace

Lok.ref.měna; ID objektu 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; ID objektu 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,
    "CurrRate": null,
    "Currency_ID": null,
    "Description": null,
    "DocDate$DATE": null,
    "DocOrder": null,
    "DocQueue_ID": null,
    "EmailSent_ID": null,
    "FirmOffice_ID": null,
    "Firm_ID": null,
    "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,
    "CurrRate": null,
    "Currency_ID": null,
    "Description": null,
    "DocDate$DATE": null,
    "DocOrder": null,
    "DocQueue_ID": null,
    "EmailSent_ID": null,
    "FirmOffice_ID": null,
    "Firm_ID": null,
    "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,
    "CurrRate": null,
    "Currency_ID": null,
    "Description": null,
    "DocDate$DATE": null,
    "DocOrder": null,
    "DocQueue_ID": null,
    "EmailSent_ID": null,
    "FirmOffice_ID": null,
    "Firm_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,
    "CurrRate": null,
    "Currency_ID": null,
    "Description": null,
    "DocDate$DATE": null,
    "DocOrder": null,
    "DocQueue_ID": null,
    "EmailSent_ID": null,
    "FirmOffice_ID": null,
    "Firm_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,
                    "CurrRate": null,
                    "Currency_ID": null,
                    "Description": null,
                    "DocDate$DATE": null,
                    "DocOrder": null,
                    "DocQueue_ID": null,
                    "EmailSent_ID": null,
                    "FirmOffice_ID": null,
                    "Firm_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,
                    "CurrRate": null,
                    "Currency_ID": null,
                    "Description": null,
                    "DocDate$DATE": null,
                    "DocOrder": null,
                    "DocQueue_ID": null,
                    "EmailSent_ID": null,
                    "FirmOffice_ID": null,
                    "Firm_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,
                    "CurrRate": null,
                    "Currency_ID": null,
                    "Description": null,
                    "DocDate$DATE": null,
                    "DocOrder": null,
                    "DocQueue_ID": null,
                    "EmailSent_ID": null,
                    "FirmOffice_ID": null,
                    "Firm_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,
                    "CurrRate": null,
                    "Currency_ID": null,
                    "Description": null,
                    "DocDate$DATE": null,
                    "DocOrder": null,
                    "DocQueue_ID": null,
                    "EmailSent_ID": null,
                    "FirmOffice_ID": null,
                    "Firm_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"
            }
        }
    ]
}