Doklady a prílohy
Načítanie dokladov, detailov, histórie zmien a príloh, exportný stav a nespracované doklady.
Tieto operácie použite pri prenose dokladov z Doklado do vlastného systému.
Všetky operácie na tejto stránke používajú metódu POST, JSON telo a hlavičku api_key. Nastavenie prístupu nájdete v návode Autentifikácia. Kliknutím na endpoint otvoríte jeho vstupy a odpovede v REST API referencii.
Načítanie dokladov
| Endpoint | Použitie |
|---|---|
POST /v2/documents | Načítanie zoznamu dokladov podľa organizácie a filtrov. |
POST /v2/documents/get | Načítanie detailu jedného dokladu podľa jeho identifikátora. |
POST /v2/documents/changes | Načítanie histórie zmien vybraných dokladov. |
Pri zozname môžete použiť aj filter data.identificationNumber podľa IČO protistrany. Ďalšie strany načítajte podľa návodu na stránkovanie.
Spracovanie a potvrdenie exportu
| Endpoint | Použitie |
|---|---|
POST /v2/documents | Načítanie dokladov určených na prenos, napríklad s filtrom isExported: false. |
POST /v2/documents/setExported | Nastavenie exportného stavu pre úspešne spracované doklady. |
setExported mení stav v Doklado; samotné uloženie dokladov do cieľového účtovného systému zabezpečuje vaša integrácia. Export potvrďte až po úspešnom spracovaní a skontrolujte výsledok pre každý doklad. Príklady nájdete v návode Ako správne pracovať s API.
Stiahnutie príloh
| Endpoint | Použitie |
|---|---|
POST /v2/documents/attachments/get | Získanie verejných odkazov na stiahnutie príloh dokladu. |
Operácia vracia odkazy na existujúce prílohy. Neslúži na nahratie alebo pripojenie novej prílohy. Aj keď vstup používa pole identifikátorov, Swagger aktuálne uvádza podporu iba jedného dokladu na požiadavku.
Nespracované doklady
| Endpoint | Použitie |
|---|---|
POST /v1/unprocessed-documents | Načítanie dokladov zo sekcie Nespracované podľa zadaného obdobia. |
Tento endpoint slúži na načítanie údajov, nie na nahratie nového dokladu alebo potvrdenie jeho spracovania. Verzia v1 je pri tejto operácii stále aktuálna.
Ďalšie informácie
Pri integrácii zohľadnite stránkovanie a chyby a spotrebu API. Úplný zoznam operácií nájdete v prehľade endpointov.