Úvod

Redque API poskytuje všechny dostupné funkcionality pro vytěžování dokumentů. Webová aplikace Alice rovněž využívá Redque API, veškerá data nahraná přes webovou aplikaci lze tak získat pomocí API a naopak vešekeré změny provedené přes API se ihned zobrazí ve webové aplikaci Alice.

Registrace a přístup do Redque API

Uživatelský účet získáte zdarma zde.

-	Adresa
Webová aplikace (Alice)	https://app.redque.com/
API	https://api.redque.com/
Identity Server	https://identity.redque.com/

Autentizace

Redque API využívá OAuth 2.0 autentizační protokol. Pro volání API je třeba nejdříve získat autentizační JWT token (Access Token) od Identity Serveru. Získaný JWT token je pak posílat v HTTP hlavičce každého API požadavku:

Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...

Identity Server vydá JWT token na základě úspěšného ověření pomocí

OAuth Password Grant - pro uživatele
OAuth Client Credentials Grant - pro klientské aplikace

# Vyžádání JWT tokenu pro uživatele jan.novak@gmail.com s heslem Redque123 (pozor na URL encoding u znaku @ a na to, že názvy parametrů příkazu curl jsou case-sensitive)
curl -X POST -d "grant_type=password&client_id=api_redque&username=jan.novak%40gmail.com&password=Redque123" "https://identity.redque.com/connect/token"

# Odpověď serveru
{"access_token":"eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...","expires_in":240,"token_type":"Bearer","scope":"v1.public"}

# Vyžádání JWT tokenu pro klientskou aplikaci id:AD1D9FA386F2BF94CBC574B704D1FB89DC... secret: 3364F6A9FF2CD3BE77...
curl -X POST -d "grant_type=client_credentials&client_id=AD1D9FA386F2BF94CBC574B704D1FB89DC&client_secret=3364F6A9FF2CD3BE77" "https://identity.redque.com/connect/token"

# Odpověď serveru
{"access_token":"eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...","expires_in":240,"token_type":"Bearer","scope":"v1.public"}

Základní proces dokumentu

Tato sekce popisuje základní práci s dokumentem v Redque API - od nahrání dokumentu, přes automatické vytěžení, až po export do externího systému.

Přehled procesu

Nahrání dokumentu	Vytěžení	Odeslání do fronty k exportu	Stažení dokumentu v požadovaném formátu	Označení exportovaného dokumentu
`POST /v1/documents`	automaticky	`POST /v1/documents/export`	`GET /v1/documents/{documentId}/file/export?exportFormat=<FormátExportu>`	`PATCH /v1/documents/markAsExported` nebo `PATCH /v1/documents/markAsExportFailure`

Krok 1: Nahrání dokumentu

Dokument nahrajete pomocí endpointu POST /v1/documents. Po nahrání se automaticky spustí proces vytěžení.

# Nahrání dokumentu
curl -X POST \
  'https://api.redque.com/v1/documents' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -F 'File=@Faktura_2025.pdf'

# Odpověď serveru
HTTP/1.1 200 OK

{
  "documentId": "0e9d4b614e1f4befa24c8649f63d8ede"
}

Krok 2: Vytěžení dokumentu

Vytěžení probíhá automaticky po nahrání dokumentu. Systém RedQue analyzuje dokument a extrahuje z něj relevantní data (číslo faktury, dodavatel, částky, atd.).

Kontrola stavu vytěžení

Stav dokumentu můžete zkontrolovat pomocí endpointu GET /v1/documents/{documentId}:

# Kontrola stavu dokumentu
curl -X GET \
  'https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...'

# Odpověď serveru - dokument vytěžen
HTTP/1.1 200 OK

{
  "id": "0e9d4b614e1f4befa24c8649f63d8ede",
  "fileName": "Faktura_2025.pdf",
  "externalDocumentId": null,
  "state": "Extracted",
  "documentClass": "czech_invoice",
  "approvalState": "None",
  "source": "Api",
  "accountingUnitId": "a1b2c3d4e5f6",
  "pageCount": 1,
  "creationTime": "2025-01-15T10:00:00.000Z",
  "extractionTime": "2025-01-15T10:00:15.000Z",
  "contentType": "application/pdf",
  "isExtractedByFormat": false,
  "canBeExported": true,
  "canBeApproved": true,
  "canBeSentToApproval": true,
  "canBeShownInApproval": true,
  "fields": {
    "invoice_number_sm": {
      "value": "FA2025001",
      "wordIds": [1]
    },
    "issued_by_name_sm": {
      "value": "Dodavatel s.r.o.",
      "wordIds": [0]
    },
    "total_amount": {
      "value": "12500.00",
      "wordIds": [15]
    }
  },
  "items": [],
  "pages": [],
  "fieldsHistory": [],
  "validationErrors": [],
  "documentExportHistory": [],
  "attachments": []
}

Možné stavy dokumentu

Stav	Popis
`New`	Dokument byl nahrán, čeká na vytěžení.
`Extracting`	Probíhá vytěžení dokumentu.
`Extracted`	Vytěžení dokončeno.
`Validated`	Dokument byl validován (ručně nebo automaticky).
`Paused`	Zpracování dokumentu pozastaveno.
`Error`	Při vytěžení došlo k chybě.

Krok 3: Odeslání do fronty k exportu

Po vytěžení (a případné validaci) dokument odešlete do fronty k exportu pomocí endpointu POST /v1/documents/export:

# Odeslání dokumentu do fronty k exportu
curl -X POST \
  'https://api.redque.com/v1/documents/export' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "0e9d4b614e1f4befa24c8649f63d8ede"
  }'

# Odpověď serveru
HTTP/1.1 200 OK

Hromadné odeslání více dokumentů

Pro odeslání více dokumentů najednou použijte endpoint POST /v1/documents/export/list:

# Hromadné odeslání dokumentů k exportu
curl -X POST \
  'https://api.redque.com/v1/documents/export/list' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -H 'Content-Type: application/json' \
  -d '["0e9d4b614e1f4befa24c8649f63d8ede", "1a2b3c4d5e6f7g8h9i0j"]'

# Odpověď serveru
HTTP/1.1 200 OK

Krok 4: Získání dokumentů k exportu

Pro získání seznamu dokumentů čekajících na export použijte endpoint POST /v1/documents/list/forExport:

# Získání seznamu dokumentů k exportu
curl -X POST \
  'https://api.redque.com/v1/documents/list/forExport' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
    "control": {
      "skip": 0,
      "take": 50
    }
  }'

# Odpověď serveru
HTTP/1.1 200 OK

{
  "list": [
    {
      "documentId": "0e9d4b614e1f4befa24c8649f63d8ede",
      "externalDocumentId": null,
      "pageCount": 1,
      "fileName": "Faktura_2025.pdf",
      "documentClass": "czech_invoice",
      "accountingUnitId": "a1b2c3d4e5f6",
      "accountingUnitExternalId": null,
      "creationTime": "2025-01-15T10:00:00.000Z",
      "size": 125,
      "contentType": "application/pdf",
      "extractionTime": "2025-01-15T10:00:15.000Z",
      "isValidated": true,
      "fields": {
        "invoice_number_sm": {
          "fieldName": "invoice_number_sm",
          "fieldValue": "FA2025001",
          "fieldValueJson": "FA2025001"
        },
        "total_amount": {
          "fieldName": "total_amount",
          "fieldValue": "12500.00",
          "fieldValueJson": 12500.00
        }
      },
      "items": [],
      "note": null
    }
  ],
  "hasMore": false,
  "offset": 0
}

Pouze ID dokumentů k exportu

Pro získání pouze ID dokumentů (bez kompletních dat) použijte endpoint POST /v1/documents/list/idsForExport:

# Získání ID dokumentů k exportu
curl -X POST \
  'https://api.redque.com/v1/documents/list/idsForExport' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{}'

# Odpověď serveru
HTTP/1.1 200 OK

{
  "list": [
    {
      "documentId": "0e9d4b614e1f4befa24c8649f63d8ede",
      "externalDocumentId": null,
      "accountingUnitId": "a1b2c3d4e5f6",
      "accountingUnitExternalId": null,
      "isValidated": true
    }
  ],
  "hasMore": false,
  "offset": 0
}

Krok 5: Stažení dokumentu v požadovaném formátu

Vytěžený dokument stáhnete v požadovaném formátu pomocí endpointu GET /v1/documents/{documentId}/file/export:

# Stažení dokumentu ve formátu JSON
curl -X GET \
  'https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/file/export?exportFormat=Json' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...'

# Stažení dokumentu ve formátu XML
curl -X GET \
  'https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/file/export?exportFormat=Xml' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...'

# Stažení dokumentu ve formátu ISDOC
curl -X GET \
  'https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/file/export?exportFormat=ISDOC' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...'

Dostupné formáty exportu

Formát	Popis
`Json`	JSON formát s vytěženými daty.
`Xml`	XML formát s vytěženými daty.
`ISDOC`	Standardizovaný formát pro elektronické faktury v ČR.

Krok 6: Označení dokumentu jako exportovaného

Po úspěšném zpracování dokumentu v externím systému je třeba dokument označit jako exportovaný pomocí endpointu PATCH /v1/documents/markAsExported:

# Označení dokumentu jako exportovaného
curl -X PATCH \
  'https://api.redque.com/v1/documents/markAsExported' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "documentId": "0e9d4b614e1f4befa24c8649f63d8ede",
      "accoutingProviderDocumentNumber": "FA2025001",
      "exportType": "MujUcetniSystem",
      "exportedByApplicationName": "MojeIntegrace"
    }
  ]'

# Odpověď serveru
HTTP/1.1 200 OK

Parametry označení

Parametr	Typ	Popis
`documentId`	string	Povinný. ID dokumentu.
`accoutingProviderDocumentNumber`	string	Číslo dokladu v cílovém systému.
`exportType`	string	Název/typ cílového systému.
`exportedByApplicationName`	string	Název aplikace, která export provedla.

Označení neúspěšného exportu

Pokud export selže, označte dokument pomocí endpointu PATCH /v1/documents/markAsExportFailure:

# Označení neúspěšného exportu
curl -X PATCH \
  'https://api.redque.com/v1/documents/markAsExportFailure' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "documentId": "0e9d4b614e1f4befa24c8649f63d8ede",
      "errorMessage": "Chyba připojení k účetnímu systému"
    }
  ]'

# Odpověď serveru
HTTP/1.1 200 OK

Klientská aplikace

Klientská aplikace slouží k integraci Redque API do účetních systémů. Klientská aplikace může být jakákoliv aplikace, která umí komunikovat pomocí HTTP protokolu.

Autentizace klientské aplikace se provádí pomocí OAuth Client Credentials Grant.

Vytvoření klientské aplikace

Vytvoření klientské aplikace je akce, která slouží k vytvoření nového klienta pro integraci s Redque API. Tato akce umožňuje nastavit název klienta, jeho roli a povolení.

Pro vytvoření klientské aplikace je třeba provést HTTP POST požadavek na endpoint https://api.redque.com/v1/configuration/client-application. V hlavičce požadavku je třeba uvést autorizační token (Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9) a typ obsahu (Content-Type: application/json). V těle požadavku je potřeba uvést název klienta, jeho roli a povolení ve formátu JSON.

# Vytvoření klientské aplikace
curl -X 'POST' \
  'https://api.redque.com/v1/configuration/client-application' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientName": "MojeIntegrace",
    "role": "Approver",
    "enabled": true,
    "accountingUnitId": "a1b2c3d4e5f6",
    "additionalAccountingUnitIds": ["g7h8i9j0k1l2", "m3n4o5p6q7r8"]
  }'

# Odpověď serveru
{
  "clientApplicationId": "8074D940D9E88447A2452B4A52290B4",
  "clientApplicationSecret": "4418bf620cd8534173220596a23bf9deb"
}

Získání klientské aplikace

Požadavek slouží k získání informací o konkrétní klientské aplikaci pomocí jejího identifikátoru. Provede se HTTP GET požadavek na endpoint https://api.redque.com/v1/configuration/client-application/{client_application_id}. V hlavičce požadavku je třeba uvést autorizační token (Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9).

# Získání klientské aplikace pomocí ID
curl -X 'GET' \
  'https://api.redque.com/v1/configuration/client-application/8074D940D9E88447A2452B4A52290B4' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9'

  # Odpověď serveru
  {
  "clientApplicationId": "97135B39CB65469FED01199744FB9FBC9EDE9A90E540C",
  "clientName": "NazevKlienta",
  "role": "Uploader",
  "enabled": true,
  "accountingUnitId": "9CB65469FED011",
  "additionalAcountingUnitIds": ["9CB65469FED011997", "D01199744FB9FBC9"]
}

Získání seznamu klientských aplikací

Požadavek slouží k získání seznamu všech klientských aplikací integrovaných s Redque API. Provede se HTTP GET požadavek na endpoint https://api.redque.com/v1/configuration/client-application. V hlavičce požadavku je třeba uvést autorizační token (Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9).

# Získání seznamu všech klientských aplikací
curl -X 'GET' \
  'https://api.redque.com/v1/configuration/client-application' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9'

# Odpověď serveru
{
  "list": [
    {
      "clientApplicationId": "135B39CB65469FED01199744FB9FBC9EDE9A90E540C",
      "clientName": "NazevKlienta",
      "role": "TenantAdmin",
      "enabled": true,
      "accountingUnitId": "9CB65469FED011",
      "additionalAcountingUnitIds": ["9CB65469FED011997", "D01199744FB9FBC9"]
    }]}

Aktualizace klientské aplikace

Požadavek slouží k aktualizaci informací o existující klientské aplikaci pomocí jejího identifikátoru. Provede se HTTP PATCH požadavek na endpoint https://api.redque.com/v1/configuration/client-application/{client_application_id}. V hlavičce požadavku je třeba uvést autorizační token (Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9) a typ obsahu (Content-Type: application/json). V těle požadavku je potřeba uvést aktualizované informace o klientské aplikaci ve formátu JSON.

# Aktualizace klientské aplikace
curl -X 'PATCH' \
  'https://api.redque.com/v1/configuration/client-application/8074D940D9E88447A2452B4A52290B4' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientApplicationId": "8074D940D9E88447A2452B4A52290B4",
    "clientName": "MojeIntegrace - aktualizovano",
    "role": "TenantAdmin",
    "enabled": true,
    "accountingUnitId": "a1b2c3d4e5f6",
    "additionalAccountingUnitIds": ["g7h8i9j0k1l2", "m3n4o5p6q7r8"]
  }'

  # Odpověd serveru
  HTTP/1.1 200 OK

Deaktivace klientské aplikace

Požadavek, který slouží k deaktivaci konkrétní klientské aplikace pomocí jejího identifikátoru. Pro provedení této akce je potřeba provést HTTP DELETE požadavek na endpoint https://api.redque.com/v1/configuration/client-application/{client_application_id}. V hlavičce požadavku je třeba uvést autorizační token (Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9). Po úspěšném provedení požadavku se klientská aplikace úspěšně deaktivuje.

# Deaktivace klientské aplikace
curl -X 'DELETE' \
  'https://api.redque.com/v1/configuration/client-application/557B043540E14F3AB1AC9593ECB2D6C148074D940D9E88447A2452B4A52290B4' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9'

  # Odpověd serveru
  HTTP/1.1 200 OK

Documenty

Vložení dokumentu

Dokument vložíte a spustíte jeho vytěžení pomocí endpointu POST /v1/documents.

# Vložení dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -F "File=@Faktura_2025.pdf" \
  "https://api.redque.com/v1/documents"

# Odpověď serveru
{
  "documentId": "0e9d4b614e1f4befa24c8649f63d8ede"
}

HTTP požadavek

POST https://api.redque.com/v1/documents

Parametry požadavku (multipart/form-data)

Parametr	Typ	Popis
File	binary	Povinný. Binární soubor dokumentu.
DocumentId	string	Externí ID dokumentu.
Date	datetime	Datum dokumentu.
Ordinal	integer	Pořadí pro zachování řazení při paralelním uploadu.
DocumentClass	string	Typ dokumentu.
Source	string	Zdroj dokumentu.
AccountingUnitId	string	ID účetní jednotky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID vloženého dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vložení dokumentu bez vytěžení

Dokument vložíte bez spuštění vytěžení pomocí endpointu POST /v1/documents/uploadOnly.

# Vložení dokumentu bez vytěžení
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"fileName": "Faktura_2025.pdf", "fileContent": "base64..."}' \
  "https://api.redque.com/v1/documents/uploadOnly"

# Odpověď serveru
{
  "documentId": "0e9d4b614e1f4befa24c8649f63d8ede"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/uploadOnly

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID vloženého dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vložení dokumentu z JSON (Base64)

Dokument vložíte ve formátu Base64 JSON pomocí endpointu POST /v1/documents/fromJson.

# Vložení dokumentu z JSON
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"fileName": "Faktura_2025.pdf", "fileContent": "JVBERi0xLjQK..."}' \
  "https://api.redque.com/v1/documents/fromJson"

# Odpověď serveru
{
  "documentId": "0e9d4b614e1f4befa24c8649f63d8ede"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/fromJson

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID vloženého dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vložení stránky dokumentu

Jednotlivou stránku dokumentu vložíte pomocí endpointu POST /v1/documents/uploadPage. Poslední stránka spustí vytěžení.

# Vložení stránky dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -F "File=@stranka1.png" \
  -F "PageIndex=0" \
  -F "DocumentId=0e9d4b614e1f4befa24c8649f63d8ede" \
  -F "IsLastPage=false" \
  "https://api.redque.com/v1/documents/uploadPage"

# Odpověď serveru
{
  "documentId": "0e9d4b614e1f4befa24c8649f63d8ede"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/uploadPage

Parametry požadavku (multipart/form-data)

Parametr	Typ	Popis
File	binary	Povinný. Soubor stránky ve formátu PNG/JPEG.
PageIndex	integer	Povinný. Index stránky.
DocumentId	string	Povinný. ID dokumentu.
IsLastPage	boolean	Povinný. Příznak poslední stránky.
DocumentClass	string	Typ dokumentu.
DocumentSource	string	Zdroj dokumentu.
AccountingUnitId	string	ID účetní jednotky.
ExtractItems	boolean	Vytěžit položky dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Seznam dokumentů

Seznam dokumentů získáte pomocí endpointu POST /v1/documents/list. Dokumenty lze filtrovat pomocí parametrů v těle požadavku.

# Získání seznamu dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "faktura",
    "filter": {
      "listStatus": {
        "values": ["new", "extracted"]
      },
      "documentClass": {
        "value": "czech_invoice"
      }
    },
    "control": {
      "skip": 0,
      "take": 50
    },
    "sort": {
      "field": "Created",
      "direction": "Descending"
    }
  }' \
  "https://api.redque.com/v1/documents/list"

# Odpověď serveru
{
  "items": [
    {
      "id": "0e9d4b614e1f4befa24c8649f63d8ede",
      "fileName": "Faktura_2025.pdf",
      "state": "Extracted",
      "documentClass": "czech_invoice",
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "totalCount": 1
}

HTTP požadavek

POST https://api.redque.com/v1/documents/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam dokumentů.
400	Neplatné parametry požadavku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Počet dokumentů

Počet dokumentů odpovídajících zadaným kritériím získáte pomocí endpointu POST /v1/documents/count.

# Získání počtu dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "",
    "filter": {
      "listStatus": {
        "values": ["new", "extracted"]
      }
    }
  }' \
  "https://api.redque.com/v1/documents/count"

# Odpověď serveru
42

HTTP požadavek

POST https://api.redque.com/v1/documents/count

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací počet dokumentů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Počet dokumentů ve vytěžování

Počet dokumentů, které jsou aktuálně ve stavu vytěžování, získáte pomocí endpointu POST /v1/documents/count/extracting.

# Získání počtu dokumentů ve vytěžování
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/count/extracting"

# Odpověď serveru
5

HTTP požadavek

POST https://api.redque.com/v1/documents/count/extracting

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací počet dokumentů ve vytěžování.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Seznam dokumentů k exportu

Seznam dokumentů připravených k exportu získáte pomocí endpointu POST /v1/documents/list/forExport.

# Získání seznamu dokumentů k exportu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "accountingUnitId": {
        "values": ["a1b2c3d4e5f6"]
      }
    },
    "control": {
      "skip": 0,
      "take": 100
    }
  }' \
  "https://api.redque.com/v1/documents/list/forExport"

# Odpověď serveru
{
  "items": [
    {
      "id": "0e9d4b614e1f4befa24c8649f63d8ede",
      "fileName": "Faktura_2025.pdf",
      "state": "ReadyForExport"
    }
  ],
  "totalCount": 1
}

HTTP požadavek

POST https://api.redque.com/v1/documents/list/forExport

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam dokumentů k exportu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

ID dokumentů k exportu

ID dokumentů připravených k exportu získáte pomocí endpointu POST /v1/documents/list/idsForExport.

# Získání ID dokumentů k exportu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "accountingUnitId": {
        "values": ["a1b2c3d4e5f6"]
      }
    },
    "control": {
      "skip": 0,
      "take": 100
    }
  }' \
  "https://api.redque.com/v1/documents/list/idsForExport"

# Odpověď serveru
{
  "items": ["0e9d4b614e1f4befa24c8649f63d8ede", "1a2b3c4d5e6f7g8h9i0j"],
  "totalCount": 2
}

HTTP požadavek

POST https://api.redque.com/v1/documents/list/idsForExport

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID dokumentů k exportu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Získání detailu dokumentu

Detail dokumentu získáte pomocí endpointu GET /v1/documents/{documentId}. Endpoint vrátí kompletní informace o dokumentu včetně všech vytěžených polí.

# Získání detailu dokumentu pomocí jeho ID
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede"

# Odpověď serveru
{
  "id": "0e9d4b614e1f4befa24c8649f63d8ede",
  "fileName": "Faktura_2025.pdf",
  "state": "Extracted",
  "documentClass": "czech_invoice",
  "accountingUnitId": "a1b2c3d4e5f6",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:35:00.000Z",
  "fields": {
    "invoice_number_sm": {
      "value": "FA2025001",
      "wordIds": [1]
    },
    "issued_by_name_sm": {
      "value": "Dodavatel s.r.o.",
      "wordIds": [0]
    }
  },
  "validationErrors": [],
  "attachments": []
}

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
isExternalId	boolean	Použít externí ID místo interního ID dokumentu. Výchozí: `false`.
detailSettings	boolean	Vrátit metadata potřebná pro zobrazení detailu dokumentu (např. lokalizované názvy polí). Výchozí: `false`.
returnDocumentTypeDefinition	boolean	Zahrnout definici typu dokumentu. Výchozí: `false`.
culture	string	Kultura pro lokalizaci názvů polí (např. `cs-CZ`).

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací detail dokumentu.
400	Neplatné parametry požadavku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.
404	Dokument neexistuje.

Obrázek stránky dokumentu

Obrázek konkrétní stránky dokumentu získáte pomocí endpointu GET /v1/documents/{documentId}/page/{pageIndex}/image.

# Získání obrázku první stránky dokumentu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/page/0/image" \
  --output page.png

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/page/{pageIndex}/image

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
pageIndex	integer	Povinný. Index stránky (začíná od 0).
isPreview	boolean	Vrátit zmenšený náhled obrázku. Výchozí: `false`.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací obrázek stránky.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Stažení původního souboru

Původní soubor dokumentu stáhnete pomocí endpointu GET /v1/documents/{documentId}/file.

# Stažení původního souboru
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/file" \
  --output dokument.pdf

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/file

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací soubor ke stažení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Stažení dokumentu v exportním formátu

Vytěžený dokument v zadaném exportním formátu stáhnete pomocí endpointu GET /v1/documents/{documentId}/file/export.

# Stažení dokumentu ve formátu JSON
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/file/export?exportFormat=json" \
  --output export.json

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/file/export

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
exportFormat	string	Formát exportu (`json`, `xml`, `isdoc`).

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací soubor v exportním formátu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Aktualizace dokumentu

Hodnoty polí dokumentu aktualizujete pomocí endpointu PATCH /v1/documents/{documentId}.

# Aktualizace polí dokumentu
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "invoice_number_sm": {"value": "FA2025002"},
      "issued_by_name_sm": {"value": "Dodavatel s.r.o."},
      "total_amount": {"value": "12500.00"}
    },
    "items": [
      {
        "item_description": {"value": "Služba A"},
        "item_amount": {"value": "10000.00"}
      }
    ],
    "filename": "Faktura_2025_opravena.pdf",
    "documentClass": "czech_invoice",
    "externalId": "EXT-FA-2025-001",
    "markDocumentAsValidated": true,
    "markDocumentAsSavedOnly": false
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/documents/{documentId}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl aktualizován.
400	Neplatné parametry požadavku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.
404	Dokument neexistuje.

Přejmenování dokumentu

Dokument přejmenujete pomocí endpointu PUT /v1/documents/{documentId}/rename.

# Přejmenování dokumentu
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "Faktura_2025_opravena.pdf"
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/rename"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/documents/{documentId}/rename

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl přejmenován.
400	Neplatné parametry požadavku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.
404	Dokument neexistuje.

Smazání dokumentu

Dokument smažete pomocí endpointu DELETE /v1/documents/{documentId}.

# Smazání dokumentu
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/documents/{documentId}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl smazán.
400	Neplatné parametry požadavku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.
404	Dokument neexistuje.

Hromadné smazání dokumentů

Více dokumentů najednou smažete pomocí endpointu DELETE /v1/documents/delete.

# Hromadné smazání dokumentů
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '["0e9d4b614e1f4befa24c8649f63d8ede", "1a2b3c4d5e6f7g8h9i0j"]' \
  "https://api.redque.com/v1/documents/delete"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/documents/delete

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokumenty byly smazány.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Historie dokumentu

Historii změn dokumentu získáte pomocí endpointu GET /v1/documents/{documentId}/history.

# Získání historie dokumentu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/history"

# Odpověď serveru
{
  "items": [
    {
      "action": "Created",
      "timestamp": "2025-01-15T10:30:00.000Z",
      "user": "jan.novak@example.com"
    },
    {
      "action": "Extracted",
      "timestamp": "2025-01-15T10:35:00.000Z"
    }
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/history

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací historii dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Změna stavu dokumentu

Stav dokumentu změníte pomocí endpointu POST /v1/documents/{documentId}/state/change/{documentState}.

# Změna stavu dokumentu na Validated
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/state/change/Validated"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/state/change/{documentState}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
documentState	string	Povinný. Cílový stav dokumentu (`Extracted`, `Paused`, `Validated`).

HTTP odpovědi

Kód	Popis
200	Úspěch. Stav dokumentu byl změněn.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Hromadná aktualizace polí

Hodnoty polí více dokumentů najednou aktualizujete pomocí endpointu PATCH /v1/documents/fields/batchUpdate.

# Hromadná aktualizace polí
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "updates": [
      {
        "documentId": "0e9d4b614e1f4befa24c8649f63d8ede",
        "fields": {
          "invoice_number_sm": {"value": "FA2025002"},
          "payment_method": {"value": "bank_transfer"}
        },
        "markDocumentAsValidated": true,
        "markDocumentAsSavedOnly": false
      },
      {
        "documentId": "1a2b3c4d5e6f7g8h9i0j",
        "fields": {
          "invoice_number_sm": {"value": "FA2025003"}
        },
        "markDocumentAsValidated": false,
        "markDocumentAsSavedOnly": false
      }
    ]
  }' \
  "https://api.redque.com/v1/documents/fields/batchUpdate"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/documents/fields/batchUpdate

HTTP odpovědi

Kód	Popis
200	Úspěch. Pole dokumentů byla aktualizována.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Sloučení a vytěžení dokumentů

Více dokumentů sloučíte do jednoho a vytěžíte pomocí endpointu POST /v1/documents/merge-and-extract.

# Sloučení dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '["0e9d4b614e1f4befa24c8649f63d8ede", "1a2b3c4d5e6f7g8h9i0j"]' \
  "https://api.redque.com/v1/documents/merge-and-extract"

# Odpověď serveru
{
  "documentId": "c3d4e5f6g7h8i9j0k1l2"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/merge-and-extract

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokumenty byly sloučeny.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Získání enumů dokumentů

Hodnoty enumů pro pole dokumentů získáte pomocí endpointu POST /v1/documents/documents-enums.

# Získání enumů dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "documentClass": "czech_invoice",
    "accountingUnitId": "a1b2c3d4e5f6",
    "culture": "cs-CZ"
  }' \
  "https://api.redque.com/v1/documents/documents-enums"

# Odpověď serveru
{
  "payment_method": [
    {"key": "bank_transfer", "value": "Bankovní převod"}
  ],
  "currency": [
    {"key": "CZK", "value": "Česká koruna"}
  ]
}

HTTP požadavek

POST https://api.redque.com/v1/documents/documents-enums

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací enumy dokumentů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Hromadné schválení dokumentů

Více dokumentů najednou schválíte pomocí endpointu POST /v1/documents/approve.

# Hromadné schválení dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '["0e9d4b614e1f4befa24c8649f63d8ede", "1a2b3c4d5e6f7g8h9i0j"]' \
  "https://api.redque.com/v1/documents/approve"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/approve

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokumenty byly schváleny.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Odeslání zpětné vazby

Zpětnou vazbu k chybě vytěžení odešlete pomocí endpointu POST /v1/documents/feedback.

# Odeslání zpětné vazby
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "feedBackType": "ExtractionError",
    "note": "Chybně vytěžené číslo faktury - správně FA2025-001",
    "documentIds": ["0e9d4b614e1f4befa24c8649f63d8ede", "1a2b3c4d5e6f7g8h9i0j"]
  }' \
  "https://api.redque.com/v1/documents/feedback"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/feedback

HTTP odpovědi

Kód	Popis
200	Úspěch. Zpětná vazba byla odeslána.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Změna typu dokumentu

Typ dokumentu změníte pomocí endpointu POST /v1/documents/change-document-type.

# Změna typu dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '["0e9d4b614e1f4befa24c8649f63d8ede"]' \
  "https://api.redque.com/v1/documents/change-document-type?documentType=czech_invoice"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/change-document-type

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Cílový typ dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Typ dokumentů byl změněn.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Změna typu konkrétního dokumentu

Typ konkrétního dokumentu změníte pomocí endpointu POST /v1/documents/{documentId}/change-document-type/{documentType}.

# Změna typu dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/change-document-type/czech_invoice"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/change-document-type/{documentType}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
documentType	string	Povinný. Cílový typ dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Typ dokumentu byl změněn.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Spuštění exportu dokumentu

Export dokumentu spustíte pomocí endpointu POST /v1/documents/export.

# Spuštění exportu dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"documentId": "0e9d4b614e1f4befa24c8649f63d8ede"}' \
  "https://api.redque.com/v1/documents/export"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/export

HTTP odpovědi

Kód	Popis
200	Úspěch. Export dokumentu byl spuštěn.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Spuštění exportu více dokumentů

Export více dokumentů najednou spustíte pomocí endpointu POST /v1/documents/export/list.

# Spuštění exportu více dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '["0e9d4b614e1f4befa24c8649f63d8ede", "1a2b3c4d5e6f7g8h9i0j"]' \
  "https://api.redque.com/v1/documents/export/list"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/export/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Export dokumentů byl spuštěn.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Stažení exportovaných dokumentů

Exportované dokumenty stáhnete pomocí endpointu POST /v1/documents/files/export.

# Stažení exportovaných dokumentů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '["0e9d4b614e1f4befa24c8649f63d8ede"]' \
  "https://api.redque.com/v1/documents/files/export" \
  --output export.zip

HTTP požadavek

POST https://api.redque.com/v1/documents/files/export

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací soubory ke stažení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Označení dokumentů jako exportované

Dokumenty označíte jako exportované pomocí endpointu PATCH /v1/documents/markAsExported.

# Označení dokumentů jako exportované
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '[{"documentId": "0e9d4b614e1f4befa24c8649f63d8ede"}]' \
  "https://api.redque.com/v1/documents/markAsExported"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/documents/markAsExported

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokumenty byly označeny jako exportované.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Označení dokumentů jako neúspěšný export

Dokumenty označíte jako neúspěšně exportované pomocí endpointu PATCH /v1/documents/markAsExportFailure.

# Označení dokumentů jako neúspěšný export
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '[{"documentId": "0e9d4b614e1f4befa24c8649f63d8ede", "errorMessage": "Chyba připojení k účetnímu systému"}]' \
  "https://api.redque.com/v1/documents/markAsExportFailure"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/documents/markAsExportFailure

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokumenty byly označeny jako neúspěšně exportované.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vrácení dokumentu odesílateli

Dokument vrátíte odesílateli pomocí endpointu POST /v1/documents/{documentId}/return-to-issuer.

# Vrácení dokumentu odesílateli
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "recipientEmail": "dodavatel@example.com",
    "reason": "Chybějící příloha - prosíme o doplnění",
    "additionalDocuments": ["1a2b3c4d5e6f7g8h9i0j"]
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/return-to-issuer"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/return-to-issuer

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl vrácen odesílateli.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Opětovné vytěžení dokumentu

Dokument znovu zařadíte do fronty vytěžování pomocí endpointu POST /v1/documents/{documentId}/requeue-extraction.

# Opětovné vytěžení dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/requeue-extraction"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/requeue-extraction

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl zařazen do fronty vytěžování.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Opětovná validace dokumentu

Dokument znovu zařadíte do fronty validace pomocí endpointu POST /v1/documents/{documentId}/requeue-validation.

# Opětovná validace dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/requeue-validation"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/requeue-validation

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl zařazen do fronty validace.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Seznam uživatelů pro delegaci

Seznam uživatelů, kterým lze delegovat dokument, získáte pomocí endpointu GET /v1/documents/{documentId}/delegation/users/list.

# Získání seznamu uživatelů pro delegaci
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/delegation/users/list"

# Odpověď serveru
{
  "items": [
    {
      "email": "jan.novak@example.com",
      "name": "Jan Novák"
    }
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/delegation/users/list

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam uživatelů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Změna účetní jednotky dokumentu

Účetní jednotku dokumentu změníte pomocí endpointu POST /v1/documents/{documentId}/update-accounting-unit/{accountingUnitId}.

# Změna účetní jednotky dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/update-accounting-unit/a1b2c3d4e5f6"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/update-accounting-unit/{accountingUnitId}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
accountingUnitId	string	Povinný. ID účetní jednotky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Účetní jednotka dokumentu byla změněna.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Označení dokumentu jako exportovaný

Dokument označíte jako exportovaný (nebo archivovaný) pomocí endpointu POST /v1/documents/{documentId}/mark-as-exported.

# Označení dokumentu jako exportovaný
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/mark-as-exported"

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/mark-as-exported

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl označen jako exportovaný.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Nastavení vytěžování pouze z PDF

Nastavíte vytěžování dokumentu pouze z PDF pomocí endpointu POST /v1/documents/{documentId}/set-extraction-as-pdf-only.

# Nastavení vytěžování pouze z PDF
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/set-extraction-as-pdf-only"

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/set-extraction-as-pdf-only

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Nastavení bylo aplikováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Získání směnného kurzu dokumentu

Směnný kurz dokumentu získáte pomocí endpointu POST /v1/documents/{documentId}/document-exchange-rate.

# Získání směnného kurzu dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "CZK",
    "dateIssued": "2025-01-15T00:00:00.000Z"
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/document-exchange-rate"

# Odpověď serveru
{
  "exchangeRate": 25.5,
  "sourceCurrency": "EUR",
  "targetCurrency": "CZK"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/document-exchange-rate

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací směnný kurz.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Odeslání zpětné vazby k dokumentu

Zpětnou vazbu ke konkrétnímu dokumentu odešlete pomocí endpointu POST /v1/documents/{documentId}/feedback.

# Odeslání zpětné vazby k dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "feedBackType": "ExtractionError",
    "note": "Chybně vytěžené datum splatnosti"
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/feedback"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/feedback

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Zpětná vazba byla odeslána.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Získání validačních chyb

Validační chyby dokumentu získáte pomocí endpointu GET /v1/documents/{documentId}/validation-errors.

# Získání validačních chyb
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/validation-errors"

# Odpověď serveru
{
  "errors": [
    {
      "field": "invoice_number_sm",
      "message": "Číslo faktury je povinné"
    }
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/validation-errors

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací validační chyby.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Nastavení validačních chyb

Validační chyby dokumentu nastavíte pomocí endpointu PUT /v1/documents/{documentId}/validation-errors. Tento endpoint je určen pro externí validační webhooky.

# Nastavení validačních chyb
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "validationErrors": [
      {
        "fieldNames": ["invoice_number_sm"],
        "message": "Neplatný formát čísla faktury",
        "validationLevel": "Error"
      }
    ]
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/validation-errors"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/documents/{documentId}/validation-errors

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Validační chyby byly nastaveny.
400	Neplatné parametry požadavku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.
404	Dokument neexistuje.

Připojení dokumentu jako příloha

Dokument převedete na přílohu jiného dokumentu pomocí endpointu POST /v1/documents/{documentId}/attach-to-another-document.

# Připojení dokumentu jako příloha
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "attachToDocumentId": "1a2b3c4d5e6f7g8h9i0j"
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/attach-to-another-document"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/attach-to-another-document

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu, který bude převeden na přílohu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl připojen jako příloha.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Rozdělení dokumentu

Dokument rozdělíte na více dokumentů pomocí endpointu POST /v1/documents/{documentId}/split-document.

# Rozdělení dokumentu podle stránek
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '[1, 3, 5]' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/split-document"

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/split-document

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

Tělo požadavku

Pole indexů stránek (integer), podle kterých se dokument rozdělí.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl rozdělen.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

QR kód pro platbu

QR kód pro platbu dokumentu získáte pomocí endpointu GET /v1/documents/{documentId}/qr-payment.

# Získání QR kódu pro platbu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/qr-payment"

# Odpověď serveru
{
  "qrCode": "SPD*1.0*ACC:CZ6508000000192000145399*AM:1234.56*CC:CZK..."
}

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/qr-payment

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací QR kód pro platbu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Hodnoty enumů dokumentu

Hodnoty enumů pro konkrétní dokument získáte pomocí endpointu POST /v1/documents/{documentId}/document-enum-values.

# Získání hodnot enumů dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "documentClass": "czech_invoice",
    "culture": "cs-CZ",
    "fields": {
      "payment_method": {"value": ""}
    },
    "accountingUnitId": "a1b2c3d4e5f6"
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/document-enum-values"

# Odpověď serveru
[
  {
    "value": "bank_transfer",
    "label": "Bankovní převod"
  },
  {
    "value": "cash",
    "label": "Hotovost"
  }
]

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/document-enum-values

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací hodnoty enumů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Získání firmy z ARES

Informace o firmě (dodavateli nebo odběrateli) z registru ARES získáte pomocí endpointu POST /v1/documents/{documentId}/company-from-ares.

# Získání firmy z ARES
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": "12345678",
    "companyVatId": "CZ12345678"
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/company-from-ares"

# Odpověď serveru
{
  "name": "Ukázková firma s.r.o.",
  "ico": "12345678",
  "dic": "CZ12345678",
  "address": "Příkladná 123, 110 00 Praha"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/company-from-ares

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o firmě.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Rotace stránky dokumentu

Stránku dokumentu otočíte pomocí endpointu POST /v1/documents/{documentId}/rotate-page.

# Rotace stránky o 90 stupňů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/rotate-page?pageRotationAngle=90"

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/rotate-page

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
pageRotationAngle	integer	Úhel rotace stránky (90, 180 nebo 270 stupňů).

HTTP odpovědi

Kód	Popis
200	Úspěch. Stránka byla otočena.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Email data dokumentu

Metadata emailu, ze kterého byl dokument nahrán, získáte pomocí endpointu GET /v1/documents/{documentId}/email-data.

# Získání email dat dokumentu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/email-data"

# Odpověď serveru
{
  "from": "dodavatel@example.com",
  "to": "faktury@firma.cz",
  "subject": "Faktura 2025001",
  "receivedAt": "2025-01-15T10:30:00.000Z"
}

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/email-data

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací email data dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Přílohy

Nahrání přílohy

Přílohu k dokumentu nahrajete pomocí endpointu POST /v1/documents/{documentId}/attachments.

# Nahrání přílohy k dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -F "File=@priloha.pdf" \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/attachments"

# Odpověď serveru
{
  "attachmentId": "a1b2c3d4e5f6"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/attachments

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
File	binary	Povinný. Soubor přílohy (multipart/form-data).

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID přílohy.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Stažení přílohy

Přílohu stáhnete pomocí endpointu GET /v1/documents/{documentId}/attachments/{attachmentId}/file.

# Stažení přílohy
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/attachments/a1b2c3d4e5f6/file" \
  --output priloha.pdf

HTTP požadavek

GET https://api.redque.com/v1/documents/{documentId}/attachments/{attachmentId}/file

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
attachmentId	string	Povinný. ID přílohy.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací soubor přílohy.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Přejmenování přílohy

Přílohu přejmenujete pomocí endpointu POST /v1/documents/{documentId}/attachments/{attachmentId}/rename.

# Přejmenování přílohy
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "nova_priloha.pdf"
  }' \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/attachments/a1b2c3d4e5f6/rename"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/attachments/{attachmentId}/rename

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
attachmentId	string	Povinný. ID přílohy.

HTTP odpovědi

Kód	Popis
200	Úspěch. Příloha byla přejmenována.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Převod přílohy na dokument

Přílohu převedete na samostatný dokument pomocí endpointu POST /v1/documents/{documentId}/attachments/{attachmentId}/change-to-document.

# Převod přílohy na dokument
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/attachments/a1b2c3d4e5f6/change-to-document"

# Odpověď serveru
{
  "documentId": "b2c3d4e5f6a7b8c9d0e1"
}

HTTP požadavek

POST https://api.redque.com/v1/documents/{documentId}/attachments/{attachmentId}/change-to-document

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
attachmentId	string	Povinný. ID přílohy.

HTTP odpovědi

Kód	Popis
200	Úspěch. Příloha byla převedena na dokument.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Smazání přílohy

Přílohu smažete pomocí endpointu DELETE /v1/documents/{documentId}/attachments/{attachmentId}.

# Smazání přílohy
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede/attachments/a1b2c3d4e5f6"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/documents/{documentId}/attachments/{attachmentId}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
attachmentId	string	Povinný. ID přílohy.

HTTP odpovědi

Kód	Popis
200	Úspěch. Příloha byla smazána.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Schvalovací workflow

Seznam dokumentů ke schválení (zastaralé)

Seznam dokumentů čekajících na schválení získáte pomocí endpointu POST /v1/approval/list.

# Získání seznamu dokumentů ke schválení
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "faktura",
    "filter": {
      "state": {
        "values": ["WaitingForApproval"]
      },
      "approvalState": {
        "values": ["Pending"]
      }
    },
    "control": {
      "skip": 0,
      "take": 20
    },
    "sort": {
      "field": "createdAt",
      "direction": "Desc"
    }
  }' \
  "https://api.redque.com/v1/approval/list"

# Odpověď serveru
{
  "items": [
    {
      "id": "0e9d4b614e1f4befa24c8649f63d8ede",
      "fileName": "Faktura_2025.pdf",
      "state": "WaitingForApproval"
    }
  ],
  "totalCount": 1
}

HTTP požadavek

POST https://api.redque.com/v1/approval/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam dokumentů ke schválení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Počet dokumentů ke schválení (zastaralé)

Počet dokumentů čekajících na schválení získáte pomocí endpointu POST /v1/approval/count.

# Získání počtu dokumentů ke schválení
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "",
    "filter": {
      "state": {
        "values": ["WaitingForApproval"]
      },
      "approvalState": {
        "values": ["Pending"]
      }
    }
  }' \
  "https://api.redque.com/v1/approval/count"

# Odpověď serveru
5

HTTP požadavek

POST https://api.redque.com/v1/approval/count

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací počet dokumentů ke schválení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení sloupců pro schvalování

Nastavení sloupců pro zobrazení schvalovacího workflow získáte pomocí endpointu POST /v1/approval/columnSettings.

# Získání nastavení sloupců
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/approval/columnSettings"

# Odpověď serveru
[
  {
    "fieldName": "invoice_number_sm",
    "label": "Číslo faktury",
    "visible": true
  }
]

HTTP požadavek

POST https://api.redque.com/v1/approval/columnSettings

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací nastavení sloupců.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Spuštění schvalovacího workflow

Schvalovací workflow pro dokument spustíte pomocí endpointu POST /v1/approval/{documentId}/workflow/start.

# Spuštění schvalovacího workflow
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/approval/0e9d4b614e1f4befa24c8649f63d8ede/workflow/start"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/approval/{documentId}/workflow/start

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Workflow bylo spuštěno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Restart schvalovacího workflow

Schvalovací workflow restartujete od začátku pomocí endpointu POST /v1/approval/{documentId}/workflow/restart.

# Restart schvalovacího workflow
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/approval/0e9d4b614e1f4befa24c8649f63d8ede/workflow/restart"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/approval/{documentId}/workflow/restart

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Workflow bylo restartováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Historie schvalovacího workflow

Historii schvalovacího workflow dokumentu získáte pomocí endpointu GET /v1/approval/{documentId}/workflow-data.

# Získání historie workflow
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/approval/0e9d4b614e1f4befa24c8649f63d8ede/workflow-data"

# Odpověď serveru
{
  "steps": [
    {
      "stepName": "Schválení vedoucím",
      "approvedBy": "jan.novak@example.com",
      "approvedAt": "2025-01-15T10:30:00.000Z",
      "status": "Approved"
    }
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/approval/{documentId}/workflow-data

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací historii workflow.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Schválení dokumentu

Dokument schválíte a posunete do dalšího kroku workflow pomocí endpointu POST /v1/approval/{documentId}/approve.

# Schválení dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Schváleno vedoucím oddělení"
  }' \
  "https://api.redque.com/v1/approval/0e9d4b614e1f4befa24c8649f63d8ede/approve"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/approval/{documentId}/approve

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl schválen.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Zamítnutí dokumentu

Dokument zamítnete a zastavíte schvalovací workflow pomocí endpointu POST /v1/approval/{documentId}/reject.

# Zamítnutí dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Chybné údaje na faktuře - IČO neodpovídá"
  }' \
  "https://api.redque.com/v1/approval/0e9d4b614e1f4befa24c8649f63d8ede/reject"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/approval/{documentId}/reject

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl zamítnut.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Delegování schválení

Dokument delegujete ke schválení jinému uživateli pomocí endpointu POST /v1/approval/{documentId}/delegate/{toUserEmail}.

# Delegování dokumentu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Prosím o schválení, jsem na dovolené"
  }' \
  "https://api.redque.com/v1/approval/0e9d4b614e1f4befa24c8649f63d8ede/delegate/kolega@example.com"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/approval/{documentId}/delegate/{toUserEmail}

Parametry požadavku

Parametr	Typ	Popis
documentId	string	Povinný. ID dokumentu.
toUserEmail	string	Povinný. Email uživatele, kterému se dokument deleguje.

HTTP odpovědi

Kód	Popis
200	Úspěch. Dokument byl delegován.
401	Chybějící nebo neplatný přístupový token.
403	Přístup k dokumentu odepřen.

Účetní jednotky

Vytvoření účetní jednotky

Novou účetní jednotku vytvoříte pomocí endpointu POST /v1/accounting-unit.

# Vytvoření účetní jednotky
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Firma s.r.o.",
    "customerId": "12345678",
    "customerVatId": "CZ12345678",
    "email": "info@firma.cz",
    "emails": ["fakturace@firma.cz", "ucetni@firma.cz"],
    "itemsExportSettings": "DefaultExportSettings",
    "isVatPayer": true,
    "isSingleEntryAccounting": false,
    "externalId": "EXT001"
  }' \
  "https://api.redque.com/v1/accounting-unit"

# Odpověď serveru
{
  "accountingUnitId": "a1b2c3d4e5f6"
}

HTTP požadavek

POST https://api.redque.com/v1/accounting-unit

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID vytvořené účetní jednotky.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.
500	Chyba při vytváření účetní jednotky.

Získání účetní jednotky

Detail účetní jednotky získáte pomocí endpointu GET /v1/accounting-unit/{accountingUnitId}.

# Získání účetní jednotky
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/accounting-unit/a1b2c3d4e5f6"

# Odpověď serveru
{
  "id": "a1b2c3d4e5f6",
  "name": "Firma s.r.o.",
  "ico": "12345678",
  "dic": "CZ12345678"
}

HTTP požadavek

GET https://api.redque.com/v1/accounting-unit/{accountingUnitId}

Parametry požadavku

Parametr	Typ	Popis
accountingUnitId	string	Povinný. ID účetní jednotky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací detail účetní jednotky.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace účetní jednotky

Účetní jednotku aktualizujete pomocí endpointu POST /v1/accounting-unit/{accountingUnitId}.

# Aktualizace účetní jednotky
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "accountingUnitId": "a1b2c3d4e5f6",
    "name": "Nový název s.r.o.",
    "customerId": "12345678",
    "customerVatId": "CZ12345678",
    "email": "novy@email.cz",
    "emails": ["fakturace@firma.cz"],
    "itemsExportSettings": "Export",
    "isVatPayer": true,
    "isSingleEntryAccounting": false,
    "externalId": "EXT001"
  }' \
  "https://api.redque.com/v1/accounting-unit/a1b2c3d4e5f6"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/accounting-unit/{accountingUnitId}

Parametry požadavku

Parametr	Typ	Popis
accountingUnitId	string	Povinný. ID účetní jednotky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Účetní jednotka byla aktualizována.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.
500	Interní chyba serveru.

Smazání účetní jednotky

Účetní jednotku smažete pomocí endpointu DELETE /v1/accounting-unit/{accountingUnitId}.

# Smazání účetní jednotky
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/accounting-unit/a1b2c3d4e5f6"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/accounting-unit/{accountingUnitId}

Parametry požadavku

Parametr	Typ	Popis
accountingUnitId	string	Povinný. ID účetní jednotky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Účetní jednotka byla smazána.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.
500	Interní chyba serveru.

Získání vlastní účetní jednotky

Primární účetní jednotku aktuálního uživatele získáte pomocí endpointu GET /v1/accounting-unit/my.

# Získání vlastní účetní jednotky
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/accounting-unit/my"

# Odpověď serveru
{
  "id": "a1b2c3d4e5f6",
  "name": "Moje firma s.r.o.",
  "ico": "12345678"
}

HTTP požadavek

GET https://api.redque.com/v1/accounting-unit/my

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací účetní jednotku uživatele.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Seznam účetních jednotek

Seznam všech účetních jednotek získáte pomocí endpointu POST /v1/accounting-unit/list.

# Získání seznamu účetních jednotek
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "firma",
    "filter": {
      "customerId": {
        "values": ["12345678"]
      }
    }
  }' \
  "https://api.redque.com/v1/accounting-unit/list"

# Odpověď serveru
{
  "items": [
    {
      "id": "a1b2c3d4e5f6",
      "name": "Firma s.r.o.",
      "ico": "12345678"
    }
  ],
  "totalCount": 1
}

HTTP požadavek

POST https://api.redque.com/v1/accounting-unit/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam účetních jednotek.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.
500	Interní chyba serveru.

Typy dokumentů

Lokalizované typy dokumentů (zastaralé)

Lokalizované typy dokumentů získáte pomocí endpointu GET /v1/document-types/localized.

# Získání lokalizovaných typů dokumentů
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/localized?culture=cs-CZ"

# Odpověď serveru
[
  {
    "documentType": "czech_invoice",
    "name": "Česká faktura"
  },
  {
    "documentType": "slovak_invoice",
    "name": "Slovenská faktura"
  }
]

HTTP požadavek

GET https://api.redque.com/v1/document-types/localized

Parametry požadavku

Parametr	Typ	Popis
culture	string	Kultura pro lokalizaci (např. `cs-CZ`).

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací lokalizované typy dokumentů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktivní typy dokumentů

Aktivní typy dokumentů pro tenanta získáte pomocí endpointu GET /v1/document-types/active.

# Získání aktivních typů dokumentů
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/active?culture=cs-CZ"

# Odpověď serveru
[
  {
    "documentType": "czech_invoice",
    "name": "Česká faktura",
    "isDefault": true
  }
]

HTTP požadavek

GET https://api.redque.com/v1/document-types/active

Parametry požadavku

Parametr	Typ	Popis
culture	string	Kultura pro lokalizaci (např. `cs-CZ`).
includeNumberOfNewDocuments	boolean	Zahrnout počet nových dokumentů. Výchozí: `false`.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací aktivní typy dokumentů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Dostupné typy dokumentů

Dostupné typy dokumentů pro tenanta získáte pomocí endpointu GET /v1/document-types/available.

# Získání dostupných typů dokumentů
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/available?culture=cs-CZ"

# Odpověď serveru
[
  {
    "documentType": "czech_invoice",
    "name": "Česká faktura",
    "isActive": true
  },
  {
    "documentType": "receipt",
    "name": "Účtenka",
    "isActive": false
  }
]

HTTP požadavek

GET https://api.redque.com/v1/document-types/available

Parametry požadavku

Parametr	Typ	Popis
culture	string	Kultura pro lokalizaci (např. `cs-CZ`).

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací dostupné typy dokumentů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktivace/deaktivace typu dokumentu

Typ dokumentu aktivujete nebo deaktivujete pomocí endpointu PATCH /v1/document-types/{documentType}/active.

# Aktivace typu dokumentu
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/active?isActive=true"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/document-types/{documentType}/active

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
isActive	boolean	Příznak aktivace.

HTTP odpovědi

Kód	Popis
200	Úspěch. Typ dokumentu byl aktivován/deaktivován.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Změna pořadí typu dokumentu

Pořadí typu dokumentu změníte pomocí endpointu PATCH /v1/document-types/{documentType}/changeOrder.

# Změna pořadí typu dokumentu
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/changeOrder?order=1"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/document-types/{documentType}/changeOrder

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
order	integer	Nové pořadí.

HTTP odpovědi

Kód	Popis
200	Úspěch. Pořadí bylo změněno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení výchozího typu dokumentu

Typ dokumentu nastavíte jako výchozí pomocí endpointu PATCH /v1/document-types/{documentType}/default.

# Nastavení výchozího typu dokumentu
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/default"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/document-types/{documentType}/default

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Typ dokumentu byl nastaven jako výchozí.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Detail typu dokumentu

Detail typu dokumentu získáte pomocí endpointu GET /v1/document-types/{documentType}/detail.

# Získání detailu typu dokumentu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/detail?culture=cs-CZ"

# Odpověď serveru
{
  "documentType": "czech_invoice",
  "name": "Česká faktura",
  "isDefault": true,
  "order": 1,
  "isActive": true
}

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/detail

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
culture	string	Kultura pro lokalizaci.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací detail typu dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Definice typu dokumentu

Definici polí typu dokumentu získáte pomocí endpointu GET /v1/document-types/{documentType}/definition.

# Získání definice typu dokumentu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/definition?culture=cs-CZ"

# Odpověď serveru
{
  "documentType": "czech_invoice",
  "fields": [
    {
      "name": "invoice_number_sm",
      "label": "Číslo faktury",
      "type": "TEXT",
      "isRequired": true
    }
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/definition

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
culture	string	Kultura pro lokalizaci.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací definici polí.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vyhledávání hodnot pole

Hodnoty pole vyhledáte pomocí endpointu GET /v1/document-types/{documentType}/field/{fieldName}/search-values.

# Vyhledávání hodnot pole
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/field/invoice_number_sm/search-values?searchQuery=FA2025"

# Odpověď serveru
[
  "FA2025001",
  "FA2025002",
  "FA2025003"
]

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/field/{fieldName}/search-values

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
fieldName	string	Povinný. Název pole.
searchQuery	string	Vyhledávací dotaz.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací nalezené hodnoty.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Hodnoty enumu pole

Hodnoty enumu pro pole získáte pomocí endpointu GET /v1/document-types/{documentType}/field/{fieldName}/enum-values/{culture}.

# Získání hodnot enumu pole
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/field/payment_method/enum-values/cs-CZ"

# Odpověď serveru
[
  {
    "key": "bank_transfer",
    "value": "Bankovní převod"
  },
  {
    "key": "cash",
    "value": "Hotovost"
  }
]

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/field/{fieldName}/enum-values/{culture}

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
fieldName	string	Povinný. Název pole.
culture	string	Povinný. Kultura pro lokalizaci.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací hodnoty enumu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Hodnoty enumů více polí

Hodnoty enumů pro více polí získáte pomocí endpointu GET /v1/document-types/{documentType}/fields/enum-values/{culture}.

# Získání hodnot enumů více polí
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/fields/enum-values/cs-CZ"

# Odpověď serveru
{
  "payment_method": [
    {"key": "bank_transfer", "value": "Bankovní převod"}
  ],
  "currency": [
    {"key": "CZK", "value": "Česká koruna"}
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/fields/enum-values/{culture}

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
culture	string	Povinný. Kultura pro lokalizaci.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací hodnoty enumů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace typu dokumentu

Definici typu dokumentu aktualizujete pomocí endpointu PUT /v1/document-types/{documentType}.

# Aktualizace typu dokumentu
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "documentTypeSettings": {
      "isDefault": true,
      "extractItems": true,
      "extractNoteFromIsdoc": false,
      "replaceVariableSymbolWithInvoiceNumber": true
    },
    "createdFields": [],
    "updatedFields": {},
    "deletedFields": [],
    "deletedItemFields": []
  }' \
  "https://api.redque.com/v1/document-types/czech_invoice"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/document-types/{documentType}

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Typ dokumentu byl aktualizován.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Pole typu dokumentu

Pole typu dokumentu získáte pomocí endpointu GET /v1/document-types/{documentType}/fields.

# Získání polí typu dokumentu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/fields"

# Odpověď serveru
[
  {
    "name": "invoice_number_sm",
    "type": "TEXT",
    "isRequired": true
  },
  {
    "name": "total_amount",
    "type": "DECIMAL",
    "isRequired": false
  }
]

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/fields

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací pole typu dokumentu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Exportní formáty typu dokumentu

Podporované exportní formáty pro typ dokumentu získáte pomocí endpointu GET /v1/document-types/{documentType}/frontendExportTypes.

# Získání exportních formátů
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/frontendExportTypes"

# Odpověď serveru
[
  {
    "type": "json",
    "name": "JSON"
  },
  {
    "type": "xml",
    "name": "XML"
  },
  {
    "type": "isdoc",
    "name": "ISDOC"
  }
]

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/frontendExportTypes

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací exportní formáty.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vytvoření pole

Nové pole typu dokumentu vytvoříte pomocí endpointu POST /v1/document-types/{documentType}/field.

# Vytvoření pole
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "fieldName": "custom_field",
    "fieldType": "TEXT",
    "state": "Visible",
    "label": {
      "cs-CZ": "Vlastní pole",
      "en-US": "Custom field"
    },
    "isItemField": false,
    "exportMapping": "None",
    "editInApprovalWorkflow": true,
    "requiredInApprovalWorkflow": false
  }' \
  "https://api.redque.com/v1/document-types/czech_invoice/field"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/document-types/{documentType}/field

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Pole bylo vytvořeno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace pole

Pole typu dokumentu aktualizujete pomocí endpointu PUT /v1/document-types/{documentType}/field/{field}.

# Aktualizace pole
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "state": "Visible",
    "label": {
      "cs-CZ": "Aktualizovaný popis",
      "en-US": "Updated description"
    },
    "isItemField": false,
    "exportMapping": "None",
    "editInApprovalWorkflow": true,
    "requiredInApprovalWorkflow": false
  }' \
  "https://api.redque.com/v1/document-types/czech_invoice/field/custom_field"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/document-types/{documentType}/field/{field}

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
field	string	Povinný. Název pole.

HTTP odpovědi

Kód	Popis
200	Úspěch. Pole bylo aktualizováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání pole

Pole typu dokumentu smažete pomocí endpointu DELETE /v1/document-types/{documentType}/field/{field}.

# Smazání pole
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/field/custom_field"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/document-types/{documentType}/field/{field}

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.
field	string	Povinný. Název pole.

HTTP odpovědi

Kód	Popis
200	Úspěch. Pole bylo smazáno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Účastníci emailu

Seznam možných odesílatelů a příjemců pro dokumenty získáte pomocí endpointu GET /v1/document-types/{documentType}/email_participants.

# Získání účastníků emailu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/czech_invoice/email_participants"

# Odpověď serveru
{
  "senders": ["dodavatel@example.com"],
  "recipients": ["faktury@firma.cz"]
}

HTTP požadavek

GET https://api.redque.com/v1/document-types/{documentType}/email_participants

Parametry požadavku

Parametr	Typ	Popis
documentType	string	Povinný. Identifikátor typu dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací účastníky emailu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Lokalizovaná pole aktivních typů

Lokalizovaná pole aktivních typů dokumentů získáte pomocí endpointu GET /v1/document-types/localized/fields.

# Získání lokalizovaných polí
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/document-types/localized/fields?culture=cs-CZ"

# Odpověď serveru
{
  "czech_invoice": [
    {"name": "invoice_number_sm", "label": "Číslo faktury"},
    {"name": "total_amount", "label": "Celková částka"}
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/document-types/localized/fields

Parametry požadavku

Parametr	Typ	Popis
culture	string	Kultura pro lokalizaci.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací lokalizovaná pole.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Společná podmíněná pole

Společná podmíněná pole pro typy dokumentů získáte pomocí endpointu POST /v1/document-types/common-conditional-fields/doctypes.

# Získání společných podmíněných polí
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "docTypes": ["czech_invoice", "slovak_invoice"]
  }' \
  "https://api.redque.com/v1/document-types/common-conditional-fields/doctypes"

# Odpověď serveru
[
  "invoice_number_sm",
  "total_amount"
]

HTTP požadavek

POST https://api.redque.com/v1/document-types/common-conditional-fields/doctypes

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací společná podmíněná pole.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Dashboardy

Generování dat dashboardu

Data pro dashboard vygenerujete pomocí endpointu POST /v1/dashboards/generateData.

# Generování dat dashboardu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "dashboardType": "DocumentsOverview",
    "accountingUnitIds": ["a1b2c3d4e5f6", "g7h8i9j0k1l2"]
  }' \
  "https://api.redque.com/v1/dashboards/generateData"

# Odpověď serveru
{
  "labels": ["Leden", "Únor", "Březen"],
  "datasets": [
    {
      "label": "Zpracované dokumenty",
      "data": [45, 52, 48]
    }
  ]
}

HTTP požadavek

POST https://api.redque.com/v1/dashboards/generateData

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací data dashboardu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Externí datové tabulky

Seznam datových tabulek

Všechny datové tabulky (bez položek) získáte pomocí endpointu GET /v1/external-data-tables.

# Získání seznamu datových tabulek
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/external-data-tables"

# Odpověď serveru
[
  {
    "id": "a1b2c3d4e5f6",
    "name": "suppliers",
    "description": "Seznam dodavatelů"
  }
]

HTTP požadavek

GET https://api.redque.com/v1/external-data-tables

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam datových tabulek.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vytvoření datové tabulky

Novou datovou tabulku vytvoříte pomocí endpointu POST /v1/external-data-tables.

# Vytvoření datové tabulky
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "suppliers",
    "values": [
      {"key": "SUP001", "value": "Dodavatel A s.r.o."},
      {"key": "SUP002", "value": "Partner B a.s."}
    ]
  }' \
  "https://api.redque.com/v1/external-data-tables"

# Odpověď serveru
{
  "id": "a1b2c3d4e5f6",
  "name": "suppliers"
}

HTTP požadavek

POST https://api.redque.com/v1/external-data-tables

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací vytvořenou datovou tabulku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Získání datové tabulky

Konkrétní datovou tabulku získáte pomocí endpointu GET /v1/external-data-tables/{id}.

# Získání datové tabulky
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/external-data-tables/a1b2c3d4e5f6"

# Odpověď serveru
{
  "id": "a1b2c3d4e5f6",
  "name": "suppliers",
  "description": "Seznam dodavatelů",
  "items": [
    {
      "key": "SUP001",
      "value": "Dodavatel A s.r.o."
    }
  ]
}

HTTP požadavek

GET https://api.redque.com/v1/external-data-tables/{id}

Parametry požadavku

Parametr	Typ	Popis
id	string	Povinný. ID datové tabulky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací datovou tabulku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nahrazení hodnot datové tabulky

Všechny hodnoty v datové tabulce nahradíte pomocí endpointu PUT /v1/external-data-tables/{id}.

# Nahrazení hodnot datové tabulky
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "suppliers",
    "values": [
      {"key": "SUP001", "value": "Nový dodavatel A s.r.o."},
      {"key": "SUP002", "value": "Nový dodavatel B a.s."},
      {"key": "SUP003", "value": "Nový dodavatel C"}
    ]
  }' \
  "https://api.redque.com/v1/external-data-tables/a1b2c3d4e5f6"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/external-data-tables/{id}

Parametry požadavku

Parametr	Typ	Popis
id	string	Povinný. ID datové tabulky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Hodnoty byly nahrazeny.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Úprava hodnot datové tabulky

Hodnoty v datové tabulce upravíte (upsert) pomocí endpointu PATCH /v1/external-data-tables/{id}.

# Úprava hodnot datové tabulky
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "add": [
      {"key": "SUP004", "value": "Nový dodavatel D"}
    ],
    "update": [
      {"key": "SUP002", "value": "Dodavatel B - aktualizováno"}
    ],
    "remove": [
      {"key": "SUP001", "value": "Dodavatel A s.r.o."}
    ]
  }' \
  "https://api.redque.com/v1/external-data-tables/a1b2c3d4e5f6"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/external-data-tables/{id}

Parametry požadavku

Parametr	Typ	Popis
id	string	Povinný. ID datové tabulky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Hodnoty byly upraveny.
400	Chybný požadavek.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání datové tabulky

Datovou tabulku smažete pomocí endpointu DELETE /v1/external-data-tables/{id}.

# Smazání datové tabulky
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/external-data-tables/a1b2c3d4e5f6"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/external-data-tables/{id}

Parametry požadavku

Parametr	Typ	Popis
id	string	Povinný. ID datové tabulky.

HTTP odpovědi

Kód	Popis
200	Úspěch. Datová tabulka byla smazána.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vyhledávání v datové tabulce

Hodnoty v datové tabulce vyhledáte pomocí endpointu GET /v1/external-data-tables/table/{tableName}/search-enums.

# Vyhledávání v datové tabulce
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/external-data-tables/table/suppliers/search-enums?query=Dodavatel&skip=0&take=10"

# Odpověď serveru
[
  {
    "key": "SUP001",
    "value": "Dodavatel A s.r.o."
  }
]

HTTP požadavek

GET https://api.redque.com/v1/external-data-tables/table/{tableName}/search-enums

Parametry požadavku

Parametr	Typ	Popis
tableName	string	Povinný. Název datové tabulky.
query	string	Povinný. Vyhledávací dotaz.
skip	integer	Povinný. Počet přeskočených záznamů.
take	integer	Povinný. Počet vrácených záznamů.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací nalezené hodnoty.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vytěžení dokumentu

Redque API podporuje dva základní způsoby vytěžování dokumentu - Vložení dokumentu a Vytěžení bez uložení. V obou případech dojde automaticky k vytěžení dokumentu, avšak při Vložení dokumentu je dokument po skončení vytěžování nadále k dispozici a uživatel s ním pak může dále pracovat (ať již přes API, nebo ve webové aplikaci Alice). Při Vytěžení bez uložení je dokument pouze vytěžen, ale není nikde uložen.

Vložení dokumentu

Dokument se vkládá pomocí endpointu POST /v1/documents, dokument je dostupný jak přes API tak v aplikaci Alice.

# Vložení dokumentu Ukazkovy_dokument.pdf z lokálního počítače
curl -X POST \
  'https://api.redque.com/v1/documents' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -F 'File=@Ukazkovy_dokument.pdf'

# Odpověď serveru
HTTP/1.1 200 OK

{
  "documentId": "0e9d4b614e1f4befa24c8649f63d8ede"
}

Dokument lze načíst pomocí endpointu GET /v1/documents/{documentId} pomocí jeho ID, s dokumentem lze pak pomocí jeho ID pracovat i v ostatních endpointech API.

Kompletní seznam výchozích polí dokumentu naleznete zde.

# Vyžádání dokumentu pomocí ID získaného v předchozím volání
curl -X GET \
  'https://api.redque.com/v1/documents/0e9d4b614e1f4befa24c8649f63d8ede' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...'

# Odpověď serveru
HTTP/1.1 200 OK

{
  "id": "0e9d4b614e1f4befa24c8649f63d8ede",
  "fileName": "Ukazkovy_dokument.pdf",
  "externalDocumentId": null,
  "state": "Extracted",
  "documentClass": "czech_invoice",
  "approvalState": "None",
  "source": "Api",
  "accountingUnitId": "a1b2c3d4e5f6",
  "pageCount": 1,
  "creationTime": "2024-07-15T10:00:00.000Z",
  "extractionTime": "2024-07-15T10:00:15.000Z",
  "contentType": "application/pdf",
  "isExtractedByFormat": false,
  "canBeExported": true,
  "canBeApproved": true,
  "canBeSentToApproval": true,
  "canBeShownInApproval": true,
  "fields": {
    "invoice_number_sm": {
      "value": "FA987654",
      "wordIds": [1]
    },
    "issued_by_name_sm": {
      "value": "Smyšlená společnost s.r.o.",
      "wordIds": [0]
    },
    "issued_by_id_sm": {
      "value": "123456789",
      "wordIds": [16]
    }
  },
  "items": [],
  "pages": [],
  "fieldsHistory": [],
  "validationErrors": [],
  "documentExportHistory": [],
  "attachments": []
}

Vytěžení bez uložení

Dokument se odešle k vytěžení pomocí endpointu POST /v1/extract, kde je asynchronně zpracován. Dokument není v systému uložen - slouží pouze pro jednorázové vytěžení.

# Odeslání dokumentu Ukazkovy_dokument.pdf k vytěžování
curl -X POST \
  'https://api.redque.com/v1/extract' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -F 'file=@Ukazkovy_dokument.pdf'

# Odpověď serveru
HTTP/1.1 200 OK

{
  "operationId": "f71b007b9ba740f69f52655a8d92a1cc"
}

HTTP požadavek

POST https://api.redque.com/v1/extract

Parametry požadavku (query string)

Název	Typ	Popis
`externalDocumentId`	string	Vlastní ID dokumentu (volitelné).
`tag`	string	Identifikátor pro statistiky vytěžování (volitelné).
`extractFirstPageIndicesOnly`	boolean	Vrátí pouze indexy stránek, kde začínají jednotlivé dokumenty - používá se pro rozdělení velkého PDF na více dokumentů (volitelné).
`extractItems`	boolean	Vytěžení položek dokumentu. Je nadřazeno nastavení tenanta (volitelné).

Tělo požadavku

Požadavek používá multipart/form-data s polem file obsahujícím binární obsah dokumentu.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID operace pro získání výsledku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Získání vytěženého dokumentu

Výsledek vytěžení se získá pomocí endpointu GET /v1/extract/{operationId} za pomoci ID operace, který vrátil předchozí endpoint.

# Získání vytěženého dokumentu pomocí ID operace
curl -X GET \
  'https://api.redque.com/v1/extract/f71b007b9ba740f69f52655a8d92a1cc' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...'

# Odpověď serveru - vytěžování dokončeno
HTTP/1.1 200 OK

{
  "operationId": "7517a987-ba17-4625-ab96-9aa7ec5e876e",
  "documentClass": "czech_invoice",
  "extractionTime": "2024-07-15T11:22:00.708Z",
  "isRetrieved": true,
  "retrievedDate": "2024-07-15T11:22:31.326Z",
  "isSuccess": true,
  "fields": {
    "is_deposit_invoice": {
      "fieldName": "is_deposit_invoice",
      "fieldValue": "False",
      "fieldValueJson": false
    },
    "invoice_number_sm": {
      "fieldName": "invoice_number_sm",
      "fieldValue": "F2440655",
      "fieldValueJson": "F2440655"
    },
    "currency": {
      "fieldName": "currency",
      "fieldValue": "CZK",
      "fieldValueJson": "CZK"
    },
    "total_amount": {
      "fieldName": "total_amount",
      "fieldValue": "12500.00",
      "fieldValueJson": 12500.00
    },
    "issued_by_name_sm": {
      "fieldName": "issued_by_name_sm",
      "fieldValue": "Dodavatel s.r.o.",
      "fieldValueJson": "Dodavatel s.r.o."
    },
    "issued_by_id_sm": {
      "fieldName": "issued_by_id_sm",
      "fieldValue": "12345678",
      "fieldValueJson": "12345678"
    }
  },
  "items": []
}

# Odpověď serveru - vytěžování ještě neskončilo
HTTP/1.1 202 Accepted

Document is in state Extracting

HTTP požadavek

GET https://api.redque.com/v1/extract/{operationId}

Parametry požadavku

Název	Umístění	Typ	Popis
`operationId`	path	string	ID operace vrácené při odeslání dokumentu k vytěžení. Povinný.
`exportFormat`	query	string	Formát exportu: `Xml`, `ISDOC` nebo `Json`. Výchozí je `Json` (volitelné).

HTTP odpovědi

Kód	Popis
200	Zpracování dokumentu dokončeno. Vrací vytěžená data.
202	RedQue stále zpracovává dokument.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Rozdíl mezi fieldValue a fieldValueJson

fieldValue - hodnota pole jako extrahovaný řetězec
fieldValueJson - reprezentace hodnoty pole fieldValue dle typu pole. Pokud nelze hodnotu převést do odpovídajícího typu (např. do pole částka celkem se vytěží hodnota, která není číslo), je hodnota pole fieldValueJson prázdná (null).

Odpověď při extractFirstPageIndicesOnly

Pokud byl při odeslání dokumentu nastaven parametr extractFirstPageIndicesOnly=true, odpověď obsahuje pole firstPageIndicies s indexy stránek:

# Odpověď serveru při extractFirstPageIndicesOnly=true
HTTP/1.1 200 OK

{
  "operationId": "43464f45-665c-4b9b-9ba1-bfb1b0d67407",
  "extractionTime": "0001-01-01T00:00:00",
  "isRetrieved": false,
  "retrievedDate": "0001-01-01T00:00:00",
  "fields": {},
  "items": [],
  "isSuccess": true,
  "firstPageIndicies": [1, 2, 3]
}

Vytěžení z JSON (Base64)

Dokument můžete odeslat k vytěžení také pomocí JSON požadavku, kde je obsah dokumentu zakódovaný v Base64. Použijte endpoint POST /v1/extract/fromJson.

# Odeslání dokumentu k vytěžování pomocí JSON
curl -X POST \
  'https://api.redque.com/v1/extract/fromJson' \
  -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileName": "Faktura.pdf",
    "fileContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC...",
    "tag": "MojeIntegrace",
    "extractItems": true
  }'

# Odpověď serveru
HTTP/1.1 200 OK

{
  "operationId": "f71b007b9ba740f69f52655a8d92a1cc"
}

HTTP požadavek

POST https://api.redque.com/v1/extract/fromJson

Tělo požadavku (JSON)

Název	Typ	Povinný	Popis
`fileName`	string	Ano	Název souboru s příponou.
`fileContent`	string	Ano	Obsah souboru zakódovaný v Base64.
`tag`	string	Ne	Identifikátor pro statistiky vytěžování.
`extractFirstPageIndicesOnly`	boolean	Ne	Vrátí pouze indexy stránek, kde začínají jednotlivé dokumenty.
`extractItems`	boolean	Ne	Vytěžení položek dokumentu. Je nadřazeno nastavení tenanta.

Příklad těla požadavku

{
  "fileName": "TestFile.json",
  "fileContent": "ewogICAid2luc3Ryb20iOiB7CiAgICAgICJmYWt0dXJhLXZ5ZGFuYSI6IHsKICAgICAgICAgImlkIjogImV4dDpGQVYiLAogICAgICAgICAidHlwRG9rbCI6ICJjb2RlOkZBS1RVUkEiLAogICAgICAgICAiZmFrdHVydWoiOiB7CiAgICAgICAgICAgICJza2xhZG92eURva2wiOiAiZXh0OlZZREVKMTIzIgogICAgICAgICB9CiAgICAgIH0sCiAgICAgICJAdmVyc2lvbiI6ICIxLjAiCiAgIH0KfQ=="
}

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací ID operace pro získání výsledku.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Notifikace

Získání novinek

Aktuální novinky (RSS položky) získáte pomocí endpointu GET /v1/notifications.

# Získání novinek
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/notifications"

# Odpověď serveru
[
  {
    "title": "Nová verze aplikace",
    "description": "Byla vydána nová verze aplikace s vylepšeními.",
    "link": "https://www.redque.com/news/new-version",
    "pubDate": "2025-01-15T10:00:00.000Z"
  }
]

HTTP požadavek

GET https://api.redque.com/v1/notifications

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam novinek.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Tenant

Získání aktuálního tenanta

Informace o aktuálním tenantovi získáte pomocí endpointu GET /v1/tenant.

# Získání tenanta
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant"

# Odpověď serveru
{
  "id": "tenant123",
  "name": "Moje firma s.r.o."
}

HTTP požadavek

GET https://api.redque.com/v1/tenant

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o tenantovi.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Informace o účtu

Informace o účtu (statistiky licence, počty dokumentů) získáte pomocí endpointu GET /v1/tenant/accountInfo.

# Získání informací o účtu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/accountInfo"

# Odpověď serveru
{
  "documentsProcessed": 1234,
  "documentsLimit": 5000,
  "usersCount": 10
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/accountInfo

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o účtu.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Informace o licenci

Informace o licenci získáte pomocí endpointu GET /v1/tenant/license.

# Získání informací o licenci
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/license"

# Odpověď serveru
{
  "type": "Premium",
  "validUntil": "2026-01-01T00:00:00.000Z",
  "documentsPerMonth": 5000
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/license

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o licenci.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Ověření licence

Licenci ověříte pomocí endpointu GET /v1/tenant/verifylicense.

# Ověření licence
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/verifylicense"

# Odpověď serveru
{
  "isValid": true,
  "message": "Licence je platná"
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/verifylicense

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací stav licence.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Funkce tenanta

Získání funkcí

Funkce tenanta získáte pomocí endpointu GET /v1/tenant/features.

# Získání funkcí tenanta
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/features"

# Odpověď serveru
["Approval", "AccountingUnits", "DeductionDateAssignment"]

HTTP požadavek

GET https://api.redque.com/v1/tenant/features

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam funkcí.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace funkcí

Funkce tenanta aktualizujete pomocí endpointu POST /v1/tenant/features.

# Aktualizace funkcí tenanta
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '["feature1", "feature2"]' \
  "https://api.redque.com/v1/tenant/features"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/tenant/features

HTTP odpovědi

Kód	Popis
200	Úspěch. Funkce byly aktualizovány.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení exportu

Aktualizace nastavení exportu

Obecná nastavení exportu aktualizujete pomocí endpointu PUT /v1/tenant/export/settings.

# Aktualizace nastavení exportu
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "trigger": "Manual",
    "finishedAction": "Archive",
    "downloadNaming": "Original",
    "exportFormat": "json"
  }' \
  "https://api.redque.com/v1/tenant/export/settings"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/export/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Nastavení bylo aktualizováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení triggeru exportu (zastaralé)

Trigger exportu nastavíte pomocí endpointu PUT /v1/tenant/export/trigger.

# Nastavení triggeru exportu
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/export/trigger?trigger=Manual"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/export/trigger

HTTP odpovědi

Kód	Popis
200	Úspěch. Trigger byl nastaven.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Akce po dokončení exportu (zastaralé)

Akci po dokončení exportu nastavíte pomocí endpointu PUT /v1/tenant/export/finished.

# Nastavení akce po exportu
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/export/finished?action=Archive"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/export/finished

HTTP odpovědi

Kód	Popis
200	Úspěch. Akce byla nastavena.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Pojmenování při stahování (zastaralé)

Pojmenování dokumentů při stahování nastavíte pomocí endpointu PUT /v1/tenant/export/download/naming.

# Nastavení pojmenování
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/export/download/naming?naming=Original"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/export/download/naming

HTTP odpovědi

Kód	Popis
200	Úspěch. Pojmenování bylo nastaveno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Předvyplněné poznámky

Získání předvyplněných poznámek

Předvyplněné poznámky získáte pomocí endpointu GET /v1/tenant/prefilled-notes.

# Získání předvyplněných poznámek
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/prefilled-notes"

# Odpověď serveru
[
  {"text": "Poznámka 1"},
  {"text": "Poznámka 2"}
]

HTTP požadavek

GET https://api.redque.com/v1/tenant/prefilled-notes

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací předvyplněné poznámky.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace předvyplněných poznámek

Předvyplněné poznámky aktualizujete pomocí endpointu POST /v1/tenant/prefilled-notes.

# Aktualizace předvyplněných poznámek
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '[{"text": "Schváleno vedením"}]' \
  "https://api.redque.com/v1/tenant/prefilled-notes"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/tenant/prefilled-notes

HTTP odpovědi

Kód	Popis
200	Úspěch. Poznámky byly aktualizovány.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Datum zahájení odpočtu

Získání data zahájení odpočtu

Datum zahájení odpočtu získáte pomocí endpointu GET /v1/tenant/deduction-start-date.

# Získání data zahájení odpočtu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/deduction-start-date"

# Odpověď serveru
{
  "date": "2025-01-01"
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/deduction-start-date

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací datum.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení data zahájení odpočtu

Datum zahájení odpočtu nastavíte pomocí endpointu POST /v1/tenant/deduction-start-date.

# Nastavení data zahájení odpočtu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"date": "2025-01-01"}' \
  "https://api.redque.com/v1/tenant/deduction-start-date"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/tenant/deduction-start-date

HTTP odpovědi

Kód	Popis
200	Úspěch. Datum bylo nastaveno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Účetní systémy

Vytvoření účetního systému

Účetní systém vytvoříte pomocí endpointu POST /v1/tenant/accountingSystems.

# Vytvoření účetního systému
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Pohoda", "type": "Pohoda"}' \
  "https://api.redque.com/v1/tenant/accountingSystems"

# Odpověď serveru
{
  "id": "sys123",
  "name": "Pohoda",
  "type": "Pohoda"
}

HTTP požadavek

POST https://api.redque.com/v1/tenant/accountingSystems

HTTP odpovědi

Kód	Popis
200	Úspěch. Účetní systém byl vytvořen.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace účetního systému

Účetní systém aktualizujete pomocí endpointu PUT /v1/tenant/accountingSystems.

# Aktualizace účetního systému
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"id": "sys123", "name": "Pohoda Premium"}' \
  "https://api.redque.com/v1/tenant/accountingSystems"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/accountingSystems

HTTP odpovědi

Kód	Popis
200	Úspěch. Účetní systém byl aktualizován.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání účetního systému

Účetní systém smažete pomocí endpointu DELETE /v1/tenant/accountingSystems.

# Smazání účetního systému
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/accountingSystems?accountingSystemId=sys123"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/tenant/accountingSystems

Parametry požadavku

Parametr	Typ	Popis
accountingSystemId	string	ID účetního systému.

HTTP odpovědi

Kód	Popis
200	Úspěch. Účetní systém byl smazán.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Seznam účetních systémů

Seznam účetních systémů získáte pomocí endpointu POST /v1/tenant/accountingSystems/list.

# Získání seznamu účetních systémů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Pohoda"
  }' \
  "https://api.redque.com/v1/tenant/accountingSystems/list"

# Odpověď serveru
[
  {
    "id": "sys123",
    "name": "Pohoda",
    "type": "Pohoda"
  }
]

HTTP požadavek

POST https://api.redque.com/v1/tenant/accountingSystems/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam účetních systémů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Informace o účetních systémech

Základní informace o účetních systémech získáte pomocí endpointu GET /v1/tenant/accountingSystems/info.

# Získání informací o účetních systémech
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/accountingSystems/info"

# Odpověď serveru
{
  "availableTypes": ["Pohoda", "Duel", "MRP"]
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/accountingSystems/info

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o účetních systémech.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Validace účetního systému

Účetní systém zvalidujete před vytvořením pomocí endpointu POST /v1/tenant/accountingSystems/validation.

# Validace účetního systému
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Pohoda", "type": "Pohoda"}' \
  "https://api.redque.com/v1/tenant/accountingSystems/validation"

# Odpověď serveru
[]

HTTP požadavek

POST https://api.redque.com/v1/tenant/accountingSystems/validation

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací validační chyby (prázdné pole pokud je vše v pořádku).
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení účetních systémů

Pohoda - získání nastavení

Nastavení pro Pohodu získáte pomocí endpointu GET /v1/tenant/pohoda/settings.

# Získání nastavení Pohody
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/pohoda/settings"

# Odpověď serveru
{
  "serverUrl": "http://localhost:8080",
  "database": "Pohoda"
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/pohoda/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací nastavení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Pohoda - nastavení konfigurace

Nastavení pro Pohodu uložíte pomocí endpointu POST /v1/tenant/pohoda/settings.

# Uložení nastavení Pohody
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.redque.com/v1/tenant/pohoda/settings"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/tenant/pohoda/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Nastavení bylo uloženo.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Duel - získání nastavení

Nastavení pro Duel získáte pomocí endpointu GET /v1/tenant/duel/settings.

# Získání nastavení Duelu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/duel/settings"

# Odpověď serveru
{
  "connectionString": "Server=localhost;Database=Duel"
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/duel/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací nastavení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Duel - nastavení konfigurace

Nastavení pro Duel uložíte pomocí endpointu POST /v1/tenant/duel/settings.

# Uložení nastavení Duelu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.redque.com/v1/tenant/duel/settings"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/tenant/duel/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Nastavení bylo uloženo.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

MRP - získání nastavení

Nastavení pro MRP získáte pomocí endpointu GET /v1/tenant/mrp/settings.

# Získání nastavení MRP
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/mrp/settings"

# Odpověď serveru
{
  "connectionString": "Server=localhost;Database=MRP"
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/mrp/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací nastavení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

MRP - nastavení konfigurace

Nastavení pro MRP uložíte pomocí endpointu POST /v1/tenant/mrp/settings.

# Uložení nastavení MRP
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.redque.com/v1/tenant/mrp/settings"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/tenant/mrp/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Nastavení bylo uloženo.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Importní připojení

Vytvoření importního připojení

Importní připojení vytvoříte pomocí endpointu POST /v1/tenant/importConnections.

# Vytvoření importního připojení
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Email import", "type": "Email"}' \
  "https://api.redque.com/v1/tenant/importConnections"

# Odpověď serveru
{
  "id": "conn123",
  "name": "Email import",
  "type": "Email"
}

HTTP požadavek

POST https://api.redque.com/v1/tenant/importConnections

HTTP odpovědi

Kód	Popis
200	Úspěch. Připojení bylo vytvořeno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace importního připojení

Importní připojení aktualizujete pomocí endpointu PUT /v1/tenant/importConnections.

# Aktualizace importního připojení
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"id": "conn123", "name": "Email import updated"}' \
  "https://api.redque.com/v1/tenant/importConnections"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/importConnections

HTTP odpovědi

Kód	Popis
200	Úspěch. Připojení bylo aktualizováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání importního připojení

Importní připojení smažete pomocí endpointu DELETE /v1/tenant/importConnections.

# Smazání importního připojení
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/importConnections?importConnectionId=conn123"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/tenant/importConnections

Parametry požadavku

Parametr	Typ	Popis
importConnectionId	string	ID importního připojení.

HTTP odpovědi

Kód	Popis
200	Úspěch. Připojení bylo smazáno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Seznam importních připojení

Seznam importních připojení získáte pomocí endpointu POST /v1/tenant/importConnections/list.

# Získání seznamu importních připojení
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.redque.com/v1/tenant/importConnections/list"

# Odpověď serveru
[
  {
    "id": "conn123",
    "name": "Email import",
    "type": "Email"
  }
]

HTTP požadavek

POST https://api.redque.com/v1/tenant/importConnections/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam připojení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Schvalovací workflow

Vytvoření schvalovacího workflow

Schvalovací workflow vytvoříte pomocí endpointu POST /v1/tenant/approvalWorkflows.

# Vytvoření schvalovacího workflow
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Workflow pro faktury"}' \
  "https://api.redque.com/v1/tenant/approvalWorkflows"

# Odpověď serveru
{
  "id": "wf123",
  "name": "Workflow pro faktury"
}

HTTP požadavek

POST https://api.redque.com/v1/tenant/approvalWorkflows

HTTP odpovědi

Kód	Popis
200	Úspěch. Workflow bylo vytvořeno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace schvalovacího workflow

Schvalovací workflow aktualizujete pomocí endpointu PUT /v1/tenant/approvalWorkflows.

# Aktualizace schvalovacího workflow
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"id": "wf123", "name": "Workflow pro faktury - aktualizováno"}' \
  "https://api.redque.com/v1/tenant/approvalWorkflows"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/approvalWorkflows

HTTP odpovědi

Kód	Popis
200	Úspěch. Workflow bylo aktualizováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání schvalovacího workflow

Schvalovací workflow smažete pomocí endpointu DELETE /v1/tenant/approvalWorkflows.

# Smazání schvalovacího workflow
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/approvalWorkflows?approvalWorkflowId=wf123"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/tenant/approvalWorkflows

Parametry požadavku

Parametr	Typ	Popis
approvalWorkflowId	string	ID schvalovacího workflow.

HTTP odpovědi

Kód	Popis
200	Úspěch. Workflow bylo smazáno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Seznam schvalovacích workflow

Seznam schvalovacích workflow získáte pomocí endpointu POST /v1/tenant/approvalWorkflows/list.

# Získání seznamu schvalovacích workflow
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.redque.com/v1/tenant/approvalWorkflows/list"

# Odpověď serveru
[
  {
    "id": "wf123",
    "name": "Workflow pro faktury"
  }
]

HTTP požadavek

POST https://api.redque.com/v1/tenant/approvalWorkflows/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam workflow.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení schvalovacího workflow

Nastavení schvalovacího workflow aktualizujete pomocí endpointu PUT /v1/tenant/approvalWorkflow/settings.

# Aktualizace nastavení workflow
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/approvalWorkflow/settings?documentApprovalWorkflowTrigger=Manual"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/approvalWorkflow/settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Nastavení bylo aktualizováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Webhooky

Vytvoření webhooku

Webhook vytvoříte pomocí endpointu POST /v1/tenant/webHooks.

# Vytvoření webhooku
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Notifikace o nových dokumentech",
    "url": "https://example.com/webhook",
    "eventType": "DocumentCreated",
    "exportFormat": "json",
    "isActive": true,
    "clientApplicationId": "app123"
  }' \
  "https://api.redque.com/v1/tenant/webHooks"

# Odpověď serveru
{
  "id": "wh123",
  "url": "https://example.com/webhook"
}

HTTP požadavek

POST https://api.redque.com/v1/tenant/webHooks

HTTP odpovědi

Kód	Popis
200	Úspěch. Webhook byl vytvořen.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace webhooku

Webhook aktualizujete pomocí endpointu PUT /v1/tenant/webHooks.

# Aktualizace webhooku
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "id": "wh123",
    "name": "Notifikace aktualizována",
    "url": "https://example.com/webhook-updated",
    "eventType": "DocumentExported",
    "exportFormat": "xml",
    "isActive": true
  }' \
  "https://api.redque.com/v1/tenant/webHooks"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/webHooks

HTTP odpovědi

Kód	Popis
200	Úspěch. Webhook byl aktualizován.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání webhooku

Webhook smažete pomocí endpointu DELETE /v1/tenant/webHooks.

# Smazání webhooku
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/webHooks?webHookId=wh123"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/tenant/webHooks

Parametry požadavku

Parametr	Typ	Popis
webHookId	string	ID webhooku.

HTTP odpovědi

Kód	Popis
200	Úspěch. Webhook byl smazán.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Seznam webhooků

Seznam webhooků získáte pomocí endpointu POST /v1/tenant/webHooks/list.

# Získání seznamu webhooků
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.redque.com/v1/tenant/webHooks/list"

# Odpověď serveru
[
  {
    "id": "wh123",
    "url": "https://example.com/webhook"
  }
]

HTTP požadavek

POST https://api.redque.com/v1/tenant/webHooks/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam webhooků.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Emailové notifikace

Nastavení emailové notifikace

Emailovou notifikaci nastavíte pomocí endpointu PUT /v1/tenant/emailNotifications.

# Nastavení emailové notifikace
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@example.com", "events": ["DocumentCreated"]}' \
  "https://api.redque.com/v1/tenant/emailNotifications"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/tenant/emailNotifications

HTTP odpovědi

Kód	Popis
200	Úspěch. Notifikace byla nastavena.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Získání emailové notifikace

Emailovou notifikaci získáte pomocí endpointu GET /v1/tenant/emailNotifications.

# Získání emailové notifikace
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/emailNotifications"

# Odpověď serveru
{
  "email": "admin@example.com",
  "events": ["DocumentCreated"]
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/emailNotifications

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací nastavení notifikace.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání emailové notifikace

Emailovou notifikaci smažete pomocí endpointu DELETE /v1/tenant/emailNotifications.

# Smazání emailové notifikace
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/emailNotifications"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/tenant/emailNotifications

HTTP odpovědi

Kód	Popis
200	Úspěch. Notifikace byla smazána.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

ARES

Získání informací o firmě z ARES

Základní informace o firmě z ARES získáte pomocí endpointu GET /v1/tenant/ares/basic-info/{companyId}.

# Získání informací o firmě z ARES
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/tenant/ares/basic-info/12345678"

# Odpověď serveru
{
  "companyName": "Firma s.r.o.",
  "companyId": "12345678",
  "vatId": "CZ12345678",
  "address": "Ulice 123, Praha"
}

HTTP požadavek

GET https://api.redque.com/v1/tenant/ares/basic-info/{companyId}

Parametry požadavku

Parametr	Typ	Popis
companyId	string	Povinný. IČO firmy.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o firmě.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Uživatelé

Seznam uživatelů

Seznam uživatelů získáte pomocí endpointu POST /v1/users/list.

# Získání seznamu uživatelů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "novak",
    "filter": {},
    "control": {
      "skip": 0,
      "take": 50
    },
    "sort": {
      "field": "LastName",
      "direction": "Ascending"
    }
  }' \
  "https://api.redque.com/v1/users/list"

# Odpověď serveru
{
  "items": [
    {
      "id": "user123",
      "email": "jan.novak@example.com",
      "firstName": "Jan",
      "lastName": "Novák"
    }
  ],
  "totalCount": 1
}

HTTP požadavek

POST https://api.redque.com/v1/users/list

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací seznam uživatelů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Základní seznam uživatelů

Základní seznam uživatelů získáte pomocí endpointu POST /v1/users/list/basic.

# Získání základního seznamu uživatelů
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.redque.com/v1/users/list/basic"

# Odpověď serveru
[
  {
    "email": "jan.novak@example.com",
    "name": "Jan Novák"
  }
]

HTTP požadavek

POST https://api.redque.com/v1/users/list/basic

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací základní seznam uživatelů.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Vytvoření uživatele

Nového uživatele vytvoříte pomocí endpointu POST /v1/users.

# Vytvoření uživatele
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jan",
    "lastName": "Novák",
    "email": "novy.uzivatel@example.com",
    "password": "SecurePassword123!",
    "phone": "+420123456789",
    "userRole": "User",
    "accountingUnitId": "a1b2c3d4e5f6",
    "additionalAccountingUnitIds": ["g7h8i9j0k1l2"]
  }' \
  "https://api.redque.com/v1/users"

# Odpověď serveru
{
  "id": "user456",
  "email": "novy.uzivatel@example.com",
  "firstName": "Nový",
  "lastName": "Uživatel"
}

HTTP požadavek

POST https://api.redque.com/v1/users

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o novém uživateli.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Získání uživatele

Detail uživatele získáte pomocí endpointu GET /v1/users/{userId}.

# Získání uživatele
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/user123"

# Odpověď serveru
{
  "id": "user123",
  "email": "jan.novak@example.com",
  "firstName": "Jan",
  "lastName": "Novák",
  "role": "User"
}

HTTP požadavek

GET https://api.redque.com/v1/users/{userId}

Parametry požadavku

Parametr	Typ	Popis
userId	string	Povinný. ID uživatele.

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o uživateli.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace uživatele

Uživatele aktualizujete pomocí endpointu PATCH /v1/users/{userId}.

# Aktualizace uživatele
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jan",
    "lastName": "Svoboda",
    "languageCode": "cs-CZ",
    "phone": "+420987654321",
    "userRole": "Admin",
    "accountingUnitId": "a1b2c3d4e5f6",
    "additionalAccountingUnitIds": ["g7h8i9j0k1l2", "m3n4o5p6q7r8"]
  }' \
  "https://api.redque.com/v1/users/user123"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/users/{userId}

Parametry požadavku

Parametr	Typ	Popis
userId	string	Povinný. ID uživatele.

HTTP odpovědi

Kód	Popis
200	Úspěch. Uživatel byl aktualizován.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání uživatele

Uživatele smažete pomocí endpointu DELETE /v1/users/{userId}.

# Smazání uživatele
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/user123"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/users/{userId}

Parametry požadavku

Parametr	Typ	Popis
userId	string	Povinný. ID uživatele.

HTTP odpovědi

Kód	Popis
200	Úspěch. Uživatel byl smazán.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Pozvání uživatele

Pozvánku novému uživateli odešlete pomocí endpointu POST /v1/users/invitation.

# Odeslání pozvánky
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/invitation?email=novy.uzivatel@example.com"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/users/invitation

Parametry požadavku

Parametr	Typ	Popis
email	string	Email uživatele pro pozvání.

HTTP odpovědi

Kód	Popis
200	Úspěch. Pozvánka byla odeslána.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktuální uživatel

Získání informací o aktuálním uživateli

Informace o aktuálně přihlášeném uživateli získáte pomocí endpointu GET /v1/users/me.

# Získání informací o aktuálním uživateli
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/me"

# Odpověď serveru
{
  "id": "user123",
  "email": "jan.novak@example.com",
  "firstName": "Jan",
  "lastName": "Novák"
}

HTTP požadavek

GET https://api.redque.com/v1/users/me

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací informace o uživateli.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Aktualizace aktuálního uživatele

Informace o aktuálně přihlášeném uživateli aktualizujete pomocí endpointu PATCH /v1/users/me.

# Aktualizace aktuálního uživatele
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jan",
    "lastName": "Svoboda",
    "languageCode": "cs-CZ",
    "phone": "+420123456789"
  }' \
  "https://api.redque.com/v1/users/me"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/users/me

HTTP odpovědi

Kód	Popis
200	Úspěch. Uživatel byl aktualizován.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Webová nastavení

Získání webových nastavení

Webová nastavení uživatele získáte pomocí endpointu GET /v1/users/web-settings.

# Získání webových nastavení
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/web-settings"

# Odpověď serveru
{
  "language": "cs",
  "theme": "light"
}

HTTP požadavek

GET https://api.redque.com/v1/users/web-settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací webová nastavení.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Nastavení webových nastavení

Webová nastavení uživatele uložíte pomocí endpointu PUT /v1/users/web-settings.

# Uložení webových nastavení
curl -X PUT -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"language": "cs", "theme": "dark"}' \
  "https://api.redque.com/v1/users/web-settings"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/users/web-settings

HTTP odpovědi

Kód	Popis
200	Úspěch. Nastavení bylo uloženo.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Správa hesel

Změna vlastního hesla

Vlastní heslo změníte pomocí endpointu POST /v1/users/password.

# Změna vlastního hesla
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/password?OldPassword=StareHeslo123&Password=NoveHeslo456"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/users/password

Parametry požadavku

Parametr	Typ	Popis
OldPassword	string	Staré heslo.
Password	string	Nové heslo.

HTTP odpovědi

Kód	Popis
200	Úspěch. Heslo bylo změněno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Změna hesla uživatele

Heslo jiného uživatele změníte pomocí endpointu POST /v1/users/{userId}/password.

# Změna hesla uživatele
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/user123/password?password=NoveHeslo789"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/users/{userId}/password

Parametry požadavku

Parametr	Typ	Popis
userId	string	Povinný. ID uživatele.
password	string	Nové heslo.

HTTP odpovědi

Kód	Popis
200	Úspěch. Heslo bylo změněno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Odeslání tokenu pro reset hesla

Token pro reset hesla odešlete pomocí endpointu POST /v1/users/sendPasswordResetToken.

# Odeslání tokenu pro reset hesla
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/sendPasswordResetToken?email=jan.novak@example.com"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/users/sendPasswordResetToken

Parametry požadavku

Parametr	Typ	Popis
email	string	Email uživatele.

HTTP odpovědi

Kód	Popis
200	Úspěch. Token byl odeslán.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Reset hesla

Heslo resetujete pomocí endpointu POST /v1/users/resetPassword.

# Reset hesla
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jan.novak@example.com",
    "resetToken": "reset-token-123",
    "password": "NoveHeslo123"
  }' \
  "https://api.redque.com/v1/users/resetPassword"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/users/resetPassword

HTTP odpovědi

Kód	Popis
200	Úspěch. Heslo bylo resetováno.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Ověření platnosti tokenu

Platnost reset tokenu ověříte pomocí endpointu POST /v1/users/reset-token/is-valid.

# Ověření platnosti tokenu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jan.novak@example.com",
    "resetToken": "reset-token-123"
  }' \
  "https://api.redque.com/v1/users/reset-token/is-valid"

# Odpověď serveru
true

HTTP požadavek

POST https://api.redque.com/v1/users/reset-token/is-valid

HTTP odpovědi

Kód	Popis
200	Úspěch. Vrací true/false.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Zkušební uživatelé

Vytvoření zkušebního uživatele

Zkušebního uživatele vytvoříte pomocí endpointu POST /v1/users/createTrialUser.

# Vytvoření zkušebního uživatele
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Trial",
    "lastName": "User",
    "email": "trial@example.com",
    "password": "TrialPassword123!"
  }' \
  "https://api.redque.com/v1/users/createTrialUser"

# Odpověď serveru
{
  "id": "trial123",
  "email": "trial@example.com"
}

HTTP požadavek

POST https://api.redque.com/v1/users/createTrialUser

HTTP odpovědi

Kód	Popis
200	Úspěch. Zkušební uživatel byl vytvořen.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Smazání zkušebního uživatele

Zkušebního uživatele smažete pomocí endpointu DELETE /v1/users/deleteTrialUser.

# Smazání zkušebního uživatele
curl -X DELETE -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." \
  "https://api.redque.com/v1/users/deleteTrialUser"

# Odpověď serveru
HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/users/deleteTrialUser

HTTP odpovědi

Kód	Popis
200	Úspěch. Zkušební uživatel byl smazán.
401	Chybějící nebo neplatný přístupový token.
403	Přístup odepřen.

Integrace do účetních systémů s použitím exportu dokumentů

Vytěžený dokument lze dále zpracovat. API umožňuje získat dokument ve formátu přímo pro některé účetní systémy. Nebo získat dokument v obecných formátech a zajistit vlastní zpracování.

Nejprve je potřeba dokument označit k exportu pomocí endpointu POST /v1/documents/export.

Pro zjištění, zda existují dokumenty k exportu, můžeme volat endpoint POST /v1/documents/list/forExport pro získání seznamu všech dokumentů určených k exportu nebo endpoint POST /v1/documents/list/idsForExport pro získání seznamu ID dokumentů určených k exportu.

Průběh zpracování dokumentu v bodech:

Nahrání dokumentu
Odeslání dokumentu do fronty k exportu
Vyzvednutí dokumentu v požadované formátu
Označení dokumentu po úspěšném zpracování

Nahrání dokumentu	Vytěžení	Odeslání do fronty k exportu	Stažení dokumentu v požadovaném formátu	Označení exportovaného dokumentu
`POST /v1/documents`	automaticky	`POST /v1/documents/export`	`GET /v1/documents/{documentId}/file/export?exportFormat=<FormatCílovéhoDokumentu>`	`PATCH /v1/documents/markAsExported` nebo `PATCH /v1/documents/markAsExportFailure`

Získání seznam kompletních dokumentů určených k exportu

Tato metoda vrací kompletní dokumenty, které jsou určeny k exportu.

Tělo požadavku je ve formátu JSON:

{ "control": { "skip": 0, "take": 0 }, "accountingUnitId": "string", "accountingUnitExternalId": "string" }

Název	Hodnota (typ)	Příklad hodnoty
`control`	objekt
└─ `skip`	číslo (int)	0
└─ `take`	číslo (int)	50
`accountingUnitId`	string	0ED1F081414F7A724FC37C05ADD6E7A53AA4888566A94B
`accountingUnitExternalId`	string	0ED1F081414F7A724FC37C05ADD6E7A53AA4888566A94B

# Zíkání seznamu všech dokumentů určených k exportu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." "https://api.redque.com/v1/documents/list/forExport"

# Tělo požadavku
{
  "control": {
    "skip": 0,
    "take": 0
  },
  "accountingUnitId": "string",
  "accountingUnitExternalId": "string"
}

# Odpověd serveru
HTTP/1.1 200 OK

{
  "list": [
    {
      "documentId": "6c60fe70642f0816445ad5",
      "externalDocumentId": null,
      "folderId": "3F9493019816BCB1B40573A1557663AD35",
      "pageCount": 1,
      "fileName": "objednavka-vzor.png",
      "documentClass": "czech_order",
      "accountingUnitId": "0ED1F081414F7A724FC37C05ADD6E7A53AA4888566A94B",
      "creationTime": "2023-10-10T14:19:10.003Z",
      "size": 138,
      "contentType": "image/png",
      "extractionTime": "2023-10-10T14:19:28.978Z",
      "isAttachment": false,
      "isValidated": true,
      "fields": {
        "order_number": {
          "fieldName": "order_number",
          "fieldValue": "0001",
          "fieldValueJson": "0001"
        },
        "supplier_name": {
          "fieldName": "supplier_name",
          "fieldValue": "Firma A s.r.o.",
          "fieldValueJson": "Firma A s.r.o."
        },
        ...
      }
    },
    ...
  ],
  "hasMore": false,
  "offset": 0
}

# Odpověd serveru
HTTP/1.1 202 Accepted


Returns documents

Získání seznamu ID dokumentů určených k exportu

Tato metoda vrací pouze ID dokumentů, které jsou určeny k exportu.

# Zíkání seznamu všech ID dokumentů určených k exportu
curl -X POST -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." "https://api.redque.com/v1/documents/list/forExport"

{
}

# Odpověd serveru
HTTP/1.1 200 OK

{
  "list": [
    {
      "documentId": "6c60fe70642f0816445ad5",
      "externalDocumentId": null,
      "accountingUnitId": "86DDD21CF093C3A56CED74EE",
      "isAttachment": false,
      "isValidated": false,
      "folderId": "0E62B94D32B6A1D1F177890278263CE4CE9CBC21CF"
    },
    ...
  ],
  "hasMore": false,
  "offset": 0
}

# Odpověd serveru
HTTP/1.1 202 Accepted

Returns documents

Stažení dokumentu v požadovaném formátu

Dokumenty určené k exportu lze stáhnout v požadovaném formátu pomocí endpointu GET /v1/documents/{documentId}/file/export?exportFormat=<FormatCilovehoDokumentu>.

# Zíkání seznamu všech ID dokumentů určených k exportu
curl -X GET -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." "https://api.redque.com/v1/documents/6c60fe70642f0816445ad5/file/export?exportFormat=Xml'

# Odpověd serveru
HTTP/1.1 200 OK

Označení dokumentu jako úspěšně exportovaného

Po úspěšném zpracování dokumentu(ů) je třeba dokument(y) označit jako exportovaný(é) pomocí endpointu
PATCH /v1/documents/markAsExported a tím je odstranit z seznamu dokumentů určených k exportu. Společně s požadavkem můžete předat informace o zdrojové a cílové aplikaci, kam byl dokument exportován, včetně označení nebo čísla dokladu v externí aplikaci.

# Označení dokumentu(ů) po úspěšném exportu
curl -X PATCH -H "Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9..." "https://api.redque.com/v1/documents/markAsExported'

[
  {
    "documentId": "6c60fe70642f0816445ad5",
    "accoutingProviderDocumentNumber": "FA123456",
    "exportType": "SystemuKamBylDokumentImportovan",
    "exportedByApplicationName": "AplikaceKteraDokumentOznacila"
  }
]

# Odpověd serveru
HTTP/1.1 200 OK

Číselníky

Číselníky slouží k ukládání hodnot, které je možné navázat na jednotlivá pole dokladu a následně je používat při jeho validaci. Usnadňují tak práci s dokladem a redukují potřebu doklad dále upravovat v účetním systému.

Vytvoření číselníku

  # Vytvoření číselníku
  curl -X 'POST' </span>
    'https://api.redque.com/v1/enums' </span>
    -H 'accept: text/plain' </span>
    -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
    -H 'Content-Type: application/json' </span>
    -d '{
      "name": "Střediska",
      "linkedFieldNames": ["cost_center"],
      "accountingUnitIds": ["a1b2c3d4e5f6"],
      "externalId": "EXT-STREDISKA-001",
      "values": [
        {
          "key": "001",
          "value": "Hlavní kancelář",
          "tag": {
            "department": "management"
          }
        },
        {
          "key": "002",
          "value": "Pobočka Praha",
          "tag": {
            "department": "sales"
          }
        }
      ],
      "documentTypes": ["czech_invoice", "czech_receipt"],
      "fieldConditions": [
        {
          "name": "issued_by_name_sm",
          "value": "Dodavatel s.r.o.",
          "operator": "Eq"
        }
      ]
    }'

# Odpověď serveru
  "enum123abc"

Odpověď obsahuje unikátní ID číselníku.

HTTP požadavek

POST https://api.redque.com/v1/enums/

Získání číselníku

  # Získání číselníku
  curl -X 'GET' </span>
    'https://api.redque.com/v1/enums/{id}' </span>
    -H 'accept: text/plain' </span>
    -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
    -H 'Content-Type: application/json'

# Odpověď serveru
  {
    "id": "a1b2c3d4e5f6",
    "name": "Střediska",
    "linkedFieldNames": ["cost_center"],
    "accountingUnitIds": ["5DFD09F5475BE448BD8D63F0828DCD4AD4D0F0A1C0F33EEA1E73B2B4C6A9B2E3"],
    "values": [
      {
        "key": "001",
        "value": "Hlavní kancelář"
      },
      {
        "key": "002",
        "value": "Pobočka Praha"
      }
    ],
    "documentType": "czech_invoice"
  }

HTTP požadavek

GET https://api.redque.com/v1/enums/<ID>

Parametry URL

Parametr	Popis
ID	ID číselníku

Získání všech číselníků

  # Získání všech číselníků
  curl -X 'GET' </span>
    'https://api.redque.com/v1/enums/list' </span>
    -H 'accept: text/plain' </span>
    -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
    -H 'Content-Type: application/json' </span>

# Odpověď serveru
  [
    {
      "id": "string",
      "name": "string",
      "linkedFieldNames": [
        "string"
      ],
      "accountingUnitIds": [
        "string"
      ],
      "values": [
        {
          "key": "string",
          "value": "string",
          "tag": {
            "objectAttribute": {},
            "arrayAttribute": [],
            "stringAttribute": "value"
          },
          "hidden": true
        }
      ],
      "externalId": "string",
      "documentType": "string",
      "fieldConditions": [
        {
          "name": "string",
          "value": "string",
          "operator": "Eq"
        }
      ]
    }
  ]

HTTP požadavek

GET https://api.redque.com/v1/enums/list

Získání číselníku v jazyce

  # Získání všech číselníků
  curl -X 'GET' </span>
    'https://api.redque.com/v1/enums/<ID>/<culture>' </span>
    -H 'accept: text/plain' </span>
    -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
    -H 'Content-Type: application/json' </span>

# Odpověď serveru
    [
      {
        "key": "string",
        "value": "string",
        "tag": {
          "objectAttribute": {},
          "arrayAttribute": [],
          "stringAttribute": "value"
        },
        "hidden": true
      }
    ]

HTTP požadavek

GET https://api.redque.com/v1/enums/<ID>/<culture>

Parametry URL

Parametr	Popis
ID	ID požadovaného číselníku
culture	Požadovaný jazyk číselníku

Úprava číselníku

    # Úprava číselníku
    curl -X 'PUT' </span>
      'https://api.redque.com/v1/enums/{id}' </span>
      -H 'accept: text/plain' </span>
      -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
      -H 'Content-Type: application/json' </span>
      -d '{
        "name": "Střediska - aktualizováno",
        "linkedFieldNames": ["cost_center", "department"],
        "accountingUnitIds": ["a1b2c3d4e5f6"],
        "externalId": "EXT-STREDISKA-001",
        "values": [
          {
            "key": "001",
            "value": "Hlavní kancelář"
          },
          {
            "key": "002",
            "value": "Pobočka Praha"
          },
          {
            "key": "003",
            "value": "Pobočka Brno"
          }
        ],
        "documentTypes": ["czech_invoice"]
      }'

# Odpověd serveru
  HTTP/1.1 200 OK

HTTP požadavek

PUT https://api.redque.com/v1/enums/<ID>

Parametry URL

Parametr	Popis
ID	ID číselníku

Úprava hodnot číselníku

  # Úprava hodnot číselníku
  curl -X 'PATCH' </span>
    'https://api.redque.com/v1/enums/{id}' </span>
    -H 'accept: text/plain' </span>
    -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
    -H 'Content-Type: application/json' </span>
    -d '{
      "values": [
        {
          "key": "001",
          "value": "Hlavní kancelář - updated"
        },
        {
          "key": "004",
          "value": "Nová pobočka"
        }
      ]
    }'

# Odpověd serveru
  HTTP/1.1 200 OK

HTTP požadavek

PATCH https://api.redque.com/v1/enums/<ID>

Parametry URL

Parametr	Popis
ID	ID číselníku

Smazání číselníku

  # Smazání číselníku
  curl -X 'DELETE' </span>
    'https://api.redque.com/v1/enums/{id}' </span>
    -H 'accept: text/plain' </span>
    -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
    -H 'Content-Type: application/json' </span>

# Odpověd serveru
  HTTP/1.1 200 OK

HTTP požadavek

DELETE https://api.redque.com/v1/enums/<ID>

Parametry URL

Parametr	Popis
ID	ID číselníku

Získání číselníků z externího účetního systému

# Získání číselníků z externího účetního systému curl -X 'POST' 'https://api.redque.com/v1/enums/getEnumsFromAccountingSystem?accountingSystemId=123' -H 'accept: text/plain' -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' -H 'Content-Type: application/json' -d '[ { "externalId": "UcetniSystem.Polozka.AC101397CCC6AF8FC68EBA5A27891", "displayName": "Účetní systém", "accountingUnitId": "AC101397CCC6AF8FC68EBA5A27891", "fieldDefinitions": [ { "fieldName": "polozka", "documentType": "czech_invoice", "detailGroupId": "invoice_type", "caption": { "cs-CZ": "Položka 1", "en-US": "Item 1" } } ], "enumType": "AccountCode", "values": [ { "key": "1", "value": "Hodnota 1" }, { "key": "2", "value": "Hodnota 2" } ], "fieldConditions": [] } ]'

# Odpověd serveru HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/enums/getEnumsFromAccountingSystem?accountingSystemId=<accountingSystemId>

Parametry požadavku

Parametr	Popis
accountingSystemId	ID účetního systému

Synchronizace číselníků z externího účetního systému

  # Synchronizace číselníků z externího účetního systému
  curl -X 'POST' </span>
    'https://api.redque.com/v1/enums/synchronizeFromAccountingSystem' </span>
    -H 'accept: text/plain' </span>
    -H 'Authorization: Bearer eyJhbGciOiJFUzUxMiIsInR5cCI6ImF0K2p3dCJ9' </span>
    -H 'Content-Type: application/json' </span>
    -d '{
      "accountingSystemId": "sys123",
      "selectedAccountingSystemEnumsExternalIds": [
        "UcetniSystem.Strediska.AC101397CCC6AF8FC68EBA5A27891",
        "UcetniSystem.Partneri.AC101397CCC6AF8FC68EBA5A27891"
      ]
    }'
  # Odpověd serveru
  HTTP/1.1 200 OK

HTTP požadavek

POST https://api.redque.com/v1/enums/synchronizeFromAccountingSystem

Chyby

Redque API používá následující chybové kódy:

Kód chyby	Popis
400	Bad Request -- Nevalidní požadavek. Zkontrolujte požadavek.
401	Unauthorized -- Volání není autorizováno.
403	Forbidden -- Neoprávněný přístup ke zdroji.
404	Not Found -- Nenalezeno.
405	Method Not Allowed -- Nepovolená metoda.
500	Internal Server Error -- Problém je na naší straně.
503	Service Unavailable -- Služba není dostupná. Zkuste to později.