Uzavřený doklad

GET

/vatclosingdocuments

Získá kolekci BO Uzavřený doklad

GET

/vatclosingdocuments/{id}

Získá konkrétní BO Uzavřený doklad

POST

/vatclosingdocuments

Vytvoří nový BO Uzavřený doklad a vrátí jeho kompletní reprezentaci

PUT

/vatclosingdocuments/{id}

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

DELETE

/vatclosingdocuments/{id}

Smaže BO Uzavřený doklad na základě jeho ID

Metadata - Perzistentní položky

DocQueue_ID string (docqueue) relace

Řada; ID objektu Řada dokladů, 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 (documenttype) relace

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

Document_ID string (datadocumentbusinessobject) relace

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

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; ID objektu Uzávěrka DPH, 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í; ID objektu 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; ID objektu Uzavřený doklad, 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,
    "DocumentStatus": null,
    "DocumentType": null,
    "Document_ID": null,
    "ID": 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,
    "DocumentStatus": null,
    "DocumentType": null,
    "Document_ID": null,
    "ID": 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,
    "DocumentStatus": null,
    "DocumentType": null,
    "Document_ID": 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,
    "DocumentStatus": null,
    "DocumentType": null,
    "Document_ID": 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,
                    "DocumentStatus": null,
                    "DocumentType": null,
                    "Document_ID": 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,
                    "DocumentStatus": null,
                    "DocumentType": null,
                    "Document_ID": 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,
                    "DocumentStatus": null,
                    "DocumentType": null,
                    "Document_ID": 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,
                    "DocumentStatus": null,
                    "DocumentType": null,
                    "Document_ID": 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"
            }
        }
    ]
}