Endpoint variables description:
| Item commercial name | Path | Item description | Example | Always populated |
|---|---|---|---|---|
| Subsidy unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-subsidy-eusubn7459073792591038698 | Yes |
| Subsidy title | data/ data/ title | Caption of the subsidy | Snížení emisí TZL odprášení odsunových cest jižní části Aglomerace AMO | No |
| Subsidy summary | data/ data/ summary | Short description of the subsidy | Cílem projektu je snížení fugitivních emisí tuhých znečišťujících látek (TZL)… | No |
| Subsidy detailed text | data/ data/ text | Full description of the subsidy | Cílem projektu je snížení fugitivních emisí tuhých znečišťujících látek (TZL)… | No |
| Subsidy recipient entity nationalIn | data/ data/ recipient/ nationalIn | 45193258 | Inherited | |
| Subsidy recipient entity name | data/ data/ recipient/ name | Liberty Ostrava a.s. | No | |
| Subsidy provider entity nationalIn | data/ data/ providers/ nationalIn | 00551023 | Inherited | |
| Subsidy provider entity name | data/ data/ providers/ name | Ministerstvo práce a sociálních věcí | No | |
| Subsidy start date | data/ data/ startedAt | 2021-03-05T00:00:00+00:00 | No | |
| Subsidy end date | data/ data/ finishedAt | 2021-03-05T00:00:00+00:00 | No | |
| Subsidy published date | data/ data/ publishedAt | 2021-03-05T00:00:00+00:00 | No | |
| Subsidy program url | data/ data/ programme/ url | null | No | |
| Subsidy program name | data/ data/ programme/ name | OP ZP | No | |
| Subsidy priority url | data/ data/ priority/ url | null | No | |
| Subsidy priority name | data/ data/ priority/ name | Name of the specific priority (under a program) | 05.2 Zlepšování kvality ovzduší v lidských sídlech | No |
| URL of the subsidy | data/ data/ url | https://www.web.cz/image.jpg | No | |
| Subsidy signing person | data/ data/ signature/ person | currently not used | null | No |
| Subsidy signature date | data/ data/ signature/ createdAt | 2018-09-12T02:00:00+00:00 | No | |
| Subsidy budget chapter | data/ data/ budgetChapter | currently not used | null | No |
| Subsidy allocation start date | data/ data/ allocations/ startedAt | 2009-01-01T00:00:00+00:00 | No | |
| Subsidy allocation end date | data/ data/ allocations/ finishedAt | null | No | |
| Subsidy requested amount | data/ data/ allocations/ values/ required/ amount | Subsidy amount requested by the recipient | 18200 | No |
| Subsidy requested amount currency | data/ data/ allocations/ values/ required/ currency | CZK | No | |
| Subsidy allocated amount | data/ data/ allocations/ values/ decided/ amount | Subsidy amount allocated to the recipient | 18200 | No |
| Subsidy allocated amount currency | data/ data/ allocations/ values/ decided/ currency | CZK | No | |
| Subsidy consumed amount | data/ data/ allocations/ values/ consumed/ amount | 18200 | No | |
| Subsidy consumed amount currency | data/ data/ allocations/ values/ consumed/ currency | CZK | No | |
| Subsidy released amount | data/ data/ allocations/ values/ released/ amount | Subsidy amount made available to the recipient | 18200 | No |
| Subsidy consumed amount currency | data/ data/ allocations/ values/ released/ currency | CZK | No | |
| Subsidy drawn amount | data/ data/ allocations/ values/ drawn/ amount | Subsidy amount drawn (cashed in) by the recipient | 18200 | No |
| Subsidy drawn amount currency | data/ data/ allocations/ values/ drawn/ currency | CZK | No | |
| Subsidy refund amount | data/ data/ allocations/ values/ refunded/ amount | Subsidy amount, which had to be returned by the recepient (due to inability or wrong use of funds) | null | No |
| Subsidy refund amount currency | data/ data/ allocations/ values/ refunded/ currency | null | No | |
| Subsidy EU co-financing share | data/ data/ allocations/ values/ euCofinancingRate | Share of subsidy provided by EU funds (0-1) | 0.3 | No |
| Subsidy keywords | data/ data/ keywords | currenty not used | null | No |
| Subsidy topics (code) | data/ data/ topics/ code | currenty not used | null | No |
| Subsidy topics (name) | data/ data/ topics/ name | currenty not used | null | No |
| Subsidy topics confidence | data/ data/ topics/ cofidence | currenty not used | null | No |
| 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. |
| Published.From | string or null <date-time> Search data by System.DateTimeOffset starting from this value. |
| Published.To | string or null <date-time> Search data by System.DateTimeOffset up to this value. |
| Started.From | string or null <date-time> Search data by System.DateTimeOffset starting from this value. |
| Started.To | string or null <date-time> Search data by System.DateTimeOffset up to this value. |
| Source.Code | Array of strings or null |
| Source.ExternalId | Array of strings or null |
| Company.NationalIn | string or null |
| Company.Role | string (BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.Params.SubsidyCompanyRole) Enum: "Any" "Recipient" "Provider" |
| 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": "string",
- "title": "string",
- "summary": "string",
- "text": "string",
- "recipient": {
- "nationalIn": "string",
- "name": "string"
}, - "providers": [
- {
- "nationalIn": "string",
- "name": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "publishedAt": "2019-08-24T14:15:22Z",
- "programme": {
- "url": "string",
- "name": "string"
}, - "priority": {
- "url": "string",
- "name": "string"
}, - "url": "string",
- "signature": {
- "person": {
- "name": "string"
}, - "createdAt": "2019-08-24T14:15:22Z"
}, - "budgetChapter": "string",
- "allocations": [
- {
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "values": {
- "required": {
- "amount": null,
- "currency": null
}, - "decided": {
- "amount": null,
- "currency": null
}, - "consumed": {
- "amount": null,
- "currency": null
}, - "released": {
- "amount": null,
- "currency": null
}, - "drawn": {
- "amount": null,
- "currency": null
}, - "refunded": {
- "amount": null,
- "currency": null
}, - "euCofinancingRate": 0
}
}
], - "keywords": [
- "string"
], - "topics": [
- {
- "confidence": 0,
- "name": "string",
- "code": "string"
}
]
}, - "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"
}
}
]
}