Přeskočit na hlavní obsah

Jak začít s API Flexi 5/6 - Podporované formáty

Přehled formátů, ve kterých REST API ABRA Flexi exportuje a importuje data, včetně ISDOC, a jak se výstupní formát určuje.

Autor: Petr Pech

REST API ABRA Flexi umí data exportovat i importovat v celé řadě formátů. V tomto díle si projdeme, jak se formát určuje a který se hodí pro jaký účel.


Jak se formát určuje

Formát můžete zvolit dvěma způsoby: příponou v adrese, nebo hlavičkou HTTP požadavku. Které z nich má přednost, závisí na směru přenosu.

  • Pro výstup má přípona adresy (.xml, .json, …) přednost před hlavičkou Accept. Pokud příponu neuvedete, řídí se server hlavičkou.

  • Pro vstup se formát určuje primárně podle hlavičky Content-Type.

⚠️ Příponu adresy a formát odesílaných dat vždy uvádějte shodně. Odeslání XML na adresu končící na .json skončí chybou.


Přehled podporovaných formátů

Formát

K čemu slouží

Přípona

Content-Type

Import

XML

Strojově čitelná struktura, nejčastější formát pro integrace

.xml

application/xml

ano

JSON

Strojově čitelná struktura, vhodná pro webové aplikace a skripty

.json, .js

application/json

ano

CSV

Tabulkový výstup pro další zpracování

.csv

text/csv

ano

XLS

Tabulkový výstup pro Excel

.xls

application/ms-excel

ano, od varianty Business

DBF

Databázový výstup ve formátu dBase

.dbf

application/dbf

ano

ISDOC

Český standard elektronické fakturace

.isdoc, .isdocx

application/x-isdoc

ano

EDI

Elektronická výměna dat ve formátu INHOUSE

.edi

application/x-edi-inhouse

ano

PDF

Tisková sestava, stejná jako v aplikaci

.pdf

application/pdf

ne

HTML

Zobrazení dat přímo v prohlížeči

.html

text/html

ne

vCard

Export adresáře do elektronické vizitky

.vcf

text/vcard

ne

iCalendar

Export událostí nebo splatností faktur do kalendáře

.ical

text/calendar

ne

⚠️ Import ve formátu XLS je dostupný od varianty licence Business. U varianty Basic tento formát pro import použít nelze.


Import faktur ve formátu ISDOC

ISDOC je pro zákazníky nejčastěji využívaný formát mimo XML a JSON, protože jde o český standard elektronické fakturace. Při importu je potřeba doplnit dva parametry:

  • typDokl je typ faktury a je povinný

  • typUcOp je předpis zaúčtování a je nepovinný

Oba parametry se zapisují jako identifikátory záznamů, tedy nejčastěji ve tvaru code:.

POST /c/firma/faktura-prijata.isdoc?typDokl=code:FAKTURA&typUcOp=code:NÁKUP SLUŽBY


Kódování a oddělovač u textových formátů

U formátů CSV a DBF můžete ovlivnit kódování a oddělovač sloupců pomocí parametrů v adrese. Hodí se to tehdy, když soubor zpracovává starší systém, který neumí UTF-8.

  • ?encoding=iso-8859-2 nastaví kódování souboru

  • ?delimeter=; nastaví oddělovač sloupců

💡 Kompletní přehled formátů včetně dalších podporovaných variant najdete v článku o podporovaných formátech. Pro tisk do PDF se podívejte na export tiskových sestav.


Další díly série

Dostali jste odpověď na svou otázku?