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"]},
        ...
    }
}

{
    "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í podla 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, ...], # ID 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": { # filktrovanie 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 (nepovinné), # 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 (nepovinné), # DIČ
        "totalDocumentCount": number, # počet dokumentov
        "type": string, # typ platcu dph (prázdne ak nie je platca)
        "vatId": string (nepovinné) # 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
        },
        ...
    ],
    ...
}

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.

{
    _: { # krok pre dokumenty bez typu
        "name": string,
        "steps": [...]
    },
    string: { # doctype ID kroku
        "name": string, # systémové ID typu dokumentu (napríklad "incomingInvoice")
        "steps": [ # zoznam krokov
            { # krok číslo 0
                "assign": ObjectID, # ID zodpovednej osoby
                "name": string, # názov kroku
                "description": string, # popis kroku
                "bulk": bool # príznak či je možné použiť hromadnú akciu na tento krok
            },
            { # krok číslo 1
                "assign": ObjectID,
                "name": string,
                "description": string,
                "bulk": bool
            },
            { # krok číslo 2
                "assign": ObjectID,
                "name": string,
                "description": string,
                "bulk": bool
            },
            ...
        ],
    }
    ...
}

{
    "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á človenok
            "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
}