Přeskočit na hlavní obsah

Analýza nákupu / prodeje

Jak přes REST API zpracovat analýzu nákupu či prodeje?

Autor: Petr Pech

Pro dotazy na analýzu nákupu a prodeje přes REST API slouží dvě adresy, volané metodou GET:

GET https://demo.flexibee.eu/c/demo/analyza-nakupu
GET https://demo.flexibee.eu/c/demo/analyza-prodeje

Segment {firma} v adrese označuje databázový identifikátor firmy. Podporované výstupní formáty se volí příponou .xml nebo .json.


Parametry

Parametry jsou až na drobné odchylky pro obě analýzy shodné. Povinný je pouze analyzovat.

Parametr

Popis

Výchozí hodnota

analyzovatpovinný

Určuje, co je cílem prováděné analýzy. Hodnoty najdete v tabulce níže.

clenit

Stanovuje další členění analyzovaných dat; přijímá stejné hodnoty jako analyzovat s výjimkou id.

Žádné další členění.

datumOd

Spodní hranice data analyzovaných dokladů.

Bez omezení nejstaršího dokladu.

datumDo

Horní hranice data analyzovaných dokladů.

Bez omezení nejnovějšího dokladu.

datumyUcetne

Určuje, zda se zadaná data berou jako datumy zaúčtování. Při false se berou jako data vystavení.

true — hledat podle data zaúčtování.

neucetniDoklady

Ovlivňuje, zda se do analýzy zahrnou i neúčetní doklady.

true — zahrnout i neúčetní doklady.

mesicniSumace

Nastavuje, zda se mají provádět měsíční sumace obratů.

true — provádět měsíční sumace.

stredisko

Omezí analýzu na vybrané středisko — ID nebo kód. Pro více středisek uveďte parametr vícekrát.

Všechna střediska bez omezení.

nekatalogovePolozky

Zahrne do analýzy i nekatalogové položky. Význam má jen při analýze dle firem (adresar) nebo skupin firem (skupFir).

false — pouze katalogové položky.

cenik

Omezí analýzu na vybranou ceníkovou položku. Význam má při analyzovat=cenik.

Všechny ceníkové položky.

firma

Omezí analýzu na vybranou společnost. Význam má při analyzovat=adresar.

Všechny firmy bez omezení.

🚨 datumyUcetne=false nelze kombinovat s měsíčními sumacemi. Chcete-li analyzovat podle data vystavení, musíte současně vypnout i sumace — tedy datumyUcetne=false&mesicniSumace=false. Jinak dotaz skončí chybou incompatible_param_values_exceptionHodnoty parametrů [datumyUcetne, mesicniSumace] nejsou vzájemně slučitelné.

Hodnoty parametrů analyzovat a clenit

Hodnota

Význam

cenik

Pohyb zboží.

skupZboz

Pohyb sumárně dle skupin zboží.

skupCen

Dle ceníkových skupin.

vyrobce

Dle výrobce.

sklad

Obraty skladů.

stredisko

Obraty středisek.

zakazka

Obraty na zakázky.

adresar

Obraty podle firem.

skupFir

Obraty sumárně dle skupin firem.

zodpOsoba

Dle zodpovědné osoby.

mistUrc

Obraty dle míst určení — pouze pro analýzu prodeje.

id

Jednotlivé záznamy bez seskupení. Pouze pro analyzovat, u clenit tuto hodnotu použít nelze.


Ukázky

Pohyb zboží bez dalšího omezení:

GET /c/demo/analyza-prodeje?analyzovat=cenik

Obraty podle firem za rok 2012, podle data vystavení — proto je nutné vypnout i měsíční sumace:

GET /c/demo/analyza-nakupu?analyzovat=adresar&datumOd=2012-01-01&datumDo=2012-12-31&datumyUcetne=false&mesicniSumace=false

Obraty skupin firem za dvě vybraná střediska:

GET /c/demo/analyza-prodeje?analyzovat=skupFir&nekatalogovePolozky=false&stredisko=code:A&stredisko=code:B

Prodej jedné ceníkové položky členěný podle skladů:

GET /c/demo/analyza-prodeje?analyzovat=cenik&clenit=sklad&cenik=code:KUFR


Chybové stavy

Situace

Odpověď

Chybí parametr analyzovat

400, missing_param_exceptionK provedení operace je vyžadován parametr 'analyzovat'

Neznámá hodnota analyzovat nebo clenit, případně mistUrc u analýzy nákupu

400, unsupported_param_value_exception — chybová zpráva vypíše i seznam povolených hodnot

datumyUcetne=false bez mesicniSumace=false

400, incompatible_param_values_exception


Související

Dostali jste odpověď na svou otázku?