Download Parameters

Most reports have a downloaded version as Excel file (xlsx). When downloading a report you should always send the following properties in order to have the report in the right format:

• group_by: Defines how the items in the report should be grouped. One of "category" or "account_code".
• lang: The language of the report excel. One of "en" or "de".
• timezone_offset: the local time zone offset for the client. In order to have the dates and times shown in the downloaded report correctly, this should be sent. Otherwise it defaults to 0 and represents all dates and times in UTC.

Stock

Most reports will be about stock movements. Stock is usually represented either by a queue or as a summary, or both. Queues are ordered by price from lowest to highest and show the different stock counts and fractional counts for each price point. Summaries are used present the aggregated values for price, total value and counts.

Stock queue item

• count: The number of full vessels. Cannot be negative and it is always an integer.
• ml: The fractional count for the item. (optional)
• price: The unit price.
• total: The total value at this pricepoint - total count (count and fractional count) times the unit price.

Stock summary

• count: The total count of all stock. When fractional counts add up to full vessels, they will be also included here.
• ml: The total remaining fractional count. (optional)
• price: Average price.
• total: Total value of the stock.