Platba

GET

/payments

Získá kolekci BO Platba

GET

/payments/{id}

Získá konkrétní BO Platba

POST

/payments

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

PUT

/payments/{id}

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

DELETE

/payments/{id}

Smaže BO Platba na základě jeho ID

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ě

DocumentType string (documenttype) relace

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

Document_ID string (datadocumentbusinessobject) relace

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

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

PDocumentType string (documenttype) relace

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

PDocument_ID string (datadocumentbusinessobject) relace

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

Row_ID string (rowbusinessobject) relace

Řádek plac.dokl.; ID objektu Řádek, 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
{
    "ID": "1000000101",
    "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
{
    "ID": "1000000101",
    "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,
    "DocumentType": "09",
    "Document_ID": "3000000101",
    "LocalAmount": 6861.5,
    "LocalAmountEET": 0,
    "LocalAmountWithoutVATEET": 0,
    "LocalTAmount": 0,
    "LocalTAmountWithoutVAT": 0,
    "PDocumentType": "03",
    "PDocument_ID": "1400000101",
    "Row_ID": "1300000101",
    "TAmount": 0,
    "TAmountWithoutVAT": 0,
    "VATDate$DATE": null
}
Response
{
    "id": "1000000101"
}
Request

PUT

https://atd.abra.eu/demodata/payments/{id}?select=id
Body
{
    "Amount": 6861.5,
    "DocumentType": "09",
    "Document_ID": "3000000101",
    "LocalAmount": 6861.5,
    "LocalAmountEET": 0,
    "LocalAmountWithoutVATEET": 0,
    "LocalTAmount": 0,
    "LocalTAmountWithoutVAT": 0,
    "PDocumentType": "03",
    "PDocument_ID": "1400000101",
    "Row_ID": "1300000101",
    "TAmount": 0,
    "TAmountWithoutVAT": 0,
    "VATDate$DATE": null
}
Response
{
    "id": "1000000101"
}

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,
                    "DocumentType": "09",
                    "Document_ID": "3000000101",
                    "LocalAmount": 6861.5,
                    "LocalAmountEET": 0,
                    "LocalAmountWithoutVATEET": 0,
                    "LocalTAmount": 0,
                    "LocalTAmountWithoutVAT": 0,
                    "PDocumentType": "03",
                    "PDocument_ID": "1400000101",
                    "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,
                    "DocumentType": "09",
                    "Document_ID": "3000000101",
                    "LocalAmount": 6861.5,
                    "LocalAmountEET": 0,
                    "LocalAmountWithoutVATEET": 0,
                    "LocalTAmount": 0,
                    "LocalTAmountWithoutVAT": 0,
                    "PDocumentType": "03",
                    "PDocument_ID": "1400000101",
                    "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": "1000000100",
                "object_data": {
                    "Amount": 6861.5,
                    "DocumentType": "09",
                    "Document_ID": "3000000101",
                    "LocalAmount": 6861.5,
                    "LocalAmountEET": 0,
                    "LocalAmountWithoutVATEET": 0,
                    "LocalTAmount": 0,
                    "LocalTAmountWithoutVAT": 0,
                    "PDocumentType": "03",
                    "PDocument_ID": "1400000101",
                    "Row_ID": "1300000101",
                    "TAmount": 0,
                    "TAmountWithoutVAT": 0,
                    "VATDate$DATE": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "payments",
                "obj_id": "1000000101",
                "object_data": {
                    "Amount": 6861.5,
                    "DocumentType": "09",
                    "Document_ID": "3000000101",
                    "LocalAmount": 6861.5,
                    "LocalAmountEET": 0,
                    "LocalAmountWithoutVATEET": 0,
                    "LocalTAmount": 0,
                    "LocalTAmountWithoutVAT": 0,
                    "PDocumentType": "03",
                    "PDocument_ID": "1400000101",
                    "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": "1000000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "payments",
                "obj_id": "1000000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "payments",
                "obj_id": "1000000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "payments",
                "obj_id": "1000000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "payments",
                "obj_id": "1000000104"
            }
        }
    ]
}