Endpoint variables description:
Item commercial name | Path | Item description | Example | Always populated |
---|---|---|---|---|
Financial report unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-financial-bs-812A8FC8D9AD0228F87C1EB5DBF0FC55 | Yes |
Publishing entity unique ID | data/ data/ company/ uniqueId | Entity, which has published (is the subject) of the financial report cross-country unique ID | cz-company-14615100 | Yes |
Publishing entity national ID | data/ data/ company/ nationalIn | Entity, which has published (is the subject) of the financial report national ID | 14615100 | Yes |
Publishing entity name | data/ data/ company/ name | MAPRO spol. s r.o. | No | |
Financial report accounting standard (code) | data/ data/ standard/ code | Enumeration code for /api/v3/financials/reports/enums/standards | cas2016 | Yes |
Financial report accounting standard (label) | data/ data/ standard/ name | Czech Accounting Standards 2016 | No | |
Financial report type | data/ data/ type | Balance sheet, IncomeStatement | BalanceSheet | Yes |
Financial report title on source | data/ data/ title | účetní závěrka [2020] , výroční zpráva [2020] , zpráva auditora vč. Přílohy | No | |
Financial report URL on source | data/ data/ url | https://or.justice.cz/ias/ui/vypis-sl-detail?dokument=68106411&subjektId=215017&spis=820308 | No | |
Financial report relevant keywords | data/ data/ content/ keywords | currently not used | null | No |
Financial report relevant free text | data/ data/ content/ text | currently not used | null | Inherited |
Financial report fiscal period year | data/ data/ period/ year | 2020 | Yes | |
Financial report fiscal period start date | data/ data/ period/ startedAt | 2020-12-31T00:00:00+00:00 | No | |
Financial report fiscal period end date | data/ data/ period/ finishedAt | 2020-12-31T00:00:00+00:00 | No | |
Financial report published date | data/ data/ publishedAt | 2021-08-30T00:00:00+00:00 | No | |
Financial auditor entity unique ID | data/ data/ audit/ company/ uniqueId | currently not used | cz-company-41186711 | Inherited |
Financial auditor entity national ID | data/ data/ audit/ company/ nationalIn | currently not used | 41186711 | Inherited |
Text of the audit | data/ data/ audit/ text | Priloha je vyhotovena v souladu s obecne zavaznymi predpisy ... | No | |
Financial item name on source | data/ data/ items/ sourceName | AKTIVA CELKEM | No | |
Financial item classification group | data/ data/ items/ rowReference | currently not used | A. | No |
Financial item standard name (code) | data/ data/ items/ financialItem/ code | Enumeration code for /api/v3/financials/reports/enums/items | BFID_16101 | Inherited |
Financial item standard name (label) | data/ data/ items/ financialItem/ name | AKTIVA CELKEM | No | |
Financial item netto value amount | data/ data/ items/ values/ netto/ amount | Netto value of assets and liabilities | 476213000 | No |
Financial item netto value currency | data/ data/ items/ values/ netto/ currency | CZK | No | |
Financial item confidence | data/ data/ items/ values/ confidence | How sure are we that the netto value is correct? (0-1) | 1 | Inherited |
Financial item brutto value amount | data/ data/ items/ values/ brutto/ amount | Brutto value of assets (only for balance sheet) | 532141000 | No |
Financial item brutto value currency | data/ data/ items/ values/ brutto/ currency | CZK | No | |
Financial item correction value amount | data/ data/ items/ values/ correction/ amount | Value adjustments for assets (difference between brutto and netto values) | 55928000 | No |
Financial item correction value currency | data/ data/ items/ values/ correction/ currency | CZK | No |
Types | Array of strings or null (BizMachine.Ultimate.DataStructures.v1.Models.FinancialReports.Enums.FinancialReportType) Collection of types of the financial report. |
Company.NationalIn | string or null Financial reports of specific company with national identifier. Example: Company.NationalIn=05450641 |
Company.Tag.Uid | string or null <uuid> Unique identifier. |
Period.Years | Array of integers or null <int32> Collection of years of the period. |
Standard.Codes | Array of strings or null A collection of financial codes to search by. |
Updated.From | string or null <date-time> Search data by System.DateTimeOffset starting from this value. |
Updated.To | string or null <date-time> Search data by System.DateTimeOffset up to this value. |
LatestOnly | boolean Filter data and return only latest reports of a company and type. |
Offset | integer <int32> Allows to specify offset from where to start streaming results. Default value: 0 |
Limit | integer <int32> Default: 200 Allows to specify limit of returned data. |
SortBy | string or null Sorting order and field to sort by in format sorting-order Valid orders: desc, asc. Example: desc(createdAt) |
Success
{- "paging": {
- "totalItems": 0,
- "totalPages": 0,
- "pageSize": 0,
- "currentPage": 0,
- "maxPageSize": 0
}, - "data": [
- {
- "data": {
- "uniqueId": "cz-financial-22774637-2015-44585106",
- "company": {
- "uniqueId": "cz-company-05450641",
- "nationalIn": "05450641",
- "name": "string"
}, - "standard": {
- "code": "cas2016",
- "name": "string"
}, - "type": "BalanceSheet",
- "title": "string",
- "url": "string",
- "content": {
- "text": "string",
- "keywords": [
- "string"
]
}, - "period": {
- "year": 0,
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z"
}, - "publishedAt": "2019-08-24T14:15:22Z",
- "audit": {
- "company": {
- "uniqueId": "cz-company-05450641",
- "nationalIn": "05450641",
- "name": "string"
}, - "text": "string"
}, - "items": [
- {
- "sourceName": "string",
- "rowReference": "string",
- "financialItem": {
- "code": "bfid_001",
- "name": "string"
}, - "values": {
- "netto": {
- "amount": null,
- "currency": null
}, - "confidence": 0,
- "brutto": {
- "amount": null,
- "currency": null
}, - "correction": {
- "amount": null,
- "currency": null
}
}
}
]
}, - "meta": {
- "dataSources": [
- {
- "code": "string",
- "name": "string",
- "externalId": "string",
- "url": "string"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "prospector": {
- "link": "string"
}, - "hash": "string"
}
}
]
}