The following two URLs are used for purchase and sales analysis queries via the REST API:
Purchase analysis –
/c/{firma}/analyza-nakupuSales analysis –
/c/{firma}/analyza-prodeje
The {firma} parameter represents the database identifier of the company.
Parameters
The parameters are identical for both analyses, with minor differences:
Parameter | * | Description | Options | Default value |
| × | Defines the target of the analysis being performed: |
|
|
|
| Defines an additional breakdown of the analyzed data: |
| No additional breakdown. |
|
| Lower date boundary (posting date) for the analyzed documents. |
| No restriction on the oldest document date. |
|
| Upper date boundary (posting date) for the analyzed documents. |
| No restriction on the most recent document date. |
|
| Specifies whether the provided document dates are treated as posting dates. When set to |
|
|
|
| Controls whether non-accounting documents are included in the analysis. |
|
|
|
| Sets whether monthly turnover summations should be performed. |
|
|
|
| Restricts the analysis to a selected cost center. For multiple cost centers, the query parameter can be specified more than once. | Cost center identifier (integer ID or code). | Analyze all cost centers without restriction. |
Applies only to |
|
|
|
|
|
| Specifies whether non-catalogue items should be included in the analysis. This is relevant only when analyzing by company or by company groups. |
|
|
Applies only to |
|
|
|
|
|
| Restricts the goods analysis to a selected item. | Identifier of the required price list item. | Analyze all price list items without restriction. |
Applies only to |
|
|
|
|
|
| Restricts the company-based analysis to a selected company. | Identifier of the required company. | Analyze all companies without restriction. |
* = required parameter
Examples
GET /c/demo/analyza-prodeje?analyzovat=cenikGET /c/demo/analyza-nakupu?analyzovat=adresar&datumOd=2012-01-01&datumDo=2012-12-31&datumyUcetne=falseGET /c/demo/analyza-prodeje?analyzovat=skupFir&nekatalogovePolozky=false&stredisko=code:A&stredisko=code:BGET /c/demo/analyza-nakupu?analyzovat=adresar&clenit=skupZboz&datumOd=2012-01-01&mesicniSumace=true
