Skip to main content

Building URLs

Structure of the URL 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

  • <register>: type of register (address book, order, invoice, …), full list here, or search for 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; otherwise, the HTML form is returned.

Register Listing

If you want a listing of register items (see listing), do not include any record identifier:

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

It is also possible to use filtering:

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

Record Summation

If you need to obtain basic summations for a given register, use summation:

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

It is also possible to combine filtering and summation:

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

Attribute Overview

For each register, it is possible to retrieve a list of attributes supported by that register. This overview takes into account access rights and licensing.

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

Print Report Overview

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

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

Sub-register Overview

Each register can have a sub-register (relation). Examples include invoice line items or contacts in an address book. These records are usually also accessible directly as a register. The difference is that a sub-register is filtered by the given relation. The sub-register overview can be retrieved as follows:

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

Sub-registers can then be worked with in the same way as a register:

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

If you want to export a record together with its sub-registers when exporting from ABRA Flexi, use the parameter ?relations=vazby,prilohy,bankovniSpojeni.

All Supported Parameters

ABRA Flexi supports many attributes and their descriptions are available 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

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 detail level

?mode=ruby

?limit=100

?start=10

?order=nazev@A

?sort=nazev&dir=desc

Record sorting for ExtJS

?add-row-count=true

Add the total record count to the output (Pagination)

?relations=vazby

Supplement data from a relation (see detail levels). A relation overview can be obtained for each register (/relations).

?includes=faktura-vydana/stredisko

Include the related object's detail level

?use-ext-id=ESHOP,MUJ

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

?use-internal-id=true

In addition to the ref and showAs attributes on objects, also provides the internalId attribute, which contains the internal record ID

?stitky-as-ids=true

Labels will be exported and imported not as a list of codes, but as a list of numeric IDs

?only-ext-ids=true

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

?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). Affects the main register only.

?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 error occurs while processing the request, the server will still return 200 OK

?nastaveni=true

Also export one extra record with the current settings at the beginning

?as-gui=true

Enables features that supplement the output for GUI processing

?code-in-response=true

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

?add-global-version=true

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

?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 built-in XSL transformations will be applied to the output XML (here awis).

?auth=http

Forces login via HTTP authentication, which can be used to change, for example, the default login method in the WUI.

?auth=html

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

?skupina-stitku=SKUPINA1,SKUPINA2

Enables grouping of labels during export by group (more at labels).

?mode=simple

The exported data will not contain additional attributes (e.g. showAs, ref, etc.).

?access-attribs=true

Populates the editability attributes of the record and collections: editable indicates the ability to edit, deletable indicates the ability to delete, and insertable indicates the ability to add to a collection.

?mode=xml_import_export

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

Did this answer your question?