Platba

GET

/payments

Získá kolekci BO Platba

GET

/payments/meta/dataprotection

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

GET

/payments/views/{view}

Získá pohled nad BO Platba

GET

/payments/{id}

Získá daný BO Platba

GET

/payments/{id}/iseditlock

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

GET

/payments/{id}/meta/dataprotection

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

GET

/payments/{id}/userparameters

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

POST

/payments

Vytvoří nový BO Platba

POST

/payments/query

Vyhodnotí query dotaz nad BO Platba

PUT

/payments/{id}

Modifikuje daný BO Platba

PUT

/payments/{id}/editlock

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

PUT

/payments/{id}/editunlock

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

DELETE

/payments/{id}

Smaže BO Platba

Metadata - Perzistentní položky

amount number

Částka, 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ě

document_id string (datadocumentbusinessobject) relace

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

documenttype string (2)

Typ plateb.dokl., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, fkAnsiCaseSensitive

localamount number

Částka (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ě

localamounteet number

Částka (lok.), pole vlastněné tabulkou, možné řadit a filtrovat, pole obsahuje částku v lokální měně

localamountwithoutvateet number

Částka bez daně (lok.) využitá do tržby EET, pole vlastněné tabulkou, možné řadit a filtrovat, pole obsahuje částku v lokální měně

localtamount number

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

localtamountwithoutvat number

Bez daně lokálně, 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

pdocument_id string (datadocumentbusinessobject) relace

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

pdocumenttype string (2)

Typ plac.dokl., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, fkAnsiCaseSensitive

row_id string (rowbusinessobject) relace

Řádek plac.dokl., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

tamount number

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

tamountwithoutvat number

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

vatdate$date string

Datum odvodu/odpočtu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

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/payments?take=1
GET
https://atd.abra.eu/demodata/payments/{id}
Response 
{
    "objversion": 2,
    "document_id": "3000000101",
    "documenttype": "09",
    "amount": 6861.5,
    "pdocument_id": "1400000101",
    "pdocumenttype": "03",
    "row_id": "1300000101",
    "localamount": 6861.5,
    "vatdate$date": null,
    "tamountwithoutvat": 0,
    "localtamountwithoutvat": 0,
    "tamount": 0,
    "localtamount": 0,
    "localamountwithoutvateet": 0,
    "localamounteet": 0
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "payments", "take": "1"}
POST
https://atd.abra.eu/demodata/payments/query
{"take": "1"}
Response 
{
    "objversion": 2,
    "document_id": "3000000101",
    "documenttype": "09",
    "amount": 6861.5,
    "pdocument_id": "1400000101",
    "pdocumenttype": "03",
    "row_id": "1300000101",
    "localamount": 6861.5,
    "vatdate$date": null,
    "tamountwithoutvat": 0,
    "localtamountwithoutvat": 0,
    "tamount": 0,
    "localtamount": 0,
    "localamountwithoutvateet": 0,
    "localamounteet": 0
}
Request 
POST
https://atd.abra.eu/demodata/payments?select=id
Body 
{
    "amount": 6861.5,
    "document_id": "3000000101",
    "documenttype": "09",
    "localamount": 6861.5,
    "localamounteet": 0,
    "localamountwithoutvateet": 0,
    "localtamount": 0,
    "localtamountwithoutvat": 0,
    "pdocument_id": "1400000101",
    "pdocumenttype": "03",
    "row_id": "1300000101",
    "tamount": 0,
    "tamountwithoutvat": 0,
    "vatdate$date": null
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/payments/{id}?select=id
Body 
{
    "amount": 6861.5,
    "document_id": "3000000101",
    "documenttype": "09",
    "localamount": 6861.5,
    "localamounteet": 0,
    "localamountwithoutvateet": 0,
    "localtamount": 0,
    "localtamountwithoutvat": 0,
    "pdocument_id": "1400000101",
    "pdocumenttype": "03",
    "row_id": "1300000101",
    "tamount": 0,
    "tamountwithoutvat": 0,
    "vatdate$date": null
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/payments/{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": "payments",
                "object_data": {
                    "amount": 6861.5,
                    "document_id": "3000000101",
                    "documenttype": "09",
                    "localamount": 6861.5,
                    "localamounteet": 0,
                    "localamountwithoutvateet": 0,
                    "localtamount": 0,
                    "localtamountwithoutvat": 0,
                    "pdocument_id": "1400000101",
                    "pdocumenttype": "03",
                    "row_id": "1300000101",
                    "tamount": 0,
                    "tamountwithoutvat": 0,
                    "vatdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "payments",
                "object_data": {
                    "amount": 6861.5,
                    "document_id": "3000000101",
                    "documenttype": "09",
                    "localamount": 6861.5,
                    "localamounteet": 0,
                    "localamountwithoutvateet": 0,
                    "localtamount": 0,
                    "localtamountwithoutvat": 0,
                    "pdocument_id": "1400000101",
                    "pdocumenttype": "03",
                    "row_id": "1300000101",
                    "tamount": 0,
                    "tamountwithoutvat": 0,
                    "vatdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "payments",
                "obj_id": "1600000100",
                "object_data": {
                    "amount": 6861.5,
                    "document_id": "3000000101",
                    "documenttype": "09",
                    "localamount": 6861.5,
                    "localamounteet": 0,
                    "localamountwithoutvateet": 0,
                    "localtamount": 0,
                    "localtamountwithoutvat": 0,
                    "pdocument_id": "1400000101",
                    "pdocumenttype": "03",
                    "row_id": "1300000101",
                    "tamount": 0,
                    "tamountwithoutvat": 0,
                    "vatdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "payments",
                "obj_id": "1600000101",
                "object_data": {
                    "amount": 6861.5,
                    "document_id": "3000000101",
                    "documenttype": "09",
                    "localamount": 6861.5,
                    "localamounteet": 0,
                    "localamountwithoutvateet": 0,
                    "localtamount": 0,
                    "localtamountwithoutvat": 0,
                    "pdocument_id": "1400000101",
                    "pdocumenttype": "03",
                    "row_id": "1300000101",
                    "tamount": 0,
                    "tamountwithoutvat": 0,
                    "vatdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "payments",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "payments",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "payments",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "payments",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "payments",
                "obj_id": "1600000104"
            }
        }
    ]
}