Prehľad endpointov
Operácie Doklado Public API a náhrady zastaraných endpointov.
Kompletné vstupné polia, povinnosť parametrov, typy, povolené hodnoty a schémy odpovedí nájdete pri jednotlivých operáciách v sekcii REST API referencia v bočnej navigácii. Referencia vychádza z OpenAPI špecifikácie Doklado. Kliknutím na aktuálny endpoint otvoríte jeho REST API referenciu. Špecifikácia obsahuje 21 operácií, z ktorých je v referencii zobrazených 17 aktuálnych.
Aktuálne operácie
| Metóda | Endpoint | Účel |
|---|---|---|
POST | /v2/documents | Načítanie dokladov |
POST | /v2/documents/get | Detail dokladu |
POST | /v2/documents/changes | História zmien dokladov |
POST | /v2/documents/setExported | Označenie exportu |
POST | /v2/organization/accounting-settings/import | Import účtovných nastavení |
POST | /v1/organization/bank-transactions | Bankové transakcie |
POST | /v3/organization/manage/list | Zoznam organizácií |
POST | /v3/organization/manage/create | Vytvorenie organizácie |
POST | /v3/organization/manage/update | Úprava organizácie |
POST | /v3/organization/manage/assign-member | Priradenie člena organizácie |
POST | /v3/organization/manage/accounting-settings/sync | Synchronizácia účtovných nastavení |
POST | /v2/documents/attachments/get | Odkazy na prílohy |
POST | /v1/documents/invoice-issue | Vystavenie faktúry bez PDF |
POST | /v1/documents/issued-invoice-update | Úprava vystavenej faktúry |
POST | /v1/documents/get-invoice-pdf | Získanie PDF vystavenej faktúry |
POST | /v1/documents/send-invoice-by-email | Odoslanie faktúry emailom |
POST | /v1/unprocessed-documents | Načítanie nespracovaných dokladov |
Endpoint bankových transakcií vyžaduje API kľúč viazaný na organizáciu. Ak zadáte dateFrom alebo dateTo, musíte zadať aj dateType s hodnotou booking_date alebo creation_date.
Zastarané operácie
Tieto štyri operácie sú v špecifikácii označené ako deprecated a v REST API referencii sú skryté. Pre existujúce integrácie zostávajú popísané v OpenAPI špecifikácii. V tabuľke náhrad nižšie kliknite na aktuálny endpoint.
| Metóda | Endpoint | Účel |
|---|---|---|
POST | /v1/documents | Načítanie dokladov (zastarané) |
POST | /v1/documents/setExported | Označenie exportu (zastarané) |
POST | /v1/organization/accounting-settings/import | Import účtovných nastavení (zastarané) |
POST | /v1/documents/getAttachments | Odkazy na prílohy (zastarané) |
| Pôvodný endpoint | Náhrada |
|---|---|
/v1/documents | /v2/documents |
/v1/documents/setExported | /v2/documents/setExported |
/v1/organization/accounting-settings/import | /v2/organization/accounting-settings/import |
/v1/documents/getAttachments | /v2/documents/attachments/get |
Pri migrácii porovnajte aj vstupné a výstupné schémy. Samotná zmena URL nemusí stačiť.
Práca s referenciou
Pri volaní použite základnú adresu z prehľadu API a hlavičku podľa návodu Autentifikácia. Hodnoty uvedené ako príklady nahraďte vlastnými údajmi.
Operácie vystavenia a úpravy faktúr, odoslania emailu, označenia exportu a správy organizácií menia údaje alebo vykonávajú akciu. Pri ich skúšaní používajte vhodné testovacie údaje a overte vybranú organizáciu.