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 25 operácií, z ktorých je v referencii zobrazených 21 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/list-members | Zoznam členov organizácie |
POST | /v3/organization/manage/accounting-settings/sync | Synchronizácia účtovných nastavení |
POST | /v3/organization/manage/partner/upsert | Import partnerov z externého systému |
POST | /v3/organization/manage/partner/delete | Mazanie partnerov podľa externého identifikátora |
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 | /v3/unprocessed-documents/upload | Nahratie jedného nespracovaného dokladu ako Base64 |
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.
Zoznam členov organizácie
Endpoint POST /v3/organization/manage/list-members načíta členov organizácie podľa IČO v data.organizationId. V data.members vráti pri členovi userEmail, name, surname a organizationRole.
Príklad volania:
curl --request POST \
'https://api-gateway-prod-europe-west-1-7epuecvu.ew.gateway.dev/v3/organization/manage/list-members' \
--header 'api_key: VAS_API_KLUC' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"data": {
"organizationId": "12345678"
}
}'
Vzorové IČO a API kľúč nahraďte vlastnými údajmi. Zoznam členov môže obsahovať roly owner, accountant, employee, desktop_agent, auditor, uploader a tb_user. Na priradenie používateľa slúži samostatné POST /v3/organization/manage/assign-member, ktorého vstup povoľuje roly owner, accountant a employee. Súvisiaci návod nájdete v časti Členovia organizácie.
Import partnerov
Endpoint POST /v3/organization/manage/partner/upsert prijíma data.organizationId (IČO organizácie) a pole data.partners s 1 až 100 partnermi. Pri každom partnerovi sú povinné polia name, accountingSoftwareInternalId, partnerCountryCode a partnerType. Typ partnera je customer alebo supplier.
accountingSoftwareInternalId je identifikátor partnera vo vašom externom systéme a kľúč párovania v rámci organizácie. partnerCountryCode používa podľa príkladov špecifikácie hodnoty ako sk alebo cz.
Príklad tela požiadavky:
{
"data": {
"organizationId": "12345678",
"partners": [
{
"name": "Ukážkový odberateľ",
"accountingSoftwareInternalId": "CUSTOMER-001",
"partnerCountryCode": "sk",
"partnerType": "customer",
"ico": "87654321"
}
]
}
}
Príkladové IČO a údaje partnera nahraďte vlastnými údajmi. Dostupné adresné a daňové polia nájdete v referencii endpointu.
V odpovedi skontrolujte aj každú položku data.partners: accountingSoftId zodpovedá odovzdanému accountingSoftwareInternalId a success výsledku vytvorenia partnera. Napriek názvu „upsert“ popis odpovede uvádza pri už existujúcom identifikátore success: false a kód DOCUMENT_ALREADY_EXISTS; aktualizáciu existujúceho partnera preto tento popis negarantuje. Kód je uvedený v popise, ale samostatné pole kódu pri položke partnera nie je v schéme definované.
Nové operácie
- Mazanie partnerov:
POST /v3/organization/manage/partner/deleteprijíma IČO vdata.organizationIda 1 až 100 identifikátorov vdata.accountingSoftwareInternalIds. Skontrolujte výsledok každého partnera vdata.partners. - Nahratie nespracovaného dokladu:
POST /v3/unprocessed-documents/uploadprijíma jeden súbor v poliachdata.organizationId,data.fileNameadata.fileBase64. Swagger uvádza limit 10 MB a podporované prípony súborov.
Rozšírenia existujúcich endpointov
POST /v2/documentspodporuje voliteľný filterdata.identificationNumberpodľa IČO protistrany.POST /v2/organization/accounting-settings/importpodporuje ajpurchasingRepresentatives(referenti nákupu),approvalProcesses(schvaľovacie procesy),paymentMethods(spôsoby úhrady) aeconomicObjects(hospodárske objekty) v objektedata. Položky obsahujúaccountingSoftwareId,valueacode.- Model
InvoiceV2obsahuje ajdeliveryNoteNumber(číslo dodacieho listu). - Import partnerov cez
POST /v3/organization/manage/partner/upsertpodporuje voliteľné poledata.partners[].emailsso zoznamom e-mailových adries. - Položky pri vystavení faktúry (
PublicIssueInvoiceItem) podporujú voliteľné boolean poliaisTaxExemptaisReverseCharge; obe môžu byťnull. POST /v1/unprocessed-documentspodporujedata.limitv rozsahu0–50: hodnoty1–50obmedzia počet dokladov,0načíta iba počtytotalDocumentsanotApprovedDocuments.POST /v1/organization/bank-transactionspodporujedata.limitv rozsahu0–50, predvolene50. Pri0vráti iba dostupné zostatky účtov bez transakcií.
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ť.
Návody k API
Použitie aktuálnych endpointov je vysvetlené v tematických návodoch tejto sekcie:
- Doklady a prílohy — zoznam, detail, história zmien, potvrdenie exportu, prílohy, načítanie a nahratie nespracovaných dokladov.
- Vystavené faktúry — vystavenie, úprava, PDF a odoslanie e-mailom.
- Firmy, používatelia a partneri — organizácie, členovia, import a mazanie partnerov.
- Účtovné nastavenia — import, synchronizácia a napojenie účtovného softvéru.
- Bankové transakcie — načítanie transakcií a podmienky prístupu.
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.