Content-Type: application/json

{
    "email": "sample@email.org",
    "password": "29500ac16fcdea35efd35be91d8463fd8bdfa2f2a012955067266db03e46e4dd"
}

Content-Type: application/json
Token: 1b722135f1c7d677802f487c73c3000ae8313986

{
    "id": "a63a6ab1ef11b3b1021a9a6",
    "type": "phone",
    "model": "iPhone 13 Pro",
    "vendor": "Apple",
    "ip": "X.X.X.X"
}

{
    "success": true,
    "user": {
        "_id": ObjectID,
        "email": string,
        "name": string,
        "phone": string,
        "currentOwnerId": ObjectID,
        "currentOwnerName": string,
        "currentOwnerIban": string,
        "currentOwnerMailbox": string,
        "owners": {"_id": ObjectID, "name": string, "role": ["admin", "editor", "viewer"]},
        ...
    }
}

{
    "documentType": string, # ID typu dokumentu (napríklad "incomingInvoice")
    "name": string, # názov súboru dokumentu
    "process": 0,
    "origin": [ # zoznam stránok dokumentu (1-n)
        {
            "name": string, # názov
            "type": string, # MIME typ (napríklad "application/pdf")
            "page": number, # číslo stránky od 0
            "data": "data:application/pdf;base64,JVBERi0xLj..." # BASE64 samostatnej jedinej stránky
        },
        ...
    ]
}

{
    "id": ObjectID, # ID nového dokumentu
    "success": true
}

{
    "docId": ObjectID, # ID rodičovského dokumentu
    "name": string, # názov súboru (napríklad "zmluva.pdf")
    "title": string, # popisný titulok prílohy
    "type": string, # MIME typ (napríklad "application/pdf")
    "data": "data:application/pdf;base64,JVBERi0xLj..." # BASE64 obsah súboru
}

{
    "_id": ObjectID # ID novej prílohy
}

[
    {
        "_id": ObjectID, # ID prílohy
        "docId": ObjectID, # ID rodičovského dokumentu
        "userId": ObjectID, # ID používateľa, ktorý prílohu nahral
        "name": string, # názov súboru
        "title": string, # popisný titulok
        "type": string, # MIME typ
        "process": number, # stav spracovania
        "blobName": string, # interný identifikátor blobu (po spracovaní)
        "url": string, # dočasný odkaz na stiahnutie (ak je príloha už uložená v storage)
        "createdAt": DATE,
        "updatedAt": DATE
    },
    ...
]

{
    "docId": ObjectID, # ID rodičovského dokumentu
    "userId": ObjectID,
    "name": string,
    "title": string,
    "type": string,
    "process": number,
    "blobName": string,
    "url": string, # dočasný odkaz na stiahnutie
    "createdAt": DATE,
    "updatedAt": DATE
}

{
    "title": string # nový titulok prílohy
}

{}

{}

Response tvorí telo súboru s hlavičkami Content-Type: application/octet-stream a Content-Disposition: attachment; filename="<name>".

{
    "id": ObjectID,
    "ownerId": ObjectID
}

{
    "id": ObjectID, # ID dokumentu
    "name": string, # meno dokumentu
    "userId": ObjectID, # ID pridelenej osoby
    "ownerId": ObjectID, # ID vlastníka (projektu / firmy)
    "doctype": string, # typ dokumentu (kategória)
    "type": [...], # zoznam typov suborov
    "step": number, # číslo kroku vo workflow
    "paid": bool, # príznak uhradenia
    ...
    "predicted": bool, # príznak či prebehla predikcia
    "predictions": [...], # zoznam predikcií podľa typu
    "fields": [...], # zoznam vyťažených a skontrolovaných údajov
    "pages": [...], # zoznam stránok s rozmermi, veľkosťou, typom, ocr a url na obrázok
    ...
    "createdAt": DATE, # dátum vytvorenia
    "updatedAt": DATE, # dátum poslednej zmeny
    "cachedAt": DATE,
    ...
}

{
    "sizePerPage": number, # počet záznamov na stránku
    "page": number, # číslo stránky
    "sortField": string, # zoradenie poľa, napríklad "fields.issueDate"
    "sortOrder": number, # zoradenie smer (asc=1, desc=-1)
    "filters": objekt, # viac v sekcii Filtrovanie
    "q": string, # textová hodnota pre fulltext vyhľadávanie
}

{
    "total": number, # počet vyhovujúcich dokumentov
    "data": [DocumentDetail, DocumentDetail, ...], # zoznam dokumentov
}

Request je rovnaký ako pri zozname dokumentov

{
    "total": number, # počet vyhovujúcich dokumentov
    "data": [ObjectID, ObjectID, ...], # ID dokumentov
}

{
    "filters": {
        "createdAtFrom": DATE, # najbežnejšie dátumové filtre sú v roote
        "createdAtTo": DATE,
        "updatedAtFrom": DATE,
        "updatedAtTo": DATE,
        "taxDateFrom": DATE,
        "taxDateTo": DATE,
        "workflow": { # filtrovanie cez číslo kroku vo workflow
            "incomingInvoice": [-1],
            "receipt": [1,2,3,4,5,6, ...] # zoznam krokov pre konkrétny doctype
        },
        "doctype": ["incomingInvoice", ...], # filtrovanie cez doctype
        "fields.issueDate": { # alebo použitie parametrov - údajov, ktoré sú vyťažené
            "operation": "between",
            "value": [DATE, DATE],
        },
        "fields.supplierId": {
            "operation": "in",
            "value": [string, ...],
        }
    }
}

[
    {
        "_id": string, # ID projektu
        "companyId": string, # IČO
        "companyName": string, # Oficiálny názov projektu
        "emailDocsSplit": bool, # príznak, či budú nahraté dokumenty rozdelené na jednotlivé strany
        "iban": [
            {
                "iban": string, # IBAN
                "name": string # názov účtu
            },
            ...
        ],
        "mailbox": string, # emailová schránka
        "name": string, # názov projektu
        "taxID": string, # DIČ
        "totalDocumentCount": number, # počet dokumentov
        "type": string, # typ platcu DPH (prázdne ak nie je platca)
        "vatId": string # IČ DPH
    },
    ...
]

{
    "id": "a63a6ab1ef11b3b1021a9a2",
}

{
    "_id": ObjectID,
    "email": string,
    "name": string,
    "phone": string,
    "currentOwnerId": ObjectID,
    "currentOwnerName": string,
    "currentOwnerIban": string,
    "currentOwnerMailbox": string,
    "owners": {"_id": ObjectID, "name": string, "role": ["admin", "editor", "viewer"]},
    ...
}

{
    "id": string, # systémové ID typu dokumentu (napríklad "incomingInvoice")
    "name": string, # názov typu dokumentu (kategórie)
    "short": string, # skratka kategórie
    "year": number, # počet znakov pre rok v internom čísle
    "number": number, # počet znakov pre číslo v internom čísle
    "documentsCount": number, # počet dokumentov v kategórii
    "currentOwnerIban": string,
    "currentOwnerMailbox": string,
    "fields": [
        {
            "id": string, # ID použitého fieldu (parametra)
            "required": bool, # príznak či má byť požadovaný
            "validation": bool, # príznak či má byť validovaný
            "invisible": bool, # príznak či má byť skrytý
            "default": string # defaultná hodnota
        },
        ...
    ],
    ...
}

[
    {
        "_id": string, # ID fieldu (napríklad "supplierId")
        "name": string, # zobrazované meno
        "regular": [string, ...], # regex pre validáciu hodnoty
        "formater": string|[string], # formátovač hodnoty (string alebo zoznam)
        "option": [ # číselník: zoznam povolených hodnôt (môže chýbať)
            {
                "key": string, # kľúč ukladaný do dokumentu
                "value": string # zobrazovaný popis kľúča
            },
            ...
        ],
        "doctypes": [string, ...] # zoznam doctypov, pre ktoré platí prepísanie
    },
    ...
]

{
    "option": [ # nový obsah číselníka (kompletný)
        {
            "key": string, # kľúč ukladaný do dokumentu
            "value": string # zobrazovaný popis kľúča
        },
        ...
    ]
}

{
    "success": true
}

[
    {
        "field": string, # ID fieldu, ktorému sa nastavuje číselník
        "options": [ # nový obsah číselníka (kompletný)
            {"key": string, "value": string},
            ...
        ]
    },
    ...
]

{
    "success": true
}

{
    "_": { # workflow pre dokumenty bez typu
        "doctype": "_",
        "steps": [...]
    },
    "incomingInvoice": { # kľúč = ID doctypu (napr. "incomingInvoice")
        "doctype": "incomingInvoice", # doctype, ku ktorému workflow patrí (alebo "_")
        "steps": [ # zoznam krokov vrátane "start" a "end"
            { # vstupný krok – vždy prítomný, nemazateľný
                "id": "start",
                "name": "Start",
                "type": "start",
                "deletable": false,
                "outputs": ["1"]
            },
            { # bežný krok
                "id": string, # ID kroku (string, použiteľné v outputs)
                "name": string, # názov kroku
                "type": "step", # typ kroku: "start", "step" alebo "end"
                "description": string, # popis kroku
                "assign": [ObjectID, ...], # zoznam ID zodpovedných osôb
                "outputs": [string, ...], # ID nasledujúcich krokov (pri "end" je null)
                "bulk": bool, # príznak či je možné použiť hromadnú akciu na tento krok
                "deletable": bool, # je možné krok vymazať? (start/end vždy false)
                "automationSystem": string|null, # ID napojenej automatizácie (alebo null)
                "automationSystemDuplicateDoctype": string|null # ID doctypu pre duplikát automatizáciou (alebo null)
            },
            ...
            { # výstupný krok – vždy prítomný, nemazateľný
                "id": "end",
                "name": "End",
                "type": "end",
                "deletable": false,
                "outputs": null # pre "end" krok je vždy null
            }
        ]
    },
    ...
}

{
    "doctype": string, # doctype, ku ktorému workflow patrí (alebo "_")
    "steps": [...] # zoznam krokov vrátane "start" a "end"
}

[
    {
        "id": "start",
        "name": "Start",
        "type": "start",
        "outputs": ["1"]
    },
    {
        "id": "1",
        "name": string,
        "type": "step",
        "description": string,
        "assign": [ObjectID, ...],
        "outputs": ["end"],
        "bulk": bool,
        "automationSystem": string|null,
        "automationSystemDuplicateDoctype": string|null
    },
    {
        "id": "end",
        "name": "End",
        "type": "end",
        "outputs": null
    }
]

[...] # zoznam krokov vrátane "start" a "end"

Response tvorí potom telo PDF dokumentu s príslušnými hlavičkami na stiahnutie dokumentu. Vygenerovanie PDF môže trvať niekoľko sekúnd. Záleží od počtu stránok.

telo dokumentu tvorí binárny súbor

{
    "success": bool,
    "generated": DATE,
    "totalTime": float,
    "result": {
        "fieldId": string,
        ...
        "customerCity": "Banská Bystrica",
        "customerCountry": "Slovensko",
        "customerId": "45663751",
        "customerName": "SoftOne, s. r. o.",
        "customerStreet": "Dolná Mičiná 98",
        "customerTaxId": "2023077903",
        "customerVatId": "SK2023077903",
        "customerZip": "97401",
        "deliveryDate": "17.09.2018",
        "invoiceNumber": "8/8662",
        "issueDate": "17.09.2018",
        "maturityDate": "01.10.2018",
        "paymentAmount": "59.38",
        "paymentIBAN": "SK8111000000002628715342",
        "paymentSWIFT": "TATRSKBX",
        "paymentVS": "18288562",
        "prepaidAmount": "0.0",
        "supplierCity": "Podtureň - Roveň",
        "supplierCountry": "Slovensko",
        "supplierId": "36389862",
        "supplierName": "GÜDE Slovakia, s.r.o.",
        "supplierStreet": "K sihoti 324/2",
        "supplierTaxId": "2020126889",
        "supplierVatId": "SK2020126889",
        "supplierZip": "03301",
        "totalAmount": "59.38",
        "vatAmount10": "0.0",
        "vatAmount20": "9.9",
        "vatBase0": "0.0",
        "vatBase10": "0.0",
        "vatBase20": "49.48"
    }
}

{
    "name": string, # vaše pomenovanie modelu pre lepšiu prehľadnosť
    "fields": ["invoiceNumber", "issueDate", "totalAmount", "paymentVS", "supplierId"] # zoznam fieldov, ktoré model bude vyťažovať
}

{
    "success": bool,
    "id": string
}

{
    "id": string, # vaše ID modelu
    "modelId": ObjectID, # naše ID modelu
    "fields": ["invoiceNumber", "issueDate", "totalAmount", "paymentVS", "supplierId", ...], # zoznam fieldov, ktoré model vyťažuje
    "totalDocs": number, # počet dokumentov
    "processDocs": number, # počet dokumentoch vhodných a použitých pre trénovanie
    "datasetProcessingTime": float, # dĺžka prípravy dát pre tréning v sekundách
    "trainingTime": float, # dĺžka tréningu v sekundách
    "trainedAt": DATE, # dátum a čas natrénovania
    "accuracy": float, # úspešnosť (0-1)
    "loss": float, # strata (0-1)
}

[
    {
        "id": string, # vaše ID modelu
        "name": string, # vaše pomenovanie
    },
    ...
]

{
    "success": bool,
    "id": ObjectId, # ID nového dokumentu
    "modelId": string, # vaše ID modelu
}

{
    "success": bool,
    "id": ObjectId, # ID dokumentu
    "modelId": string, # vaše ID modelu
    "name": string, # automaticky generovaný názov dokumentu
    "fields": [
        {
            "id": string, # ID fieldu (parametra)
            "value": string, # vyťažená hodnota
            "verified": bool, # príznak či hodnota bola verifikovaná človekom
            "accuracy": float, # presnosť (0-1)
            "bboxIds": [string, string, ...] # formát pageId-wordId (pageId: ObjectId = ID stránky, wordId: number = číslo slova z OCR)
        },
        ...
    ],
    "pages": [...], # zoznam stránok s rozmermi, veľkosťou, typom, ocr a url na obrázok
}