Mapa rout
Každá routa rozhraní Saldo v aplikaci Rails a operace, která ji popisuje. Tabulka se sestavuje z tras aplikace a z OpenAPI, takže nedokumentovaná routa by se tu objevila jako mezera.
Výjimky a mezery
Rails ke každé routě PATCH přidává stejnou routu PUT. Obě volají tutéž akci se stejnými parametry, proto má reference jen operaci PATCH a PUT je v tabulkách označený jako alias.
Žádná routa nezůstala bez dokumentace.
Veřejné kalkulátory a číselníky
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /docs | public#docs | Stručný popis API ve formátu JSON |
| GET | /openapi.json | public#openapi | Popis API ve formátu OpenAPI 3.1 |
| GET | /rates | public#rates | Zákonné sazby a konstanty pro rok |
| GET | /holidays | public#holidays | Státní svátky v Česku pro rok |
| GET | /deadlines | public#deadlines | Daňové a pojistné lhůty pro zadaný profil |
| GET | /codebooks | public#codebooks | Číselníky pro formuláře a API |
| GET | /qr | public#qr | Řetězec QR Platby (SPAYD) pro platbu |
| POST | /isdoc/parse | public#parse_isdoc | Přečte fakturu ve formátu ISDOC |
| POST | /calc/{calculator} | public#calculate | Veřejná kalkulačka daní, pojistného, mezd a náhrad |
| GET | /share/{token} | share#show | Veřejný náhled sdílené faktury |
| GET | /share/{token}/isdoc | share#isdoc | ISDOC sdílené faktury ke stažení |
Účet, firmy a přístupy
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /api_keys | api_keys#index | Seznam vlastních API klíčů |
| POST | /api_keys | api_keys#create | Vytvoří API klíč |
| DELETE | /api_keys/{id} | api_keys#destroy | Zruší API klíč |
| POST | /invitations/{id}/accept | invitations#accept | Přijme pozvánku do firmy |
| GET | /invitations | invitations#index | Pozvánky do firem čekající na přijetí |
| DELETE | /invitations/{id} | invitations#destroy | Odmítne pozvánku do firmy |
| GET | /lookup/banks | lookup#banks | Číselník českých bank s kódy a BIC |
| GET | /lookup/statement_formats | lookup#statement_formats | Formáty bankovních výpisů, které umí import |
| GET | /lookup/bank_providers | lookup#bank_providers | Registr bank a jejich napojení přes API |
| GET | /lookup/{ico} | lookup#show | Firma podle IČO s návrhem nastavení Salda |
| POST | /entities/demo | entities#demo | Založí ukázkovou firmu s daty od začátku roku |
| POST | /entities/{id}/lock | entities#lock | Uzamkne nebo odemkne účetní období |
| GET | /entities/{id}/getting_started | entities#getting_started | První kroky s firmou a jejich splnění |
| POST | /entities/{id}/getting_started/dismiss | entities#dismiss_getting_started | Skryje jeden první krok nebo celý seznam |
| DELETE | /entities/{id}/getting_started/dismiss | entities#dismiss_getting_started | Znovu zobrazí všechny první kroky |
| POST | /entities/{entity_id}/members/{id}/ownership | members#offer_ownership | Nabídne členovi vlastnictví firmy |
| DELETE | /entities/{entity_id}/members/{id}/ownership | members#withdraw_ownership | Odmítne nebo zruší nabídku vlastnictví |
| POST | /entities/{entity_id}/members/{id}/ownership/accept | members#accept_ownership | Přijme nabídnuté vlastnictví firmy |
| GET | /entities/{entity_id}/members | members#index | Členové firmy a čekající pozvánky |
| POST | /entities/{entity_id}/members | members#create | Pozve uživatele TechTools do firmy |
| PATCH | /entities/{entity_id}/members/{id} | members#update | Změní roli člena nebo jeho přístup ke mzdám |
| PUT | /entities/{entity_id}/members/{id} | members#update | Změní roli člena nebo jeho přístup ke mzdám Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/members/{id} | members#destroy | Odebere člena, zruší pozvánku nebo opustí firmu |
| PATCH | /entities/{entity_id}/responsible | clients#responsible | Určí, kdo za firmu odpovídá |
| GET | /entities/{entity_id}/events | events#index | Historie změn firmy |
| GET | /entities | entities#index | Firmy, ke kterým má uživatel přístup |
| POST | /entities | entities#create | Založí novou firmu |
| GET | /entities/{id} | entities#show | Detail firmy s nastavením a logem |
| PATCH | /entities/{id} | entities#update | Změní údaje a nastavení firmy |
| PUT | /entities/{id} | entities#update | Změní údaje a nastavení firmy Alias PATCH se stejným chováním |
| DELETE | /entities/{id} | entities#destroy | Trvale smaže firmu se všemi daty |
Kontakty
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /entities/{entity_id}/partners/lookup | partners#lookup | Údaje subjektu z ARES pro nový kontakt |
| POST | /entities/{entity_id}/partners/vat_registry_all | partners#vat_registry_all | Ověří všechna česká DIČ v registru plátců DPH |
| POST | /entities/{entity_id}/partners/insolvency_all | partners#insolvency_all | Ověří další várku kontaktů v insolvenčním rejstříku |
| GET | /entities/{entity_id}/partners/{id}/vat_registry | partners#vat_registry | Ověří DIČ kontaktu v registru plátců DPH |
| POST | /entities/{entity_id}/partners/{id}/vies | partners#vies | Ověří DIČ kontaktu ve VIES a výsledek uloží jako doklad |
| POST | /entities/{entity_id}/partners/{id}/insolvency | partners#insolvency | Ověří kontakt v insolvenčním rejstříku |
| GET | /entities/{entity_id}/partners | partners#index | Kontakty firmy s obraty |
| POST | /entities/{entity_id}/partners | partners#create | Založí kontakt |
| GET | /entities/{entity_id}/partners/{id} | partners#show | Detail kontaktu s posledními doklady |
| PATCH | /entities/{entity_id}/partners/{id} | partners#update | Změní kontakt |
| PUT | /entities/{entity_id}/partners/{id} | partners#update | Změní kontakt Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/partners/{id} | partners#destroy | Smaže kontakt bez dokladů |
Doklady a jejich stavy
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /entities/{entity_id}/documents/template | documents#template | Předvyplněný nový doklad |
| GET | /entities/{entity_id}/documents/next_number | documents#next_number | Náhled dalšího čísla dokladu |
| GET | /entities/{entity_id}/documents/items | documents#items | Našeptávač položek z dřívějších dokladů |
| GET | /entities/{entity_id}/documents/partner_defaults | documents#partner_defaults | Výchozí údaje dokladu podle kontaktu |
| GET | /entities/{entity_id}/documents/duplicates | documents#duplicates | Kontrola duplicity přijatého dokladu |
| GET | /entities/{entity_id}/documents/reminders | documents#reminders | Doklady k upomenutí s úroky z prodlení |
| POST | /entities/{entity_id}/documents/bulk | documents#bulk | Hromadná akce s doklady |
| POST | /entities/{entity_id}/documents/{id}/issue | documents#issue | Vystavení dokladu |
| POST | /entities/{entity_id}/documents/{id}/cancel | documents#cancel | Storno dokladu |
| POST | /entities/{entity_id}/documents/{id}/reopen | documents#reopen | Vrácení dokladu do konceptu |
| POST | /entities/{entity_id}/documents/{id}/remind | documents#remind | Zaznamenání odeslané upomínky |
| POST | /entities/{entity_id}/documents/{id}/settle | documents#settle | Zúčtování uhrazené zálohy úhradou faktury |
| GET | /entities/{entity_id}/documents/{id}/duplicate | documents#duplicate | Kopie dokladu jako nový koncept |
| GET | /entities/{entity_id}/documents/{id}/credit_note | documents#credit_note | Dobropis k faktuře jako nový koncept |
| GET | /entities/{entity_id}/documents/{id}/final_invoice | documents#final_invoice | Konečná faktura k zálohové faktuře jako koncept |
| GET | /entities/{entity_id}/documents/{id}/advance_document | documents#advance_document | Daňový doklad k přijaté platbě zálohy jako koncept |
| GET | /entities/{entity_id}/documents/{id}/penalty_invoice | documents#penalty_invoice | Penalizační faktura z úroku z prodlení jako koncept |
| GET | /entities/{entity_id}/documents/{id}/reminder | documents#reminder | Podklady pro upomínku dokladu |
| GET | /entities/{entity_id}/documents/{id}/qr | documents#qr | Řetězec QR Platby k dokladu |
| GET | /entities/{entity_id}/documents/{id}/isdoc | documents#isdoc | Stažení dokladu ve formátu ISDOC |
| POST | /entities/{entity_id}/documents/{id}/payments | documents#create_payment | Zaznamenání úhrady dokladu |
| DELETE | /entities/{entity_id}/documents/{id}/payments/{payment_id} | documents#destroy_payment | Zrušení úhrady dokladu |
| GET | /entities/{entity_id}/documents/{id}/unpay | documents#unpay_plan | Náhled zrušení úhrad dokladu |
| POST | /entities/{entity_id}/documents/{id}/unpay | documents#unpay | Označení dokladu jako nezaplaceného |
| GET | /entities/{entity_id}/documents/{id}/offsets | documents#offsets | Doklady k zápočtu |
| GET | /entities/{entity_id}/documents/{id}/convert | documents#convert | Převod dokladu na jiný druh jako koncept |
| POST | /entities/{entity_id}/documents/{id}/outcome | documents#outcome | Výsledek cenové nabídky nebo přijaté objednávky |
| POST | /entities/{entity_id}/documents/{id}/share | documents#share | Zapnutí veřejného odkazu na doklad |
| DELETE | /entities/{entity_id}/documents/{id}/share | documents#unshare | Zrušení veřejného odkazu na doklad |
| GET | /entities/{entity_id}/documents/{id}/versions | documents#versions | Verze dokladu s původním obsahem a změnami |
| GET | /entities/{entity_id}/documents/{id}/versions/{number}/isdoc | documents#version_isdoc | ISDOC uložené verze vydaného dokladu |
| GET | /entities/{entity_id}/documents/{id}/versions/{number}/pdf | documents#version_pdf | Originál PDF verze vydaného dokladu |
| POST | /entities/{entity_id}/documents/{id}/original | documents#archive_original | Uložení originálu PDF vydané faktury |
| GET | /entities/{entity_id}/documents | documents#index | Seznam dokladů |
| POST | /entities/{entity_id}/documents | documents#create | Založení dokladu, volitelně s vystavením |
| GET | /entities/{entity_id}/documents/{id} | documents#show | Detail dokladu |
| PATCH | /entities/{entity_id}/documents/{id} | documents#update | Úprava dokladu |
| PUT | /entities/{entity_id}/documents/{id} | documents#update | Úprava dokladu Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/documents/{id} | documents#destroy | Smazání konceptu nebo stornovaného dokladu |
| POST | /entities/{entity_id}/recurrences/run | recurrences#run | Vytvoření splatných opakovaných faktur |
| GET | /entities/{entity_id}/recurrences | recurrences#index | Seznam opakovaných faktur |
| POST | /entities/{entity_id}/recurrences | recurrences#create | Založení opakované faktury |
| PATCH | /entities/{entity_id}/recurrences/{id} | recurrences#update | Úprava opakované faktury |
| PUT | /entities/{entity_id}/recurrences/{id} | recurrences#update | Úprava opakované faktury Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/recurrences/{id} | recurrences#destroy | Smazání opakované faktury |
| GET | /entities/{entity_id}/series | series#index | Číselné řady firmy |
| PATCH | /entities/{entity_id}/series/{id} | series#update | Nastavení číselné řady |
| PUT | /entities/{entity_id}/series/{id} | series#update | Nastavení číselné řady Alias PATCH se stejným chováním |
Schvalování výdajů
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| POST | /entities/{entity_id}/documents/{id}/approval/submit | documents#submit_approval | Odeslání přijatého výdaje ke schválení |
| POST | /entities/{entity_id}/documents/{id}/approval/approve | documents#approve | Schválení přijatého výdaje |
| POST | /entities/{entity_id}/documents/{id}/approval/return | documents#return_approval | Vrácení přijatého výdaje k opravě |
| GET | /entities/{entity_id}/approval_rules | approval_rules#show | Pravidla schvalování přijatých výdajů |
| PATCH | /entities/{entity_id}/approval_rules | approval_rules#update | Nastavení pravidel schvalování |
Přílohy a importy
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| POST | /entities/{entity_id}/documents/import_isdoc | documents#import_isdoc | Import faktur ve formátu ISDOC |
| GET | /entities/{entity_id}/documents/{id}/attachments | documents#attachments | Seznam příloh dokladu |
| POST | /entities/{entity_id}/documents/{id}/attachments | documents#attach | Přiložení souboru k dokladu |
| GET | /entities/{entity_id}/documents/{id}/attachments/{attachment_id} | documents#attachment | Stažení přílohy dokladu |
| DELETE | /entities/{entity_id}/documents/{id}/attachments/{attachment_id} | documents#detach | Smazání přílohy dokladu |
| POST | /entities/{entity_id}/imports/preview | imports#preview | Náhled importu dat z jiného programu |
| GET | /entities/{entity_id}/imports | imports#index | Historie importů a údaje pro převod dat |
| POST | /entities/{entity_id}/imports | imports#create | Import jedné dávky dat z jiného programu |
| DELETE | /entities/{entity_id}/imports/{batch} | imports#destroy | Vrácení importu |
Banka, párování a výpisy
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /bank_connections/oauth/callback | bank_connections#callback | Návrat z banky po přihlášení |
| GET | /entities/{entity_id}/documents/waiting_payments | documents#waiting_payments | Úhrady vydaných dokladů čekající v bance na spárování |
| POST | /entities/{entity_id}/bank_accounts/{id}/connect | bank_accounts#connect | Připojení nebo odpojení Fio API k účtu |
| POST | /entities/{entity_id}/bank_accounts/{id}/sync | bank_accounts#sync | Stažení nových pohybů z Fio API |
| GET | /entities/{entity_id}/bank_accounts | bank_accounts#index | Seznam bankovních účtů a pokladen |
| POST | /entities/{entity_id}/bank_accounts | bank_accounts#create | Přidání bankovního účtu nebo pokladny |
| PATCH | /entities/{entity_id}/bank_accounts/{id} | bank_accounts#update | Úprava bankovního účtu nebo pokladny |
| PUT | /entities/{entity_id}/bank_accounts/{id} | bank_accounts#update | Úprava bankovního účtu nebo pokladny Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/bank_accounts/{id} | bank_accounts#destroy | Smazání nepoužitého bankovního účtu nebo pokladny |
| POST | /entities/{entity_id}/bank_connections/{id}/authorize | bank_connections#authorize | Adresa pro přihlášení do banky (OAuth) nebo obnovení souhlasu |
| GET | /entities/{entity_id}/bank_connections/{id}/accounts | bank_connections#accounts | Účty u banky a návrh přiřazení |
| POST | /entities/{entity_id}/bank_connections/{id}/link | bank_connections#link | Přiřazení účtů banky k účtům Salda |
| POST | /entities/{entity_id}/bank_connections/{id}/sync | bank_connections#sync | Stažení nových pohybů ze všech účtů napojení |
| GET | /entities/{entity_id}/bank_connections | bank_connections#index | Napojení firmy na banky přes API |
| POST | /entities/{entity_id}/bank_connections | bank_connections#create | Založení napojení na banku |
| GET | /entities/{entity_id}/bank_connections/{id} | bank_connections#show | Jedno napojení na banku |
| PATCH | /entities/{entity_id}/bank_connections/{id} | bank_connections#update | Úprava napojení na banku |
| PUT | /entities/{entity_id}/bank_connections/{id} | bank_connections#update | Úprava napojení na banku Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/bank_connections/{id} | bank_connections#destroy | Odpojení banky |
| GET | /entities/{entity_id}/cash_registers/{id}/book | cash_registers#book | Pokladní kniha |
| POST | /entities/{entity_id}/cash_registers/{id}/count | cash_registers#count | Inventura pokladny |
| POST | /entities/{entity_id}/bank_rules/apply | bank_rules#apply | Spuštění pravidel na nespárované pohyby |
| POST | /entities/{entity_id}/bank_rules/preview | bank_rules#preview | Náhled pohybů, které by pravidlo zachytilo |
| GET | /entities/{entity_id}/bank_rules/draft | bank_rules#draft | Návrh pravidla z jednoho pohybu |
| GET | /entities/{entity_id}/bank_rules/suggestions | bank_rules#suggestions | Doporučená pravidla z historie pohybů |
| GET | /entities/{entity_id}/bank_rules/applied | bank_rules#applied | Pohyby vyřízené pravidlem |
| POST | /entities/{entity_id}/bank_rules/reorder | bank_rules#reorder | Změna pořadí pravidel pro banku |
| GET | /entities/{entity_id}/bank_rules | bank_rules#index | Seznam pravidel pro banku |
| POST | /entities/{entity_id}/bank_rules | bank_rules#create | Vytvoření pravidla pro banku |
| PATCH | /entities/{entity_id}/bank_rules/{id} | bank_rules#update | Úprava pravidla pro banku |
| PUT | /entities/{entity_id}/bank_rules/{id} | bank_rules#update | Úprava pravidla pro banku Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/bank_rules/{id} | bank_rules#destroy | Smazání pravidla pro banku |
| POST | /entities/{entity_id}/bank_transactions/import | bank_transactions#import | Import bankovního výpisu (datový export nebo PDF) |
| DELETE | /entities/{entity_id}/bank_transactions/imports/{batch} | bank_transactions#revert_import | Vrácení importu bankovního výpisu |
| POST | /entities/{entity_id}/bank_transactions/auto_match | bank_transactions#auto_match | Automatické párování pohybů s doklady |
| GET | /entities/{entity_id}/bank_transactions/statements | bank_transactions#statements | Uložené výpisy s kontrolou zůstatků |
| GET | /entities/{entity_id}/bank_transactions/statements/{archive_id}/{kind} | bank_transactions#statement_file | Stažení originálu uloženého výpisu |
| PATCH | /entities/{entity_id}/bank_transactions/statements/{archive_id}/balances | bank_transactions#statement_balances | Zadání zůstatků výpisu opsaných z PDF |
| POST | /entities/{entity_id}/bank_transactions/statements/{archive_id}/review | bank_transactions#statement_review | Označení problémového výpisu jako ručně zkontrolovaného |
| DELETE | /entities/{entity_id}/bank_transactions/statements/{archive_id}/review | bank_transactions#withdraw_statement_review | Zrušení ruční kontroly výpisu |
| GET | /entities/{entity_id}/bank_transactions/{id}/suggestions | bank_transactions#suggestions | Návrhy dokladů ke spárování s pohybem |
| POST | /entities/{entity_id}/bank_transactions/{id}/match | bank_transactions#match | Spárování pohybu s dokladem |
| POST | /entities/{entity_id}/bank_transactions/{id}/book | bank_transactions#book | Přímé zaúčtování pohybu bez dokladu |
| POST | /entities/{entity_id}/bank_transactions/{id}/ignore | bank_transactions#ignore | Ignorování pohybu |
| POST | /entities/{entity_id}/bank_transactions/{id}/reset | bank_transactions#reset | Vrácení pohybu mezi nespárované |
| GET | /entities/{entity_id}/bank_transactions | bank_transactions#index | Seznam bankovních pohybů |
| DELETE | /entities/{entity_id}/bank_transactions/{id} | bank_transactions#destroy | Smazání chybného bankovního pohybu |
Účetní knihy a výkazy
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /entities/{entity_id}/accounts | accounts#index | Účtový rozvrh nebo kategorie daňové evidence |
| POST | /entities/{entity_id}/accounts | accounts#create | Založení účtu nebo kategorie |
| PATCH | /entities/{entity_id}/accounts/{id} | accounts#update | Úprava účtu nebo kategorie |
| PUT | /entities/{entity_id}/accounts/{id} | accounts#update | Úprava účtu nebo kategorie Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/accounts/{id} | accounts#destroy | Smazání nepoužitého účtu |
| GET | /entities/{entity_id}/entries | entries#index | Účetní deník |
| POST | /entities/{entity_id}/entries | entries#create | Ruční účetní zápis |
| DELETE | /entities/{entity_id}/entries/{id} | entries#destroy | Smazání ručního zápisu |
| GET | /entities/{entity_id}/closing | closing#show | Kontrolní seznam roční uzávěrky |
| GET | /entities/{entity_id}/closing/month | closing#month | Kontrolní seznam měsíční uzávěrky |
| POST | /entities/{entity_id}/closing/revaluation | closing#revaluation | Zaúčtování kurzových rozdílů k rozvahovému dni |
| DELETE | /entities/{entity_id}/closing/revaluation | closing#revaluation | Zrušení kurzových rozdílů k rozvahovému dni |
| POST | /entities/{entity_id}/closing/income_tax | closing#income_tax | Zaúčtování daně z příjmů právnické osoby |
| DELETE | /entities/{entity_id}/closing/income_tax | closing#income_tax | Zrušení zaúčtované daně z příjmů |
| GET | /entities/{entity_id}/closing/provisions | closing#provisions | Návrh zákonných opravných položek k pohledávkám |
| POST | /entities/{entity_id}/closing/provisions | closing#post_provisions | Zaúčtování zákonných opravných položek |
| GET | /entities/{entity_id}/closing/inventory | closing#inventory | Inventurní soupisy k rozvahovému dni |
| GET | /entities/{entity_id}/closing/distribution | closing#distribution | Rozdělení výsledku hospodaření – stav a náhled |
| POST | /entities/{entity_id}/closing/distribution | closing#post_distribution | Zaúčtování rozdělení výsledku hospodaření |
| DELETE | /entities/{entity_id}/closing/distribution | closing#post_distribution | Zrušení zaúčtovaného rozdělení výsledku |
| GET | /entities/{entity_id}/closing/books | closing#books | Uzavírací a otevírací zápisy |
| POST | /entities/{entity_id}/closing/handoff | closing#handoff | Předání do nástroje Účetní závěrka |
| PATCH | /entities/{entity_id}/closing/inventory | closing#save_inventory | Uložení inventury |
| POST | /entities/{entity_id}/accruals/release | accruals#release | Zaúčtování rozpuštění časového rozlišení podle plánu |
| POST | /entities/{entity_id}/accruals/{id}/settle | accruals#settle | Zúčtování dohadu, výdaje příštích období nebo čerpání rezervy |
| GET | /entities/{entity_id}/accruals | accruals#index | Časové rozlišení, dohadné položky a rezervy |
| POST | /entities/{entity_id}/accruals | accruals#create | Nové časové rozlišení, dohad nebo rezerva |
| GET | /entities/{entity_id}/accruals/{id} | accruals#show | Detail uzávěrkové operace |
| DELETE | /entities/{entity_id}/accruals/{id} | accruals#destroy | Smazání uzávěrkové operace i se zápisy |
| GET | /entities/{entity_id}/reports/{report}/xlsx | reports#export | Účetní kniha jako sešit Excelu |
| GET | /entities/{entity_id}/reports/{report} | reports#show | Účetní sestava |
Daně, podání a doručenky
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /entities/{entity_id}/documents/{id}/vat_correction | vat_corrections#show | Náhled opravy DPH u nedobytné pohledávky (§ 46) nebo závazku po splatnosti (§ 74b) |
| POST | /entities/{entity_id}/documents/{id}/vat_correction | vat_corrections#create | Vystavení opravy DPH u nedobytné pohledávky (§ 46) nebo závazku po splatnosti (§ 74b) |
| POST | /entities/{entity_id}/taxes/profile_from_bank | taxes#profile_from_bank | Doplnění daňového profilu OSVČ z bankovních pohybů |
| GET | /entities/{entity_id}/taxes/profile | taxes#tax_profile | Údaje pro přiznání za jeden rok |
| GET | /entities/{entity_id}/taxes/payments/candidates | taxes#payment_candidates | Pohyby z výpisu, které mohou zaplatit platbu úřadům |
| POST | /entities/{entity_id}/taxes/payments/link | taxes#link_payment | Ruční přiřazení platby k platbě úřadům |
| DELETE | /entities/{entity_id}/taxes/payments/link | taxes#link_payment | Zrušení ručního přiřazení platby |
| PUT | /entities/{entity_id}/taxes/profile | taxes#update_tax_profile | Uložení údajů pro přiznání za jeden rok Alias PATCH se stejným chováním |
| PATCH | /entities/{entity_id}/taxes/profile | taxes#update_tax_profile | Uložení údajů pro přiznání za jeden rok |
| GET | /entities/{entity_id}/taxes/{report}/xml | taxes#xml | XML podání pro EPO nebo přehled OSVČ ke stažení |
| POST | /entities/{entity_id}/taxes/{report}/epo | taxes#epo | Kontrola podání v EPO nebo otevření předvyplněného formuláře |
| POST | /entities/{entity_id}/taxes/{report}/validate | taxes#validate | Předběžná kontrola přehledu OSVČ u ČSSZ |
| POST | /entities/{entity_id}/taxes/{report}/filing | taxes#filing | Uložení podání daně z příjmů nebo přehledu OSVČ |
| GET | /entities/{entity_id}/taxes/{report} | taxes#show | Daňový výkaz nebo přehled podle hodnoty report |
| GET | /entities/{entity_id}/vat_adjustments | vat_adjustments#index | Ruční úpravy řádků přiznání k DPH |
| POST | /entities/{entity_id}/vat_adjustments | vat_adjustments#create | Ruční úprava řádku přiznání k DPH |
| DELETE | /entities/{entity_id}/vat_adjustments/{id} | vat_adjustments#destroy | Zrušení ruční úpravy přiznání k DPH |
| GET | /entities/{entity_id}/vat_registrations | vat_registrations#index | Historie registrace k DPH |
| POST | /entities/{entity_id}/vat_registrations | vat_registrations#create | Nový záznam historie registrace k DPH |
| PATCH | /entities/{entity_id}/vat_registrations/{id} | vat_registrations#update | Oprava záznamu historie registrace k DPH |
| PUT | /entities/{entity_id}/vat_registrations/{id} | vat_registrations#update | Oprava záznamu historie registrace k DPH Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/vat_registrations/{id} | vat_registrations#destroy | Smazání záznamu historie registrace k DPH |
| POST | /entities/{entity_id}/filings/external | filings#external | Zapíše přiznání podané mimo Saldo |
| POST | /entities/{entity_id}/filings/{id}/exception | filings#exception | Schválení odeslaného podání bez doručenky |
| DELETE | /entities/{entity_id}/filings/{id}/exception | filings#revoke_exception | Zrušení schválení podání bez doručenky |
| GET | /entities/{entity_id}/filings/{id}/databox | databox#preview | Náhled podání datovou schránkou |
| POST | /entities/{entity_id}/filings/{id}/databox | databox#deliver | Odešle podání datovou schránkou |
| POST | /entities/{entity_id}/filings/{id}/databox/check | databox#check_filing | Zkontroluje doručení podání odeslaného datovou schránkou |
| GET | /entities/{entity_id}/filings/{filing_id}/evidences/{id}/file | filing_evidences#file | Stažení originálu doručenky |
| POST | /entities/{entity_id}/filings/{filing_id}/evidences/{id}/verify | filing_evidences#verify | Ověření doručenky k odeslanému podání |
| POST | /entities/{entity_id}/filings/{filing_id}/evidences/{id}/void | filing_evidences#void | Vyřazení chybného důkazního souboru |
| POST | /entities/{entity_id}/filings/{filing_id}/evidences/{id}/correct | filing_evidences#correct | Oprava druhu nebo obnovení vyřazeného důkazního souboru |
| GET | /entities/{entity_id}/filings/{filing_id}/evidences | filing_evidences#index | Důkazní soubory podání (doručenky a potvrzení) |
| POST | /entities/{entity_id}/filings/{filing_id}/evidences | filing_evidences#create | Přiložení doručenky nebo potvrzení k podání |
| GET | /entities/{entity_id}/filings/{filing_id}/evidences/{id} | filing_evidences#show | Detail důkazního souboru podání |
| GET | /entities/{entity_id}/filings | filings#index | Seznam uložených podání |
| POST | /entities/{entity_id}/filings | filings#create | Uložení podání k DPH (přiznání, kontrolní nebo souhrnné hlášení) |
| GET | /entities/{entity_id}/filings/{id} | filings#show | Detail podání nebo jeho uložené XML |
| PATCH | /entities/{entity_id}/filings/{id} | filings#update | Označení podání jako odeslaného nebo vrácení mezi připravená |
| PUT | /entities/{entity_id}/filings/{id} | filings#update | Označení podání jako odeslaného nebo vrácení mezi připravená Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/filings/{id} | filings#destroy | Smazání připraveného podání |
| POST | /entities/{entity_id}/databox/check | databox#check | Znovu ověří propojení s datovou schránkou |
| POST | /entities/{entity_id}/databox/sync | databox#sync | Zkontroluje datovou schránku hned |
| GET | /entities/{entity_id}/databox/messages | databox#messages | Zprávy datové schránky |
| POST | /entities/{entity_id}/databox/messages/{id}/handled | databox#handled | Označí přijatou zprávu jako vyřízenou |
| DELETE | /entities/{entity_id}/databox/messages/{id}/handled | databox#reopen | Vrátí přijatou zprávu k vyřízení |
| GET | /entities/{entity_id}/databox/messages/{id}/file | databox#file | Stažení zprávy datové schránky (ZFO) |
| GET | /entities/{entity_id}/databox | databox#show | Propojení s datovou schránkou |
| DELETE | /entities/{entity_id}/databox | databox#destroy | Odpojí datovou schránku |
| POST | /entities/{entity_id}/databox | databox#create | Propojí firmu s datovou schránkou |
| POST | /entities/{entity_id}/profit_distributions/{id}/posting | profit_distributions#posting | Zaúčtování rozdělení zisku |
| DELETE | /entities/{entity_id}/profit_distributions/{id}/posting | profit_distributions#posting | Zrušení zaúčtování rozdělení zisku |
| GET | /entities/{entity_id}/profit_distributions | profit_distributions#index | Rozdělení zisku a srážková daň z podílů |
| POST | /entities/{entity_id}/profit_distributions | profit_distributions#create | Nové rozdělení zisku |
| PATCH | /entities/{entity_id}/profit_distributions/{id} | profit_distributions#update | Úprava rozdělení zisku |
| PUT | /entities/{entity_id}/profit_distributions/{id} | profit_distributions#update | Úprava rozdělení zisku Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/profit_distributions/{id} | profit_distributions#destroy | Smazání rozdělení zisku |
| GET | /entities/{entity_id}/calendar | calendar#show | Daňový kalendář firmy (JSON nebo iCalendar) |
Majetek, mzdy a cesty
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| POST | /entities/{entity_id}/assets/depreciate | assets#depreciate | Zaúčtování ročních účetních odpisů majetku |
| GET | /entities/{entity_id}/assets/{id}/schedule | assets#schedule | Odpisové plány majetku |
| GET | /entities/{entity_id}/assets | assets#index | Seznam dlouhodobého majetku s odpisy za rok |
| POST | /entities/{entity_id}/assets | assets#create | Zařazení majetku do evidence |
| GET | /entities/{entity_id}/assets/{id} | assets#show | Detail majetku s odpisovými plány a pohyby |
| PATCH | /entities/{entity_id}/assets/{id} | assets#update | Úprava nebo vyřazení karty majetku |
| PUT | /entities/{entity_id}/assets/{id} | assets#update | Úprava nebo vyřazení karty majetku Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/assets/{id} | assets#destroy | Smazání majetku včetně jeho zápisů |
| GET | /entities/{entity_id}/employees/names | employees#names | Jména pracovníků |
| GET | /entities/{entity_id}/employees/{id}/sheet | employees#sheet | Mzdový list pracovníka za rok |
| GET | /entities/{entity_id}/employees | employees#index | Seznam pracovníků |
| POST | /entities/{entity_id}/employees | employees#create | Nový pracovník |
| PATCH | /entities/{entity_id}/employees/{id} | employees#update | Úprava karty pracovníka |
| PUT | /entities/{entity_id}/employees/{id} | employees#update | Úprava karty pracovníka Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/employees/{id} | employees#destroy | Smazání pracovníka bez výplatních pásek |
| POST | /entities/{entity_id}/payslips/calculate | payslips#calculate | Orientační výpočet mzdy bez uložení |
| POST | /entities/{entity_id}/payslips/generate | payslips#generate | Vygenerování výplatních pásek za měsíc |
| POST | /entities/{entity_id}/payslips/close | payslips#close | Uzavření mezd do měsíce |
| POST | /entities/{entity_id}/payslips/reopen | payslips#reopen | Otevření uzavřených mezd od měsíce |
| GET | /entities/{entity_id}/payslips/summary | payslips#summary | Rekapitulace mezd, přehled pro zdravotní pojišťovny a oznámení za měsíc |
| POST | /entities/{entity_id}/payslips/payment_order | payslips#payment_order | Příkaz k úhradě mezd (ABO) |
| GET | /entities/{entity_id}/payslips/jmhz | jmhz#show | Kontrola a stav hlášení JMHZ za měsíc |
| GET | /entities/{entity_id}/payslips/jmhz/xml | jmhz#xml | Stažení XML hlášení JMHZ a jeho uložení jako podání |
| POST | /entities/{entity_id}/payslips/jmhz/validation | jmhz#validation | Předběžná kontrola hlášení JMHZ validační službou ČSSZ |
| POST | /entities/{entity_id}/payslips/{id}/post_entries | payslips#post_entries | Zaúčtování výplatní pásky |
| GET | /entities/{entity_id}/payslips | payslips#index | Výplatní pásky za rok nebo měsíc |
| PATCH | /entities/{entity_id}/payslips/{id} | payslips#update | Úprava výplatní pásky – nepřítomnosti, složky mzdy, ruční mzda, stav a docházka |
| PUT | /entities/{entity_id}/payslips/{id} | payslips#update | Úprava výplatní pásky – nepřítomnosti, složky mzdy, ruční mzda, stav a docházka Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/payslips/{id} | payslips#destroy | Smazání výplatní pásky |
| POST | /entities/{entity_id}/annual_settlements/{id}/compute | annual_settlements#compute | Výpočet ročního zúčtování |
| POST | /entities/{entity_id}/annual_settlements/{id}/refund | annual_settlements#refund | Vrácení přeplatku ze zúčtování ve mzdě nebo mimo ni |
| GET | /entities/{entity_id}/annual_settlements | annual_settlements#index | Roční zúčtování záloh – přehled zaměstnanců za rok |
| GET | /entities/{entity_id}/annual_settlements/{id} | annual_settlements#show | Roční zúčtování jednoho zaměstnance – podklady, výsledek, potvrzení |
| PATCH | /entities/{entity_id}/annual_settlements/{id} | annual_settlements#update | Uložení žádosti a podkladů ročního zúčtování |
| PUT | /entities/{entity_id}/annual_settlements/{id} | annual_settlements#update | Uložení žádosti a podkladů ročního zúčtování Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/annual_settlements/{id} | annual_settlements#destroy | Smazání podkladů ročního zúčtování |
| POST | /entities/{entity_id}/trips/calculate | trips#calculate | Výpočet cestovních náhrad bez uložení |
| POST | /entities/{entity_id}/trips/{id}/approve | trips#approve | Schválení cestovního příkazu |
| POST | /entities/{entity_id}/trips/{id}/settle | trips#settle | Vyúčtování cestovního příkazu |
| POST | /entities/{entity_id}/trips/{id}/reopen | trips#reopen | Vrácení vyúčtování k úpravě |
| POST | /entities/{entity_id}/trips/{id}/pay | trips#pay | Označení cestovního příkazu jako proplaceného |
| POST | /entities/{entity_id}/trips/{id}/cancel | trips#cancel | Storno cestovního příkazu |
| GET | /entities/{entity_id}/trips | trips#index | Seznam cestovních příkazů |
| POST | /entities/{entity_id}/trips | trips#create | Nový cestovní příkaz s výpočtem náhrad |
| GET | /entities/{entity_id}/trips/{id} | trips#show | Detail cestovního příkazu se zaúčtováním |
| PATCH | /entities/{entity_id}/trips/{id} | trips#update | Přepočet a úprava cestovního příkazu |
| PUT | /entities/{entity_id}/trips/{id} | trips#update | Přepočet a úprava cestovního příkazu Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/trips/{id} | trips#destroy | Smazání cestovního příkazu |
| POST | /entities/{entity_id}/rides/{id}/trip | rides#trip | Cestovní příkaz z jízdy |
| GET | /entities/{entity_id}/rides | rides#index | Kniha jízd |
| POST | /entities/{entity_id}/rides | rides#create | Zápis jízdy do knihy jízd |
| PATCH | /entities/{entity_id}/rides/{id} | rides#update | Úprava jízdy |
| PUT | /entities/{entity_id}/rides/{id} | rides#update | Úprava jízdy Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/rides/{id} | rides#destroy | Smazání jízdy |
Automatizace, fronta a podklady
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| GET | /clients | clients#index | Přehled všech firem volajícího podle naléhavosti |
| POST | /clients/lock | clients#lock | Uzamkne období ve více firmách najednou |
| GET | /notifications | notifications#index | Upozornění přihlášeného uživatele |
| GET | /notifications/count | notifications#count | Počet nepřečtených upozornění |
| POST | /notifications/read | notifications#read_all | Označí všechna upozornění jako přečtená |
| POST | /notifications/{id}/read | notifications#read | Označí upozornění jako přečtené |
| GET | /notifications/settings | notifications#settings | Vlastní nastavení e-mailových upozornění |
| PUT | /notifications/settings | notifications#update_settings | Změní vlastní nastavení e-mailových upozornění Alias PATCH se stejným chováním |
| PATCH | /notifications/settings | notifications#update_settings | Změní vlastní nastavení e-mailových upozornění |
| GET | /notifications/unsubscribe | unsubscribe#show | Stránka pro odhlášení e-mailů bez přihlášení |
| POST | /notifications/unsubscribe | unsubscribe#create | Odhlásí e-maily s upozorněními jedním kliknutím |
| POST | /work_items/assign | work_items#assign | Hromadné přidělení kroků fronty |
| POST | /work_items/{id}/resolve | work_items#resolve | Označí vlastní úkol jako hotový |
| POST | /work_items/{id}/reopen | work_items#reopen | Znovu otevře vlastní úkol |
| GET | /work_items | work_items#index | Fronta úkolů účetní napříč firmami |
| POST | /work_items | work_items#create | Založí vlastní úkol ve frontě |
| PATCH | /work_items/{id} | work_items#update | Přidělení kroku z fronty úkolů |
| PUT | /work_items/{id} | work_items#update | Přidělení kroku z fronty úkolů Alias PATCH se stejným chováním |
| DELETE | /work_items/{id} | work_items#destroy | Smaže vlastní úkol |
| GET | /entities/{entity_id}/notification_defaults | notifications#defaults | Výchozí nastavení upozornění firmy |
| PUT | /entities/{entity_id}/notification_defaults | notifications#update_defaults | Nastaví výchozí upozornění pro členy firmy Alias PATCH se stejným chováním |
| PATCH | /entities/{entity_id}/notification_defaults | notifications#update_defaults | Nastaví výchozí upozornění pro členy firmy |
| GET | /entities/{entity_id}/automation | automation#show | Nastavení automatizací a jejich výsledky za tento měsíc |
| PATCH | /entities/{entity_id}/automation | automation#update | Zapnutí a vypnutí automatizací |
| POST | /entities/{entity_id}/automation/run | automation#run | Spuštění automatizací firmy |
| GET | /entities/{entity_id}/document_requests/counts | document_requests#counts | Počty otevřených žádostí a žádostí čekajících na volajícího |
| POST | /entities/{entity_id}/document_requests/bulk | document_requests#create_many | Hromadná žádost o podklady k více dokladům nebo pohybům |
| POST | /entities/{entity_id}/document_requests/{id}/reply | document_requests#reply | Odpověď na žádost o podklad, případně se soubory |
| POST | /entities/{entity_id}/document_requests/{id}/verify | document_requests#verify | Ověření dodaného podkladu a uzavření žádosti |
| POST | /entities/{entity_id}/document_requests/{id}/cancel | document_requests#cancel | Zrušení otevřené žádosti o podklad |
| GET | /entities/{entity_id}/document_requests/{id}/files/{file_id} | document_requests#file | Stažení souboru ze žádosti o podklad |
| GET | /entities/{entity_id}/document_requests | document_requests#index | Žádosti o podklady ve firmě |
| POST | /entities/{entity_id}/document_requests | document_requests#create | Žádost o doklad nebo vysvětlení k pohybu či dokladu |
| GET | /entities/{entity_id}/document_requests/{id} | document_requests#show | Detail žádosti o podklad se zprávami a soubory |
| GET | /entities/{entity_id}/time_entries | time_entries#index | Výkaz práce za měsíc |
| POST | /entities/{entity_id}/time_entries | time_entries#create | Zapíše práci do výkazu |
| PATCH | /entities/{entity_id}/time_entries/{id} | time_entries#update | Upraví záznam výkazu |
| PUT | /entities/{entity_id}/time_entries/{id} | time_entries#update | Upraví záznam výkazu Alias PATCH se stejným chováním |
| DELETE | /entities/{entity_id}/time_entries/{id} | time_entries#destroy | Smaže záznam výkazu |
| GET | /entities/{entity_id}/billing/agreements | billing#agreements | Ceníky klientů |
| PUT | /entities/{entity_id}/billing/agreements/{partner_id} | billing#save_agreement | Uloží ceník klienta Alias PATCH se stejným chováním |
| PATCH | /entities/{entity_id}/billing/agreements/{partner_id} | billing#save_agreement | Uloží ceník klienta |
| DELETE | /entities/{entity_id}/billing/agreements/{partner_id} | billing#destroy_agreement | Smaže ceník klienta |
| GET | /entities/{entity_id}/billing/preview | billing#preview | Náhled fakturace měsíce |
| POST | /entities/{entity_id}/billing/invoices | billing#invoices | Připraví koncepty faktur za měsíc |
Exporty a předání účetní
| Metoda | Cesta | Akce | Operace |
|---|---|---|---|
| POST | /entities/restore | entities#restore | Obnoví firmu ze zálohy do nové firmy |
| GET | /entities/{id}/export | entities#export | Export účetních dat firmy v JSON (bez souborů) |
| GET | /entities/{entity_id}/documents/export | documents#export | Export dokladů do POHODY nebo Money S3 |
| GET | /entities/{entity_id}/documents/payables | documents#payables | Neuhrazené přijaté faktury pro příkaz k úhradě |
| GET | /entities/{entity_id}/documents/payables/registry | documents#payables_registry | Prověření dodavatelů v registru plátců DPH |
| POST | /entities/{entity_id}/documents/payment_order | documents#payment_order | Příkaz k úhradě ABO nebo SEPA z přijatých faktur |
| GET | /entities/{entity_id}/accounting_package/preview | accounting_packages#preview | Náhled balíčku pro účetní |
| GET | /entities/{entity_id}/accounting_package | accounting_packages#show | Stažení balíčku pro účetní (ZIP) |
| GET | /entities/{entity_id}/archive/preview | archives#preview | Obsah úplného archivu firmy a zda jde firmu smazat |
| GET | /entities/{entity_id}/archive | archives#show | Úplný archiv firmy (ZIP) se soubory a historií |