Přejít na obsah
FakturanetAPI v1.0.0
OpenAPI API klíče

Exporty

Vytvořit export

POST/exports

Zařadí export do fronty a hned vrátí 202. Stav sledujte přes GET /exports/{id}; jakmile je ready, stáhněte soubor z download_url.

Oprávnění klíče: exports:write

Parametry

Idempotency-Keystringpovinnéhlavička

Jedinečný klíč operace, například UUID. Opakovaný požadavek se stejným klíčem a daty vrátí původní výsledek.

  • Min. znaků: 16
  • Max. znaků: 128
  • Vzorec: ^[A-Za-z0-9._:-]+$

Tělo požadavku

kindstringpovinné

Co exportovat. Hodnoty: invoices – doklady; expenses – výdaje; contacts – kontakty; archive – kompletní záloha dat firmy (ZIP: doklady v PDF a ISDOC, přehledy XLSX, přílohy výdajů, uložená přiznání k DPH, záznam EET). Vyžaduje format = zip a nepoužívá filtry.

formatstringpovinné

Formát. Kontakty jen xlsx. Hodnoty: pdf – PDF v ZIPu – jen doklady; isdoc – ISDOC v ZIPu – jen doklady; xlsx – Excel; pohoda – Pohoda XML – doklady a výdaje; money_s3 – Money S3 XML – doklady a výdaje.

  • Hodnoty: pdf isdoc xlsx pohoda money_s3 zip
Vnořená pole 9
fromdate | null

Datum vystavení od.

todate | null

Datum vystavení do.

statusstring | null

Stav dokladu (paid, unpaid, overdue, draft, future) nebo výdaje (paid, unpaid).

contact_idinteger | null

Jen doklady tohoto kontaktu.

qstring | null

Fulltext.

doc_typestring | null

Typ dokladu.

payment_methodstring | null

Způsob úhrady.

mindecimal | null

Částka od.

maxdecimal | null

Částka do.

Odpovědi

202Export čeká ve frontě.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.
RateLimit
Zbývající požadavky a sekundy do obnovení, např. "default";r=118;t=42.
RateLimit-Policy
Pravidlo limitu: "default";q=120;w=60.
Location
Adresa vytvořeného záznamu.

application/json

dataExportpovinné
400Chybný požadavek.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.

application/problem+json

Schéma: Problem

JSON · 400
{
  "type": "https://api.fakturanet.cz/#problem-invalid-parameter",
  "title": "Invalid parameter",
  "status": 400,
  "detail": "page must be at least 1 and limit between 1 and 100.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

401Chybí nebo neplatí API klíč.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.
WWW-Authenticate
Bearer realm="Fakturanet API"

application/problem+json

Schéma: Problem

JSON · 401
{
  "type": "https://api.fakturanet.cz/#problem-unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Send an API key as \"Authorization: Bearer <key>\" or in the X-Api-Key header.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

403Chybí oprávnění, role nebo funkce tarifu.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.

application/problem+json

Schéma: Problem

JSON · 403
{
  "type": "https://api.fakturanet.cz/#problem-insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This API key does not have the invoices:write scope.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

413Tělo je příliš velké.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.

application/problem+json

Schéma: Problem

JSON · 413
{
  "type": "https://api.fakturanet.cz/#problem-payload-too-large",
  "title": "Payload too large",
  "status": 413,
  "detail": "The request body is limited to 1 MB.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

415Tělo není JSON.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.

application/problem+json

Schéma: Problem

JSON · 415
{
  "type": "https://api.fakturanet.cz/#problem-unsupported-media-type",
  "title": "Unsupported media type",
  "status": 415,
  "detail": "Send the request body as application/json.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

422Data neprošla kontrolou.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.

application/problem+json

Schéma: Problem

JSON · 422
{
  "type": "https://api.fakturanet.cz/#problem-validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "2 fields are invalid. See errors.",
  "request_id": "9f2c41d0a7b3e815",
  "errors": [
    {
      "pointer": "/due_date",
      "detail": "Must be a date in YYYY-MM-DD format."
    },
    {
      "pointer": "/items/0/price",
      "detail": "Unknown field."
    }
  ]
}

Přehled typů chyb

429Překročen limit požadavků.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.
Retry-After
Sekundy do dalšího pokusu.

application/problem+json

Schéma: Problem

JSON · 429
{
  "type": "https://api.fakturanet.cz/#problem-rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "The limit is 120 requests per 60 seconds per key. Retry in 42 s.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

500Neočekávaná chyba.

Hlavičky

X-Request-Id
ID požadavku pro podporu. Vlastní hodnotu z 8–64 písmen, číslic a . _ - API vrátí beze změny, jinak vytvoří novou.

application/problem+json

Schéma: Problem

JSON · 500
{
  "type": "https://api.fakturanet.cz/#problem-server-error",
  "title": "Server error",
  "status": 500,
  "detail": "The request could not be completed. Quote request ID 9f2c41d0a7b3e815 when contacting support.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

Požadavek · cURL
curl -X POST "https://api.fakturanet.cz/v1/exports" \
  -H "Authorization: Bearer $FAKTURANET_API_KEY" \
  -H "Idempotency-Key: $FAKTURANET_IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '"{\n  \"type\": \"https://api.fakturanet.cz/#problem-server-error\",\n  \"title\": \"Server error\",\n  \"status\": 500,\n  \"detail\": \"The request could not be completed. Quote request ID 9f2c41d0a7b3e815 when contacting support.\",\n  \"request_id\": \"9f2c41d0a7b3e815\"\n}"'
Požadavek · PHP
<?php
declare(strict_types=1);

$key = getenv('FAKTURANET_API_KEY');
if (!$key) { throw new RuntimeException('Nastavte FAKTURANET_API_KEY.'); }

$headers = ["Authorization: Bearer $key"];
$idempotencyKey = getenv('FAKTURANET_IDEMPOTENCY_KEY');
if (!$idempotencyKey) { throw new RuntimeException('Nastavte klíč operace; při opakování použijte stejný.'); }
$headers[] = "Idempotency-Key: $idempotencyKey";
$headers[] = 'Content-Type: application/json';
$body = <<<'JSON'
"{\n  \"type\": \"https://api.fakturanet.cz/#problem-server-error\",\n  \"title\": \"Server error\",\n  \"status\": 500,\n  \"detail\": \"The request could not be completed. Quote request ID 9f2c41d0a7b3e815 when contacting support.\",\n  \"request_id\": \"9f2c41d0a7b3e815\"\n}"
JSON;

$ch = curl_init('https://api.fakturanet.cz/v1/exports');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_POSTFIELDS => $body,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($response === false) { throw new RuntimeException(curl_error($ch)); }
if ($status >= 400) { throw new RuntimeException('HTTP ' . $status . ': ' . $response); }
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);

Před požadavkem nastavte FAKTURANET_IDEMPOTENCY_KEY. Při opakování stejné operace zachovejte klíč i tělo.

Odpověď · 202
{
  "data": {
    "id": 123,
    "kind": "invoices",
    "format": "pohoda",
    "filters": {
      "from": "2026-11-01",
      "to": "2026-11-30"
    },
    "status": "pending",
    "error": null,
    "expires_at": null,
    "created_at": "2026-11-18T10:15:00+01:00",
    "processed": 0,
    "total": 0,
    "download_url": null
  }
}

Hledat v dokumentaci

Hledejte endpoint, pole, objekt, typ chyby nebo téma příručky.