ZačínamePrehľad endpointov

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 23 operácií, z ktorých je v referencii zobrazených 19 aktuálnych.

Aktuálne operácie

MetódaEndpointÚčel
POST/v2/documentsNačítanie dokladov
POST/v2/documents/getDetail dokladu
POST/v2/documents/changesHistória zmien dokladov
POST/v2/documents/setExportedOznačenie exportu
POST/v2/organization/accounting-settings/importImport účtovných nastavení
POST/v1/organization/bank-transactionsBankové transakcie
POST/v3/organization/manage/listZoznam organizácií
POST/v3/organization/manage/createVytvorenie organizácie
POST/v3/organization/manage/updateÚprava organizácie
POST/v3/organization/manage/assign-memberPriradenie člena organizácie
POST/v3/organization/manage/list-membersZoznam členov organizácie
POST/v3/organization/manage/accounting-settings/syncSynchronizácia účtovných nastavení
POST/v3/organization/manage/partner/upsertImport partnerov z externého systému
POST/v2/documents/attachments/getOdkazy na prílohy
POST/v1/documents/invoice-issueVystavenie faktúry bez PDF
POST/v1/documents/issued-invoice-updateÚprava vystavenej faktúry
POST/v1/documents/get-invoice-pdfZískanie PDF vystavenej faktúry
POST/v1/documents/send-invoice-by-emailOdoslanie faktúry emailom
POST/v1/unprocessed-documentsNačí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é.

Rozšírenia existujúcich endpointov

  • POST /v2/documents podporuje voliteľný filter data.identificationNumber podľa IČO protistrany.
  • POST /v2/organization/accounting-settings/import podporuje aj purchasingRepresentatives (referenti nákupu), approvalProcesses (schvaľovacie procesy), paymentMethods (spôsoby úhrady) a economicObjects (hospodárske objekty) v objekte data. Položky obsahujú accountingSoftwareId, value a code.
  • Model InvoiceV2 obsahuje aj deliveryNoteNumber (číslo dodacieho listu).

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ódaEndpointÚčel
POST/v1/documentsNačítanie dokladov (zastarané)
POST/v1/documents/setExportedOznačenie exportu (zastarané)
POST/v1/organization/accounting-settings/importImport účtovných nastavení (zastarané)
POST/v1/documents/getAttachmentsOdkazy na prílohy (zastarané)
Pôvodný endpointNá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:

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.

Was this page helpful?