Způsob úhrady

GET

/paymenttypes

Získá kolekci BO Způsob úhrady

GET

/paymenttypes/{id}

Získá konkrétní BO Způsob úhrady

POST

/paymenttypes

Vytvoří nový BO Způsob úhrady a vrátí jeho kompletní reprezentaci

PUT

/paymenttypes/{id}

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

DELETE

/paymenttypes/{id}

Smaže BO Způsob úhrady na základě jeho ID

Metadata - Perzistentní položky

AnalyticalAccount string (10)

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

AuthCodeRequired boolean

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

Code string (2)

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

CommentRequired boolean

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

CommentTitle string (50)

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

EET boolean

EET, 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, pole nepodporuje ochranu dat/GDPR

MaximumGiveBackAmount number

Max.vracená částka, 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ě

MaximumPaymentAmount number

Maximální částka platby, 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ě

Name string (30)

Název, 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

PaymentKind integer

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

PrintComment boolean

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

SummarizeDisabled boolean

Nesčítat, 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/paymenttypes?take=1
GET
https://atd.abra.eu/demodata/paymenttypes/{id}
Response 
{
    "ID": "1000000101",
    "ObjVersion": 2,
    "Hidden": false,
    "Code": "U1",
    "Name": "Na bankovní účet",
    "PaymentKind": 0,
    "CommentTitle": "",
    "CommentRequired": false,
    "AuthCodeRequired": false,
    "SummarizeDisabled": false,
    "PrintComment": false,
    "MaximumGiveBackAmount": 0,
    "AnalyticalAccount": "",
    "MaximumPaymentAmount": 0,
    "EET": false
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "paymenttypes", "take": "1"}
POST
https://atd.abra.eu/demodata/paymenttypes/query
{"take": "1"}
Response 
{
    "ID": "1000000101",
    "ObjVersion": 2,
    "Hidden": false,
    "Code": "U1",
    "Name": "Na bankovní účet",
    "PaymentKind": 0,
    "CommentTitle": "",
    "CommentRequired": false,
    "AuthCodeRequired": false,
    "SummarizeDisabled": false,
    "PrintComment": false,
    "MaximumGiveBackAmount": 0,
    "AnalyticalAccount": "",
    "MaximumPaymentAmount": 0,
    "EET": false
}
Request 
POST
https://atd.abra.eu/demodata/paymenttypes?select=id
Body 
{
    "AnalyticalAccount": "",
    "AuthCodeRequired": false,
    "Code": "U1",
    "CommentRequired": false,
    "CommentTitle": "",
    "EET": false,
    "Hidden": false,
    "MaximumGiveBackAmount": 0,
    "MaximumPaymentAmount": 0,
    "Name": "Na bankovní účet",
    "PaymentKind": 0,
    "PrintComment": false,
    "SummarizeDisabled": false
}
Response 
{
    "id": "1000000101"
}
Request 
PUT
https://atd.abra.eu/demodata/paymenttypes/{id}?select=id
Body 
{
    "AnalyticalAccount": "",
    "AuthCodeRequired": false,
    "Code": "U1",
    "CommentRequired": false,
    "CommentTitle": "",
    "EET": false,
    "Hidden": false,
    "MaximumGiveBackAmount": 0,
    "MaximumPaymentAmount": 0,
    "Name": "Na bankovní účet",
    "PaymentKind": 0,
    "PrintComment": false,
    "SummarizeDisabled": false
}
Response 
{
    "id": "1000000101"
}
DELETE
https://atd.abra.eu/demodata/paymenttypes/{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": "paymenttypes",
                "object_data": {
                    "AnalyticalAccount": "",
                    "AuthCodeRequired": false,
                    "Code": "U1",
                    "CommentRequired": false,
                    "CommentTitle": "",
                    "EET": false,
                    "Hidden": false,
                    "MaximumGiveBackAmount": 0,
                    "MaximumPaymentAmount": 0,
                    "Name": "Na bankovní účet",
                    "PaymentKind": 0,
                    "PrintComment": false,
                    "SummarizeDisabled": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "paymenttypes",
                "object_data": {
                    "AnalyticalAccount": "",
                    "AuthCodeRequired": false,
                    "Code": "U1",
                    "CommentRequired": false,
                    "CommentTitle": "",
                    "EET": false,
                    "Hidden": false,
                    "MaximumGiveBackAmount": 0,
                    "MaximumPaymentAmount": 0,
                    "Name": "Na bankovní účet",
                    "PaymentKind": 0,
                    "PrintComment": false,
                    "SummarizeDisabled": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "paymenttypes",
                "obj_id": "1000000100",
                "object_data": {
                    "AnalyticalAccount": "",
                    "AuthCodeRequired": false,
                    "Code": "U1",
                    "CommentRequired": false,
                    "CommentTitle": "",
                    "EET": false,
                    "Hidden": false,
                    "MaximumGiveBackAmount": 0,
                    "MaximumPaymentAmount": 0,
                    "Name": "Na bankovní účet",
                    "PaymentKind": 0,
                    "PrintComment": false,
                    "SummarizeDisabled": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "paymenttypes",
                "obj_id": "1000000101",
                "object_data": {
                    "AnalyticalAccount": "",
                    "AuthCodeRequired": false,
                    "Code": "U1",
                    "CommentRequired": false,
                    "CommentTitle": "",
                    "EET": false,
                    "Hidden": false,
                    "MaximumGiveBackAmount": 0,
                    "MaximumPaymentAmount": 0,
                    "Name": "Na bankovní účet",
                    "PaymentKind": 0,
                    "PrintComment": false,
                    "SummarizeDisabled": false
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "paymenttypes",
                "obj_id": "1000000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "paymenttypes",
                "obj_id": "1000000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "paymenttypes",
                "obj_id": "1000000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "paymenttypes",
                "obj_id": "1000000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "paymenttypes",
                "obj_id": "1000000104"
            }
        }
    ]
}