Uzavřený doklad

GET

/vatclosingdocuments

Získá kolekci BO Uzavřený doklad

GET

/vatclosingdocuments/meta/dataprotection

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

GET

/vatclosingdocuments/views/{view}

Získá pohled nad BO Uzavřený doklad

GET

/vatclosingdocuments/{id}

Získá daný BO Uzavřený doklad

GET

/vatclosingdocuments/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Uzavřený doklad

GET

/vatclosingdocuments/{id}/meta/dataprotection

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

GET

/vatclosingdocuments/{id}/userparameters

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

POST

/vatclosingdocuments

Vytvoří nový BO Uzavřený doklad

POST

/vatclosingdocuments/query

Vyhodnotí query dotaz nad BO Uzavřený doklad

PUT

/vatclosingdocuments/{id}

Modifikuje daný BO Uzavřený doklad

PUT

/vatclosingdocuments/{id}/editlock

Vytvoří editační zámek na daném BO Uzavřený doklad

PUT

/vatclosingdocuments/{id}/editunlock

Zruší editační zámek na daném BO Uzavřený doklad

DELETE

/vatclosingdocuments/{id}

Smaže BO Uzavřený doklad

Metadata - Perzistentní položky

docqueue_id string (docqueue) relace

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

document_id string (datadocumentbusinessobject) relace

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

documentstatus integer

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

documenttype string (2)

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

ischangeincluded boolean

Změny dokladu jsou v DPH přiznání, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

isinvatcheckreport boolean

Je v KV/KH DPH, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

isinvatdeclarationreport boolean

Je v DPH přiznání, 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, pole je duplikováno při klonování objektu

parent_id string (vatclosing) relace

Uzávěrka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

period_id string (period) relace

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

relatedclosingdocument_id string (vatclosingdocument) relace

ID původního uzavřeného dokladu, pole vlastněné tabulkou, možné řadit a filtrovat

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í

documentstatusastext string (20)

Stav dokumentu

id string (10)

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

vatdate$date string

Datum plnění

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

GET

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

GET

https://atd.abra.eu/demodata/vatclosingdocuments/{id}
Response
{
    "docqueue_id": null,
    "document_id": null,
    "documentstatus": null,
    "documenttype": null,
    "ischangeincluded": null,
    "isinvatcheckreport": null,
    "isinvatdeclarationreport": null,
    "objversion": null,
    "ordnumber": null,
    "parent_id": null,
    "period_id": null,
    "relatedclosingdocument_id": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/vatclosingdocuments/query
{"take": "1"}
Response
{
    "docqueue_id": null,
    "document_id": null,
    "documentstatus": null,
    "documenttype": null,
    "ischangeincluded": null,
    "isinvatcheckreport": null,
    "isinvatdeclarationreport": null,
    "objversion": null,
    "ordnumber": null,
    "parent_id": null,
    "period_id": null,
    "relatedclosingdocument_id": null
}
Request

POST

https://atd.abra.eu/demodata/vatclosingdocuments?select=id
Body
{
    "docqueue_id": null,
    "document_id": null,
    "documentstatus": null,
    "documenttype": null,
    "ischangeincluded": null,
    "isinvatcheckreport": null,
    "isinvatdeclarationreport": null,
    "ordnumber": null,
    "parent_id": null,
    "period_id": null,
    "relatedclosingdocument_id": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/vatclosingdocuments/{id}?select=id
Body
{
    "docqueue_id": null,
    "document_id": null,
    "documentstatus": null,
    "documenttype": null,
    "ischangeincluded": null,
    "isinvatcheckreport": null,
    "isinvatdeclarationreport": null,
    "ordnumber": null,
    "parent_id": null,
    "period_id": null,
    "relatedclosingdocument_id": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/vatclosingdocuments/{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": "vatclosingdocuments",
                "object_data": {
                    "docqueue_id": null,
                    "document_id": null,
                    "documentstatus": null,
                    "documenttype": null,
                    "ischangeincluded": null,
                    "isinvatcheckreport": null,
                    "isinvatdeclarationreport": null,
                    "ordnumber": null,
                    "parent_id": null,
                    "period_id": null,
                    "relatedclosingdocument_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "vatclosingdocuments",
                "object_data": {
                    "docqueue_id": null,
                    "document_id": null,
                    "documentstatus": null,
                    "documenttype": null,
                    "ischangeincluded": null,
                    "isinvatcheckreport": null,
                    "isinvatdeclarationreport": null,
                    "ordnumber": null,
                    "parent_id": null,
                    "period_id": null,
                    "relatedclosingdocument_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "vatclosingdocuments",
                "obj_id": "1600000100",
                "object_data": {
                    "docqueue_id": null,
                    "document_id": null,
                    "documentstatus": null,
                    "documenttype": null,
                    "ischangeincluded": null,
                    "isinvatcheckreport": null,
                    "isinvatdeclarationreport": null,
                    "ordnumber": null,
                    "parent_id": null,
                    "period_id": null,
                    "relatedclosingdocument_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "vatclosingdocuments",
                "obj_id": "1600000101",
                "object_data": {
                    "docqueue_id": null,
                    "document_id": null,
                    "documentstatus": null,
                    "documenttype": null,
                    "ischangeincluded": null,
                    "isinvatcheckreport": null,
                    "isinvatdeclarationreport": null,
                    "ordnumber": null,
                    "parent_id": null,
                    "period_id": null,
                    "relatedclosingdocument_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "vatclosingdocuments",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "vatclosingdocuments",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "vatclosingdocuments",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "vatclosingdocuments",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "vatclosingdocuments",
                "obj_id": "1600000104"
            }
        }
    ]
}