Reference API
Automatizace, fronta a podklady
Přepínače automatizací a jejich ruční spuštění, přehled všech firem pro účetní, fronta úkolů napříč firmami, výkaz práce s ceníky klientů a koncepty faktur za měsíc a žádosti o chybějící doklady nebo vysvětlení.
GET Nastavení automatizací a jejich výsledky za tento měsíc
/entities/{entity_id}/automation
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Klíč jen pro čtení
- Stačí
Vrátí přepínače automatizací firmy a co která automatizace udělala v aktuálním kalendářním měsíci, spolu s tím, co právě čeká: splatná opakování faktur, faktury k upomínce a nové kontakty ke kontrole. Nic nespouští.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Odpověď
200 application/json Nastavení a stav automatizací.
| Pole | Význam |
|---|---|
month | První den aktuálního měsíce; počty month níže platí pro něj |
settings | Přepínače bank_rules, auto_match, fio_on_open, recurring, reminders, partner_checks (výchozí true), partial_match (párovat i částečné úhrady se shodným VS ze známého účtu, výchozí false) a reminder_days (výchozí 7) |
bank_rules | rules, active (aktivní pravidla), month (použití pravidel), last_at |
auto_match | month (plateb spárovaných při importu výpisů), open (nespárovaných bankovních pohybů) |
fio | connected (účty napojené na Fio API), month (pohybů staženo z Fio), accounts s časem a chybou poslední synchronizace |
recurring | active, due (splatná k dnešku), upcoming (nejbližších 6 opakování se šablonou a částkou), month (dokladů vytvořených z opakování) |
reminders | days, count a totals podle měn (vydané faktury k upomínce), month (upomínek zaznamenaných tento měsíc – Saldo je samo neposílá), rows (prvních 8 faktur) |
partner_checks | new (kontakty za 30 dní), unchecked, demo, month (provedených kontrol), flagged (až 8 nespolehlivých, insolventních nebo v ARES nenalezených kontaktů) |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/automationJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/automation', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"month": "2026-09-01",
"settings": {
"bank_rules": true,
"auto_match": true,
"partial_match": false,
"fio_on_open": true,
"recurring": true,
"reminders": true,
"reminder_days": 7,
"partner_checks": true
},
"bank_rules": {
"rules": 5,
"active": 5,
"month": 36,
"last_at": "2026-09-28T10:00:00.000Z"
},
"auto_match": {
"month": 0,
"open": 6
},
"fio": {
"connected": 0,
"month": 0,
"accounts": []
},
"recurring": {
"active": 1,
"due": 0,
"upcoming": [
{
"id": 1,
"next_on": "2026-10-03",
"frequency": "monthly",
"auto_issue": false,
"template_id": 22,
"number": "FV20260022",
"partner": "Kavárna U Zeleného stromu s.r.o.",
"total": 77440.0,
"currency": "CZK",
"due": false
}
],
"month": 0
},
"reminders": {
"days": 7,
"count": 1,
"totals": {
"CZK": 23958.0
},
"month": 0,
"rows": [
{
"id": 130,
"number": "FV20260026",
"partner": "Nordwood Studio s.r.o.",
"remaining": 23958.0,
"currency": "CZK",
"due_date": "2026-09-14",
"days_overdue": 14,
"reminders_sent": 0,
"last_reminder_on": null
}
]
},
"partner_checks": {
"new": 17,
"unchecked": 22,
"demo": true,
"month": 0,
"flagged": []
}
}
PATCH Zapnutí a vypnutí automatizací
/entities/{entity_id}/automation
- Oprávnění
- Vlastník nebo účetní
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Změní přepínače automatizací firmy; neuvedené a neznámé klíče se nemění. bank_rules a auto_match řídí, zda se při importu bankovního výpisu použijí pravidla pro banku a spárují platby s doklady (auto_match platí i pro import ISDOC); partial_match k tomu dovolí automaticky spárovat i částečnou úhradu se shodným VS z účtu uloženého u kontaktu. recurring, reminders a partner_checks řídí, co udělá POST …/automation/run. fio_on_open čte jen aplikace, která podle něj při otevření banky stáhne pohyby z Fio; server podle něj nic nespouští.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
automation | objekt | ano | |
automation. | ano/ne | ne | Pravidla pro banku při importu výpisu |
automation. | ano/ne | ne | Párování plateb s doklady při importu výpisu a ISDOC |
automation. | ano/ne | ne | Automaticky párovat i částečné úhrady se shodným VS ze známého účtu odběratele (výchozí false) |
automation. | ano/ne | ne | Stažení pohybů z Fio při otevření banky v aplikaci |
automation. | ano/ne | ne | Vytváření opakovaných faktur při běhu automatizací |
automation. | ano/ne | ne | Přehled faktur k upomínce při běhu automatizací |
automation. | celé číslo | ne | Kolik dní po splatnosti (a od poslední upomínky) je faktura k upomínce; 1–90 |
automation. | ano/ne | ne | Kontrola nových kontaktů v registrech při běhu automatizací |
Odpověď
200 application/json Nastavení po změně.
| Pole | Význam |
|---|---|
settings | Všech osm přepínačů včetně nezměněných |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | reminder_days není celé číslo 1–90 („Upomínky lze chystat 1 až 90 dní po splatnosti …“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Pokud se něco změnilo, uloží nastavení firmy (settings.automation) a zapíše událost automation.updated se seznamem změn. Hodnoty přepínačů se převedou na true/false (jiná hodnota než pravdivá znamená false).
- Opakování
- Stejné hodnoty podruhé nic neuloží ani nezapíší.
Příklad
cURL
curl \
-X PATCH \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"automation":{"reminder_days":14,"partner_checks":true}}' \
https://techtools.cz/ucetnictvi-api/entities/1/automationJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/automation', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'PATCH',
body: JSON.stringify({
"automation": {
"reminder_days": 14,
"partner_checks": true
}
})
});
const data = await response.json();{
"settings": {
"bank_rules": true,
"auto_match": true,
"partial_match": false,
"fio_on_open": true,
"recurring": true,
"reminders": true,
"reminder_days": 14,
"partner_checks": true
}
}
POST Spuštění automatizací firmy
/entities/{entity_id}/automation/run
- Oprávnění
- Zvláštní pravidlo
- Pravidlo
- Volat smí každý člen firmy. Automatizace ale spustí jen vlastník, účetní nebo editor; divákovi vrátí 200 s ran false a důvodem a nic neudělá (ne 403).
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Spustí automatizace, které aplikace pouští při otevření firmy: opakované faktury (recurring), kontrolu nových kontaktů v registrech (partner_checks) a přepočet faktur k upomínce (reminders). Každá běží jen, je-li v nastavení zapnutá; s only jen ta jedna. Upomínky se jen spočítají, nic se neodesílá. Jiná hodnota only vrátí 422.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
only | text | ne | Spustit jen tuto automatizaci Hodnoty: recurring, reminders, partner_checks. |
force | ano/ne | ne | Zkontrolovat kontakty i během 10minutové pauzy po předchozí kontrole Výchozí false. |
Odpověď
200 application/json Výsledek každé spuštěné automatizace; klíč chybí u automatizace, která neběžela.
| Pole | Význam |
|---|---|
ran | true; false u člena jen pro čtení |
reason | Jen při ran false: proč se nic nespustilo |
recurring | count, documents (id, number, kind, status, partner_name, total_payable, currency) a failed (recurrence_id, template, error) |
partners | vat, isir, ares (počty ověřených kontaktů), errors a flagged (id, name); nebo skipped true (pauza) či skipped a demo true (ukázková firma) |
reminders | count – počet vydaných faktur k upomínce |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | only není recurring, reminders ani partner_checks |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- recurring: pro každé aktivní opakování s termínem dnes nebo dříve vytvoří doklad podle šablony (datum vystavení = termín, splatnost podle kontaktu nebo firmy, u cizí měny kurz ČNB, je-li dostupný). S auto_issue ho vystaví (v podvojném účetnictví i zaúčtuje), nebo pošle ke schválení, pokud ho pokrývá pravidlo schvalování; jinak zůstane koncept. Termín opakování posune (po ends_on ho deaktivuje); při chybě se doklad nevytvoří, opakování se neposune a chyba je ve failed. partner_checks: u kontaktů založených za posledních 30 dní ověří všechna dosud neověřená česká DIČ v registru plátců DPH (uloží spolehlivost a plátcovství), až 5 IČO v ISIR (uloží insolvenci) a až 5 IČO v ARES (doplní chybějící DIČ, ulici, obec a PSČ, zapíše událost partner.ares_checked); když něco ověřila nebo narazila na chybu, zapíše souhrnnou událost automation.partner_checks. U ukázkové firmy se registry nevolají. reminders nic nezapisuje. Volá externí služby ARES, ISIR, registr plátců DPH a ČNB.
- Limity
- Nejvýše 24 dokladů na jedno opakování v jednom běhu (dohánění zmeškaných termínů); ISIR a ARES nejvýše 5 kontaktů na běh; bez force se kontrola kontaktů přeskočí, pokud byla v posledních 10 minutách zapsána událost automation.partner_checks.
- Opakování
- Tentýž termín opakování nevytvoří dva doklady: běh si každý termín atomicky zarezervuje posunem data dalšího opakování. Další volání vytvoří doklad jen za termín, který mezitím nastal, nebo za termíny nad limit 24 z předchozího běhu. Kontrola kontaktů se do 10 minut po zapsané kontrole přeskočí (skipped); s force proběhne znovu, ale jen pro dosud neověřené kontakty.
Příklad
Ukázková firma má další opakování až příští měsíc, proto count je 0.
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"only":"recurring"}' \
https://techtools.cz/ucetnictvi-api/entities/1/automation/runJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/automation/run', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"only": "recurring"
})
});
const data = await response.json();{
"recurring": {
"count": 0,
"failed": [],
"warnings": [],
"documents": []
},
"ran": true
}
GET Přehled všech firem volajícího podle naléhavosti
/clients
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Firmy, kde je volající jen v roli Nahrává doklady, se nezahrnou.
- Klíč jen pro čtení
- Stačí
Vrátí všechny firmy, kde je volající přijatým členem (archivované na konci), s tím, co vyžaduje pozornost: stav přiznání k DPH za poslední skončené období a další lhůtu, pohledávky po splatnosti, nespárované bankovní pohyby, koncepty, uzamčení období a poslední aktivitu. Seřazeno podle naléhavosti (urgency), při shodě podle názvu. Stav DPH počítá jen s podáními druhu dph (i podaným za období, které poslední období překrývá); podání označené jako odeslané bez ověřené doručenky nebo schválené výjimky je unverified, ne filed. Období, jehož lhůta skončila dřív, než firma přišla do Salda, je before_saldo (jako ve frontě úkolů). older_unfiled počítá nepodaná dřívější období od příchodu do Salda (nejvýš dva roky zpět), kh ukazuje kontrolní hlášení posledního období (bez posouzení, zda je povinné).
Odpověď
200 application/json Souhrn a seznam firem.
| Pole | Význam |
|---|---|
today | Dnešní datum |
total | Počet vrácených firem |
truncated | true, když má volající víc než 200 firem |
limit | Nejvyšší počet vrácených firem (200) |
summary | Jen nearchivované firmy: attention, critical, vat_due (open nebo draft s lhůtou do 7 dnů, a unverified), vat_late (late nebo nepodané starší období), overdue_count, overdue_amount (Kč), unmatched, drafts |
clients[] | id, name, ico, legal_form, legal_form_label, role, role_label, archived, demo, bookkeeping, vat, overdue (count, amount v Kč), unmatched, drafts, locked_until, accountants (jména účetních firmy), can_manage (volající je vlastník nebo účetní), responsible ({ id, name } odpovědné osoby, jen když má ve firmě právo zápisu, jinak null), mine (odpovídá volající), writers (členové s právem zápisu, jen pro vlastníka a účetní nearchivované firmy, jinak null), last_activity, level, urgency |
people | Odpovědné osoby vrácených firem bez opakování: id, name |
me | ID volajícího (porovnání s responsible.id) |
clients[].vat.state | none (neregistrovaná), filed (odesláno a doloženo nebo schválená výjimka), unverified (odesláno bez doložení), draft (jen připraveno), optional (podání není povinné), before_saldo (lhůta skončila před příchodem firmy do Salda), late (nepodáno po lhůtě), open (nepodáno, lhůta běží) |
clients[].vat | Také period, deadline, days, filed_on, proof_state, external (zapsáno jako podané mimo Saldo), older_unfiled, kh { period, period_label, deadline, filing, proof_state, external } a další období next_period, next_deadline, next_days |
clients[].level | critical, warning, ok nebo archived |
Chování
- Co změní
- Nic nezapisuje.
- Limity
- Nejvýše 200 firem; výběr proběhne podle archivace a názvu ještě před řazením podle naléhavosti, takže nad 200 firem se naléhavější firma dál v abecedě nemusí vrátit.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/clientsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/clients', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"today": "2026-09-28",
"total": 2,
"truncated": false,
"limit": 200,
"summary": {
"attention": 2,
"critical": 0,
"vat_due": 1,
"vat_late": 0,
"overdue_count": 5,
"overdue_amount": 217758.0,
"unmatched": 9,
"drafts": 2
},
"clients": [
{
"id": 1,
"name": "Ukázková firma s.r.o.",
"ico": "99999994",
"legal_form": "sro",
"legal_form_label": "s.r.o.",
"role": "owner",
"role_label": "Vlastník",
"archived": false,
"demo": true,
"bookkeeping": "double_entry",
"vat": {
"status": "monthly",
"label": "Plátce DPH – měsíčně",
"payer": true,
"period": "2026-08",
"period_label": "srpen 2026",
"deadline": "2026-09-25",
"days": -3,
"filing": "filed",
"filed_on": "2026-09-24",
"proof_state": "awaiting_proof",
"external": false,
"state": "unverified",
"next_period": "2026-09",
"next_period_label": "září 2026",
"next_deadline": "2026-10-26",
"next_days": 28,
"kh": {
"period": "2026-08",
"period_label": "srpen 2026",
"deadline": "2026-09-25",
"filing": "draft",
"proof_state": "draft",
"external": false
},
"older_unfiled": 0
},
"overdue": {
"count": 2,
"amount": 96558.0
},
"unmatched": 6,
"drafts": 2,
"locked_until": null,
"accountants": [
"ucetni_ukazka"
],
"can_manage": true,
"responsible": null,
"mine": false,
"writers": [
{
"id": 1,
"name": "ukazka"
},
{
"id": 2,
"name": "ucetni_ukazka"
}
],
"last_activity": {
"at": "2026-09-28T10:00:00.000Z",
"action": "vat_registration.created",
"summary": "Registrace k DPH od 1. 1. 2027: Plátce DPH – čtvrtletně",
"user": "ukazka"
},
"level": "warning",
"urgency": 87
},
{
"id": 2,
"name": "Jan Ukázka – grafické studio (ukázka)",
"ico": "99999986",
"legal_form": "osvc",
"legal_form_label": "OSVČ",
"role": "owner",
"role_label": "Vlastník",
"archived": false,
"demo": true,
"bookkeeping": "tax_records",
"vat": {
"status": "none",
"label": "Neplátce DPH",
"payer": false,
"state": "none"
},
"overdue": {
"count": 3,
"amount": 121200.0
},
"unmatched": 3,
"drafts": 0,
"locked_until": null,
"accountants": [],
"can_manage": true,
"responsible": null,
"mine": false,
"writers": [
{
"id": 1,
"name": "ukazka"
}
],
"last_activity": {
"at": "2026-09-28T10:00:00.000Z",
"action": "bank.rule_applied",
"summary": "Pravidlo „Zdravotní pojištění“: pohyb -3306,00 CZK ze dne 7. 9. 2026 zaúčtován na V91",
"user": "ukazka"
},
"level": "warning",
"urgency": 29
}
],
"people": [],
"me": 1
}
POST Uzamkne období ve více firmách najednou
/clients/lock
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Nastaví locked_until na zadaný den ve všech vybraných firmách, kde je volající přijatým vlastníkem nebo účetní. Archivovanou firmu a firmu, která už je uzamčená stejně nebo později, přeskočí (zámek nikdy neposune zpět); firmy bez takové role přeskočí bez názvu. Uzamknout jde jen den, který už minul.
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
entity_ids | pole (celé číslo) | ano | ID firem, nejvýš 200. |
locked_until | datum | ano | Poslední uzamčený den (YYYY-MM-DD), dřívější než dnešek. |
Odpověď
200 application/json Výsledek po firmách.
| Pole | Význam |
|---|---|
locked_until | Použité datum |
locked | Počet uzamčených firem |
results[] | { id, name, status: locked nebo skipped, reason } |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Chybí datum, nebo není v minulosti |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží locked_until a v každé uzamčené firmě zapíše událost entity.locked („Uzamčeno období do … (hromadně z Klientů)“, details.from, details.to, details.bulk).
- Limity
- Nejvýš 200 firem v jednom požadavku.
- Opakování
- Opakování se stejným datem firmy přeskočí („Uzamčeno už do …“).
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"entity_ids":[1],"locked_until":"2026-08-31"}' \
https://techtools.cz/ucetnictvi-api/clients/lockJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/clients/lock', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"entity_ids": [
1
],
"locked_until": "2026-08-31"
})
});
const data = await response.json();{
"locked_until": "2026-08-31",
"results": [
{
"id": 1,
"name": "Ukázková firma s.r.o.",
"status": "locked"
}
],
"locked": 1
}
GET Fronta úkolů účetní napříč firmami
/work_items
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Firmy, kde je volající jen v roli Nahrává doklady, se nezahrnou.
- Klíč jen pro čtení
- Stačí
- V příručce
- Daně a pojistné › Úkol Doložit doručení
Vrátí konkrétní kroky ve všech nearchivovaných firmách volajícího: koncepty účetních dokladů (draft), nespárované bankovní pohyby (bank), vystavené přijaté faktury, dobropisy a výdajové pokladní doklady bez přílohy od 1. 1. předchozího roku, kromě načtených z ISDOC (missing), u plátců DPH nepodaná přiznání k DPH za každé skončené období od příchodu firmy do Salda a za období před ním, pokud jeho lhůta tehdy ještě běžela (filing; počítá se i podání se stavem filed pokrývající jen část období), a podání označená jako odeslaná bez ověřené doručenky či schválené výjimky (proof, podání všech druhů). Nepodaná kontrolní a souhrnná hlášení fronta nesleduje. K tomu vlastní úkoly (manual) založené ručně, které synchronizace nikdy nevyřeší. Před výpisem frontu synchronizuje s daty (refresh): nové a vrácené kroky otevře, otevřený krok vyřeší, jen když kontrola jeho vlastního zdroje ukáže, že je hotový, zruší přidělení lidem, kteří ve firmě ztratili právo zápisu, a otevřené kroky, které nikdo nepřidělil ručně, přidělí odpovědné osobě firmy (assigned_auto). S refresh=0 nebo s API klíčem jen pro čtení vrátí frontu tak, jak byla naposledy synchronizována.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | dotaz | celé číslo | ne | Jen kroky této firmy (firma bez členství vrátí prázdný seznam) Příklad 12. |
assignee | dotaz | text | ne | me (přidělené mně), unassigned (nepřidělené) nebo číselné ID uživatele; jiná hodnota nefiltruje Příklad me. |
priority | dotaz | text | ne | Jen kroky s touto prioritou Hodnoty: high, normal, low. Příklad high. |
due | dotaz | text | ne | overdue = termín už minul; week = termín nejpozději za 7 dní (včetně prošlých) Hodnoty: overdue, week. Příklad week. |
state | dotaz | text | ne | resolved = vyřešené za posledních 90 dní, nejnovější první; jiná hodnota znamená open Hodnoty: open, resolved. Výchozí open. Příklad open. |
refresh | dotaz | text | ne | 0 = bez synchronizace; jakákoli jiná hodnota nebo vynechání synchronizuje Hodnoty: 0, 1. Výchozí 1. Příklad 1. |
Odpověď
200 application/json Kroky, počty a lidé, kterým lze kroky přidělit.
| Pole | Význam |
|---|---|
today | Dnešní datum, ke kterému se počítá overdue |
rows | Kroky: id, entity_id, entity_name, kind, kind_label, title, detail (u vlastního úkolu poznámka), href (odkaz do aplikace, u vlastního úkolu null), due_on, period, year, overdue, priority, priority_label, assignee_id, assignee, assigned_auto (přiděleno automaticky odpovědné osobě firmy), manual, created_by, can_assign, can_resolve, can_delete, state, first_seen_at, resolved_at, resolved_by, reopened_count |
rows[].kind | filing, proof, bank, draft, missing, advance (platba zálohy bez daňového dokladu), closing (rozpuštění časového rozlišení, inventura k rozvahovému dni), manual (vlastní úkol) |
truncated | true, když je kroků víc než 1000 |
limit | Nejvyšší počet vrácených kroků (1000) |
counts | Otevřené kroky ve všech firmách bez ohledu na filtr: open, mine, unassigned, high, overdue |
firms | Firmy ve frontě: id, name, manage (volající smí přidělovat), write (smí zakládat a řešit vlastní úkoly), responsible_id (odpovědná osoba, jen když má ve firmě právo zápisu) |
people | Lidé s právem zápisu v některé z firem |
members | ID firmy → lidé s právem zápisu v ní |
me | ID volajícího |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 400 | – | Parametr entity_id, assignee, priority, due, state nebo refresh je pole či objekt („Parametr … musí být jedna hodnota“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Synchronizace zapisuje jen do fronty úkolů (nové kroky, aktualizace názvu, termínu a priority, vyřešení, znovuotevření s reopened_count, zrušení přidělení, automatické přidělení odpovědné osobě); účetní data nemění. S refresh=0 nebo klíčem jen pro čtení nic nezapisuje.
- Limity
- Nejvýše 200 nearchivovaných firem (podle názvu) a 1000 řádků. Nové kroky se hledají nejvýše po 500 na firmu a druh; krok proof jen u podání odeslaných za posledních 365 dní nebo bez data odeslání. Vyřešené kroky se vypisují 90 dní.
- Opakování
- Opakovaná synchronizace bez změny dat nic nového nezaloží.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
"https://techtools.cz/ucetnictvi-api/work_items?state=open"JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/work_items?state=open', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"today": "2026-09-28",
"rows": [
{
"id": 3,
"entity_id": 1,
"entity_name": "Ukázková firma s.r.o.",
"kind": "bank",
"kind_label": "Bankovní výjimka",
"title": "Spárovat nebo zaúčtovat pohyb 1 500,00 Kč",
"detail": "Vratka přeplatku · 15. 7. 2026",
"href": "#/banka?account=2",
"due_on": "2026-08-15",
"period": null,
"year": null,
"overdue": true,
"priority": "high",
"priority_label": "Vysoká",
"assignee_id": null,
"assignee": null,
"assigned_auto": false,
"manual": false,
"created_by": null,
"can_assign": true,
"can_resolve": false,
"can_delete": false,
"state": "open",
"first_seen_at": "2026-09-28T10:00:00.000Z",
"resolved_at": null,
"resolved_by": null,
"reopened_count": 0
},
{
"id": 4,
"entity_id": 1,
"entity_name": "Ukázková firma s.r.o.",
"kind": "bank",
"kind_label": "Bankovní výjimka",
"title": "Spárovat nebo zaúčtovat pohyb 12 100,00 Kč",
"detail": "Nordwood Studio s.r.o. · Úhrada faktury · 12. 8. 2026",
"href": "#/banka?account=2",
"due_on": "2026-09-15",
"period": null,
"year": null,
"overdue": true,
"priority": "high",
"priority_label": "Vysoká",
"assignee_id": null,
"assignee": null,
"assigned_auto": false,
"manual": false,
"created_by": null,
"can_assign": true,
"can_resolve": false,
"can_delete": false,
"state": "open",
"first_seen_at": "2026-09-28T10:00:00.000Z",
"resolved_at": null,
"resolved_by": null,
"reopened_count": 0
}
],
"truncated": false,
"limit": 1000,
"counts": {
"open": 90,
"mine": 0,
"unassigned": 90,
"high": 3,
"overdue": 3
},
"firms": [
{
"id": 2,
"name": "Jan Ukázka – grafické studio (ukázka)",
"manage": true,
"write": true,
"responsible_id": null
},
{
"id": 1,
"name": "Ukázková firma s.r.o.",
"manage": true,
"write": true,
"responsible_id": null
}
],
"people": [
{
"id": 2,
"name": "ucetni_ukazka"
},
{
"id": 1,
"name": "ukazka"
}
],
"members": {
"1": [
{
"id": 1,
"name": "ukazka"
},
{
"id": 2,
"name": "ucetni_ukazka"
}
],
"2": [
{
"id": 1,
"name": "ukazka"
}
]
},
"me": 1
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.
POST Založí vlastní úkol ve frontě
/work_items
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Firma musí být nearchivovaná a volající v ní přijatý člen (jinak 404). Zakládat smí jen člen s právem zápisu (vlastník, účetní, editor), jinak 422.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Založí vlastní úkol (kind manual) ve firmě volajícího: název, poznámku, termín, prioritu a komu. Bez assignee_id dostane úkol odpovědná osoba firmy (assigned_auto), pokud ji firma má. Synchronizace fronty vlastní úkol nikdy nevyřeší; vyřeší ho POST /work_items/{id}/resolve.
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
entity_id | celé číslo | ano | ID firmy. |
title | text | ano | Co je potřeba udělat. Nejvýše 250 znaků. |
note | text | ne | Nepovinná poznámka. Nejvýše 1000 znaků. |
assignee_id | celé číslo | ne | Komu; člen firmy s právem zápisu. Bez hodnoty odpovědná osoba firmy, nebo nikdo. |
due_on | datum | ne | Termín (RRRR-MM-DD), nepovinný. |
priority | text | ne | Priorita. Hodnoty: high, normal, low. Výchozí normal. |
Odpověď
201 application/json Založený úkol (tvar jako rows[] v GET /work_items).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 400 | – | Chybí entity_id, nebo je některý parametr pole či objekt |
| 422 | – | Volající nemá ve firmě právo zápisu („Úkol může založit jen člen firmy s právem zápisu“) |
| 422 | – | Prázdný nebo delší název, delší poznámka, neznámá priorita, neplatný termín |
| 422 | – | Osoba není členem firmy s právem zápisu („Úkol lze přidělit jen členovi firmy s právem zápisu“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží úkol a do historie firmy zapíše událost work_item.created. Účetní data nemění.
- Opakování
- Každé volání založí nový úkol.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"entity_id":1,"title":"Zavolat klientovi kvůli inventuře skladu","note":"Domluvit termín na konec prosince","due_on":"2026-12-15","priority":"normal"}' \
https://techtools.cz/ucetnictvi-api/work_itemsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/work_items', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"entity_id": 1,
"title": "Zavolat klientovi kvůli inventuře skladu",
"note": "Domluvit termín na konec prosince",
"due_on": "2026-12-15",
"priority": "normal"
})
});
const data = await response.json();{
"id": 90,
"entity_id": 1,
"entity_name": "Ukázková firma s.r.o.",
"kind": "manual",
"kind_label": "Vlastní úkol",
"title": "Zavolat klientovi kvůli inventuře skladu",
"detail": "Domluvit termín na konec prosince",
"href": null,
"due_on": "2026-12-15",
"period": null,
"year": null,
"overdue": false,
"priority": "normal",
"priority_label": "Běžná",
"assignee_id": null,
"assignee": null,
"assigned_auto": false,
"manual": true,
"created_by": "ukazka",
"can_assign": true,
"can_resolve": true,
"can_delete": true,
"state": "open",
"first_seen_at": "2026-09-28T10:00:00.000Z",
"resolved_at": null,
"resolved_by": null,
"reopened_count": 0
}
PATCH Přidělení kroku z fronty úkolů
/work_items/{id}
- Oprávnění
- Zvláštní pravidlo
- Pravidlo
- Krok musí patřit nearchivované firmě, kde je volající přijatým členem (jinak 404). Přidělovat smí vlastník nebo účetní té firmy, vlastní úkol i jeho autor s právem zápisu; ostatním vrátí 422, ne 403.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Přidělí krok fronty úkolů odpovědné osobě, nebo přidělení zruší (assignee_id null). Přidělit lze jen členovi firmy s právem zápisu (vlastník, účetní, editor). Ruční přidělení (i zrušení) má přednost před automatickým: krok už odpovědné osobě firmy nepřejde.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
id | cesta | celé číslo | ano | ID kroku fronty Příklad 301. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
assignee_id | celé číslo | ne | ID uživatele; null nebo prázdná hodnota přidělení zruší |
Odpověď
200 application/json Krok po přidělení (tvar jako rows[] v GET /work_items).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 400 | – | assignee_id je pole či objekt („Parametr assignee_id musí být jedna hodnota“) |
| 422 | – | Volající není vlastník ani účetní firmy ani autor vlastního úkolu („Úkoly smí přidělovat vlastník nebo účetní firmy, vlastní úkol i jeho autor“) |
| 422 | – | Uživatel není členem firmy s právem zápisu („Úkol lze přidělit jen členovi firmy s právem zápisu“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží odpovědnou osobu, kdo a kdy přidělil, a zapíše do historie firmy událost work_item.assigned. Účetní data nemění.
- Opakování
- Každé volání znovu uloží čas a autora přidělení a zapíše novou událost, i při stejné osobě.
Příklad
cURL
curl \
-X PATCH \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"assignee_id":2}' \
https://techtools.cz/ucetnictvi-api/work_items/1JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/work_items/1', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'PATCH',
body: JSON.stringify({
"assignee_id": 2
})
});
const data = await response.json();{
"id": 1,
"entity_id": 1,
"entity_name": "Ukázková firma s.r.o.",
"kind": "draft",
"kind_label": "Koncept dokladu",
"title": "Dokončit a vystavit koncept: Přijatá faktura 2026090418",
"detail": "Coworking Karlín s.r.o. · 17 545,00 Kč · 25. 9. 2026",
"href": "#/doklad/133",
"due_on": null,
"period": null,
"year": null,
"overdue": false,
"priority": "low",
"priority_label": "Nízká",
"assignee_id": 2,
"assignee": "ucetni_ukazka",
"assigned_auto": false,
"manual": false,
"created_by": null,
"can_assign": true,
"can_resolve": false,
"can_delete": false,
"state": "open",
"first_seen_at": "2026-09-28T10:00:00.000Z",
"resolved_at": null,
"resolved_by": null,
"reopened_count": 0
}
DELETE Smaže vlastní úkol
/work_items/{id}
- Oprávnění
- Zvláštní pravidlo
- Pravidlo
- Úkol musí patřit nearchivované firmě, kde je volající přijatým členem (jinak 404). Smazat smí autor úkolu s právem zápisu nebo vlastník či účetní firmy, jinak 422.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Smaže vlastní úkol (kind manual). Automatický krok smazat nejde, zmizí sám, až bude hotový.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
id | cesta | celé číslo | ano | ID úkolu Příklad 301. |
Odpověď
200 application/json { deleted: true, id }
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Automatický krok, nebo volající není autor ani vlastník či účetní firmy |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Smaže úkol a do historie firmy zapíše událost work_item.deleted.
- Opakování
- Druhé volání vrátí 404.
Příklad
cURL
curl \
-X DELETE \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/work_items/89JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/work_items/89', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY },
method: 'DELETE'
});
const data = await response.json();{
"deleted": true,
"id": 89
}
POST Hromadné přidělení kroků fronty
/work_items/assign
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Přidělovat smí vlastník nebo účetní firmy kroku, vlastní úkol i jeho autor (jinak not_allowed). Klíč omezený na jednu firmu vrátí 403 KEY_LIMITED_TO_FIRM.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Přidělí víc kroků fronty jedné osobě, nebo jim přidělení zruší (assignee_id null). Krok, který volající nesmí přidělit, krok firmy, kde osoba nemá právo zápisu, a ID, které ve firmách volajícího neexistuje nebo není otevřené, přeskočí a spočítá; cizí a neexistující krok se nerozlišují.
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
ids | pole (celé číslo) | ano | ID kroků z GET /work_items, nejvýš 200. |
assignee_id | celé číslo | ne | ID uživatele; null nebo prázdná hodnota přidělení zruší. |
Odpověď
200 application/json Počty.
| Pole | Význam |
|---|---|
assigned | Počet přidělených kroků |
skipped | Počet přeskočených ID |
not_member | Přeskočeno, protože osoba nemá ve firmě kroku právo zápisu |
not_allowed | Přeskočeno, protože volající krok nesmí přidělit |
not_found | Přeskočeno, protože krok mezi otevřenými kroky firem volajícího není |
assignee | Jméno osoby, nebo null |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 400 | – | ids není seznam („Parametr ids musí být seznam ID úkolů“) |
| 422 | – | Prázdný seznam nebo víc než 200 ID |
| 422 | – | Osoba nemá právo zápisu v žádné z firem kroků, které volající smí přidělit („Úkol lze přidělit jen členovi firmy s právem zápisu“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Každému přidělenému kroku uloží osobu, kdo a kdy přidělil, a do historie jeho firmy zapíše událost work_item.assigned („… (hromadně)“). Účetní data nemění.
- Limity
- Nejvýš 200 ID v jednom požadavku.
- Opakování
- Každé volání znovu uloží čas a autora přidělení a zapíše nové události.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ids":[1],"assignee_id":2}' \
https://techtools.cz/ucetnictvi-api/work_items/assignJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/work_items/assign', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"ids": [
1
],
"assignee_id": 2
})
});
const data = await response.json();{
"assigned": 1,
"skipped": 0,
"not_member": 0,
"not_allowed": 0,
"not_found": 0,
"assignee": "ucetni_ukazka"
}
POST Označí vlastní úkol jako hotový
/work_items/{id}/resolve
- Oprávnění
- Zvláštní pravidlo
- Pravidlo
- Úkol musí patřit nearchivované firmě, kde je volající přijatým členem (jinak 404). Vyřešit smí kdokoli s právem zápisu ve firmě úkolu, jinak 422.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Vyřeší vlastní úkol (kind manual): uloží stav resolved, kdy a kdo. Automatické kroky se řeší jen samy, když je hotový jejich zdroj, proto u nich vrátí 422.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
id | cesta | celé číslo | ano | ID úkolu Příklad 301. |
Odpověď
200 application/json Úkol po vyřešení (tvar jako rows[] v GET /work_items).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Automatický krok („Automatický krok se vyřeší sám, až bude hotový jeho zdroj“) |
| 422 | – | Volající nemá ve firmě právo zápisu |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží stav resolved, resolved_at a resolved_by a do historie firmy zapíše událost work_item.resolved.
- Opakování
- Už vyřešený úkol vrátí beze změny a bez nové události.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/work_items/89/resolveJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/work_items/89/resolve', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY },
method: 'POST'
});
const data = await response.json();{
"id": 89,
"entity_id": 1,
"entity_name": "Ukázková firma s.r.o.",
"kind": "manual",
"kind_label": "Vlastní úkol",
"title": "Zavolat klientovi kvůli inventuře skladu",
"detail": null,
"href": null,
"due_on": null,
"period": null,
"year": null,
"overdue": false,
"priority": "normal",
"priority_label": "Běžná",
"assignee_id": null,
"assignee": null,
"assigned_auto": false,
"manual": true,
"created_by": "ukazka",
"can_assign": true,
"can_resolve": true,
"can_delete": true,
"state": "resolved",
"first_seen_at": "2026-09-28T10:00:00.000Z",
"resolved_at": "2026-09-28T10:00:00.000Z",
"resolved_by": "ukazka",
"reopened_count": 0
}
POST Znovu otevře vlastní úkol
/work_items/{id}/reopen
- Oprávnění
- Zvláštní pravidlo
- Pravidlo
- Stejně jako resolveWorkItem – kdokoli s právem zápisu ve firmě úkolu.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Vrátí vyřešený vlastní úkol mezi otevřené a zvýší reopened_count. U automatických kroků vrátí 422.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
id | cesta | celé číslo | ano | ID úkolu Příklad 301. |
Odpověď
200 application/json Úkol po znovuotevření (tvar jako rows[] v GET /work_items).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Automatický krok, nebo volající nemá ve firmě právo zápisu |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží stav open, smaže resolved_at a resolved_by a do historie firmy zapíše událost work_item.reopened.
- Opakování
- Otevřený úkol vrátí beze změny a bez nové události.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/work_items/89/reopenJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/work_items/89/reopen', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY },
method: 'POST'
});
const data = await response.json();{
"id": 89,
"entity_id": 1,
"entity_name": "Ukázková firma s.r.o.",
"kind": "manual",
"kind_label": "Vlastní úkol",
"title": "Zavolat klientovi kvůli inventuře skladu",
"detail": null,
"href": null,
"due_on": null,
"period": null,
"year": null,
"overdue": false,
"priority": "normal",
"priority_label": "Běžná",
"assignee_id": null,
"assignee": null,
"assigned_auto": false,
"manual": true,
"created_by": "ukazka",
"can_assign": true,
"can_resolve": true,
"can_delete": true,
"state": "open",
"first_seen_at": "2026-09-28T10:00:00.000Z",
"resolved_at": null,
"resolved_by": null,
"reopened_count": 1
}
GET Výkaz práce za měsíc
/entities/{entity_id}/time_entries
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Klíč jen pro čtení
- Stačí
Vrátí záznamy výkazu práce firmy za jeden kalendářní měsíc od nejnovějšího, se součty po osobách a klientech, členy firmy pro volbu „Kdo“ a kontakty s ceníkem nebo se záznamem v měsíci. Výkaz patří firmě, která práci fakturuje (účetní kancelář, OSVČ); vyfakturovaný záznam nese číslo a stav faktury.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky (firmy, která práci fakturuje) Příklad 12. |
month | dotaz | text | ne | Měsíc RRRR-MM; bez parametru aktuální měsíc Příklad 2026-09. |
partner_id | dotaz | celé číslo | ne | Jen záznamy jednoho klienta (kontaktu firmy) Příklad 41. |
user_id | dotaz | celé číslo | ne | Jen záznamy jedné osoby Příklad 7. |
billed | dotaz | text | ne | unbilled = fakturovatelné a ještě nevyfakturované, billed = už na faktuře; bez parametru vše Hodnoty: unbilled, billed. Příklad unbilled. |
Odpověď
200 application/json Záznamy, součty a číselníky pro filtr.
| Pole | Význam |
|---|---|
month, month_label | Měsíc RRRR-MM a jeho název („září 2026“) |
entries[] | id, worked_on, minutes, description, billable, partner_id, partner_name, user_id, user_name, document_id, document_number, document_status, created_at |
totals | minutes, billable_minutes, unbilled_minutes, billed_minutes, by_person [{ user_id, name, minutes }], by_client [{ partner_id, name, minutes }] za měsíc s filtrem klienta a osoby (bez filtru billed) |
people[] | Přijatí členové firmy kromě role Nahrává doklady: id, name |
clients[] | Kontakty s ceníkem nebo se záznamem v měsíci: id, name, ico, agreement, client_entity_id |
truncated | true, když měsíc má víc než 2 000 záznamů (vrátí se nejnovější) |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Měsíc není RRRR-MM nebo je mimo roky 2000–2100 |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Nic nezapisuje.
- Limity
- Nejvýš 2 000 záznamů.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
"https://techtools.cz/ucetnictvi-api/entities/1/time_entries?month=2026-09"JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/time_entries?month=2026-09', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"month": "2026-09",
"month_label": "září 2026",
"entries": [
{
"id": 1,
"partner_id": 1,
"user_id": 1,
"worked_on": "2026-09-15",
"minutes": 60,
"description": "Měsíční uzávěrka",
"billable": true,
"document_id": null,
"created_at": "2026-09-28T10:00:00.000Z",
"partner_name": "Nordwood Studio s.r.o.",
"user_name": "ukazka",
"document_number": null,
"document_status": null
}
],
"totals": {
"minutes": 60,
"billable_minutes": 60,
"unbilled_minutes": 60,
"billed_minutes": 0,
"by_person": [
{
"user_id": 1,
"name": "ukazka",
"minutes": 60
}
],
"by_client": [
{
"partner_id": 1,
"name": "Nordwood Studio s.r.o.",
"minutes": 60
}
]
},
"people": [
{
"id": 1,
"name": "ukazka"
},
{
"id": 2,
"name": "ucetni_ukazka"
}
],
"clients": [
{
"id": 1,
"name": "Nordwood Studio s.r.o.",
"ico": "90000013",
"agreement": false,
"client_entity_id": null
}
],
"truncated": false
}
POST Zapíše práci do výkazu
/entities/{entity_id}/time_entries
- Oprávnění
- Vlastník, účetní nebo editor
- Pravidlo
- client_entity_id cizí firmy (volající v ní není přijatým členem) odpoví 404 stejně jako neexistující firma.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Zapíše jeden záznam: klienta (kontakt firmy), kdo pracoval, den, dobu a popis a zda se fakturuje. Místo partner_id jde poslat client_entity_id – firmu v Saldu, ve které je volající členem (tlačítko „Zapsat práci“ v Klientech): Saldo použije kontakt s ní propojený, jinak kontakt se stejným IČO, jinak kontakt založí z údajů firmy, a firmu s kontaktem propojí. Doba jde zadat v minutách (minutes), nebo jako duration „1:30“, „1,5“ (hodiny) či „90m“.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky (firmy, která práci fakturuje) Příklad 12. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
time_entry | objekt | ano | |
time_entry. | celé číslo | ne | Klient – kontakt této firmy (nebo client_entity_id mimo time_entry) |
time_entry. | celé číslo | ne | Kdo pracoval – přijatý člen firmy; bez hodnoty volající |
time_entry. | datum | ano | Den práce |
time_entry. | celé číslo | ne | Doba v minutách, 1 až 1 440 |
time_entry. | text | ne | Doba jako text: „1:30“, „1,5“ (hodiny) nebo „90m“; použije se, když chybí minutes |
time_entry. | text | ne | Co se dělalo – na faktuře u hodin Nejvýše 500 znaků. |
time_entry. | ano/ne | ne | Fakturovat Výchozí true. |
Odpověď
201 application/json Zapsaný záznam (tvar jako entries[] v GET time_entries).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | client_entity_id firmy, kde volající není členem, nebo neexistující |
| 422 | – | Chybí klient nebo patří jiné firmě, osoba není členem firmy, doba mimo 1 až 1 440 minut, den mimo roky 2000–2100 |
| 422 | – | client_entity_id je sama tato firma („Práci pro vlastní firmu do výkazu nezapisujte“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží záznam. S client_entity_id případně založí kontakt a ceník s propojenou firmou. Účetní data nemění.
- Opakování
- Každé volání zapíše nový záznam.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"time_entry":{"partner_id":1,"worked_on":"2026-09-22","duration":"1:30","description":"Konzultace k DPH za srpen"}}' \
https://techtools.cz/ucetnictvi-api/entities/1/time_entriesJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/time_entries', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"time_entry": {
"partner_id": 1,
"worked_on": "2026-09-22",
"duration": "1:30",
"description": "Konzultace k DPH za srpen"
}
})
});
const data = await response.json();{
"id": 2,
"partner_id": 1,
"user_id": 1,
"worked_on": "2026-09-22",
"minutes": 90,
"description": "Konzultace k DPH za srpen",
"billable": true,
"document_id": null,
"created_at": "2026-09-28T10:00:00.000Z",
"partner_name": "Nordwood Studio s.r.o.",
"user_name": "ukazka",
"document_number": null,
"document_status": null
}
PATCH Upraví záznam výkazu
/entities/{entity_id}/time_entries/{id}
- Oprávnění
- Vlastník, účetní nebo editor
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Změní klienta, osobu, den, dobu, popis nebo příznak fakturace. Vyfakturovaný záznam změnit nejde, dokud je na faktuře (smazáním konceptu faktury se uvolní). PUT je totéž.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
id | cesta | celé číslo | ano | ID záznamu Příklad 301. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
time_entry | objekt | ano | |
time_entry. | celé číslo | ne | Klient – kontakt této firmy |
time_entry. | celé číslo | ne | Kdo pracoval – přijatý člen firmy |
time_entry. | datum | ne | Den práce |
time_entry. | celé číslo | ne | Doba v minutách |
time_entry. | text | ne | Doba jako text, když chybí minutes |
time_entry. | text | ne | Popis Nejvýše 500 znaků. |
time_entry. | ano/ne | ne | Fakturovat |
Odpověď
200 application/json Upravený záznam (tvar jako entries[] v GET time_entries).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | Záznam nepatří firmě |
| 422 | – | Záznam je vyfakturovaný (code BILLED), nebo neplatné hodnoty jako u zápisu |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží změnu. Účetní data nemění.
- Opakování
- Stejná změna podruhé nic nemění.
Příklad
cURL
curl \
-X PATCH \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"time_entry":{"minutes":105,"description":"Konzultace k DPH za srpen a kontrolní hlášení"}}' \
https://techtools.cz/ucetnictvi-api/entities/1/time_entries/1JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/time_entries/1', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'PATCH',
body: JSON.stringify({
"time_entry": {
"minutes": 105,
"description": "Konzultace k DPH za srpen a kontrolní hlášení"
}
})
});
const data = await response.json();{
"id": 1,
"partner_id": 1,
"user_id": 1,
"worked_on": "2026-09-15",
"minutes": 105,
"description": "Konzultace k DPH za srpen a kontrolní hlášení",
"billable": true,
"document_id": null,
"created_at": "2026-09-28T10:00:00.000Z",
"partner_name": "Nordwood Studio s.r.o.",
"user_name": "ukazka",
"document_number": null,
"document_status": null
}
DELETE Smaže záznam výkazu
/entities/{entity_id}/time_entries/{id}
- Oprávnění
- Vlastník, účetní nebo editor
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Smaže záznam, který není na faktuře.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
id | cesta | celé číslo | ano | ID záznamu Příklad 301. |
Odpověď
204 Bez obsahu.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | Záznam nepatří firmě |
| 422 | – | Záznam je vyfakturovaný (code BILLED) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Smaže záznam a do historie firmy zapíše událost time_entry.deleted.
- Opakování
- Druhé volání vrátí 404.
Příklad
cURL
curl \
-X DELETE \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/time_entries/1JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/time_entries/1', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY },
method: 'DELETE'
});
const data = await response.json();soubor, 0 bajtů
GET Ceníky klientů
/entities/{entity_id}/billing/agreements
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Klíč jen pro čtení
- Stačí
Vrátí ceníky (dohody) kontaktů firmy: měsíční paušál, hodinovou sazbu, ceny za doklad, bankovní pohyb a mzdový list, splatnost, text na fakturu a propojenou firmu klienta v Saldu.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Odpověď
200 application/json Pole ceníků.
| Pole | Význam |
|---|---|
id, partner_id, partner_name | Ceník a kontakt |
monthly_fee, hourly_rate, document_price, bank_price, payslip_price | Ceny bez DPH v Kč, null = nesjednáno |
due_days, invoice_text | Splatnost faktury ve dnech a text na fakturu |
client_entity_id, client_entity_name | Propojená firma v Saldu; název jen pro jejího člena, jinak null |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/billing/agreementsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/billing/agreements', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();[]
PATCH Uloží ceník klienta
/entities/{entity_id}/billing/agreements/{partner_id}
- Oprávnění
- Vlastník, účetní nebo editor
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Založí nebo změní ceník jednoho kontaktu. Všechny ceny jsou nepovinné a bez DPH (DPH doplní faktura podle registrace firmy). client_entity_id propojí kontakt s firmou v Saldu, ze které se pak počítá objem měsíce; propojit jde jen firmu, kde je volající přijatým členem, a jednu firmu jen s jedním kontaktem. null propojení zruší. PUT je totéž.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
partner_id | cesta | celé číslo | ano | ID kontaktu firmy Příklad 41. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
agreement | objekt | ano | |
agreement. | číslo | ne | Měsíční paušál bez DPH |
agreement. | číslo | ne | Hodinová sazba bez DPH |
agreement. | číslo | ne | Cena za zaúčtovaný doklad |
agreement. | číslo | ne | Cena za bankovní pohyb |
agreement. | číslo | ne | Cena za mzdový list (výplatní pásku) |
agreement. | celé číslo | ne | Splatnost faktury ve dnech (0–365); bez hodnoty splatnost kontaktu nebo firmy |
agreement. | text | ne | Text na fakturu (Text na dokladu) Nejvýše 1000 znaků. |
agreement. | celé číslo | ne | Firma klienta v Saldu, kde je volající členem |
Odpověď
200 application/json Uložený ceník (tvar jako v GET billing/agreements); nový vrací 201.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | Kontakt nepatří firmě |
| 422 | – | Záporná nebo příliš vysoká cena, splatnost mimo 0–365, text nad 1 000 znaků |
| 422 | – | client_entity_id firmy, kde volající není členem, této firmy, nebo firmy propojené s jiným kontaktem |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží ceník a do historie firmy zapíše událost billing.agreement_saved.
- Opakování
- Stejné hodnoty podruhé nic nemění kromě nové události.
Příklad
cURL
curl \
-X PATCH \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"agreement":{"monthly_fee":4500,"hourly_rate":900,"document_price":35,"bank_price":8,"due_days":14,"invoice_text":"Fakturujeme vedení účetnictví podle smlouvy."}}' \
https://techtools.cz/ucetnictvi-api/entities/1/billing/agreements/1JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/billing/agreements/1', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'PATCH',
body: JSON.stringify({
"agreement": {
"monthly_fee": 4500,
"hourly_rate": 900,
"document_price": 35,
"bank_price": 8,
"due_days": 14,
"invoice_text": "Fakturujeme vedení účetnictví podle smlouvy."
}
})
});
const data = await response.json();{
"id": 1,
"bank_price": 8.0,
"client_entity_id": null,
"created_at": "2026-09-28T10:00:00.000Z",
"document_price": 35.0,
"due_days": 14,
"hourly_rate": 900.0,
"invoice_text": "Fakturujeme vedení účetnictví podle smlouvy.",
"monthly_fee": 4500.0,
"partner_id": 1,
"payslip_price": null,
"updated_at": "2026-09-28T10:00:00.000Z",
"partner_name": "Nordwood Studio s.r.o.",
"client_entity_name": null
}
DELETE Smaže ceník klienta
/entities/{entity_id}/billing/agreements/{partner_id}
- Oprávnění
- Vlastník, účetní nebo editor
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Smaže ceník kontaktu i jeho propojení s firmou v Saldu. Výkaz práce a faktury zůstanou.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
partner_id | cesta | celé číslo | ano | ID kontaktu Příklad 41. |
Odpověď
204 Bez obsahu.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | Kontakt nemá ceník nebo nepatří firmě |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Smaže ceník a do historie firmy zapíše událost billing.agreement_deleted.
- Opakování
- Druhé volání vrátí 404.
Příklad
cURL
curl \
-X DELETE \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/billing/agreements/1JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/billing/agreements/1', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY },
method: 'DELETE'
});
const data = await response.json();soubor, 0 bajtů
GET Náhled fakturace měsíce
/entities/{entity_id}/billing/preview
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Klíč jen pro čtení
- Stačí
Pro každého klienta s ceníkem nebo s nevyfakturovaným fakturovatelným časem do konce měsíce spočítá položky budoucí faktury: měsíční paušál, doklady × cena (zaúčtované doklady s datem účetního případu v měsíci), bankovní pohyby × cena, výplatní pásky × cena a hodiny × sazba (jeden řádek na záznam s datem a popisem), a součty bez DPH, DPH a celkem tak, jak je spočítá faktura. Objem se čte z propojené firmy klienta jen tehdy, když je v ní volající přijatým členem (pásky jen s přístupem ke mzdám); jinak platí počet z counts, nebo 0 s upozorněním. Paušál a objem měsíce, který už je na faktuře, se znovu nenabízí.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky (firmy, která fakturuje) Příklad 12. |
month | dotaz | text | ne | Měsíc RRRR-MM; bez parametru minulý měsíc Příklad 2026-09. |
counts | dotaz | objekt | ne | Ručně zadané počty po kontaktech: counts[<partner_id>][documents|bank|payslips] Příklad {"41" => {"documents" => 18, "bank" => 25}}. |
Odpověď
200 application/json Klienti s položkami a součty.
| Pole | Význam |
|---|---|
month, month_label, total, ready | Měsíc, jeho název, součet všech faktur s DPH a počet klientů s čím fakturovat |
clients[] | partner_id, name, ico, agreement, client_entity ({ id, name jen pro člena, member }), billed ({ document_id, number, status } když paušál a objem měsíce už jsou na faktuře), counts, entries, minutes, lines, total_net, total_vat, total, warnings, ready |
clients[].counts | Pro každou sjednanou cenu: documents, bank, payslips → { count, source: saldo | manual, price, reason } |
clients[].lines[] | kind (fee, documents, bank, payslips, time), description, quantity, unit, unit_price, amount bez DPH |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Měsíc není RRRR-MM nebo je mimo roky 2000–2100 |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
"https://techtools.cz/ucetnictvi-api/entities/1/billing/preview?month=2026-09"JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/billing/preview?month=2026-09', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"month": "2026-09",
"month_label": "září 2026",
"clients": [
{
"partner_id": 1,
"name": "Nordwood Studio s.r.o.",
"ico": "90000013",
"agreement": null,
"client_entity": null,
"billed": null,
"counts": {},
"entries": 1,
"minutes": 60,
"lines": [
{
"kind": "time",
"description": "15. 9. 2026 – Měsíční uzávěrka",
"quantity": 1.0,
"unit": "h",
"unit_price": 0.0,
"amount": 0.0
}
],
"total_net": 0.0,
"total_vat": 0.0,
"total": 0.0,
"warnings": [
"Bez hodinové sazby – hodiny budou na faktuře za 0 Kč, doplňte sazbu v ceníku"
],
"ready": true
}
],
"total": 0.0,
"ready": 1
}
POST Připraví koncepty faktur za měsíc
/entities/{entity_id}/billing/invoices
- Oprávnění
- Vlastník, účetní nebo editor
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Pro vybrané klienty vytvoří koncept vydané faktury s položkami z náhledu (GET billing/preview): datum vystavení dnes, DUZP poslední den měsíce (nejpozději dnes), splatnost z ceníku, kontaktu nebo firmy, text na fakturu, sazba DPH podle registrace firmy. Vyfakturované záznamy výkazu dostanou odkaz na fakturu a paušál s objemem se u měsíce označí, aby se neúčtovaly dvakrát; smazáním konceptu se obojí uvolní. Každý klient je samostatná transakce.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky (firmy, která fakturuje) Příklad 12. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
month | text | ne | Měsíc RRRR-MM; bez hodnoty minulý měsíc |
partner_ids | pole (celé číslo) | ano | Kontakty, kterým fakturovat, nejvýš 200 |
counts | objekt | ne | Ručně zadané počty jako v náhledu |
Odpověď
201 application/json Výsledek po klientech.
| Pole | Význam |
|---|---|
month, created | Měsíc a počet vytvořených konceptů |
results[] | { partner_id, name, status: created | skipped | error, document_id, total, reason } |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 400 | – | partner_ids není seznam |
| 422 | – | Měsíc není RRRR-MM |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Vytvoří koncepty vydaných faktur (událost document.created), označí záznamy výkazu a měsíc a zapíše událost billing.invoices_created. Nic nevystaví ani nezaúčtuje.
- Limity
- Nejvýš 200 klientů v jednom požadavku.
- Opakování
- Klient, který už nemá co fakturovat, se přeskočí (skipped), takže druhé volání nic nezdvojí.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"month":"2026-09","partner_ids":[1]}' \
https://techtools.cz/ucetnictvi-api/entities/1/billing/invoicesJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/billing/invoices', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"month": "2026-09",
"partner_ids": [
1
]
})
});
const data = await response.json();{
"month": "2026-09",
"results": [
{
"partner_id": 1,
"name": "Nordwood Studio s.r.o.",
"status": "created",
"document_id": 136,
"total": 0.0
}
],
"created": 1
}
GET Žádosti o podklady ve firmě
/entities/{entity_id}/document_requests
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Pravidlo
- Role Nahrává doklady (submitter): jen žádosti, které mu někdo přidělil; members je prázdné a odkaz na pohyb v bance chybí.
- Klíč jen pro čtení
- Stačí
Vrátí žádosti o chybějící doklad nebo vysvětlení k bankovnímu pohybu či dokladu, bez zpráv. Otevřené (waiting, delivered) jsou seřazené podle termínu (žádosti bez termínu na konci, při shodě nejnovější první), uzavřené (verified, cancelled) od posledně uzavřené; s filter=all jsou otevřené první. filter=action vrátí jen otevřené žádosti, které čekají na volajícího.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
filter | dotaz | text | ne | open = čekající a dodané; action = z nich ty, na které má volající odpovědět nebo které smí ověřit; closed = ověřené a zrušené; all = vše. Jiná hodnota znamená open. Hodnoty: open, action, closed, all. Výchozí open. Příklad open. |
subject_type | dotaz | text | ne | Jen žádosti k tomuto druhu položky – vyžaduje subject_ids Hodnoty: bank_transaction, document. Příklad bank_transaction. |
subject_ids | dotaz | text | ne | ID položek oddělená čárkou (nejvýše 500); bez subject_type se ignorují, bez nich je výsledek prázdný Příklad 4711,4712. |
Odpověď
200 application/json Žádosti a počty.
| Pole | Význam |
|---|---|
rows | Žádosti: id, title, status, status_label, subject, requested_by, assignee_id, assignee, due_on, overdue, created_at, updated_at, closed_at, action_needed, can_reply, can_verify, can_cancel, files_count |
rows[].status | waiting (čeká na podklad), delivered (podklad dodán), verified (ověřeno), cancelled (zrušeno) |
rows[].subject | type, id, label, amount, currency, date, partner, href; u pohybu i message a tx_status; u smazané položky missing true |
rows[].assignee_id | Odpovědná osoba, jen dokud má ve firmě právo zápisu, jinak null. Určuje, na koho žádost čeká (action_needed); odpovědět smí kterýkoli člen s právem zápisu |
truncated | true, když žádostí je víc než limit |
limit | 500 |
action_needed | Počet všech otevřených žádostí firmy, které čekají na volajícího (bez ohledu na filtr) |
members | Členové s právem zápisu (id, name, role); žádost lze přidělit kterémukoli z nich kromě sebe |
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Neznámý subject_type („Neznámý druh položky“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Nic nezapisuje.
- Limity
- Nejvýše 500 žádostí; u filter=action se limit uplatní před výběrem žádostí čekajících na volajícího.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
"https://techtools.cz/ucetnictvi-api/entities/1/document_requests?filter=all"JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests?filter=all', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"rows": [
{
"id": 1,
"title": "Doklad k příchozí platbě",
"status": "delivered",
"status_label": "Podklad dodán",
"subject": {
"type": "bank_transaction",
"id": 64,
"label": "Platba 18 150,00 Kč z 25. 9. 2026",
"amount": 18150.0,
"currency": "CZK",
"date": "2026-09-25",
"partner": "Atelier Lumen s.r.o.",
"message": "Úhrada – viz smlouva",
"tx_status": "unmatched",
"href": "#/banka?tx=64"
},
"requested_by": "ukazka",
"assignee_id": 2,
"assignee": "ucetni_ukazka",
"due_on": "2026-10-05",
"overdue": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z",
"closed_at": null,
"action_needed": true,
"can_reply": true,
"can_verify": true,
"can_cancel": true,
"files_count": 1
}
],
"truncated": false,
"limit": 500,
"action_needed": 1,
"members": [
{
"id": 1,
"name": "ukazka",
"role": "owner"
},
{
"id": 2,
"name": "ucetni_ukazka",
"role": "accountant"
}
]
}
POST Žádost o doklad nebo vysvětlení k pohybu či dokladu
/entities/{entity_id}/document_requests
- Oprávnění
- Vlastník, účetní nebo editor
- Pravidlo
- Odpovědnou osobou (assignee_id) může být i člen s rolí Nahrává doklady; uvidí pak jen tuto žádost a položku, které se týká.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Založí žádost o podklad k bankovnímu pohybu nebo účetnímu dokladu (i konceptu) s první zprávou. K jedné položce může být otevřená jen jedna žádost; k nabídce, objednávce a dodacímu listu žádost založit nelze. Odpovědnou osobou může být jiný člen firmy s právem zápisu, ne sám žadatel. Smazání pohybu nebo dokladu jeho otevřenou žádost zruší se systémovou zprávou.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
subject_type | text | ano | Druh položky Hodnoty: bank_transaction, document. |
subject_id | celé číslo | ano | ID bankovního pohybu nebo dokladu v této firmě |
question | text | ano | Co je potřeba dodat, nejvýše 2000 znaků |
title | text | ne | Název žádosti, nejvýše 200 znaků (delší se zkrátí); výchozí „Doklad nebo vysvětlení k platbě“ nebo „Chybějící podklad k dokladu“ |
assignee_id | celé číslo | ne | ID uživatele, který má odpovědět – jiný člen s právem zápisu |
due_on | datum | ne | Termín, dnes nebo později |
Odpověď
201 application/json Nová žádost se zprávami (tvar jako GET …/document_requests/{id}), status waiting.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Neznámý subject_type („Žádost lze založit k bankovnímu pohybu nebo dokladu“) |
| 422 | – | Položka je nabídka, objednávka nebo dodací list |
| 422 | – | K položce už je otevřená žádost („K této položce už je otevřená žádost … – pokračujte v ní“) |
| 422 | – | Prázdná otázka nebo delší než 2000 znaků |
| 422 | – | Termín v minulosti („Termín nemůže být v minulosti“) |
| 422 | – | Odpovědnou osobou je sám žadatel, nebo člen bez práva zápisu |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Vytvoří žádost ve stavu waiting a zprávu s otázkou a zapíše událost document_request.created. Bankovní pohyb ani doklad nemění a nic neúčtuje.
- Opakování
- Druhá žádost ke stejné položce vrátí 422, dokud je první otevřená; po uzavření lze založit novou.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"subject_type":"bank_transaction","subject_id":22,"title":"Doklad k platbě","question":"Prosím o fakturu nebo účtenku k této platbě."}' \
https://techtools.cz/ucetnictvi-api/entities/1/document_requestsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"subject_type": "bank_transaction",
"subject_id": 22,
"title": "Doklad k platbě",
"question": "Prosím o fakturu nebo účtenku k této platbě."
})
});
const data = await response.json();{
"id": 2,
"title": "Doklad k platbě",
"status": "waiting",
"status_label": "Čeká na podklad",
"subject": {
"type": "bank_transaction",
"id": 22,
"label": "Platba 77 440,00 Kč z 22. 9. 2026",
"amount": 77440.0,
"currency": "CZK",
"date": "2026-09-22",
"partner": "Kavárna U Zeleného stromu s.r.o.",
"message": "Úhrada faktury FV20260022",
"tx_status": "matched",
"href": "#/banka?tx=22"
},
"requested_by": "ukazka",
"assignee_id": null,
"assignee": null,
"due_on": null,
"overdue": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z",
"closed_at": null,
"action_needed": false,
"can_reply": true,
"can_verify": false,
"can_cancel": true,
"files_count": 0,
"attachable_files": 0,
"messages": [
{
"id": 3,
"kind": "question",
"user": "ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Prosím o fakturu nebo účtenku k této platbě.",
"files": []
}
]
}
POST Hromadná žádost o podklady k více dokladům nebo pohybům
/entities/{entity_id}/document_requests/bulk
- Oprávnění
- Vlastník, účetní nebo editor
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Založí ke každé vybrané položce jednu žádost se stejnou otázkou, odpovědnou osobou a termínem – typicky originály přijatých dokladů, které chybí (filtr state=missing_original v seznamu dokladů). Položky s otevřenou žádostí, nabídky, objednávky, dodací listy a položky jiné firmy se přeskočí s důvodem; otázka, termín a odpovědná osoba se kontrolují jednou pro všechny jako u createDocumentRequest.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
subject_type | text | ano | Druh všech položek Hodnoty: bank_transaction, document. |
subject_ids | pole (celé číslo) | ano | ID položek v této firmě, nejvýše 100 (lze i text oddělený čárkou) |
question | text | ano | Co je potřeba dodat, nejvýše 2000 znaků |
assignee_id | celé číslo | ne | ID uživatele, který má odpovědět – jiný člen s právem zápisu |
due_on | datum | ne | Termín, dnes nebo později |
Odpověď
201 application/json created – nové žádosti (tvar jako v rows[] seznamu), skipped – přeskočené položky s id a reason.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Prázdný seznam, víc než 100 položek, neznámý subject_type, prázdná nebo dlouhá otázka, termín v minulosti nebo nepovolená odpovědná osoba |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Pro každou založenou žádost totéž co createDocumentRequest (žádost waiting, zpráva s otázkou, událost document_request.created). Nic neúčtuje.
- Opakování
- Opakované volání přeskočí položky, které už otevřenou žádost mají.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"subject_type":"document","subject_ids":[30],"question":"Prosím o originál dokladu – sken nebo fotku."}' \
https://techtools.cz/ucetnictvi-api/entities/1/document_requests/bulkJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests/bulk', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"subject_type": "document",
"subject_ids": [
30
],
"question": "Prosím o originál dokladu – sken nebo fotku."
})
});
const data = await response.json();{
"created": [
{
"id": 2,
"title": "Chybějící podklad k dokladu",
"status": "waiting",
"status_label": "Čeká na podklad",
"subject": {
"type": "document",
"id": 30,
"label": "Přijatá faktura FP20260001",
"amount": 17545.0,
"currency": "CZK",
"date": "2026-01-02",
"partner": "Coworking Karlín s.r.o.",
"href": "#/doklad/30"
},
"requested_by": "ukazka",
"assignee_id": null,
"assignee": null,
"due_on": null,
"overdue": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z",
"closed_at": null,
"action_needed": false,
"can_reply": true,
"can_verify": false,
"can_cancel": true,
"files_count": 0
}
],
"skipped": []
}
GET Detail žádosti o podklad se zprávami a soubory
/entities/{entity_id}/document_requests/{id}
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Pravidlo
- Role Nahrává doklady (submitter): jen přidělená žádost, jiná vrátí 404.
- Klíč jen pro čtení
- Stačí
Vrátí žádost se všemi zprávami (otázka, odpovědi, ověření, zrušení) a jejich soubory a s tím, co smí volající udělat (can_reply, can_verify, can_cancel).
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
id | cesta | celé číslo | ano | ID žádosti Příklad 88. |
Odpověď
200 application/json Žádost (pole jako v rows[] seznamu) a zprávy.
| Pole | Význam |
|---|---|
messages | Zprávy od nejstarší: id, kind (question, reply, verified, cancelled), user (null u systémové zprávy po smazání položky), at, body, files (id, filename, content_type, byte_size) |
attachable_files | Kolik souborů dodaných jinými než žadatelem by ověření s attach přiložilo k dokladu (0 u pohybu nebo když volající ověřit nesmí) |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"id": 1,
"title": "Doklad k příchozí platbě",
"status": "delivered",
"status_label": "Podklad dodán",
"subject": {
"type": "bank_transaction",
"id": 64,
"label": "Platba 18 150,00 Kč z 25. 9. 2026",
"amount": 18150.0,
"currency": "CZK",
"date": "2026-09-25",
"partner": "Atelier Lumen s.r.o.",
"message": "Úhrada – viz smlouva",
"tx_status": "unmatched",
"href": "#/banka?tx=64"
},
"requested_by": "ukazka",
"assignee_id": 2,
"assignee": "ucetni_ukazka",
"due_on": "2026-10-05",
"overdue": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z",
"closed_at": null,
"action_needed": true,
"can_reply": true,
"can_verify": true,
"can_cancel": true,
"files_count": 1,
"attachable_files": 0,
"messages": [
{
"id": 1,
"kind": "question",
"user": "ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Pošlete prosím fakturu nebo smlouvu k platbě 7 260 Kč.",
"files": []
},
{
"id": 2,
"kind": "reply",
"user": "ucetni_ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Posílám smlouvu.",
"files": [
{
"id": 4,
"filename": "faktura.pdf",
"content_type": "application/pdf",
"byte_size": 152
}
]
}
]
}
GET Počty otevřených žádostí a žádostí čekajících na volajícího
/entities/{entity_id}/document_requests/counts
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Pravidlo
- Role Nahrává doklady (submitter): počítá jen žádosti, které mu někdo přidělil.
- Klíč jen pro čtení
- Stačí
Vrátí jen počty bez žádostí a zpráv – pro odznaky v aplikaci. action_needed počítá žádosti, na které má volající odpovědět (není žadatel a žádost je přidělená jemu nebo nikomu), a dodané žádosti, které smí ověřit; člen bez práva zápisu má vždy 0.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Odpověď
200 application/json Počty.
| Pole | Význam |
|---|---|
open | Otevřené žádosti firmy (waiting a delivered) |
action_needed | Z nich ty, které čekají na volajícího |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/document_requests/countsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests/counts', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"open": 1,
"action_needed": 1
}
POST Odpověď na žádost o podklad, případně se soubory
/entities/{entity_id}/document_requests/{id}/reply
- Oprávnění
- Vlastník, účetní nebo editor
- Pravidlo
- Role Nahrává doklady (submitter): odpoví jen na přidělenou žádost, jiná vrátí 404.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Přidá do otevřené žádosti odpověď s textem a/nebo soubory. Odpověď kohokoli jiného než žadatele žádost označí jako dodanou (delivered); odpověď žadatele (doplňující dotaz) ji vrátí do stavu waiting. Soubory zůstávají u žádosti – k dokladu se přiloží až při ověření s attach. Soubory se posílají jako multipart/form-data v poli files[] (nebo files[0], files[1] …); odpověď bez souborů lze poslat i jako JSON.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
id | cesta | celé číslo | ano | ID žádosti Příklad 88. |
Tělo požadavku
Formát multipart/form-data.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
body | text | ne | Text odpovědi, nejvýše 2000 znaků; povinný, není-li přiložen soubor |
files | pole (text) | ne | Nejvýše 5 souborů PDF, JPEG, PNG, WebP, GIF, HEIC/HEIF nebo XML (typ se určí z obsahu), každý nejvýše 15 MB, dohromady nejvýše 20 MB |
Odpověď
200 application/json Žádost se zprávami po odpovědi (tvar jako GET …/document_requests/{id}).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Žádost je uzavřená („Žádost je uzavřená – případně založte novou“) |
| 422 | – | Chybí text i soubor, nebo je text delší než 2000 znaků |
| 422 | – | Víc než 5 souborů, prázdný soubor, soubor nad 15 MB, nepovolený typ nebo víc než 20 MB dohromady |
| 422 | – | V poli files není soubor („Soubory se nepodařilo přečíst – pošlete je jako multipart/form-data v poli files[]“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží zprávu a soubory a změní stav žádosti (delivered s časem a autorem dodání, nebo waiting); zapíše událost document_request.delivered nebo document_request.followed_up. Doklad ani pohyb nemění, nic neúčtuje. Když cokoli selže, nahrané soubory se smažou.
- Limity
- 5 souborů, 15 MB na soubor, 20 MB na odpověď, 2000 znaků textu.
- Opakování
- Každé volání přidá novou zprávu; stejné soubory se neslučují.
Příklad
V ukázce odpovídá sám žadatel (doplňující dotaz), proto se žádost vrátí do stavu waiting; odpověď jiného člena by ji označila jako delivered.
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-F "body=Posílám účtenku z čerpací stanice." \
-F "files[]=@uctenka.jpg" \
https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/replyJavaScript
const form = new FormData();
form.append('files[]', fileInput.files[0], 'uctenka.jpg');
form.append('body', 'Posílám účtenku z čerpací stanice.');
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/reply', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY },
method: 'POST',
body: form
});
const data = await response.json();{
"id": 1,
"title": "Doklad k příchozí platbě",
"status": "waiting",
"status_label": "Čeká na podklad",
"subject": {
"type": "bank_transaction",
"id": 64,
"label": "Platba 18 150,00 Kč z 25. 9. 2026",
"amount": 18150.0,
"currency": "CZK",
"date": "2026-09-25",
"partner": "Atelier Lumen s.r.o.",
"message": "Úhrada – viz smlouva",
"tx_status": "unmatched",
"href": "#/banka?tx=64"
},
"requested_by": "ukazka",
"assignee_id": 2,
"assignee": "ucetni_ukazka",
"due_on": "2026-10-05",
"overdue": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z",
"closed_at": null,
"action_needed": false,
"can_reply": true,
"can_verify": false,
"can_cancel": true,
"files_count": 2,
"attachable_files": 0,
"messages": [
{
"id": 1,
"kind": "question",
"user": "ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Pošlete prosím fakturu nebo smlouvu k platbě 7 260 Kč.",
"files": []
},
{
"id": 2,
"kind": "reply",
"user": "ucetni_ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Posílám smlouvu.",
"files": [
{
"id": 4,
"filename": "faktura.pdf",
"content_type": "application/pdf",
"byte_size": 152
}
]
}
]
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.
POST Ověření dodaného podkladu a uzavření žádosti
/entities/{entity_id}/document_requests/{id}/verify
- Oprávnění
- Zvláštní pravidlo
- Pravidlo
- Vyžaduje právo zápisu. Ověřit smí žadatel, dokud má ve firmě právo zápisu; jinak vlastník nebo účetní. Nikdy člen, který podklad dodal. Nesplnění vrátí 422.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Uzavře dodanou žádost jako ověřenou. U žádosti k dokladu s attach=true zkopíruje k dokladu jako přílohy soubory, které v odpovědích dodal někdo jiný než žadatel a které doklad ještě nemá (podle kontrolního součtu). Nic se neúčtuje a stav bankovního pohybu se nemění.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
id | cesta | celé číslo | ano | ID žádosti Příklad 88. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
attach | ano/ne | ne | Přiložit dodané soubory k dokladu (jen u žádosti k dokladu) Výchozí false. |
Odpověď
200 application/json Žádost se zprávami po ověření (status verified).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Volající nesmí ověřit („Ověřit smí ten, kdo o podklad požádal; vlastník nebo účetní jen za žadatele, který už nemá právo zápisu“) |
| 422 | – | Žádost je uzavřená („Žádost je už uzavřená“) |
| 422 | – | Žádost není ve stavu delivered („Ověřit lze až dodaný podklad …“) |
| 422 | – | Volající podklad sám dodal („Vámi dodaný podklad musí ověřit někdo jiný“) |
| 422 | – | Doklad by měl víc než 20 příloh |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Zapíše zprávu verified, nastaví stav verified s časem a autorem ověření a zapíše událost document_request.verified; s attach přiloží soubory k dokladu a u každého zapíše událost document.attached. Nic neúčtuje.
- Limity
- Doklad může mít nejvýše 20 příloh.
- Opakování
- Druhé volání vrátí 422, protože žádost je uzavřená.
Příklad
Potřebuje žádost ve stavu delivered, kterou založil volající a dodal jiný člen.
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"attach":false}' \
https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/verifyJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/verify', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"attach": false
})
});
const data = await response.json();{
"id": 1,
"title": "Doklad k příchozí platbě",
"status": "verified",
"status_label": "Ověřeno",
"subject": {
"type": "bank_transaction",
"id": 64,
"label": "Platba 18 150,00 Kč z 25. 9. 2026",
"amount": 18150.0,
"currency": "CZK",
"date": "2026-09-25",
"partner": "Atelier Lumen s.r.o.",
"message": "Úhrada – viz smlouva",
"tx_status": "unmatched",
"href": "#/banka?tx=64"
},
"requested_by": "ukazka",
"assignee_id": 2,
"assignee": "ucetni_ukazka",
"due_on": "2026-10-05",
"overdue": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z",
"closed_at": "2026-09-28T10:00:00.000Z",
"action_needed": false,
"can_reply": false,
"can_verify": false,
"can_cancel": false,
"files_count": 1,
"attachable_files": 0,
"messages": [
{
"id": 1,
"kind": "question",
"user": "ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Pošlete prosím fakturu nebo smlouvu k platbě 7 260 Kč.",
"files": []
},
{
"id": 2,
"kind": "reply",
"user": "ucetni_ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Posílám smlouvu.",
"files": [
{
"id": 4,
"filename": "faktura.pdf",
"content_type": "application/pdf",
"byte_size": 152
}
]
}
]
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.
POST Zrušení otevřené žádosti o podklad
/entities/{entity_id}/document_requests/{id}/cancel
- Oprávnění
- Zvláštní pravidlo
- Pravidlo
- Vyžaduje právo zápisu. Zrušit smí žadatel, dokud má ve firmě právo zápisu; jinak vlastník nebo účetní. Nesplnění vrátí 422.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Uzavře otevřenou žádost jako zrušenou, s nepovinným důvodem.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
id | cesta | celé číslo | ano | ID žádosti Příklad 88. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
reason | text | ne | Důvod zrušení; delší než 2000 znaků se zkrátí |
Odpověď
200 application/json Žádost se zprávami po zrušení (status cancelled).
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 422 | – | Volající nesmí zrušit („Zrušit smí ten, kdo o podklad požádal; …“) |
| 422 | – | Žádost je uzavřená („Žádost je už uzavřená“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Zapíše zprávu cancelled s důvodem, nastaví stav cancelled a čas uzavření a zapíše událost document_request.cancelled.
- Opakování
- Druhé volání vrátí 422, protože žádost je uzavřená.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"reason":"Doklad dorazil poštou."}' \
https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/cancelJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/cancel', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify({
"reason": "Doklad dorazil poštou."
})
});
const data = await response.json();{
"id": 1,
"title": "Doklad k příchozí platbě",
"status": "cancelled",
"status_label": "Zrušeno",
"subject": {
"type": "bank_transaction",
"id": 64,
"label": "Platba 18 150,00 Kč z 25. 9. 2026",
"amount": 18150.0,
"currency": "CZK",
"date": "2026-09-25",
"partner": "Atelier Lumen s.r.o.",
"message": "Úhrada – viz smlouva",
"tx_status": "unmatched",
"href": "#/banka?tx=64"
},
"requested_by": "ukazka",
"assignee_id": 2,
"assignee": "ucetni_ukazka",
"due_on": "2026-10-05",
"overdue": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z",
"closed_at": "2026-09-28T10:00:00.000Z",
"action_needed": false,
"can_reply": false,
"can_verify": false,
"can_cancel": false,
"files_count": 1,
"attachable_files": 0,
"messages": [
{
"id": 1,
"kind": "question",
"user": "ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Pošlete prosím fakturu nebo smlouvu k platbě 7 260 Kč.",
"files": []
},
{
"id": 2,
"kind": "reply",
"user": "ucetni_ukazka",
"at": "2026-09-28T10:00:00.000Z",
"body": "Posílám smlouvu.",
"files": [
{
"id": 4,
"filename": "faktura.pdf",
"content_type": "application/pdf",
"byte_size": 152
}
]
}
]
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.
GET Stažení souboru ze žádosti o podklad
/entities/{entity_id}/document_requests/{id}/files/{file_id}
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Pravidlo
- Role Nahrává doklady (submitter): jen soubory přidělené žádosti, jiná vrátí 404.
- Klíč jen pro čtení
- Stačí
Vrátí soubor přiložený k některé zprávě žádosti. PDF, JPEG, PNG, WebP a GIF se posílají k zobrazení (inline), HEIC, HEIF a XML jako příloha; vždy s hlavičkou Cache-Control private, no-store. Soubor, který k žádosti nepatří, vrátí 404.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
id | cesta | celé číslo | ano | ID žádosti Příklad 88. |
file_id | cesta | celé číslo | ano | ID souboru z messages[].files[].id Příklad 902. |
Odpověď
200 application/octet-stream Obsah souboru s uloženým Content-Type a původním názvem.
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/files/4JavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/document_requests/1/files/4', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();application/pdf, 152 bajtů (soubor faktura.pdf)
GET Upozornění přihlášeného uživatele
/notifications
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Jen vlastní upozornění. Klíč omezený na jednu firmu vrátí 403 KEY_LIMITED_TO_FIRM.
- Klíč jen pro čtení
- Stačí
Vrátí posledních 50 upozornění volajícího napříč firmami od nejnovějšího a počet nepřečtených. Upozornění vzniká, když volajícímu někdo přidělí krok fronty nebo vlastní úkol (i automaticky odpovědné osobě), založí pro něj žádost o podklad, odpoví na jeho žádost nebo ověří jím dodaný podklad, pošle doklad k jeho schválení nebo mu vrátí doklad k opravě, když člen s rolí Nahrává doklady nahraje doklady (jeden řádek za den s počtem) a ráno před blížícími se termíny DPH, kontrolního a souhrnného hlášení, odvodů a JMHZ a záloh (firmy, které volající spravuje nebo za ně odpovídá). Vlastní akce volajícího upozornění nevytváří. Upozornění firmy, ve které volající už není přijatým členem, se nevrací.
Odpověď
200 application/json Seznam a počet nepřečtených.
| Pole | Význam |
|---|---|
unread | Počet nepřečtených upozornění |
limit | Nejvyšší počet vrácených řádků (50) |
rows[].id | ID upozornění |
rows[].entity_id | ID firmy |
rows[].entity_name | Název firmy |
rows[].kind | queue_assigned, task_assigned, request_new, request_reply, request_delivered, request_verified, approval_waiting, approval_returned, uploads nebo deadlines |
rows[].event | Skupina pro nastavení e-mailů: queue, requests, approvals, uploads, deadlines |
rows[].title | Text upozornění |
rows[].body | Podrobnosti nebo null |
rows[].href | Cesta v aplikaci Saldo (např. /doklad/123), otevírá se ve firmě entity_id |
rows[].count | Počet sloučených událostí (nahrané doklady za den), jinak 1 |
rows[].actor | Kdo událost způsobil, nebo null (termíny, automatické přidělení bez autora) |
rows[].read | Přečteno |
rows[].created_at | Vznik |
rows[].updated_at | Poslední změna (u sloučených událostí poslední událost) |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/notificationsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/notifications', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"unread": 1,
"limit": 50,
"rows": [
{
"id": 2,
"entity_id": 1,
"entity_name": "Ukázková firma s.r.o.",
"kind": "request_delivered",
"event": "requests",
"title": "Odpověď na vaši žádost: Doklad k příchozí platbě",
"body": "Posílám smlouvu. · 1 soubor",
"href": "/podklady?zadost=1",
"count": 1,
"actor": "ucetni_ukazka",
"read": false,
"created_at": "2026-09-28T10:00:00.000Z",
"updated_at": "2026-09-28T10:00:00.000Z"
}
]
}
GET Počet nepřečtených upozornění
/notifications/count
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Klíč omezený na jednu firmu vrátí 403 KEY_LIMITED_TO_FIRM.
- Klíč jen pro čtení
- Stačí
Vrátí jen počet nepřečtených upozornění volajícího (pro odznak zvonečku); stejné pravidlo viditelnosti jako GET /notifications.
Odpověď
200 application/json Počet.
| Pole | Význam |
|---|---|
unread | Počet nepřečtených upozornění |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/notifications/countJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/notifications/count', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"unread": 1
}
POST Označí upozornění jako přečtené
/notifications/{id}/read
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Jen vlastní upozornění; zápis z prohlížeče potřebuje hlavičku X-Saldo: 1.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Označí jedno vlastní upozornění jako přečtené. Upozornění jiného uživatele i neexistující ID vrátí stejně 404.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
id | cesta | celé číslo | ano | ID upozornění z GET /notifications Příklad 41. |
Odpověď
200 application/json Upozornění ve tvaru rows[] z GET /notifications.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | Cizí nebo neexistující upozornění, nebo upozornění firmy, ve které volající už není členem |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží čas přečtení; přečtené upozornění se už nepošle v ranním souhrnu.
- Opakování
- Opakované volání nic nezmění.
Příklad
Upozornění vzniká až akcí jiného člena firmy, ukázková data ho nemají.
POST Označí všechna upozornění jako přečtená
/notifications/read
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Zápis z prohlížeče potřebuje hlavičku X-Saldo: 1.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Označí všechna nepřečtená upozornění volajícího jako přečtená („Označit vše“).
Odpověď
200 application/json Počet změněných řádků.
| Pole | Význam |
|---|---|
updated | Kolik upozornění se označilo |
unread | Vždy 0 |
Chování
- Co změní
- Uloží čas přečtení všem nepřečteným upozorněním volajícího.
- Opakování
- Další volání vrátí updated 0.
Příklad
cURL
curl \
-X POST \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/notifications/readJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/notifications/read', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY },
method: 'POST'
});
const data = await response.json();{
"updated": 1,
"unread": 0
}
GET Vlastní nastavení e-mailových upozornění
/notifications/settings
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Jen vlastní nastavení. Klíč omezený na jednu firmu vrátí 403 KEY_LIMITED_TO_FIRM.
- Klíč jen pro čtení
- Stačí
Vrátí, co volajícímu Saldo posílá e-mailem: nastavení pro všechny firmy (all), vlastní nastavení jednotlivých firem (firms[].own), výchozí nastavení firmy od vlastníka nebo účetní (firms[].default) a co pro firmu skutečně platí (firms[].effective, source firm, all, default nebo none). Pořadí: vlastní nastavení firmy, pak pro všechny firmy, pak výchozí nastavení firmy, jinak vypnuto. E-maily jdou jen na ověřenou adresu: vlastní schránku účtu @techtools.cz, nebo ověřený propojený e-mail (address.to); jiný e-mail vepsaný v účtu se nepoužije (address.unverified).
Odpověď
200 application/json Nastavení.
| Pole | Význam |
|---|---|
events | Události, které lze posílat (queue, requests, approvals, uploads, deadlines) s popisem |
frequencies | instant (ihned), digest (denní souhrn ráno), off (vypnuto) |
deadline_days | Kolik dní předem lze hlídat termíny (1, 3, 5, 7) |
all | Nastavení pro všechny firmy { email, events, deadline_days }, nebo null |
address.account | Vlastní schránka účtu @techtools.cz, nebo null |
address.unverified | E-mail vepsaný v účtu bez ověření (na něj Saldo nepíše), nebo null |
address.linked | Ověřený propojený e-mail (zamaskovaný), nebo null |
address.chosen | account nebo linked |
address.to | Kam e-maily skutečně půjdou (propojený e-mail zamaskovaný), nebo null |
firms[].id | ID firmy |
firms[].own | Vlastní nastavení pro tuto firmu, nebo null |
firms[].default | Výchozí nastavení firmy, nebo null |
firms[].effective | Co platí, se zdrojem source |
firms[].can_manage | Volající smí měnit výchozí nastavení firmy |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/notifications/settingsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/notifications/settings', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"events": {
"queue": "Krok fronty nebo vlastní úkol přidělený mně",
"requests": "Žádosti o podklady pro mě, odpovědi na mé žádosti a ověření",
"approvals": "Doklady čekající na mé schválení a mé doklady vrácené k opravě",
"uploads": "Nahrané doklady ke kontrole",
"deadlines": "Blížící se termíny DPH, kontrolního hlášení, JMHZ a záloh",
"databox": "Nové zprávy od úřadů v datové schránce a konec platnosti jejího hesla",
"bank": "Napojení na banku: konec souhlasu nebo certifikátu a chyby stahování"
},
"frequencies": {
"instant": "Ihned",
"digest": "Denní souhrn ráno",
"off": "Vypnuto"
},
"deadline_days": [
1,
3
],
"all": null,
"address": {
"account": null,
"unverified": "ukazka@example.cz",
"linked": null,
"chosen": null,
"to": null
},
"firms": [
{
"id": 2,
"name": "Jan Ukázka – grafické studio (ukázka)",
"own": null,
"default": null,
"effective": {
"email": "off",
"events": [
"queue",
"requests"
],
"deadline_days": 3,
"source": "none"
},
"can_manage": true
},
{
"id": 1,
"name": "Ukázková firma s.r.o.",
"own": null,
"default": null,
"effective": {
"email": "off",
"events": [
"queue",
"requests"
],
"deadline_days": 3,
"source": "none"
},
"can_manage": true
}
]
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.
PATCH Změní vlastní nastavení e-mailových upozornění
/notifications/settings
- Oprávnění
- Přihlášený uživatel nebo jeho API klíč, bez vazby na jednu firmu
- Pravidlo
- Jen vlastní nastavení; entity_id musí být firma, kde je volající přijatým členem (jinak 404). Zápis z prohlížeče potřebuje hlavičku X-Saldo: 1.
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Uloží nastavení pro všechny firmy, nebo s entity_id jen pro jednu firmu. reset true zruší vlastní nastavení firmy, takže pro ni zase platí nastavení pro všechny firmy nebo výchozí nastavení firmy. Upozornění v aplikaci (zvoneček) se ukazují vždy, nastavení řídí jen e-maily. Ve výchozím stavu Saldo nic neposílá.
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
entity_id | celé číslo | ne | Jen pro tuto firmu; bez hodnoty pro všechny firmy. |
email | text | ne | Ihned, denní souhrn ráno, nebo vypnuto. Hodnoty: instant, digest, false. |
events | pole (text) | ne | Které události posílat (queue, requests, approvals, uploads, deadlines); bez hodnoty všechny. |
deadline_days | celé číslo | ne | Kolik dní předem upozornit na termín. Hodnoty: 1, 3, 5, 7. Výchozí 3. |
address | text | ne | Jen pro všechny firmy – posílat na schránku účtu @techtools.cz, nebo na ověřený propojený e-mail. Hodnoty: account, linked. |
reset | ano/ne | ne | S entity_id zruší vlastní nastavení té firmy. |
Odpověď
200 application/json Celé nastavení ve tvaru getNotificationSettings.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | entity_id cizí nebo neexistující firmy |
| 422 | – | Neznámá četnost, událost, počet dní nebo adresa; reset bez entity_id |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží vlastní nastavení volajícího. Účetní data nemění.
- Opakování
- Stejné hodnoty uloží znovu beze změny.
Příklad
cURL
curl \
-X PATCH \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"digest","events":["queue","requests","approvals"],"deadline_days":3}' \
https://techtools.cz/ucetnictvi-api/notifications/settingsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/notifications/settings', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'PATCH',
body: JSON.stringify({
"email": "digest",
"events": [
"queue",
"requests",
"approvals"
],
"deadline_days": 3
})
});
const data = await response.json();{
"events": {
"queue": "Krok fronty nebo vlastní úkol přidělený mně",
"requests": "Žádosti o podklady pro mě, odpovědi na mé žádosti a ověření",
"approvals": "Doklady čekající na mé schválení a mé doklady vrácené k opravě",
"uploads": "Nahrané doklady ke kontrole",
"deadlines": "Blížící se termíny DPH, kontrolního hlášení, JMHZ a záloh",
"databox": "Nové zprávy od úřadů v datové schránce a konec platnosti jejího hesla",
"bank": "Napojení na banku: konec souhlasu nebo certifikátu a chyby stahování"
},
"frequencies": {
"instant": "Ihned",
"digest": "Denní souhrn ráno",
"off": "Vypnuto"
},
"deadline_days": [
1,
3
],
"all": {
"email": "digest",
"events": [
"queue",
"requests"
],
"deadline_days": 3
},
"address": {
"account": null,
"unverified": "ukazka@example.cz",
"linked": null,
"chosen": null,
"to": null
},
"firms": [
{
"id": 2,
"name": "Jan Ukázka – grafické studio (ukázka)",
"own": null,
"default": null,
"effective": {
"email": "digest",
"events": [
"queue",
"requests"
],
"deadline_days": 3,
"source": "all"
},
"can_manage": true
},
{
"id": 1,
"name": "Ukázková firma s.r.o.",
"own": null,
"default": null,
"effective": {
"email": "digest",
"events": [
"queue",
"requests"
],
"deadline_days": 3,
"source": "all"
},
"can_manage": true
}
]
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.
GET Stránka pro odhlášení e-mailů bez přihlášení
/notifications/unsubscribe
- Oprávnění
- Veřejné, bez přihlášení
- Pravidlo
- Bez přihlášení; účet určuje podepsaný token z e-mailu.
Odkaz z patičky každého e-mailu. Vrátí HTML stránku s tlačítkem, které e-maily odhlásí (POST na stejnou adresu). Sám nic nemění, aby odkaz neodhlásil kontrolní nástroj poštovního serveru.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
token | dotaz | text | ano | Podepsaný token z odkazu v e-mailu Příklad eyJfcmFpbHMiOns.... |
Odpověď
200 text/html Stránka s tlačítkem „Odhlásit e-maily“.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | Neplatný nebo poškozený token (stránka „Odkaz pro odhlášení neplatí“) |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Nic nezapisuje.
Příklad
Token vzniká jen v odeslaném e-mailu.
POST Odhlásí e-maily s upozorněními jedním kliknutím
/notifications/unsubscribe
- Oprávnění
- Veřejné, bez přihlášení
- Pravidlo
- Bez přihlášení a bez hlavičky X-Saldo; účet určuje jen podepsaný token.
Vypne e-maily s upozorněními ve všech firmách účtu z tokenu (nastavení pro všechny firmy i vlastní nastavení firem na off). Funguje i jako List-Unsubscribe-Post (RFC 8058) přímo z poštovního programu. Upozornění v aplikaci zůstanou.
Tělo požadavku
Formát application/x-www-form-urlencoded.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
token | text | ano | Podepsaný token z odkazu v e-mailu |
Odpověď
200 text/html Stránka „E-maily jsou odhlášené“.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 404 | – | Neplatný nebo poškozený token |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží nastavení e-mailů účtu na off.
- Opakování
- Opakované volání nic dalšího nezmění.
Příklad
Token vzniká jen v odeslaném e-mailu.
GET Výchozí nastavení upozornění firmy
/entities/{entity_id}/notification_defaults
- Oprávnění
- Každý člen firmy včetně role Jen čtení
- Pravidlo
- Člen s rolí Nahrává doklady dostane 403 SUBMITTER_ONLY.
- Klíč jen pro čtení
- Stačí
Vrátí výchozí nastavení e-mailových upozornění, které platí pro členy firmy bez vlastního nastavení, nebo null (Saldo nic neposílá).
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Odpověď
200 application/json Výchozí nastavení.
| Pole | Význam |
|---|---|
default | { email, events, deadline_days }, nebo null |
can_manage | Volající smí výchozí nastavení měnit (vlastník nebo účetní) |
events | Události s popisem |
frequencies | Četnosti s popisem |
deadline_days | Možné počty dní předem |
Chování
- Co změní
- Nic nezapisuje.
Příklad
cURL
curl \
-H "X-API-Key: $SALDO_API_KEY" \
https://techtools.cz/ucetnictvi-api/entities/1/notification_defaultsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/notification_defaults', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY }
});
const data = await response.json();{
"entity_id": 1,
"default": null,
"can_manage": true,
"events": {
"queue": "Krok fronty nebo vlastní úkol přidělený mně",
"requests": "Žádosti o podklady pro mě, odpovědi na mé žádosti a ověření",
"approvals": "Doklady čekající na mé schválení a mé doklady vrácené k opravě",
"uploads": "Nahrané doklady ke kontrole",
"deadlines": "Blížící se termíny DPH, kontrolního hlášení, JMHZ a záloh",
"databox": "Nové zprávy od úřadů v datové schránce a konec platnosti jejího hesla",
"bank": "Napojení na banku: konec souhlasu nebo certifikátu a chyby stahování"
},
"frequencies": {
"instant": "Ihned",
"digest": "Denní souhrn ráno",
"off": "Vypnuto"
},
"deadline_days": [
1,
3
]
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.
PATCH Nastaví výchozí upozornění pro členy firmy
/entities/{entity_id}/notification_defaults
- Oprávnění
- Vlastník nebo účetní
- Klíč jen pro čtení
- Nestačí, vrátí 403
READ_ONLY_KEY
Uloží výchozí nastavení e-mailových upozornění firmy. Platí pro každého člena, který si sám nic nenastavil, takže oddělení tak zapne upozornění celému týmu; vlastní nastavení člena má vždy přednost a každý e-mail má odkaz na odhlášení. Nastavení je součástí zálohy firmy a smaže se s ní.
Parametry
| Název | Kde | Typ | Povinný | Popis |
|---|---|---|---|---|
entity_id | cesta | celé číslo | ano | ID účetní jednotky Příklad 12. |
Tělo požadavku
Formát application/json.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
email | text | ano | Ihned, denní souhrn ráno, nebo vypnuto. Hodnoty: instant, digest, false. |
events | pole (text) | ne | Které události posílat; bez hodnoty všechny. |
deadline_days | celé číslo | ne | Kolik dní předem upozornit na termín. Hodnoty: 1, 3, 5, 7. Výchozí 3. |
Odpověď
200 application/json Uložené nastavení ve tvaru getNotificationDefaults.
Chyby této operace
| Stav | Kód | Kdy |
|---|---|---|
| 403 | – | Volající není vlastník ani účetní, nebo je firma archivovaná |
| 422 | – | Neznámá četnost, událost nebo počet dní |
Společné chyby všech operací (přihlášení, oprávnění, limity) popisuje Chyby a limity.
Chování
- Co změní
- Uloží nastavení do nastavení firmy a do historie zapíše událost entity.notification_defaults.
- Opakování
- Každé volání zapíše novou událost do historie.
Příklad
cURL
curl \
-X PATCH \
-H "X-API-Key: $SALDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"digest","events":["queue","requests","approvals","deadlines"],"deadline_days":5}' \
https://techtools.cz/ucetnictvi-api/entities/1/notification_defaultsJavaScript
const response = await fetch('https://techtools.cz/ucetnictvi-api/entities/1/notification_defaults', {
headers: { 'X-API-Key': process.env.SALDO_API_KEY, 'Content-Type': 'application/json' },
method: 'PATCH',
body: JSON.stringify({
"email": "digest",
"events": [
"queue",
"requests",
"approvals",
"deadlines"
],
"deadline_days": 5
})
});
const data = await response.json();{
"entity_id": 1,
"default": {
"email": "digest",
"events": [
"queue",
"requests"
],
"deadline_days": 5
},
"can_manage": true,
"events": {
"queue": "Krok fronty nebo vlastní úkol přidělený mně",
"requests": "Žádosti o podklady pro mě, odpovědi na mé žádosti a ověření",
"approvals": "Doklady čekající na mé schválení a mé doklady vrácené k opravě",
"uploads": "Nahrané doklady ke kontrole",
"deadlines": "Blížící se termíny DPH, kontrolního hlášení, JMHZ a záloh",
"databox": "Nové zprávy od úřadů v datové schránce a konec platnosti jejího hesla",
"bank": "Napojení na banku: konec souhlasu nebo certifikátu a chyby stahování"
},
"frequencies": {
"instant": "Ihned",
"digest": "Denní souhrn ráno",
"off": "Vypnuto"
},
"deadline_days": [
1,
3
]
}
Dlouhé seznamy jsou v ukázce zkrácené na první položky.