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

Doklady

Smazat doklad

DELETE/invoices/{id}

Smaže doklad. Vystavený doklad se archivuje v revizích; doklad zahrnutý v uloženém přiznání DPH smazat nelze (422).

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

Parametry

idintegerpovinnécesta

ID záznamu.

  • Minimum: 1
If-Matchstringhlavička

ETag záznamu, jak jste ho naposledy přečetli. Když se záznam mezitím změnil, API změnu odmítne s 412 a nic neprovede. Bez hlavičky se změna provede vždy.

Odpovědi

204Smazáno.

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.

Odpověď nemá tělo.

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

404Záznam nenalezen.

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 · 404
{
  "type": "https://api.fakturanet.cz/#problem-not-found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested record does not exist.",
  "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

412Záznam se změnil od čtení s `If-Match`; nic se neprovedlo. Hlavička `ETag` nese aktuální verzi.

Hlavičky

ETag
Verze vrácené podoby záznamu. Pošlete ji v If-Match při změně, nebo v If-None-Match při dalším čtení.

application/problem+json

Schéma: Problem

JSON · 412
{
  "type": "https://api.fakturanet.cz/#problem-precondition-failed",
  "title": "Precondition failed",
  "status": 412,
  "detail": "The record has changed since you read it. Fetch it again and repeat the change with its new ETag.",
  "request_id": "9f2c41d0a7b3e815"
}

Přehled typů chyb

Požadavek · cURL
curl -X DELETE "https://api.fakturanet.cz/v1/invoices/123" \
  -H "Authorization: Bearer $FAKTURANET_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '"{\n  \"type\": \"https://api.fakturanet.cz/#problem-precondition-failed\",\n  \"title\": \"Precondition failed\",\n  \"status\": 412,\n  \"detail\": \"The record has changed since you read it. Fetch it again and repeat the change with its new ETag.\",\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"];
$headers[] = 'Content-Type: application/json';
$body = <<<'JSON'
"{\n  \"type\": \"https://api.fakturanet.cz/#problem-precondition-failed\",\n  \"title\": \"Precondition failed\",\n  \"status\": 412,\n  \"detail\": \"The record has changed since you read it. Fetch it again and repeat the change with its new ETag.\",\n  \"request_id\": \"9f2c41d0a7b3e815\"\n}"
JSON;

$ch = curl_init('https://api.fakturanet.cz/v1/invoices/123');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    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); }
// HTTP 204: odpověď nemá tělo.

ID 123 nahraďte ID svého záznamu.

Hledat v dokumentaci

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