Firmy, používatelia a partneri
Zoznam a vytvorenie organizácie, načítanie a priradenie členov a import partnerov.
Firma sa v Doklado Public API označuje ako organizácia. Vstupy správy organizácií ju identifikujú podľa IČO.
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.
Zoznam a vytvorenie firmy
| Endpoint | Použitie |
|---|---|
POST /v3/organization/manage/list | Zoznam organizácií s možnosťou filtrovania podľa IČO alebo DIČ. |
POST /v3/organization/manage/create | Vytvorenie organizácie podľa IČO, účtovného softvéru a krajiny. |
Pri vytvorení posielajte v objekte data polia identificationNumber, accountingSoftware a countryCode. Krajina má hodnotu sk alebo cz; podporovaný účtovný softvér vyberte zo schémy endpointu.
Členovia organizácie
| Endpoint | Použitie |
|---|---|
POST /v3/organization/manage/list-members | Načítanie členov organizácie vrátane e-mailu, mena, priezviska a roly. |
POST /v3/organization/manage/assign-member | Priradenie používateľov k organizácii. |
Zoznam členov načítate zadaním IČO do data.organizationId. Pri priradení môžete odoslať 1 až 20 používateľov v data.users. Pri každom uveďte userEmail, name, surname a organizationRole s hodnotou owner, accountant alebo employee. Načítaný zoznam môže obsahovať aj ďalšie roly podľa referencie. Tieto endpointy nepopisujú odobratie používateľa.
Import partnerov
| Endpoint | Použitie |
|---|---|
POST /v3/organization/manage/partner/upsert | Import partnerov podľa identifikátora z externého systému. |
Jedna požiadavka prijíma 1 až 100 partnerov v data.partners. Pri každom uveďte name, accountingSoftwareInternalId, partnerCountryCode a partnerType (customer alebo supplier). Identifikátor accountingSoftwareInternalId slúži na párovanie v rámci organizácie.
Pri už existujúcom identifikátore popis odpovede uvádza success: false a DOCUMENT_ALREADY_EXISTS. Napriek názvu „upsert“ preto nepredpokladajte, že operácia automaticky aktualizuje existujúceho partnera. Podrobnosti a príklad nájdete v prehľade endpointov.
Ď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.