Tržba

GET

/posreceipts

Získá kolekci BO Tržba

GET

/posreceipts/{id}

Získá konkrétní BO Tržba

POST

/posreceipts

Vytvoří nový BO Tržba a vrátí jeho kompletní reprezentaci

PUT

/posreceipts/{id}

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

DELETE

/posreceipts/{id}

Smaže BO Tržba na základě jeho ID

Metadata - Perzistentní položky

CorrectedBy_ID string (securityuser) relace

Opravil; ID objektu Uživatel, 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

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

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

Ended boolean

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

EndedBy_ID string (securityuser) relace

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

EndedDate$DATE string

Dat. odvodu, 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

OrdNumber integer

Pořadové číslo, pole vlastněné tabulkou, možné řadit a filtrovat

POSShift_ID string (posshift) relace

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

PayChangeDocCount integer

Počet dokladů ve změně platby, 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

Rows array (posreceiptrow) relace

Řádky; kolekce BO Tržba - řádek, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

Stoped boolean

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

StopedBy_ID string (securityuser) relace

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

StopedDate$DATE string

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

VirtualPOS_ID string (virtualpos) relace

Pok. místo; ID objektu Pokladní místo, 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 (24)

Číslo dok., pouze pro čtení

ID string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

NewRelatedDocument_ID string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

NewRelatedType integer

Typ relace

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request

GET

https://atd.abra.eu/demodata/posreceipts?take=1

GET

https://atd.abra.eu/demodata/posreceipts/{id}
Response
{
    "ID": "1100000101",
    "ObjVersion": 5,
    "Rows": [
        {
            "amountcollection": 0,
            "amountdeposit": 0,
            "amountdifference": 0,
            "amountgived": 0,
            "amountleft": 29262,
            "amounttenancy": 29262,
            "currency_id": "0000CZK000",
            "finalamount": 29262,
            "id": "1100000101",
            "initiativeamount": 0,
            "issuedadvance": 0,
            "issueddinvoice": 0,
            "issuedinvoice": 0,
            "objversion": 4,
            "parent_id": "1100000101",
            "paymenttype_id": "2000000101",
            "realamount": 29262
        }
    ],
    "DocQueue_ID": "W700000101",
    "Period_ID": "4200000101",
    "OrdNumber": 2,
    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
    "CreatedBy_ID": "SUPER00000",
    "CorrectedBy_ID": "SUPER00000",
    "VirtualPOS_ID": "1200000101",
    "Stoped": true,
    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
    "StopedBy_ID": "SUPER00000",
    "Ended": true,
    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
    "EndedBy_ID": "SUPER00000",
    "POSShift_ID": null,
    "PayChangeDocCount": 0
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/posreceipts/query
{"take": "1"}
Response
{
    "ID": "1100000101",
    "ObjVersion": 5,
    "Rows": [
        {
            "amountcollection": 0,
            "amountdeposit": 0,
            "amountdifference": 0,
            "amountgived": 0,
            "amountleft": 29262,
            "amounttenancy": 29262,
            "currency_id": "0000CZK000",
            "finalamount": 29262,
            "id": "1100000101",
            "initiativeamount": 0,
            "issuedadvance": 0,
            "issueddinvoice": 0,
            "issuedinvoice": 0,
            "objversion": 4,
            "parent_id": "1100000101",
            "paymenttype_id": "2000000101",
            "realamount": 29262
        }
    ],
    "DocQueue_ID": "W700000101",
    "Period_ID": "4200000101",
    "OrdNumber": 2,
    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
    "CreatedBy_ID": "SUPER00000",
    "CorrectedBy_ID": "SUPER00000",
    "VirtualPOS_ID": "1200000101",
    "Stoped": true,
    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
    "StopedBy_ID": "SUPER00000",
    "Ended": true,
    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
    "EndedBy_ID": "SUPER00000",
    "POSShift_ID": null,
    "PayChangeDocCount": 0
}
Request

POST

https://atd.abra.eu/demodata/posreceipts?select=id
Body
{
    "CorrectedBy_ID": "SUPER00000",
    "CreatedBy_ID": "SUPER00000",
    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
    "DocQueue_ID": "W700000101",
    "Ended": true,
    "EndedBy_ID": "SUPER00000",
    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
    "OrdNumber": 2,
    "POSShift_ID": null,
    "PayChangeDocCount": 0,
    "Period_ID": "4200000101",
    "Rows": [
        {
            "amountcollection": 0,
            "amountdeposit": 0,
            "amountdifference": 0,
            "amountgived": 0,
            "amountleft": 29262,
            "amounttenancy": 29262,
            "currency_id": "0000CZK000",
            "finalamount": 29262,
            "id": "1100000101",
            "initiativeamount": 0,
            "issuedadvance": 0,
            "issueddinvoice": 0,
            "issuedinvoice": 0,
            "objversion": 4,
            "parent_id": "1100000101",
            "paymenttype_id": "2000000101",
            "realamount": 29262
        }
    ],
    "Stoped": true,
    "StopedBy_ID": "SUPER00000",
    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
    "VirtualPOS_ID": "1200000101"
}
Response
{
    "id": "1100000101"
}
Request

PUT

https://atd.abra.eu/demodata/posreceipts/{id}?select=id
Body
{
    "CorrectedBy_ID": "SUPER00000",
    "CreatedBy_ID": "SUPER00000",
    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
    "DocQueue_ID": "W700000101",
    "Ended": true,
    "EndedBy_ID": "SUPER00000",
    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
    "OrdNumber": 2,
    "POSShift_ID": null,
    "PayChangeDocCount": 0,
    "Period_ID": "4200000101",
    "Rows": [
        {
            "amountcollection": 0,
            "amountdeposit": 0,
            "amountdifference": 0,
            "amountgived": 0,
            "amountleft": 29262,
            "amounttenancy": 29262,
            "currency_id": "0000CZK000",
            "finalamount": 29262,
            "id": "1100000101",
            "initiativeamount": 0,
            "issuedadvance": 0,
            "issueddinvoice": 0,
            "issuedinvoice": 0,
            "objversion": 4,
            "parent_id": "1100000101",
            "paymenttype_id": "2000000101",
            "realamount": 29262
        }
    ],
    "Stoped": true,
    "StopedBy_ID": "SUPER00000",
    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
    "VirtualPOS_ID": "1200000101"
}
Response
{
    "id": "1100000101"
}

DELETE

https://atd.abra.eu/demodata/posreceipts/{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": "posreceipts",
                "object_data": {
                    "CorrectedBy_ID": "SUPER00000",
                    "CreatedBy_ID": "SUPER00000",
                    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
                    "DocQueue_ID": "W700000101",
                    "Ended": true,
                    "EndedBy_ID": "SUPER00000",
                    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
                    "OrdNumber": 2,
                    "POSShift_ID": null,
                    "PayChangeDocCount": 0,
                    "Period_ID": "4200000101",
                    "Rows": [
                        {
                            "amountcollection": 0,
                            "amountdeposit": 0,
                            "amountdifference": 0,
                            "amountgived": 0,
                            "amountleft": 29262,
                            "amounttenancy": 29262,
                            "currency_id": "0000CZK000",
                            "finalamount": 29262,
                            "id": "1100000101",
                            "initiativeamount": 0,
                            "issuedadvance": 0,
                            "issueddinvoice": 0,
                            "issuedinvoice": 0,
                            "objversion": 4,
                            "parent_id": "1100000101",
                            "paymenttype_id": "2000000101",
                            "realamount": 29262
                        }
                    ],
                    "Stoped": true,
                    "StopedBy_ID": "SUPER00000",
                    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
                    "VirtualPOS_ID": "1200000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "posreceipts",
                "object_data": {
                    "CorrectedBy_ID": "SUPER00000",
                    "CreatedBy_ID": "SUPER00000",
                    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
                    "DocQueue_ID": "W700000101",
                    "Ended": true,
                    "EndedBy_ID": "SUPER00000",
                    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
                    "OrdNumber": 2,
                    "POSShift_ID": null,
                    "PayChangeDocCount": 0,
                    "Period_ID": "4200000101",
                    "Rows": [
                        {
                            "amountcollection": 0,
                            "amountdeposit": 0,
                            "amountdifference": 0,
                            "amountgived": 0,
                            "amountleft": 29262,
                            "amounttenancy": 29262,
                            "currency_id": "0000CZK000",
                            "finalamount": 29262,
                            "id": "1100000101",
                            "initiativeamount": 0,
                            "issuedadvance": 0,
                            "issueddinvoice": 0,
                            "issuedinvoice": 0,
                            "objversion": 4,
                            "parent_id": "1100000101",
                            "paymenttype_id": "2000000101",
                            "realamount": 29262
                        }
                    ],
                    "Stoped": true,
                    "StopedBy_ID": "SUPER00000",
                    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
                    "VirtualPOS_ID": "1200000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "posreceipts",
                "obj_id": "1100000100",
                "object_data": {
                    "CorrectedBy_ID": "SUPER00000",
                    "CreatedBy_ID": "SUPER00000",
                    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
                    "DocQueue_ID": "W700000101",
                    "Ended": true,
                    "EndedBy_ID": "SUPER00000",
                    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
                    "OrdNumber": 2,
                    "POSShift_ID": null,
                    "PayChangeDocCount": 0,
                    "Period_ID": "4200000101",
                    "Rows": [
                        {
                            "amountcollection": 0,
                            "amountdeposit": 0,
                            "amountdifference": 0,
                            "amountgived": 0,
                            "amountleft": 29262,
                            "amounttenancy": 29262,
                            "currency_id": "0000CZK000",
                            "finalamount": 29262,
                            "id": "1100000101",
                            "initiativeamount": 0,
                            "issuedadvance": 0,
                            "issueddinvoice": 0,
                            "issuedinvoice": 0,
                            "objversion": 4,
                            "parent_id": "1100000101",
                            "paymenttype_id": "2000000101",
                            "realamount": 29262
                        }
                    ],
                    "Stoped": true,
                    "StopedBy_ID": "SUPER00000",
                    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
                    "VirtualPOS_ID": "1200000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "posreceipts",
                "obj_id": "1100000101",
                "object_data": {
                    "CorrectedBy_ID": "SUPER00000",
                    "CreatedBy_ID": "SUPER00000",
                    "DocDate$DATE": "2006-06-27T05:41:51.686Z",
                    "DocQueue_ID": "W700000101",
                    "Ended": true,
                    "EndedBy_ID": "SUPER00000",
                    "EndedDate$DATE": "2007-01-25T07:39:44.614Z",
                    "OrdNumber": 2,
                    "POSShift_ID": null,
                    "PayChangeDocCount": 0,
                    "Period_ID": "4200000101",
                    "Rows": [
                        {
                            "amountcollection": 0,
                            "amountdeposit": 0,
                            "amountdifference": 0,
                            "amountgived": 0,
                            "amountleft": 29262,
                            "amounttenancy": 29262,
                            "currency_id": "0000CZK000",
                            "finalamount": 29262,
                            "id": "1100000101",
                            "initiativeamount": 0,
                            "issuedadvance": 0,
                            "issueddinvoice": 0,
                            "issuedinvoice": 0,
                            "objversion": 4,
                            "parent_id": "1100000101",
                            "paymenttype_id": "2000000101",
                            "realamount": 29262
                        }
                    ],
                    "Stoped": true,
                    "StopedBy_ID": "SUPER00000",
                    "StopedDate$DATE": "2007-01-25T07:39:44.564Z",
                    "VirtualPOS_ID": "1200000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "posreceipts",
                "obj_id": "1100000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "posreceipts",
                "obj_id": "1100000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "posreceipts",
                "obj_id": "1100000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "posreceipts",
                "obj_id": "1100000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "posreceipts",
                "obj_id": "1100000104"
            }
        }
    ]
}