Skip to main content

# Building URLs

The URL structure for ABRA Flexi consists of several parts

Written by Petr Pech
/c/<identifikátor firmy>/<evidence>/<ID záznamu>.<výstupní formát>
  • <company identifier>: unique company identification

  • <record type>: type of records (address book, order, invoice, …), a complete list is available here, or you can look up Evidence list directly in your web interface.

  • <record ID>: record identifier

  • <output format>: output format (XML, JSON, …). If not specified, the Accept header is taken into account, or the HTML form is returned.


Record listing

If you want a listing of records (see listing), do not specify any record identifier:

/c/<identifikátor firmy>/<evidence>

You can also use filtering:

/c/<identifikátor firmy>/<evidence>/(<filtr>)


Record summaries

If you need to obtain basic summaries for a given record type, use a summary:

/c/<identifikátor firmy>/<evidence>/$sum

You can also combine filtering and summaries:

/c/<identifikátor firmy>/<evidence>/(<filtr>)/$sum


Attribute overview

For each record type, you can get a list of attributes it supports. This overview takes access rights and licensing into account.

/c/<identifikátor firmy>/<evidence>/properties


Print report overview

For a record type, you can display a list of supported reports for printing to PDF:

/c/<identifikátor firmy>/<evidence>/reports


Sub-record overview

Each record type can have sub-records (a relation). An example would be invoice items or contacts within an address book. These records are usually also accessible directly as a record type. The difference is that a sub-record is filtered by the given relation. You can obtain an overview of sub-records like this:

/c/<identifikátor firmy>/<evidence>/relations

Sub-records can then be worked with in the same way as record types:

/c/<identifikátor firmy>/<evidence>/<ID záznamu>/<podevidence>

If, when exporting from ABRA Flexi, you also want to export a record's sub-records, use the ?relations=vazby,prilohy,bankovniSpojeni parameter.


All supported parameters

ABRA Flexi supports many attributes, which are described on this page.

?dry-run=true

?fail-on-warning=true

If a warning occurs, do not save the record (Data validation)

?report-name=faktura

Name of the print output when exporting to PDF

?report-lang=en

The language in which the print output should be generated when exporting to PDF

?report-sign=true

Whether the PDF should be exported with an electronic signature

?detail=summary

Definition of the level of detail

?mode=ruby

?limit=100

?start=10

?order=nazev@A

?sort=nazev&dir=desc

Sorting records for ExtJS

?add-row-count=true

Adds the total number of records to the output (Pagination)

?relations=vazby

Adds data from a relation (see levels of detail). An overview of relations can be obtained for each record type (/relations).

?includes=faktura-vydana/stredisko

Includes the related object's level of detail

?use-ext-id=ESHOP,MUJ

If the object contains an external ID of type ESHOP or MUJ, use it as the linking identifier.

?use-internal-id=true

In addition to the ref and showAs attributes, objects will also include the internalId attribute, which contains the record's internal ID

?stitky-as-ids=true

Tags will be exported and imported as a list of numeric IDs rather than a list of codes

?only-ext-ids=true

The primary key will not be exported; <id> elements will only contain the external ID. Similar to no-ids, but it also affects sub-records.

?no-ext-ids=true

The response will not contain external identifiers (performance optimization)

?no-ids=true

The response will not contain any primary identifiers (performance optimization). Only affects the main record type.

?code-as-id=true

If the object has a unique code, it will be exported (in addition to the <kod> element) also as <id>code:...</id>

?no-http-errors=true

If a 4xx type error occurs while processing the request, the server will still send 200 OK

?nastaveni=true

Export one extra record with the current settings at the beginning as well

?as-gui=true

Enables features that add outputs for GUI processing

?code-in-response=true

In the response, each object will include not only the ID and URL, but also the code.

?add-global-version=true

The response will contain the global version number current at the time the export was performed.

?encoding=iso-8859-2

Specifies the encoding of the input/output file in CSV format.

?delimeter=;

Specifies the delimiter of the input/output file in CSV format.

?format=awis

One of the compiled-in XSL transformations will be applied to the output XML (here awis).

?auth=http

Forces login using HTTP authentication, which can, for example, change the default login method in the WUI.

?auth=html

Forces authentication using an HTML form. This can be useful for suppressing automatic SSO authentication.

?skupina-stitku=SKUPINA1,SKUPINA2

Allows tags to be grouped by group during export (more about tags).

?mode=simple

The response will not contain comments or supplementary attributes (e.g. showAs, ref, etc.).

?access-attribs=true

Fills in the record and collection editability attributes: editable indicates the ability to edit, deletable indicates the ability to delete, and insertable indicates the ability to add to the collection.

?mode=xml_import_export

A special response format that facilitates data transfers. The response uses Hybrid identifiers and, when needed, splits the export of 1 record into 2 elements (e.g. setting a reference to the main attachment of a user report).

?xpath=//winstrom/adresar/email/text()

Allows an XPath expression to be applied to the resulting XML and returns only the selected part of the output.

?no-comments=true

The response will not contain comments for the exported elements.

Did this answer your question?