Changelog

Poslední změny

25.09.2019
  • Přidány endpointy GET/ProformaInvoices/{id}/Account, který vrátí novou vydanou fakturu určenou pro vyúčtování zálohové faktury, a POST/IssuedInvoices/Accounting, který uloží novou vydanou fakturu a použije ji pro vyúčtování zálohové faktury.
18.09.2019
  • Do modelu SalesReceiptApiModelExpand pro GET/SalesReceipts/{id}/Expand a GET/SalesReceipts/Expand přídán Partner
28.08.2019
  • Přidány metody pro vytoření kopie faktury přijate, vydané a zálohové. Resp. ReceivedInvoices/{id}/Copy, IssuedInvoices/{id}/Copy, ProformaInvoices/{id}/Copy
17.07.2019
  • Přidána možnost odesílat poděkování za úhradu.
  • Do modelu pro POST/IssuedInvoicePayments přídán SentPaymenntConfirmation
  • Přidán endpoint POST/Mails/IssuedDocumentPayments/SendConfirmation/{id}
20.03.2018
  • Přidány metody pro práci s e-maily.
  • Přidány metody pro práci s tiskovými sestavami.
  • Přidán číselník kódů plnení - VatReverseChargeCodes.
  • Přidány metody pro práci s bankovními výpisy včetně párování.
07.02.2018
  • Pokladní doklady jsou nyní vícepoložkové. Kvůli zpětné kompatibilitě byla ponechána i stará vlastnost Item, která vždy vrací první položku. Pokud chcete přes API používat vícepoložkové pokladní doklady, použijte novou vlastnost Items. Pro update byla přidána metoda PATCH. Metoda PUT funguje nadále jenom pro jednopoložkové doklady.
  • Na prodejkách přibyl odběratel. Do GET modelů byly přidány adresy odběratele a dodavatele, do POST modelu id odběratele (PartnerId).
14.12.2017
  • Do dokumentace byly přidány filtry na legislativu a zastaralé vlastnosti. Tyto filtry nemají vliv na chování API, jenom na to, co je vidět v dokumentaci. Se zastaralými vlastnostmi v budoucích verzích API nelze počítat, ale v API v2 budou fungovat nadále.
  • Opraveny endpointy Agendas pro správné fungování s víceuživatelským přístupem. Přibyl taky endpoint Agendas/Current.
  • Přidány endpointy pro přílohy Attachments/GET, Attachments/PUT a Attachments/DELETE, které fungují pro všechny podporované entity na základě id a typu dokumentu. Existující endpointy pro přílohy byly označeny za zastaralé.
04.10.2017
  • Do GET metod faktur byly přidány filtry na id kontaktu odběratele (PurchaserId) nebo dodavatele (SupplierId).
30.08.2017
  • Přidány metody pro práci se skladovými pohyby
  • Optimalizace rychlosti metod GetExpand
  • Opravena logika dat u ReceivedInvoices/POST. DateOfMaturity a DateOfTaxing se špatně vyplňovaly vždy podle DateOfIssue. Nevyplněný DateOfIssue se už nenaplní aktuálním datem. Nevyplněný DateOfTaxing se už nenaplní podle DateOfReceiving
  • Další vylepšení dokumentace
27.06.2017
  • Oprava chyb u PUT/PATCH
  • Přidaná položka BarCode do modelu ceníku (GET, POST, PATCH)
10.04.2017
  • Vylepšení dokumentace - přidány sekce changelog a často kladené dotazy
  • Přidán stav skladu do modelu ceníku
  • Mazání ceníkové položky: Při specifikování deleteIfReferenced=false se nesmažou ani exportováné položky
  • Model prodejky - přidány údaje související se zaúčtováním prodejek: IsAccounted, CashVoucherItemId
  • Model pokladního dokladu - přidány údaje související se zaúčtováním prodejek: IsSummarySalesReceipt, SummarySalesReceiptDate
24.01.2017
  • Oprava - odstranění kontroly na unikátnost ID položky aktualizovaného dokladu (znemožňovalo přidat více než jednu novou položku)
10.01.2017
  • U vydaných faktur, zálohových faktur a dobropisů přidaná podpora pro více číselných řad
  • U vydaných faktur, zálohových faktur a dobropisů přidaná podpora pro přílohy. Přílohy fungují stejně jako u faktur přijatých

Quick start

Pro okamžitý začátek práce s API

Postman

Pro snadnou komunikaci a rychlý start jsme pro Vás připravili Postman kolekci dotazů. Během několika minut můžete začít pracovat s Vašimi daty.
Pro přístup k datům pomocí aplikace doporučujeme REST API klienta Postman. Další krok »


Hlavní endpoint pro přístup k API

  • https://api.idoklad.cz
  • Např.: https://api.idoklad.cz/v2/IssuedInvoices

Rozdíly oproti API v1

  • Api verze 2 využívá místo secure tokenu standard OAuth2. Pro zavolání API musíte mít tzv. access token. Pro vyzkoušení API v2 doporučujeme použít získání tokenu pomocí Client Credentials a program Postman. Víc detailů najdete v sekci Autorizace.

Získání seznamů faktur

  1. Zavolejte GET metodu api/v2/IssuedInvoices doc
  2. Odpověď requestu bude obsahovat seznam faktur v poli Data

Vytvoření faktury

  1. Zavolejte api/v2/IssuedInvoices/Default doc
  2. Metoda vrátí předvyplněný objekt faktury s výchozím nastavením uživatele
  3. Vyplňte požadovaná data objektu
  4. Vyplněný objekt serializujte do Body parametru requestu
  5. Zavolání POST metody api/IssuedInvoices doc
  6. Požadavek vrátí fakturu i s nově přepočítanými hodnotami


Obecná pravidla

Konvence a zpětná kompatibilita

HTTP návratové kódy

    Signalizující úspěch:
  • 200 OK. Součástí response bývá obvykle vzniklá entita nebo výsledek operace, je-li potřeba.
    Signalizující neúspěch:
  • Model nesplňuje validaci (400 Bad Request).
  • Entita nebyla nalezena (404 not found)
  • Překročení limitu (429 Too Many Requests). V hlavičce odpovědi je vrácena hodnot Retry-After v sekundách
  • Plánovaná odstávka aplikace (503 Service unavailable). Po dobu odstávky je API nedostupné.
  • Nespecifikovaná chyba (500 Internal Server Error) - v tomto případě nás kontaktujte. Nejrychleji vám pomůžeme, když pošlete celý request, který způsobuje chybu.
    Související s předplatným iDokladu:
  • Expirovaný nebo nepostačující tarif (402 Payment Required)
  • Potřeba manuálního downgrade předplatného přes webové rozhrání (403)
  • Překročení limitu (429 Too Many Requests)
    Související s autentizací:
  • Expirovaný/neplatný token (401 Unauthorized)
  • Neplatný refresh token (400 se správou "invalid_grant"). Refresh tokeny neexpirují, ale můžou být zneplatněny (revokovány). Tato chyba se může u requestu na token objevit i z jiných důvodů, např. špatně vyplněn některý z parametrů. Při výskytu této chyby by se měla aplikace pokusit vyzvat uživatele k opětovnému přihlášení.

Zpětná kompatibilita

    Klient API musí být připraven na následující:
  • Může přibýt (nepovinná) vlastnost na libovolný model.
  • Response bude obsahovat libovolný zdokumentovaný status kód, pokud v dané situaci dává smysl.
    Klient API se může spoléhat na následující:
  • Nikdy nezmizí vlastnost z modelu. Výjimkou jsou major verze API (1.0/2.0/3.0), kde je vyžadovaná větší migrace a změny můžou být libovolné.
  • Nezmění se mu pod rukama chování, nezmění-li on posílaný model. Pod chováním se myslí:
    • Změna návratového kódu, např. přidáním nové validace.
    • Změna vráceného modelu, s výjimkou přidání nových vlastností.
    Pod chováním se nemyslí např. změna algoritmu, jen formát jeho výstupu. Nevztěhuje se ani na opravy chyb.
    Klient API se nemůže spoléhat na následující:
  • Nezdokumentované chování. Týká se hlavně POSTu, kde se některé vlastnosti automaticky berou z nastavení, i když nejsou vyplněny. Před POSTem by se měla použít metoda Default, která vrátí model dle nastavení. (Netýká se popsaných chování, jako jsou číselné řady a podobně.)

HTTP konvence

  • GET - získávání dat
  • PUT - změna existujících dat
  • PATCH - částečný update
  • POST - přidání nového záznamu
  • DELETE - smazání záznamu

Práce se seznamy

Všechny seznamy z API vracejí data zaobalena do objektu, který se skládá z:

  • Data - seznam požadovaných objektů
  • TotalItems - celkový počet záznamů pro request
  • TotalPages - počet stránek pro request

Stránkování

Pro stránkování v seznamech se používají parametry:

  • PageSize - počet položek na stránce
  • Page - číslo zobrazené stránky
  • Maximální množství záznamu na jedné strance je 200 a výchozí je 20 200 a výchozí je 20

Přidávání a úprava záznamu

Před POST-em nového záznamu si připravíte model dle vašich aktuálních nastavení pomocí metody Default. Ta vrací vždy model vhodný pro metodu POST. V tomhle modelu už stačí jenom provést potřebné změny a poslat ho.

PUT se používá pro úplný update záznamu a vyžaduje specifikovat všechny jeho vlastnosti. PATCH aktualizuje jenom to, co specifikujete. Je tedy jednodušší na použití a doporučujeme používat spíše PATCH než PUT.

Při použití requestů PUT, POST, PATCH a DELETE je potřeba přidat do hlavičky záznam Content-Type
Např.: Content-Type: application/json



Autorizace

Úvodní informace ohledně identifikace uživatele Api a uživatele iDokladu

Vzorovou kolekci pro autorizaci si můžete stáhnout zde.

OAuth2

Api iDokladu ve verzi 2 využívá autentizaci pomocí standardu OAuth2. Pro použití API je nutné získat tzv. access token, který se dá získat různými způsoby podle potřeb aplikace. iDoklad momentálně podporuje autentizaci pomocí následujících způsobů:

  • Authorization code flow
  • Client credentials flow
  • PIN flow (používané EET zařízeními)

Autentizace access tokenem
Každý request musí obsahovat hlavičku

Authorization: Bearer your_access_token

Authorization code flow:

Tento flow je vhodný pro aplikace, které potřebují data různých uživatelů. Aplikace zobrazí uživateli přihlašovací okno iDokladu, kde zadá své přihlašovací údaje, čímž povolí aplikaci pracovat s jeho daty.

Aplikace se musí registrovat na Developer portálu, kde získá své client id a client secret.
Získání samotného tokenu probíhá následovně:

Poslaní requestu na authorize endpoint

https://identity.idoklad.cz/server/connect/authorize
                ?scope=idoklad_api%20offline_access
                &client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
                &response_type=code
                &redirect_uri=http://test.test.com/
Parametr Význam
scope viz tabulka scopes
client_id z Developer portálu
response_type řetězec “code”
redirect_uri adresa, na kterou přijde po přihlášení uživatele autorizační kód, který se vymění za access token. Adresa musí být přidaná do seznamu v Developer portálu (podrobnosti klienta - záložka redirect uris)

Přihlášení uživatele

Uživateli se otevře popup okno, kde se přihlásí do iDokladu. Po přihlášení bude přesměrovaný na adresu specifikovanou v redirect_uri.


Poslaní requestu na token endpoint

POST https://identity.idoklad.cz/server/connect/token
                grant_type=authorization_code
                &client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
                &client_secret=yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy
                &scope=idoklad_api%20offline_access
                &code=70ae4b57d835d3755a59b3aa2a729546
                &redirect_uri=http://test.test.com/

Odpovědí na úspěšný request je access token (spolu s refresh tokenem, pokud byl vyžádán).

{
  "access_token": "eyJ0eXAi...",
  "expires_in": 6000,
  "token_type": "Bearer",
  "refresh_token": "abcd..."
}
Parametr Význam
grant_type řetězec “authorization_code”
client_id z Developer portálu
response_type z Developer portálu
scope viz tabulka scopes
code autorizační kód vrácený po přesměrování na redirect_uri. Kód lze použít jenom jednou. Chcete-li se vyhnout opakovanému přihlašování uživatele, použijte refresh token.
redirect_uri adresa, která byla specifikována při requestu na authorize endpoint

Refresh token

POST https://identity.idoklad.cz/server/connect/token
                grant_type=refresh_token
                &client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
                &client_secret=yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy
                &scope=idoklad_api%20offline_access
                &redirect_uri=http://test.test.com/
                &refresh_token=f4bcdc2e6d964f519cd74e2ac4a2105f
Parametr Význam
grant_type řeťezec “refresh_token”
refresh_token z Developer portálu
ostatní shodné s access token requestem

Client credentials flow

Každý uživatel si může v nastavení vygenerovat své client id a client secret bez potřeby registrovat se jako aplikace. Tyto údaje se nacházejí v nastavení uživatele. Použití client credentials je vhodné pouze v případech, kde je client secret bezpečně uložený, např. při server-to-server komunikaci. Je také jednoduchý na zprovoznění přes klienta Postman.

Access token

Parametr Hodnota
scope idoklad_api
grant_type client_credentials
client_id z nastavení iDokladu
client_secret z nastavení iDokladu

Client credentials nepoužívá refresh token

EET - Pin flow

POST https://app.idoklad.cz/identity/server/connect/token
                scope=eet+offline_access
                &client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
                &client_secret=yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy
                &grant_type=pin
                &pin=12345678
Parametr Hodnota
scope eet offline_acccess
grant_type pin
client_id z Developer portálu
client_secret z Developer portálu
pin kód zařízení

Pozor

  • Při použití EET flow je důležité uložit si refresh token. Vygenerováním access tokenu se zařízení nastaví jako spárované a odpárování je možné jenom manuálně v iDokladu. Pro spárované zařízení nejde vyžádat nový access token jinak než přes refresh token.
POST https://identity.idoklad.cz/server/connect/token
    scope=eet+offline_access
    &client_id=a05743fa-f043-42f2-a26b-7c75194762d0
    &client_secret=510e5d46-0566-48b2-8e30-71a28abeb077
    &grant_type=refresh_token
    &refresh_token=397e08355318cc85dd890e3bc33b0cc1

Refresh token

Parametr Hodnota
scope eet offline_acccess
grant_type refresh_token
refresh_token hodnota refresh tokenu uděleného s prvním access tokenem
client_id z Developer portálu
client_secret z Developer portálu

* Při žádosti o refresh token se nemusí znovu specifikovat pin

Scopes

Scope Význam
idoklad_api univerzální scope pro read/write přístup do API
offline_access potřebný pro udělení refresh tokenu
eet používaný v eet pin flow


Filtrování

Syntax pro filtry

Url syntax

url/v2/controller/endpoint
   ?filter=FILTER_SYNTAX
    &sort=SORT_SYNTAX
    &page={int}
    &pagesize={int}
Parametr Defaultní hodnota
filter -
sort id~asc
pagesize 20
page 1
filtertype and
  • pořadí query parametrů je libovolné
  • může se uvést víc než jeden filtr na jednu vlastnost

Filter syntax

FILTER_SYNTAX = (
{PROPERTY_NAME}~{OPERATOR}~{PROPERTY_VALUE}
    ~and~ // ~or~
{PROPERTY_NAME}~{OPERATOR}~{PROPERTY_VALUE}
    ... )

Operátory

Operátor Význam Podporované datové typy
lt < int, datetime
lte <= int, datetime
gt > int, datetime
gte >= int, datetime
eq == všechny
!eq != všechny
ct contains string
!ct !contains string

Vlastnosti typu enum je možné filtrovat i na základě textové hodnoty, např.:

movementType~eq~Received je ekvivalentní s movementType~eq~1

Sort syntax

{PROPERTY_NAME}~{SORT_ORDER}
        |  // oddělovač sortů
{PROPERTY_NAME}~{SORT_ORDER}

SORT_ORDER

Operátor Význam
asc ascending (123)
desc descending (321)

Příklad konkrétního requestu:

GET
/v2/IssuedInvoices
   ?filter=DocumentNumber~ct~2016|Price~gt~50
    &sort=Id~desc
    &page=2
    &pagesize=30
    &filtertype=or

Seznam filtrovatelných vlastností entit je dostupný v podrobné dokumentaci.

FAQ

Často kladené dotazy

Autorizace

Dotaz:
Request na authorize endpoint mi vrací The requested resource does not support http method 'GET'

Odpověď:

Request na authorize endpoint je typu POST


Dotaz:
Request na token endpoint mi vrací "error": "invalid_scope"

Odpověď:

Prostudujte scopes v dokumentaci nebo ve vzorové Postman kolekci. Pozor na mezery.


Dotaz:
Request na token endpoint mi vrací "error": "invalid_client"

Odpověď:

Zkontrolujte:

  • Jestli se posílané údaje opravdu shodují (překlepy, extra mezery).
  • V případě client credentials se může stát, že jste je vygenerovali, ale neuložili nastavení.
  • V případě client credentials se může stát, že jste vygenerovali nové a uložili nastavení, které zneplatní ty staré.


Dotaz:
Request na token endpoint mi vrací "error": "invalid_grant"

Odpověď:

U authorization code (request na access token) - code získaný po přihlášení uživatele je jednorazový. Opakované použití vrátí tuto chybu.


Dotaz:
Request na token endpoint mi vrací "error": "unsupported_grant_type"

Odpověď:

Špatně vyplněná hlavička grant_type. Platné hodnoty najdete v dokumentaci nebo ve vzorové Postman kolekci.


Dotaz:
Kdy použít client id a client secret z Developer portálu a kdy z nastavení iDokladu?

Odpověď:

Údaje z Developer portálu identifikují aplikaci. Využijete je, když chcete vyvíjet napojení, která budou používat různí uživatelé iDokladu. Ti dávají aplikaci povolení pracovat s jejich daty (přihlášením). Samotná aplikace žádná data nevlastní. Účet na Developer portálu a účet na iDokladu nejsou svázány, a to ani v případě, že se shoduje přihlašovací e-mail.
Údaje z nastavení iDokladu identifikují konkrétní kombinaci firmy a uživatele. Lze je použít jen pro client credentials flow. Ideální je tedy použití pro práci s vlastními daty nebo v automatizovaném prostředí, kde se uživatel manuálně nepřihlašuje.


Jiné

Dotaz:
Tiskovka se mi vrátí v jiném jazyce, než bych chtěl.

Odpověď:

Pro většinu tiskovek lze použít HTTP header Accept-Lanuage. Akceptovanou hodnotou je jedna z en-US, de-DE, sk-SK a cs-CZ. U vydaných faktur, zálohových faktur a dobropisů se jazyk tiskovky řídí parametrem LanguageCode, se kterým byla faktura uložená.


Knihovny a rozšíření

My vývojáři táhneme za jeden provaz. Oceňujeme, že čím dál častěji sdílíte výsledky svého úsilí a vzájemně tak usnadňujete práci všem.

C#

SDK pro C# od Miroslava Holce najdete na jeho Githubu. Je také dostupný jako NuGet package.


PHP

Honza Malcánek vytvořil open source knihovnu pro snadné napojení PHP aplikací přes API iDokladu a dal ji všem volně k použití. Děkujeme mu, je to opravdu hodně dobrá práce! Najdete ji zde.


Jiné

Máte taky aplikaci nebo knihovnu využívající iDoklad? Zaregistrujte si ji zde!

Podrobná dokumentace

Všechno do posledního detailu.

Hlavné entity

Agendas

Metody pro práci s agendami.

GET v2/Agendas

Seznam agend.

GET v2/Agendas/{id}

Detail agendy dle Id.

GET v2/Agendas/Current

Detail autorizované agendy.

GET v2/Agendas/GetActualMonthInvoicing

Funkce vypočítá statistické údaje pro aktuální měsíc

GET v2/Agendas/GetAgendaBankAccounts

Seznam bankovních účtů agendy.

GET v2/Agendas/GetAgendaContact

Kontaktní údaje agendy.

GET v2/Agendas/GetAgendaContactExpand

Kontaktní údaje agendy - rozšířená verze.

GET v2/Agendas/GetAgendaSummary

Počet dokladů v agendě.

GET v2/Agendas/GetInvoicingForPeriod

Funkce vypočítá statistické údaje pro vydané a přijaté faktury

GET v2/Agendas/GetInvoicingForYear

Funkce vypočítá statistické údaje pro vydané a přijaté faktury

GET v2/Agendas/GetStatisticForContact/{id}

Statistika pro kontakt.

GET v2/Agendas/GetSummaryQuarters

Součet fakturačních částek dle jednotlivých kvartálů.

GET v2/Agendas/GetTopPartners

Funkce vypočítá nejlepší kontakty dle vyfakturované částky.

BankStatements

Metody pro práci s bankovými výpisy.

GET v2/BankStatements

Vrátí seznam bankovních výpisů. Filtry jsou volitelné.

GET v2/BankStatements/{id}

Vrátí údaje o bankovním výpisu s daným id.

POST v2/BankStatements/Pair

Vytvoří výpis a spáruje ho automaticky s fakturou na základě variabilního symbolu a měny. Bankovní účet se hledá podle čísla a kódu banky u CZ legislativy a podle IBANu u SK legislativy.

CashVouchers

Metody pro práci s pokladními doklady.

Vícepoložkový pokladní doklad

Pokladní doklady jsou vícepoložkové od 7.2.2018. Kvůli zpětné kompatibilitě zůstala na modelech položka Item. Pokud chcete používat vícepoložkové doklady, začněte ve vašem napojení využívat Items. Pro update pokladního dokladu použijte metodu PATCH, která již pracuje jenom s Items.
Také se změnilo umístnění pro VariableSymbol, který byl přesunutý z Item na hlavičku dokladu. Starý variabilní symbol na položkách je nyní redundantní a bude vždy totožný s tím na hlavičce.

GET v2/CashVouchers

Vrátí seznam pokladních dokladů. Filtry jsou volitelné.

GET v2/CashVouchers/{id}

Vrátí údaje o pokladním dokladu.

GET v2/CashVouchers/{id}/Expand

Vrátí pokladní doklad s pridruženými entitami.

GET v2/CashVouchers/{id}/GetCashVoucherPdf

Vrátí pdf s tiskovou sestavou Pokladní doklad. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/CashVouchers/{id}/GetCashVoucherPdfCompressed

Vrátí pdf s tiskovou sestavou Pokladní doklad. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/CashVouchers/Default/{movementType}

Vrátí prázdný pokladní doklad s výchozími hodnotami, dle nastavení agendy.

GET v2/CashVouchers/Default/{movementType}/{invoiceType}/{invoiceId}

Vrátí pokladní doklad z dané faktury pro daný typ pohybu a typ faktury

GET v2/CashVouchers/Expand

Vrátí seznam pokladních dokladů s pridruženými entitami.

POST v2/CashVouchers

Vloží nový pokladní doklad.

POST v2/CashVouchers/Pair/{cashVoucherId}/{invoiceType}/{invoiceId}

Spáruje pokladní doklad s neuhrazenou fakturou. Při párování se vytvoří úhrada k dané faktuře.

POST v2/CashVouchers/Pair/{invoiceType}/{invoiceId}

Spáruje pokladní doklad s neuhrazenou fakturou. Při párování se vytvoří úhrada k dané faktuře.

PUT v2/CashVouchers/{id}

Kompletní Update pokladního dokladu dle Id.

PUT v2/CashVouchers/{id}/Exported/{exported}

Update příznaku Exported pokladního dokladu. Využívá se při komunikaci s externími účetními programy.

PATCH v2/CashVouchers/{id}

Částečný update pokladního dokladu dle Id.

DELETE v2/CashVouchers/{id}

Odstraní pokladní doklad ze systému.

Contacts

Metody pro práci s kontakty.

Terminologie

Contact označuje kontakt v adresáři. DocumentAddress se vytvoří v momentě vytvoření dokumentu pro dodavatele i pro odběratele. Údaje v kontaktních údajích na faktuře nemusí odpovídat údajům, které má kontakt nastavené v adresáři (při změne kontaktu se DocumentAddress nemění). Změnu DocumentAddress lze dodatočně provést pomocí metody PATCH/DocumentAddresses, která povoluje i částečný update.

Užitečné rady

Id kontaktu je u faktur vyžadované. Jedná se o PurchaserId na vydaných fakturách a SupplierId na přijatých.

GET v2/Contacts

Seznam kontaktů.

GET v2/Contacts/{id}

Vrátí Kontakt dle Id.

GET v2/Contacts/{id}/Expand

Vrátí kontakt i se zanořenými entitami dle Id.

GET v2/Contacts/Default

Vrátí výchozí kontakt, který je vhodný pro naplnění údaji a uložení pomocí metody POST.

GET v2/Contacts/Expand

Seznam kontaktů i se zanořenými entitami.

POST v2/Contacts

Přidání nového kontaktu.

PUT v2/Contacts/{id}

Úplný update kontaktu.

PATCH v2/Contacts/{id}

Update kontaktu. Lze updatovat i částečně.

DELETE v2/Contacts/{id}

Odstraní kontakt.

CreditNotes

Metody pro práci s dobropisy.

GET v2/CreditNotes

Vrátí seznam dobropisů. Filtry jsou volitelné.

GET v2/CreditNotes/{id}

Vrátí údaje o dobropisu včetně výpočtu sum. Vhodné pro zobrazení detailu dobropisu.

GET v2/CreditNotes/{id}/Expand

Vrátí dobropis s kompletními údaji o dobropisu a odběrateli.

GET v2/CreditNotes/{id}/GetAttachment

Vrátí soubor s přilohou, pokud dobropis nějakou má. Soubor je zakódován Base64 kódováním.

GET v2/CreditNotes/{id}/GetAttachmentCompressed

Vrátí soubor s přilohou, pokud dobropis nějakou má. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/CreditNotes/Expand

Vrátí seznam dobropisů s kompletními údaji o dobropisech a odběratelích.

PUT v2/CreditNotes/{id}/Exported/{exported}

Update příznaku Exported dobropisu. Využívá se při komunikaci s externími účetními programy.

PUT v2/CreditNotes/{id}/FullyPay

Metoda provede plnou úhradu dobropisu.

PUT v2/CreditNotes/{id}/FullyUnpay

Provede plné oduhrazení dobropisu.

PUT v2/CreditNotes/SetAttachment/{invoiceId}

Nastaví přílohu u dobropisu. Případná existující příloha se přepíše.

DELETE v2/CreditNotes/DeleteAttachment/{invoiceId}

Smaže přílohu u dobropisu.

IssuedDocumentPayments

Metody pro práci s úhradami vydaných dokladů.

GET v2/IssuedDocumentPayments

Vrátí seznam úhrad. Filtry jsou volitelné.

GET v2/IssuedDocumentPayments/{id}

Vrátí údaje o úhradě. Vhodné pro zobrazení detailu úhrady.

GET v2/IssuedDocumentPayments/{id}/Expand

Vrátí úhradu s kompletními údaji o navázaných entitách jako například doklad úhrady.

GET v2/IssuedDocumentPayments/Default/{documentId}

Vygeneruje defaultní úhradu k zadanému dokladu. Vhodné pro vytvoření nové úhrady.

GET v2/IssuedDocumentPayments/Expand

Vrátí seznam úhrad s kompletními údaji o navázaných entitách jako například doklad úhrady.

POST v2/IssuedDocumentPayments

Vloží novou úhradu do seznamu úhrad. Úhrada by měla obsahovat id dokladu který hradí.

PUT v2/IssuedDocumentPayments/{id}/Exported/{exported}

Update příznaku Exported úhrady. Využívá se při komunikaci s externími účetními programy.

DELETE v2/IssuedDocumentPayments/{id}

Odstraní úhradu ze systému. Pokud má úhrada pokladní doklad, odstraní ho.

IssuedInvoices

Metody pro práci s fakturami vydanými.

GET v2/IssuedInvoices

Vrátí seznam faktur vydaných. Filtry jsou volitelné.

GET v2/IssuedInvoices/{contactId}/IssuedInvoices

Vrátí seznam faktur pro kontakt.

GET v2/IssuedInvoices/{id}

Vrátí údaje o faktuře vydané včetně výpočtu sum. Vhodné pro zobrazení detailu faktury.

GET v2/IssuedInvoices/{id}/Copy

Vrátí kopii existující faktury vydané. Vhodné pro vytvoření nové faktury vydané.

GET v2/IssuedInvoices/{id}/Expand

Vrátí fakturu s kompletními údaji o faktuře a odběrateli.

GET v2/IssuedInvoices/{id}/GetAttachment

Vrátí soubor s přilohou, pokud faktura nějakou má. Soubor je zakódován Base64 kódováním.

GET v2/IssuedInvoices/{id}/GetAttachmentCompressed

Vrátí soubor s přílohou, pokud faktura nějakou má. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/IssuedInvoices/{id}/GetCashVoucherPdf

Vrátí pdf s tiskovou sestavou Pokladní doklad pro fakturu. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/IssuedInvoices/{id}/GetCashVoucherPdfCompressed

Vrátí pdf s tiskovou sestavou Pokladní doklad pro fakturu. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/IssuedInvoices/{id}/GetPdf

Vrátí pdf s tiskovou sestavou Faktura vydaná. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/IssuedInvoices/{id}/GetPdfCompressed

Vrátí pdf s tiskovou sestavou Faktura vydaná. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/IssuedInvoices/{id}/GetPdfWithPayments

Vrátí pdf s tiskovou sestavou Faktura vydaná s úhradami. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/IssuedInvoices/{id}/GetPdfWithPaymentsCompressed

Vrátí pdf s tiskovou sestavou Faktura vydaná s úhradami. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/IssuedInvoices/{id}/MyDocumentAddress

Vrátí fakturační údaje dodavatele faktury vydané.

GET v2/IssuedInvoices/{id}/PurchaserDocumentAddress

Vrátí fakturační údaje odběratele faktury vydané.

GET v2/IssuedInvoices/Default

Vrátí prázdnou fakturu s výchozími hodnotami, dle nastavení agendy. Vhodné pro vytvoření nové faktury.

GET v2/IssuedInvoices/Expand

Vrátí seznam faktur s kompletními údaji o fakturách a odběratelích.

POST v2/IssuedInvoices

Vloží novou fakturu do seznamu faktur. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

POST v2/IssuedInvoices/{id}/Recount

Provede přepočet faktury. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

POST v2/IssuedInvoices/Accounting

Vloží novou fakturu do seznamu faktur a použije ji pro vyúčtování zálohové faktury. Zálohová faktura musí být uhrazena.

POST v2/IssuedInvoices/Recount

Provede přepočet faktury. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

PUT v2/IssuedInvoices/{id}

Update faktury dle Id. Lze provést jak kompletní nebo i částečný update. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

PUT v2/IssuedInvoices/{id}/Exported/{exported}

Update příznaku Exported faktury. Využívá se při komunikaci s externími účetními programy.

PUT v2/IssuedInvoices/{id}/FullyPay

Metoda provede plnou úhradu faktury.

PUT v2/IssuedInvoices/{id}/FullyUnpay

Provede plné oduhrazení faktury.

PUT v2/IssuedInvoices/{id}/MyDocumentAddress

Upraví fakturační údaje dodavatele faktury vydané.

PUT v2/IssuedInvoices/{id}/PurchaserDocumentAddress

Upraví fakturační údaje odběratele faktury vydané

PUT v2/IssuedInvoices/{id}/SendMailToPurchaser

Odešle fakturu odběrateli.

PUT v2/IssuedInvoices/SetAttachment/{invoiceId}

Nastaví přílohu u faktury vydané. Případná existující příloha se přepíše.

PATCH v2/IssuedInvoices/{id}

Update faktury dle Id. Lze provést jak kompletní nebo i částečný update. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

DELETE v2/IssuedInvoices/{id}

Odstraní fakturu ze systému.

DELETE v2/IssuedInvoices/DeleteAttachment/{invoiceId}

Smaže přílohu u faktury vydané.

PriceListItems

Metody pro práci s ceníkem.

Užitečné rady

Pro efektivnější práci s ceníkem lze použít dávkové operace pro vkládání i mazání.

GET v2/PriceListItems

Vrátí stránkovaný seznam položek ceníku.

GET v2/PriceListItems/{id}

Vrátí položku ceníku dle Id.

GET v2/PriceListItems/{id}/Expand

Vrátí položku ceníku včetně zanořených entit dle Id.

GET v2/PriceListItems/Default

Vygeneruje položku s defaultními hodnotami dle nastavení agendy vhodnou pro následnou úpravu a uložení.

GET v2/PriceListItems/Expand

Seznam položek ceníku i se zanořenými entitami.

POST v2/PriceListItems

Vloží novou položku ceníku do seznamu.

POST v2/PriceListItems/Batch

Vloží novou položku ceníku do seznamu. Dávková verze.

PUT v2/PriceListItems/{id}

Upraví položku ceníku.

PUT v2/PriceListItems/Batch

Upraví položky ceníku. Dávková operace.

PATCH v2/PriceListItems/{id}

Upraví položku ceníku.

PATCH v2/PriceListItems/Batch

Částečná úprava položek. Dávková operace.

DELETE v2/PriceListItems/{id}/{deleteIfReferenced}

Smaže položku ze seznamu ceníku.

DELETE v2/PriceListItems/Batch/{deleteIfReferenced}

Smaže položky ze seznamu ceníku.

ProformaInvoices

Metody pro práci se zálohovými fakturami.

GET v2/ProformaInvoices

Vrátí seznam zálohových faktur. Filtry jsou volitelné.

GET v2/ProformaInvoices/{contactId}/Invoices

Vrátí seznam zálohových faktur pro kontakt.

GET v2/ProformaInvoices/{id}

Vrátí údaje o zálohové faktuře včetně výpočtu sum. Vhodné pro zobrazení detailu faktury.

GET v2/ProformaInvoices/{id}/Account

Vrátí novou vydanou fakturu určenou pro vyúčtování zálohové faktury. Zálohová faktura musí být uhrazena.

GET v2/ProformaInvoices/{id}/Copy

Vrátí kopii existující zálohové faktury. Vhodné pro vytvoření nové zálohové faktury.

GET v2/ProformaInvoices/{id}/Expand

Vrátí zálohovou fakturu s kompletními údaji o faktuře a odběrateli.

GET v2/ProformaInvoices/{id}/GetAttachment

Vrátí soubor s přilohou, pokud faktura nějakou má. Soubor je zakódován Base64 kódováním.

GET v2/ProformaInvoices/{id}/GetAttachmentCompressed

Vrátí soubor s přílohou, pokud faktura nějakou má. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/ProformaInvoices/{id}/GetCashVoucherPdf

Vrátí pdf s tiskovou sestavou Pokladní doklad pro fakturu. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/ProformaInvoices/{id}/GetCashVoucherPdfCompressed

Vrátí pdf s tiskovou sestavou Pokladní doklad pro fakturu. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/ProformaInvoices/{id}/GetPdf

Vrátí pdf s tiskovou sestavou Faktura vydaná. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/ProformaInvoices/{id}/GetPdfCompressed

Vrátí pdf s tiskovou sestavou Faktura vydaná. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/ProformaInvoices/{id}/GetPdfWithPayments

Vrátí pdf s tiskovou sestavou Zálohová faktura s úhradami. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/ProformaInvoices/{id}/GetPdfWithPaymentsCompressed

Vrátí pdf s tiskovou sestavou Zálohová faktura s úhradami. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/ProformaInvoices/{id}/MyDocumentAddress

Vrátí fakturační údaje dodavatele zálohové faktury.

GET v2/ProformaInvoices/{id}/PurchaserDocumentAddress

Vrátí fakturační údaje odběratele zálohové faktury.

GET v2/ProformaInvoices/Default

Vrátí prázdnou zálohovou fakturu s výchozími hodnotami, dle nastavení agendy. Vhodné pro vytvoření nové faktury.

GET v2/ProformaInvoices/Expand

Vrátí seznam zálohových faktur s kompletními údaji o fakturách a odběratelích.

POST v2/ProformaInvoices

Vloží novou zálohovou fakturu do seznamu faktur. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

POST v2/ProformaInvoices/{id}/Recount

Provede přepočet faktury. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

POST v2/ProformaInvoices/Recount

Provede přepočet faktury. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

PUT v2/ProformaInvoices/{id}

Kompletní update faktury dle Id.

PUT v2/ProformaInvoices/{id}/Account

Provede vyúčtování zálohové faktury. Faktura musí být uhrazena.

PUT v2/ProformaInvoices/{id}/Exported/{exported}

Update příznaku Exported faktury. Využívá se při komunikaci s externími účetními programy.

PUT v2/ProformaInvoices/{id}/FullyPay

Metoda provede plnou úhradu zálohové faktury.

PUT v2/ProformaInvoices/{id}/FullyUnpay

Provede plné oduhrazení zálohové faktury.

PUT v2/ProformaInvoices/{id}/SendMailToPurchaser

Odešle fakturu odběrateli.

PUT v2/ProformaInvoices/SetAttachment/{invoiceId}

Nastaví přílohu u zálohové faktury. Případná existující příloha se přepíše.

PATCH v2/ProformaInvoices/{id}

Update faktury dle Id. Lze provést jak kompletní nebo i částečný update. Faktura by měla obsahovat pouze položky typu ItemTypeNormal.

DELETE v2/ProformaInvoices/{id}

Odstraní zálohovou fakturu ze systému.

DELETE v2/ProformaInvoices/DeleteAttachment/{invoiceId}

Smaže přílohu u zálohové faktury.

ReceivedDocumentPayments

Metody pro práci s úhradami přijatých dokladů.

GET v2/ReceivedDocumentPayments

Vrátí seznam úhrad. Filtry jsou volitelné.

GET v2/ReceivedDocumentPayments/{id}

Vrátí údaje o úhradě. Vhodné pro zobrazení detailu úhrady.

GET v2/ReceivedDocumentPayments/{id}/Expand

Vrátí úhradu s kompletními údaji o navázaných entitách jako například doklad úhrady.

GET v2/ReceivedDocumentPayments/Default/{documentId}

Vygeneruje defaultní úhradu k zadanému dokladu. Vhodné pro vytvoření nové úhrady.

GET v2/ReceivedDocumentPayments/Expand

Vrátí seznam úhrad s kompletními údaji o navázaných entitách jako například doklad úhrady.

POST v2/ReceivedDocumentPayments

Vloží novou úhradu do seznamu úhrad. Úhrada by měla obsahovat id dokladu který hradí.

PUT v2/ReceivedDocumentPayments/{id}/Exported/{exported}

Update příznaku Exported úhrady. Využívá se při komunikaci s externími účetními programy.

DELETE v2/ReceivedDocumentPayments/{id}

Odstraní úhradu ze systému. Pokud má úhrada pokladní doklad, odstraní ho.

ReceivedInvoices

Metody pro práci s fakturami přijatými.

GET v2/ReceivedInvoices

Vrátí seznam faktur přijatých. Filtry jsou volitelné.

GET v2/ReceivedInvoices/{id}

Vrátí údaje o faktuře přijaté včetně výpočtu sum. Vhodné pro zobrazení detailu faktury.

GET v2/ReceivedInvoices/{id}/Copy

Vrátí kopii existující faktury přijaté. Vhodné pro vytvoření nové faktury přijaté.

GET v2/ReceivedInvoices/{id}/Expand

Vrátí fakturu přijatou s kompletními údaji o faktuře a dodavateli.

GET v2/ReceivedInvoices/{id}/GetAttachment

Vrátí soubor s přilohou, pokud faktura nějakou má. Soubor je zakódován Base64 kódováním.

GET v2/ReceivedInvoices/{id}/GetAttachmentCompressed

Vrátí soubor s přílohou, pokud faktura nějakou má. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/ReceivedInvoices/{id}/GetPdf

Vrátí pdf s tiskovou sestavou Faktura přijatá. Dokument je zakódován Base64 kódováním a je vrácen jako řetězec.

GET v2/ReceivedInvoices/{id}/GetPdfCompressed

Vrátí pdf s tiskovou sestavou Faktura přijatá. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/ReceivedInvoices/{id}/MyDocumentAddress

Vrátí fakturační údaje odběratele faktury přijaté.

GET v2/ReceivedInvoices/{id}/SupplierDocumentAddress

Vrátí fakturační údaje dodavatele faktury přijaté.

GET v2/ReceivedInvoices/{supplierId}/ReceivedInvoices

Vrátí seznam faktur přijatých pro kontakt.

GET v2/ReceivedInvoices/Default

Vrátí prázdnou fakturu s výchozími hodnotami, dle nastavení agendy. Vhodné pro vytvoření nové faktury přijaté.

GET v2/ReceivedInvoices/Expand

Vrátí seznam přijatých faktur s kompletními údaji o rozšířených entitách.

POST v2/ReceivedInvoices

Vloží novou fakturu do seznamu faktur přijatých.

POST v2/ReceivedInvoices/{id}/Recount

Provede přepočet existující faktury přijaté a vrátí výsledek výpočtu. Přepočítanou fakturu je pak nutné uložit pomocí metody POST.

POST v2/ReceivedInvoices/Recount

Provede přepočet nové faktury přijaté

PUT v2/ReceivedInvoices/{id}

Kompletní update faktury přijaté dle Id.

PUT v2/ReceivedInvoices/{id}/Exported/{exported}

Update příznaku Exported faktury. Využívá se při komunikaci s externími účetními programy.

PUT v2/ReceivedInvoices/{id}/FullyPay

Metoda provede plnou úhradu faktury.

PUT v2/ReceivedInvoices/{id}/FullyUnpay

Provede plné oduhrazení faktury.

PUT v2/ReceivedInvoices/{id}/MyDocumentAddress

Upraví fakturační údaje odběratelé faktury přijaté.

PUT v2/ReceivedInvoices/{id}/SupplierPurchaserDocumentAddress

Upraví fakturační údaje dodavatele faktury přijaté.

PUT v2/ReceivedInvoices/SetAttachment/{invoiceId}

Nastaví přílohu u faktury přijaté. Případná existující příloha se přepíše.

PATCH v2/ReceivedInvoices/{id}

Kompletní nebo částečný update faktury přijaté dle Id.

DELETE v2/ReceivedInvoices/{id}

Odstraní fakturu ze systému.

DELETE v2/ReceivedInvoices/DeleteAttachment/{invoiceId}

Smaže přílohu u faktury přijaté.

RegisteredSale

Metody pro práci s evidovanými tržbami.

GET v2/RegisteredSales

Vrátí seznam údajů o evidovaných tržběách.

GET v2/RegisteredSales/{type}/{id}

Vrátí údaje o evidované tržbě pro typ prodeje a id dokladu.

GET v2/RegisteredSales/{type}/{id}/Expand

Vrátí údaje o evidované tržbě pro typ prodeje a id dokladu s pridruženými entitami.

GET v2/RegisteredSales/Default

Vrátí prázdnou evidovanou tržbu s výchozími hodnotami, dle nastavení agendy.

GET v2/RegisteredSales/Expand

Vrátí seznam údajů o evidovaných tržběách s pridruženými entitami.

POST v2/RegisteredSales/{type}/{id}

Vloží novou evidovanou tržbu.

SalesReceipts

Metody pro práci s prodejkami.

GET v2/SalesReceipts

Vrátí seznam prodejek. Filtry jsou volitelné.

GET v2/SalesReceipts/{id}

Vrátí údaje o prodejce.

GET v2/SalesReceipts/{id}/Expand

Vrátí prodejku s pridruženými entitami.

GET v2/SalesReceipts/{id}/GetPdf

Vrátí pdf s tiskovou sestavou prodejky. Dokument je zakódovaný Base64 kódováním a je vrácen jako řetězec.

GET v2/SalesReceipts/{id}/GetPdfCompressed

Vrátí pdf s tiskovou sestavou prodejky. Dokument je dále komprimovaný do Zip souboru. Archív je zakódován Base64 kódováním.

GET v2/SalesReceipts/Default

Vrátí prázdnou prodejku s výchozími hodnotami, dle nastavení agendy.

GET v2/SalesReceipts/Expand

Vrátí seznam prodejek s pridruženými entitami.

POST v2/SalesReceipts

Vloží novou prodejku.

POST v2/SalesReceipts/{id}/Recount

Provede přepočet prodejky.

POST v2/SalesReceipts/Recount

Provede přepočet prodejky.

PUT v2/SalesReceipts/{id}

Kompletní update prodejky dle id.

PUT v2/SalesReceipts/{id}/EetStatus/{eetStatus}

Update příznaku EetStatus

PUT v2/SalesReceipts/{id}/Exported/{exported}

Update příznaku Exported prodejky. Využívá se při komunikaci s externími účetními programy.

PUT v2/SalesReceipts/{id}/Imported/{value}

Update příznaku Imported prodejky. Využívá se při komunikaci s externími účetními programy.

PATCH v2/SalesReceipts/{id}

Částečný update prodejky dle id.

DELETE v2/SalesReceipts/{id}

Odstraní prodejku ze systému.

StockMovements

Metody pro práci se skladovými pohyby.

Užitečné rady

  • Skladové pohyby se provedou automaticky, pokud při uložení faktury použijete skladovou ceníkovou položku.
  • Pro efektivnější práci se skladem lze použít dávkové vkládání pohybů.
GET v2/StockMovements

Vrátí stránkovaný seznam skladových pohybů.

GET v2/StockMovements/{id}

Vrátí skladový pohyb dle id.

GET v2/StockMovements/Default/{priceListItemId}

Vrátí model skladového pohybu dle nastavení agendy.

POST v2/StockMovements

Vytvoří nový skladový pohyb. Pro záporný pohyb použijte záporné množství. V případě, že ceníková položka není skladová, změní se na skladovou.

POST v2/StockMovements/Batch

Vytvoří nové skladové pohyby. Pohyby mohou být i k různým ceníkovým položkám. Pro záporný pohyb použijte záporné množství.

PATCH v2/StockMovements/{id}

Částečný update skladového pohybu s daným id.

DELETE v2/StockMovements/{id}

Smaže skladový pohyb s daným id.


Vedlejší entity

CashRegisters

Metody pro práci s pokladnami.

Terminologie

Pokladna není to stejné, co pokladní zařízení. Pokud hledáte SalesPosEquipmentId pro EET, použijte metodu GET/SalesPosEquipments.

GET v2/CashRegisters

Vrátí seznam pokladen

GET v2/CashRegisters/{id}

Vrátí údaje o pokladně.

GET v2/CashRegisters/{id}/Expand

Vrátí pokladnu s pridruženými entitami.

GET v2/CashRegisters/Expand

Vrátí seznam pokladen s pridruženými entitami.

DocumentAddresses

Metody pro práci s kontaktními údaji dokumentů.

Terminologie

Contact označuje kontakt v adresáři. DocumentAddress se vytvoří v momentě vytvoření dokumentu pro dodavatele i pro odběratele. Údaje v kontaktních údajích na faktuře nemusí odpovídat údajům, které má kontakt nastavené v adresáři (při změne kontaktu se DocumentAddress nemění). Změnu DocumentAddress lze dodatočně provést pomocí metody PATCH/DocumentAddresses, která povoluje i částečný update.

GET v2/DocumentAddresses/{id}

Vrátí kontaktní údaje pro fakturu Faktura obsahuje dvě položky daného typu - jednu pro odběratele a jednu pro dodavatele.

PUT v2/DocumentAddresses/{id}

Provede update kontaktních údajů k faktuře

PATCH v2/DocumentAddresses/{id}

Provede update kontaktních údajů k faktuře. Lze provést částečný update.

NumericSequences

Metody pro práci s číselnými řady.

Užitečné rady

V případě, že chcete vkládat dokumenty do předvolené řady pro daný typ dokumentu, nemusíte NumericSequenceIdspecifikovat.

GET v2/NumericSequences

Vrátí stránkovaný seznam číselných řad.

GET v2/NumericSequences

Vrátí číselnou řadu podle Id.

SalesOffice

Metody pro práci s prodejními místy.

GET v2/SalesOffice

Vrátí seznam prodejních míst. Filtry jsou volitelné.

SalesPosEquipment

Metody pro práci s pokladními zařízeními.

GET v2/SalesPosEquipment

Vrátí seznam prodejních zařízení. Filtry jsou volitelné.

GET v2/SalesPosEquipment/Expand

Vrátí seznam prodejních zařízení s rozšířenými entitami.

GET v2/SalesPosEquipment/Info

Vrátí informace o spárovaném pokladním zařízení, vrátaně informace o číselné řadě.


Číselníky

Banks

Číselník bank.

GET v2/Banks

Metoda vrátí seznam bank.

GET v2/Banks/{id}

Metoda vrátí banku dle Id.

GET v2/Banks/GetChanges

Metoda vrátí seznam bank, které byly změněné.

ConstantSymbols

Číselník konstantní symbolů.

GET v2/ConstantSymbols

Metoda vrátí seznam konstantních symbolů

GET v2/ConstantSymbols/{id}

Metoda vrátí konstantní symbol dle Id

GET v2/ConstantSymbols/GetChanges

Metoda vrátí seznam konstantních symbolů, které byli změněne.

Countries

Číselník států.

GET v2/Countries

Metoda vrátí seznam států

GET v2/Countries/{id}

Metoda vrátí stát dle Id.

GET v2/Countries/GetChanges

Metoda vrátí seznam států, které byly změněny.

Currencies

Číselník měn.

GET v2/Currencies

Metoda vrátí seznam měn.

GET v2/Currencies/{id}

Metoda vrátí měnu dle Id

GET v2/Currencies/GetChanges

Metoda vrátí seznam měn, které byly změněny.

ExchangeRates

Číselník kurzů.

GET v2/ExchangeRates

Metoda vrátí seznam kurzů.

GET v2/ExchangeRates/{id}

Metoda vrátí kurz dle Id

GET v2/ExchangeRates/GetChanges

Metoda vrátí seznam kurzů, které byly změněny.

PaymentOptions

Číselník způsobů úhrady.

GET v2/PaymentOptions

Metoda vrátí seznam způsobů úhrad

GET v2/PaymentOptions/{id}

Metoda vrátí způsob úhrady dle Id.

GET v2/PaymentOptions/GetChanges

Metoda vrátí seznam způsobů úhrad, které byly změněny.

System

Systémové funkce pro práci s číselníky.

GET v2/System/GetCodeBooks

Vrátí všechny číselníky.

GET v2/System/GetCodeBooksChanges

Indikace zda v číselníku nastala změna oproti poslední kontrole.

VatCodes

Metody pro práci s členením DPH.

GET v2/VatCodes

Metoda vrátí seznam členení DPH.

GET v2/VatCodes/{id}

Metoda vrátí členení DPH dle Id.

GET v2/VatCodes/GetChanges

Metoda vrátí seznam členení DPH, které byly změněny.

VatRates

Číselník sazeb DPH.

GET v2/VatRates

Metoda vrátí seznam sazeb DPH.

GET v2/VatRates/{id}

Metoda vrátí sazbu DPH dle Id.

GET v2/VatRates/GetChanges

Metoda vrátí seznam sazeb DPH, které byly změněny.

VatReverseChargeCodes

Číselník kódů plnění.

GET v{version:apiVersion}/VatReverseChargeCodesVersion2

Není dostupná žádná dokumentace.

GET v2/VatReverseChargeCodes

Metoda vrátí seznam kódů plnění.

GET v2/VatReverseChargeCodes/{id}

Vrátí kód plnění s daným id.



Jiné

Attachments

Metody pro práci s přílohami.

Užitečné rady

  • Nekomprimované přílohy jsou zakódovány pomocí Base64.
  • Komprimované přílohy jsou zabalené do zip souboru, který je zakódován pomocí Base64.
  • Limit pro přílohu v API je max. 5MB.
  • Upload přílohy se provádí přes content-type multipart/form-data. Pokud dostáváte výsledek 415 Unsupported Media Type, zkontrolujte si hlavičky requestu.
GET v2/Attachments/{documentId}/{documentType}/{compressed}

Vrátí soubor s přilohou, pokud dokument nějakou má.

PUT v2/Attachments/{documentId}/{documentType}

Nastaví přílohu u dokumentu. Případná existující příloha se přepíše.

DELETE v2/Attachments/{documentId}/{documentType}

Smaže přílohu u dokumentu.

Batch

Dávkové operace.

PUT v2/Batch/Exported

Update příznaku Exported entity. Využívá se při komunikaci s externími účetními programy.

Mails

Metody pro práci s maily.

Užitečné rady

  • Jazyk odeslané faktury lze změnit pomocí vlastnosti Language. Lze specifikovat i vlastní šablonu v cizím jazyce a posílat tak e-maily zahraničním klientům.
  • Šablona může obsahovat stejné zástupné znaky jako lze zadat v aplikaci.

Pozor

  • Ne všechny vlastnosti odeslání se shodují napříč entitama (např. přijatá faktura nelze zasílat odkazem).
POST v2/Mails/CreditNote/Send

Odeslání dobropisu.

POST v2/Mails/IssuedDocumentPayments/SendConfirmation/{id}

Odeslání podekovani za úhradu.

POST v2/Mails/IssuedInvoice/Send

Odeslání faktury vydané.

POST v2/Mails/ProformaInvoice/Send

Odeslání zálohové faktury.

POST v2/Mails/ReceivedInvoice/Send

Odeslání přijaté faktury.

POST v2/Mails/SalesOrder/Send

Odeslání cenové nabídky.

Reports

Metody pro práci s tiskovými sestavami.

Užitečné rady

  • Každá metoda obsahuje nepovinné parametry:
    • Language - jazyk vrácené sestavy (platné hodnoty jsou Cz, Sk, De, En). Parametr má u výběru jazyka nejvyšší prioritu.
    • Compressed - dále komprimuje sestavu do zip souboru. Vrácený zip soubor je zakódován pomocí Base64.
GET v2/Reports/CashVoucher/{id}/Pdf

Vrátí pdf s tiskovou sestavou Pokladní doklad.

GET v2/Reports/CreditNote/{id}/Pdf

Vrátí pdf s tiskovou sestavou Dobropis.

GET v2/Reports/CreditNote/{id}/PdfWithPayments

Vrátí pdf s tiskovou sestavou Dobropis s úhradami.

GET v2/Reports/IssuedInvoice/{id}/CashVoucherPdf

Vrátí pdf s tiskovou sestavou Pokladní doklad pro vydanou fakturu.

GET v2/Reports/IssuedInvoice/{id}/Pdf

Vrátí pdf s tiskovou sestavou Faktura vydaná.

GET v2/Reports/IssuedInvoice/{id}/PdfWithPayments

Vrátí pdf s tiskovou sestavou Faktura vydaná s úhradami.

GET v2/Reports/ProformaInvoice/{id}/CashVoucherPdf

Vrátí pdf s tiskovou sestavou Pokladní doklad pro zálohovou fakturu.

GET v2/Reports/ProformaInvoice/{id}/Pdf

Vrátí pdf s tiskovou sestavou Zálohová faktura.

GET v2/Reports/ReceivedInvoice/{id}/Pdf

Vrátí pdf s tiskovou sestavou Faktura přijatá.

GET v2/Reports/SalesReceipt/{id}/Pdf

Vrátí pdf s tiskovou sestavou Prodejka.

Test

Testovací metody.

GET v{version:apiVersion}/TestVersion2

Neprovede žádnou operaci, jenom vrátí query string v response. Může se použít jako redirect url pro callback pri authorization code flow.

GET v2/Test/DowngradeNeeded

Vždy vrátí status informující o nutnosti v aplikaci manuálně provést přechod na nižší předplatné.

GET v2/Test/GetActualApiLimit

Vrátí aktuální stav API požadavků.

GET v2/Test/PaymentRequired

Vždy vrátí status informující o nutnosti zakoupit předplatné před použitím volané funkce.

GET v2/Test/RateLimitExceeded

Vždy vrátí status pro prekročení limitu.