Skip to main content

URL and Output Formats

How to Correctly Build a URL

Written by Lenka Haringerová

In the article PHP data retrieval from Flexi we showed how to retrieve data from ABRA Flexi. The key to successfully retrieving data is a correctly constructed URL.

The URL for retrieving data from ABRA Flexi consists of the server address, port, and company identifier.

https://server:port/c/identifikátor_firmy např. https://demo.flexibee.eu:5434/c/demo

After the company identifier, you append the record type from which you want to retrieve data, the format in which ABRA Flexi should provide it, and any additional parameters.

server:port/c/identifikátor_firmy/evidence.xml?detail=full např. demo.flexibee.eu:5434/c/demo/adresar.xml?detail=full

The list of available record types is available at:

server:port/c/identifikátor_firmy/evidence-list např. demo.flexibee.eu:5434/c/demo/evidence-list

Output Formats

Flexi supports several output formats.

1. XML

  • The most common format when you need to view structured data.

  • Demanding in terms of data transfer.

  • To retrieve data in this format, append .xml after the record type.

demo.flexibee.eu/c/demo/adresar.xml

2. JSON

  • The most widely used format for all ABRA Flexi integrations.

  • Not human-readable, but less data-intensive than XML.

  • Simply append .json after the record type.

demo.flexibee.eu/c/demo/adresar.json

3. CSV

  • If you need to retrieve data for processing in older applications, you can obtain data from ABRA Flexi in CSV format.

  • Appending .csv after the record type will store the data in this format.

  • However, please note that CSV, unlike XML and JSON, cannot output nested collections (for example, invoice line items together with the invoice).

  • For this format, you can also use the encoding parameter to enforce the encoding of the output file.

demo.flexibee.eu/c/demo/adresar.csv demo.flexibee.eu/c/demo/adresar.csv?encoding=iso-8859-2

4. XLS and XLSX

  • Excel is also a supported output format. However, it has the same limitations as CSV.

demo.flexibee.eu/c/demo/adresar.xls demo.flexibee.eu/c/demo/adresar.xslx

5. PDF

  • You can also retrieve print reports in PDF format from Flexi via the API.

  • For this output format, parameters can be used to specify which print report ABRA Flexi should return, the language it should be returned in, and whether it should be signed.

  • The report-name parameter is used to select the print report, and the report-lang parameter is used to select the language.

  • PDF signing is enforced using the report-sign parameter.

demo.flexibee.eu/c/demo/adresar.pdf demo.flexibee.eu/c/demo/adresar.pdf?report-name=obalkaDL demo.flexibee.eu/c/demo/adresar.pdf?report-lang=en

6. ISDOC

  • The ISDOC format is only applicable to issued invoices.

  • Appending .isdoc after the record type will retrieve an ISDOC file with the invoice from ABRA Flexi.

http://demo.flexibee.eu/c/demo/faktura-vydana.isdoc

7. DBF, vCard, iCalendar, and EDI

  • The remaining formats are less commonly used and only supported by certain record types.

  • vCard and iCalendar are not meaningful for some record types, as those records do not contain data that would be exported.

  • The DBF format has today been replaced by other formats.

  • Nevertheless, it is still possible to retrieve data in these formats from ABRA Flexi via the REST API.

  • The only format with a meaningful use case — for example, for retail chains — is EDI. However, this format is only supported by certain record types (issued invoices, delivery notes, and issued orders). Importing data in EDI format is only possible for received orders.

http://demo.flexibee.eu/c/demo/adresar.dbf demo.flexibee.eu/c/demo/adresar.vcf demo.flexibee.eu/c/demo/udalost.ical demo.flexibee.eu/c/demo/faktura-vydana/836.edi
Did this answer your question?