{ "openapi": "3.0.1", "info": { "title": "BizMachine API", "description": "# BizMachine API\n\n**Welcome to BizMachine API!**\n\nExtend your CRM with corporate data from over a hundred data sources. Leverage carefully collected, validated and updated BizMachine data. We are building the richest database of companies from the Czech Republic, Slovakia and Germany.\n\n- Current information about companies in CRM\n- Real-time market segmentation\n- Flexible connection to internal systems\n\n## Format\n\nThis API is a REST-compliant JSON API. Both request and response bodies should be formatted as valid JSON document.\n\n## Datasets\n\nIf API supports multiple datasets, a `dataset` parameter as part of the URL has to be provided.\n\nFormat of the parameter is in `ISO 3166-1 alpha-2` in lower case.\n\nExamples:\n\n- `cz` - Czech dataset\n- `sk` - Slovak dataset\n- `de` - German dataset\n\n## API Keys\n\n### Generating API Key\n\nIn order to generate an API key, please follow instructions below:\n\n1) Scroll down to list of endpoints and look for \"ApiKeys\"\n2) Select the POST endpoint `/v1/ApiKeys/otp/request`\n3) Click on `Try it out` on right-hand side and fill in your email `\"email\":\"yourEmail@address.com\"`\n4) Click on `Execute` below\n5) You receive One Time Password (OTP) in to the email address you have entered\n6) Copy the password\n7) Select second POST endpoint `/v1/ApiKeys/otp`\n8) Click on `Try it out` on right-hand side\n9) Paste your OTP from the email into the body `\"token\": \"your password\"`,\n10) If needed, change date in `ExpiresAt` as required (date must be in the future)\n11) Select `Execute`\n10) Generated ApiKey for you can be found in the response body\n11) Copy the ApiKey and paste it into the Value box under the \"Authorize\" button (can be found on top of the list on the right-hand side)\n12) Click on `Authorize`\n\n**To generate an API key, the client has to have an existing, active account.**\n\n![How to generate OTP process](https://cdn.bizmachine.com/prospector/resources/api-key-otp-request.png)\n\n### Using API Key\n\nTo authenticate your calls with using API Key add following header with a valid API Key value.\n\n+ Headers\n - `X-Api-Key: {YOUR_API_KEY}`\n\nMake sure you treat API key as any other secret (i.e. passwords).\n\nExample:\n\n curl --location --request GET 'https://api.beta.bizmachine.com/api/v3/companies/basic-infos' \\\n --header \"X-Api-Key: 4984052df611ff96e5c76d8feb185cd09bec444f811be6e41863cca14a61dbdc\"\n\n## Language\n\nThe API allows you to retrieve localized information for some of the text values.\nYou can specify your language preference by using the standard Accept-Language header:\n\n+ Headers\n - `Accept-Language: {LANGUAGE_ID}`\n\nCurrently available languages are:\n\n- EN (English)\n- CS (Czech)\n- SK (Slovak)\n\nEN (English) is the default language used if the header is not provided.\n\n## User identification\n\nIf applicable (e.g., call initiated by CRM user), the identity of a user is tracked for reporting purposes.\n\nSuch API calls have to include the following header:\n\n+ Headers\n - `X-User: {USER_EMAIL_OR_ID}`\n\n## Rate limiting\n\nTo ensure a good service level for all our clients, we are applying rate limits on number of requests per minute and per day. These limits are set and tracked per API key.\n\nThe information about the current and remaining API calls per time period are included in each response.\n\n## Maintenance\n\nDue to the data refresh, there may be periods of time (typically during the late night) when the service is temporarily unavailable. In such situations, the response will include:\n- Status code 503 (service unavailable)\n- Header X-Retry-After with an indication of time the service is expected to be restored\n\n## Metadata\n\nResponse from every dataset also contains a section called 'meta' that describes the dataset itself. \nHere is a description of fields that can be found in this section: \n\n| Item | Path | Item description | Example | Always populated? |\n|------------------|-------------------------|----------------------------------------------------------------------|-------------------------------------------------------------------|-------------------|\n| Data source code | meta/ dataSources/ code | Code that identifies a specific data source | cz-ruian | No |\n| Created at date | meta/ createdAt | The oldest date when the item was registered in the dataset instance | 2021-03-22T14:16:05.724Z | No |\n| Hash | data/ hash | A control hash ensuring the data integrity | 378dbad7b9f4145cad5be6dacea466e58ea86a823e40f03d13d93c8c29106f4b | No |\n\n# Guides\n\n## v1 Migration\n\nDeprecated v1 endpoints end its support on the 31st of May 2024. All users using these endpoints\n(listed below) needs to migrate to new alternatives.\n\nThis guide describes which endpoints are affected, what are the replacements for deprecated endpoints\nand how they differ.\n\n### List of deprecated v1 endpoints\n\n* GET v1/company/{nationalIn}\n* GET v1/embed/company/{nationalIn}\n* GET v1/company/customdata\n* GET v1/search/company/{query}\n* GET v1/vehicles\n\nIf you are using one of the above mentioned endpoints, please follow the migration guide or contact support at `support@bizmachine.com`.\n\n### Endpoints alternatives\n\n| Deprecated | New alternative |\n|-------------------------------------|-----------------------------------------------------------|\n| `GET v1/company/{nationalIn}` | `GET {dataset}/v4/companies/{nationalIn}/aggregated-data` |\n| `GET v1/embed/company/{nationalIn}` | `POST {dataset}/v4/companies/{nationalIn}/iframe` |\n| `GET v1/company/customdata` | `GET {dataset}/v3/custom-data` |\n| `GET v1/search/company/{query}` | `GET {dataset}/v4/companies/suggest` |\n| `GET v1/vehicles` | `GET {dataset}/v4/vehicles` |\n\nNote, that all new endpoints have `{dataset}` option. You can specify a country, you are interested in.\nValid values are: `cz`, `sk`, `hu`. If `{dataset}` is not provided, it defaults to `cz`.\n\nNew endpoints also no longer provides detailed API usage in `Meta` part of the payload. `Meta` is now used to provide metadata information about current payload related to the called endpoint.\n\n#### Migrating v1/company/{nationalIn}\n\nA new alternative to `v1/company` is `aggregated-data` endpoint.\nThe Aggregated Data endpoint is your go-to solution for accessing essential company-related data in a streamlined and easy-to-implement manner. This endpoint serves as a centralized hub for extracting essential company-related data, encompassing the \"Basic-Infos\" dataset along with selected values from diverse datasets such as Contacts, Metrics, Risks, Indicators, NACE codes, Eshops, and Locations.\n\nThe deprecated `v1/company` endpoint had different outputs based on `template` provided.\nBelow are migration guides (`XLSX` files) for specific templates, containing differences between the endpoints\nmapping, notes, data availability, and what values should be used instead:\n\n* [Automotive Template](https://exchangebizmachine.blob.core.windows.net/cdn/docs/BizMachine_Migration_Automotive_AggregatedData.xlsx)\n* [Basic Template](https://exchangebizmachine.blob.core.windows.net/cdn/docs/BizMachine_Migration_Basic_AggregatedData.xlsx)\n* [Premium Template](https://exchangebizmachine.blob.core.windows.net/cdn/docs/BizMachine_Migration_Premium_AggregatedData.xlsx)\n\nExample:\n\nCall GET `https://api.bizmachine.com/v1/company/05450641` will be migrated as\nGET `https://api.bizmachine.com/cz/v4/companies/05450641/aggregated-data`\n\n#### Migrating v1/embed/company/{nationalIn}\n\nA new alternative for this deprecated endpoint is `POST {dataset}/v4/companies/{nationalIn}/iframe`.\n\nThe endpoint will provide a direct shareable link with IFrame options.\n\n> Endpoint changed HTTP method from `GET` to `POST`.\n\n#### Migrating v1/company/customdata\n\nTo get Custom Data, use endpoint `GET {dataset}/v3/custom-data`. This endpoint changes both input parameters and returned payload as well.\n\nTo specify a company, you no longer provide it as `RegistrationNumbers` but as `NationalIn`. Filtering options were extended, so please pay attention to those changes.\n\n#### Migrating v1/search/company/{query}\n\nNew alternative changed naming and form of the endpoint. It's not called Search anymore, but Suggest. \n\nInstead of searching using route `v1/search/company/Bizmachine`, it's now using query parameter to pass down query `GET {dataset}/v4/companies/suggest?query=Bizmachine`. \nThe biggest change for this endpoint is its payload. We no longer provide locations (Premises) and entire payload is targeted to company information.\n\n#### Migrating v1/vehicles\n\nAlternative to `v1/vehicles` is `{dataset}/v4/vehicles`.\nThere are small changes and differences between the endpoints. Most notably it's not using NationalIn (ičo),\nbut rather Company Unique Id, which consists of dataset and NationalIn value.\n\n> **NationalIn:** 05450641 -> **UniqueId:** cz-company-05450641\n\nExample:\nCall GET `https://api.bizmachine.com/v1/vehicles?Company.Bid=05450641`\nwill be migrated as GET `https://api.bizmachine.com/cz/v4/vehicles?Company.UniqueId=cz-company-05450641`\n\n### Troubleshooting\n\n#### I'm getting 400 error\n\nError 400 means bad input to API. Double check the documentation and your input parameters, if they have correct name and format. Most of the endpoints changed format, path, and naming.\n\n#### I'm getting 403 error\n\nIf you are getting 403 HTTP Code response from new endpoints, please contact support at `support@bizmachine.com`.\n\n## Tags\n\nThis workflow will show you how to add companies to a tag and then use this tag as a parameter for one of our data endpoints.\n\nFiltering BizMachine API with a tag is a common use case allowing you to get data only for the companies you specify. Tag is a list of companies to which you can add or take away companies as needed.\n\n> The tags can be managed in Prospector as well. You will find them there under the name \"Company Lists.\"\n\n> Please note that you can ****create a new tag**** solely in Prospector; this feature is not available through BizMachine API yet.\n\n\nIn the short workflow below, we will show how you can add companies to a tag and then filter one of our data endpoints by the tag.\n\n### Step 1: Add company to a tag\n\nTo add a company to the tag, you will need to know the following:\n\n- Dataset (cz, sk...)\n- National In (ICO...) of the company you want to add\n- Tag UID\n\nCURL example:\n\n```bash\ncurl --location --request POST 'https://api.bizmachine.com/prospector/cz/v2/companies/05450641/tags/a518e43c-0298-4cbc-92da-529b29ce3b42' \\\n--header \"X-Api-Key: your-api-key\"\n```\n\n> If you created a new tag in Prospector and are trying to figure out the ****Tag UID****, do the following:\n> - Open the tag you created in Prospector\n > - Look at the URL it should be in this format:\n > - https://prospector.bizmachine.com/cz/my-portfolio?tags=a518e43c-0298-4cbc-92da-529b29ce3b42\n> - Copy the code after \"tags=\" that is your Tag UID.\n\n### Step 2: Using tag as a parameter on company dataset\n\nYou can use the tag as a parameter to get data only for selected companies. For this, you will need to know following:\n\n- Dataset (cz, sk...)\n- Tag UID\n\nCURL example:\n\n```bash\ncurl --location --request GET 'https://api.bizmachine.com/cz/v3/companies/basic-infos?Tag.Uid=a518e43c-0298-4cbc-92da-529b29ce3b42' \\\n--header \"X-Api-Key: your-api-key\"\n```\n\n### Constructing PATCH JSON\n\nOur `PATCH {dataset}/v2/tags/{uid}/companies` endpoint requires specific json structure to be send in the body.\nThis section contains some examples on how to correctly construct it. \n\nAllowed operations: `add, remove`\n
\nAllowed path: `/companyTags`\n\n#### Adding new companies to tag\n```json\n[\n {\n \"path\": \"/companyTags\",\n \"op\": \"add\",\n \"value\": {\"Bid\": \"05450641\"}\n },\n {\n \"path\": \"/companyTags\",\n \"op\": \"add\",\n \"value\": {\"Bid\": \"09540385\"}\n }\n]\n```\n\n#### Removing companies from tag\n```json\n[\n {\n \"path\": \"/companyTags\",\n \"op\": \"remove\",\n \"value\": {\"Bid\": \"05450641\"}\n }\n]\n```\n\n### Common issues\n\n#### I created a new tag, and add companies however the company dataset is not returning any data\n\nPlease remember that a new tag might not be available on the API for 15 minutes after its creation.\n\nIf the dataset is empty even after 15 minutes from creating the tag, don't hesitate to get in touch with support@bizmachine.com\n\n#### API is returning 401 unauthorized\n\nYour API key is not authorized to get data from the specific dataset.\n\nPlease make sure that:\n\n- You specified header `X-Api-Key` with the correct API key as its value\n- Your API key is not expired. In that case, please generate a new API key\n- You generated the API key with a service account which have all the necessary rights for this dataset\n\nIf the problem persists, please get in touch with support@bizmachine.com\n", "version": "external" }, "servers": [ { "url": "https://api.bizmachine.com", "description": "Production Server" }, { "url": "https://api.beta.bizmachine.com", "description": "Beta Server" } ], "paths": { "/{dataset}/v4/companies/{nationalIn}/aggregated-data": { "get": { "tags": [ "Aggregated Data" ], "summary": "Gets aggregated data for company identified by nationalIn.", "description": "# **Dataset Description:**\n\nThe Aggregated Data endpoint is your go-to solution for accessing essential company-related data in a streamlined and easy-to-implement manner. This endpoint serves as a centralized hub for extracting essential company-related data, encompassing the \"Basic-Infos\" dataset along with selected values from diverse datasets such as Contacts, Metrics, Risks, Indicators, NACE codes, Eshops, and Locations.\n\nPlease note that metrics values do not include historical data. For historical data, clients are encouraged to utilize the dedicated Metrics endpoint.\n\n## **Availability:**\n- Supported in Czech Republic (cz), Slovakia (sk), and Hungary (hu).\n\n## **Dataset Updates:**\nThe datasets are updated on a weekly to monthly basis, ensuring access to the most current and reliable data for your business needs.\n\n## **Selected Use Cases:**\n- **Simplified Integration:** This endpoint is designed for easy integration into your systems and applications by combining multiple datasets into one package.\n- **Business Research:** Ideal for market research, due diligence, competitor and risk analysis.\n- **Financial Insights:** Gain instant insights into financial performance, revenue, and growth prospects.\n- **Business Development:** Facilitate lead generation and partner identification.\n- **Marketing and Sales:** Customize marketing campaigns and outreach efforts.\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "National identifier of the company.", "required": true, "schema": { "type": "string", "description": "National identifier of the company." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.AggregatedDataEnvelopeDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v1/ApiKeys/otp/request": { "post": { "tags": [ "API Keys" ], "summary": "Request OTP", "description": "Requests one-time password used to generate API Key.\r\nOTP has limited expiration frame and is created for existing email address.", "parameters": [ { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Existing Prospector user's email address", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.EmailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.EmailDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.EmailDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.EmailDto" } } } }, "responses": { "200": { "description": "Success" } } } }, "/{dataset}/v1/ApiKeys/otp": { "post": { "tags": [ "API Keys" ], "summary": "Generate API Key", "description": "Verifies one-time password. If OTP is valid, returns new API key.", "parameters": [ { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OTP token and expiryDate of newly generated API key", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.OtpDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.OtpDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.OtpDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.OtpDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.ApiKeyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto" } } } } } } }, "/{dataset}/v4/companies/aggregated-data": { "get": { "tags": [ "Aggregated Data" ], "summary": "Gets aggregated data for companies in a tag.", "description": "# **Dataset Description:**\n\nReturns aggregated data for all companies in one of your tags in a single paged call. Each item has the same content as the single-company Aggregated Data endpoint - see its description for the included datasets, availability, update frequency and use cases.\n\n## **Request:**\n\n- **Tag** (`Tag.Uid`, required): unique identifier of the tag whose companies should be returned. The tag has to be owned by or shared with the calling user.\n- **Paging** (`Offset`, `Limit`): `Offset` sets where to start, `Limit` sets the page size (default 200, max 250). The `paging` object in the response contains the total number of items and pages.\n\n## **Response:**\n\n- `data` is a list of companies. Each item carries its own `_meta` object with the content hash, the date of the last update and a link to the company in Prospector.\n- `204 No Content` is returned when no data could be provided for the request.\n", "parameters": [ { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BulkAggregatedDataDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/contacts/business-cards": { "get": { "tags": [ "Company Collection Request" ], "summary": "Business cards (restricted)", "description": "Gets available business cards information.", "parameters": [ { "name": "Tag.Uid", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true } }, { "name": "Types", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Companies.DataStructures.Models.Contacts.v4.ContactType" }, "nullable": true } }, { "name": "Sources", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "LastCheck.From", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "LastCheck.To", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPrivate", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "IsPrimary", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/contacts/business-cards": { "get": { "tags": [ "Company Single Request" ], "summary": "Business cards (restricted)", "description": "Gets available business cards information for given company.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get business cards for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get business cards for." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Query", "in": "query", "description": "Search query string.", "schema": { "type": "string", "description": "Search query string.", "nullable": true } }, { "name": "DepartmentCodes", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "Types", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Companies.DataStructures.Models.Contacts.v4.ContactType" }, "nullable": true } }, { "name": "Sources", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "LastCheck.From", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "LastCheck.To", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPrivate", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "IsPrimary", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/contacts": { "get": { "tags": [ "Company Collection Request" ], "summary": "Contacts", "description": "Dataset description:\n\nContact details for the company split into phones, emails, urls and social media.\nDataset combines 2 levels of contact details - personal and generic.\nWhile generic contacts are isolated, typically like `info@company.com`, a personal contact (phones, emails or professional social media profiles) is linked to a person profile with name and role in the company.\n\n\nAll contact details are regularly verified and we guarantee availability on the source url within the previous 30 days, thereby complying with most GDPR policies. Personal contacts are verified on a weekly basis.\n\nAll our contact data originate from publicly available sources. We do not use any purchased contact lists from 3rd parties.\n\nA contact like `john.smith@company.com` may be considered generic when detailed information about the person (name,role) are not explicitly published on the website or our system is unable to link these into a single profile.\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nUpdates of our contacts differ across sources. While in contacts sourced from company websites are parsed and verified on a continuous basis, company catalogues and contacts coming from job postings follow weekly updates.\n\nSelected use cases:\n\n- avoid GDPR issues by having a publicly available source of your contact, ready to show when challenged\n- filter specific roles in your target company using our Role enumeration and approach only contacts you specifically need\n- increase conversion using our confidence indication and call the numbers we cross-validated across multiple data sources\n- monitor departures from your target company by taking advantage of our Linkedin update tracking / verification service\n\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-----------------------------------------------|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| Contact person ID | data/ contacts/ people/ id | Internal file ID to connect a person with phones, emails, etc. | 1 | Inherited |\n| Contact person unique ID | data/ contacts/ people/ uniqueId | | cz-person-ABC12345677 | Inherited |\n| Contact full name | data/ contacts/ people/ name/ text | Full name of the person (first & last) as a text string | Jiří Částka | Inherited |\n| Contact first name | data/ contacts/ people/ name/ firstName | First name of the contact person | Jiří | No |\n| Contact last name | data/ contacts/ people/ name/ lastName | Last name of the contact person | Částka | No |\n| Contact role (label) | data/ contacts/ people/ roles/ text | Role of the contact person in a given company | Elektromechanický technik | Inherited |\n| Contact role (code) | data/ contacts/ people/ roles/ code | | a8e26a257d | Inherited |\n| Contact role start date | data/ contacts/ people/ roles/ validFrom | Date, when the contact person has been first identified in the role | 2021-03-15T23:36:03+00:00 | Inherited |\n| Contact role end date | data/ contacts/ people/ roles/ validTo | | 2021-03-15T23:36:03+00:00 | No |\n| Contact department text | data/ contacts/ departments/ roles/ text | | ABC123 | Inherited |\n| Contact department code | data/ contacts/ departments/ roles/ code | | Handyman | Inherited |\n| Contact department start date | data/ contacts/ departments/ roles/ validFrom | | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Contact department end date | data/ contacts/ departments/ roles/ validTo | | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number unique ID | data/ contacts/ phoneNumbers/ guid | Technical phone number ID | 84811132-1830-4278-1934-0a78f7636a02 | Inherited |\n| Phone number first entry | data/ contacts/ phoneNumbers/ createdAt | Date on which the phone number has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Phone number last update | data/ contacts/ phoneNumbers/ updatedAt | Last known update of the phone number | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number primary | data/ contacts/ phoneNumbers/ isPrimary | 3 most credible phone numbers (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Phone number confidence | data/ contacts/ phoneNumbers/ confidence | Contact-to-company link confidence | 0.98 | Inherited |\n| Phone number private | data/ contacts/ phoneNumbers/ isPrivate | When TRUE, the phone number has been identified as potentially linked to a specific individual (as opposed to company generic contact) | True | No |\n| Phone number source URL | data/ contacts/ phoneNumbers/ sources/ url | Where has the phone number been found | https://www.zivefirmy.cz/mapro_f1072996?cz=548 | Inherited |\n| Phone number last validity check | data/ contacts/ phoneNumbers/ sources/ lastCheckedAt | Date of last check, when the phone number has been found on the source | 2022-02-16T12:23:52+00:00 | Inherited |\n| Phone number source (code) | data/ contacts/ phoneNumbers/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-zivefirmycz | Inherited |\n| Phone number source (label) | data/ contacts/ phoneNumbers/ sources/ name | Name of the source of information | Zivefirmy.cz | No |\n| Phone number linked contact person ID | data/ contacts/ phoneNumbers/ person/ id | Internal person reference linking the phone number to a person | 42619 | Inherited |\n| Phone number | data/ contacts/ phoneNumbers/ value | The actual phone number | 00420585157811 | Inherited |\n| Email unique ID | data/ contacts/ emails/ guid | TBD | f52f6f95-a039-e93d-08cc-b05a62569c5c | Inherited |\n| Email first entry | data/ contacts/ emails/ createdAt | Date on which the email has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Email last update | data/ contacts/ emails/ updatedAt | Last known update of the email address | 2022-03-04T08:58:08.17+00:00 | No |\n| Email primary | data/ contacts/ emails/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Email confidence | data/ contacts/ emails/ confidence | | 0.98 | Inherited |\n| Email private | data/ contacts/ emails/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Email source URL | data/ contacts/ emails/ sources/ url | Where has the email address been found | https://www.mapro.cz/kontakt/mapro-cz/ | Inherited |\n| Email last validity check | data/ contacts/ emails/ sources/ lastCheckedAt | Date of last check, when the email address has been found on the source | 2022-03-04T08:58:08+00:00 | Inherited |\n| Email source (code) | data/ contacts/ emails/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-uradprace | Inherited |\n| Email source (label) | data/ contacts/ emails/ sources/ name | Name of the source of information | Úřad Práce ČR | No |\n| Email linked contact person ID | data/ contacts/ emails/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Email | data/ contacts/ emails/ value | The actual email address | jelinkova@mapro.cz | Inherited |\n| Website unique ID | data/ contacts/ websites/ guid | Uniqe ID of the specific website | 49307135-52cc-b9bb-4415-e0525bc858d5 | Inherited |\n| Website first entry | data/ contacts/ websites/ createdAt | First date when the website was identified and linked to the company | 2022-02-08T08:35:56.607+00:00 | Inherited |\n| Website last update | data/ contacts/ websites/ updatedAt | Latest update of the website database entry | 2022-02-08T08:35:56.607+00:00 | No |\n| Website primary | data/ contacts/ websites/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Website confidence | data/ contacts/ websites/ confidence | How confident are we that the website belongs to this company (probabilistic matching used) | 0.99 | Inherited |\n| website private | data/ contacts/ websites/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Website source URL | data/ contacts/ websites/ sources/ url | URL of the source, where we have found the website | https://www.edb.eu/czech-firm-119752-mapro-s-r-o/contact | Inherited |\n| Website last validity check | data/ contacts/ websites/ sources/ lastCheckedAt | Date of last check of the information availability on source | 2022-02-08T08:35:57+00:00 | Inherited |\n| Website source (code) | data/ contacts/ websites/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-edb | Inherited |\n| Website source (label) | data/ contacts/ websites/ sources/ name | Name of the source of information | Evropská databanka firem | No |\n| Website linked contact person ID | data/ contacts/ websites/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Website | data/ contacts/ websites/ value | The actual website URL | http://mapro.cz | Inherited |\n| Social media name (code) | data/ contacts/ socialMedia/ type/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account unique ID | data/ contacts/ socialMedia/ guid | Uniqe ID of the specific social media profile | c37707bb-8185-d709-10ba-8eb92e3113f2 | Inherited |\n| Social media account first entry | data/ contacts/ socialMedia/ createdAt | First date when the social media profile was identified and linked to the company | 2022-03-06T09:24:57.24+00:00 | Inherited |\n| Social media account last update | data/ contacts/ socialMedia/ updatedAt | Latest update of the social media profile database entry | 2022-03-06T09:24:57.24+00:00 | No |\n| Social media account primary | data/ contacts/ socialMedia/ isPrimary | Is this the primary profile for the specific social media for this company | True | No |\n| Social media account confidence | data/ contacts/ socialMedia/ confidence | How confident are we that the social media profile belongs to this company (probabilistic matching used) | 1 | Inherited |\n| Social media account private | data/ contacts/ socialMedia/ isPrivate | Is this social media profile personal (i.e., not a company profile, but individual person's profile) | True | No |\n| Social media account source URL | data/ contacts/ socialMedia/ sources/ url | | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |\n| Social media account last validity check | data/ contacts/ socialMedia/ sources/ lastCheckedAt | | 2021-03-15T23:01:19+00:00 | Inherited |\n| Social media account source (code) | data/ contacts/ socialMedia/ sources/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account source (label) | data/ contacts/ socialMedia/ sources/ name | Social media name | Linkedin | No |\n| Social media account linked contact person ID | data/ contacts/ socialMedia/ person/ id | Internal person reference linking the LinkedIn account to a person | 207342 | Inherited |\n| Social media account | data/ contacts/ socialMedia/ value | The actual LinkedIn profile URL | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |", "parameters": [ { "name": "Tag.Uid", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true } }, { "name": "Types", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Companies.DataStructures.Models.Contacts.v4.ContactType" }, "nullable": true } }, { "name": "Sources", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "LastCheck.From", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "LastCheck.To", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPrivate", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "IsPrimary", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/contacts": { "get": { "tags": [ "Company Single Request" ], "summary": "Contacts", "description": "Dataset description:\n\nContact details for the company split into phones, emails, urls and social media.\nDataset combines 2 levels of contact details - personal and generic.\nWhile generic contacts are isolated, typically like `info@company.com`, a personal contact (phones, emails or professional social media profiles) is linked to a person profile with name and role in the company.\n\n\nAll contact details are regularly verified and we guarantee availability on the source url within the previous 30 days, thereby complying with most GDPR policies. Personal contacts are verified on a weekly basis.\n\nAll our contact data originate from publicly available sources. We do not use any purchased contact lists from 3rd parties.\n\nA contact like `john.smith@company.com` may be considered generic when detailed information about the person (name,role) are not explicitly published on the website or our system is unable to link these into a single profile.\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nUpdates of our contacts differ across sources. While in contacts sourced from company websites are parsed and verified on a continuous basis, company catalogues and contacts coming from job postings follow weekly updates.\n\nSelected use cases:\n\n- avoid GDPR issues by having a publicly available source of your contact, ready to show when challenged\n- filter specific roles in your target company using our Role enumeration and approach only contacts you specifically need\n- increase conversion using our confidence indication and call the numbers we cross-validated across multiple data sources\n- monitor departures from your target company by taking advantage of our Linkedin update tracking / verification service\n\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-----------------------------------------------|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| Contact person ID | data/ contacts/ people/ id | Internal file ID to connect a person with phones, emails, etc. | 1 | Inherited |\n| Contact person unique ID | data/ contacts/ people/ uniqueId | | cz-person-ABC12345677 | Inherited |\n| Contact full name | data/ contacts/ people/ name/ text | Full name of the person (first & last) as a text string | Jiří Částka | Inherited |\n| Contact first name | data/ contacts/ people/ name/ firstName | First name of the contact person | Jiří | No |\n| Contact last name | data/ contacts/ people/ name/ lastName | Last name of the contact person | Částka | No |\n| Contact role (label) | data/ contacts/ people/ roles/ text | Role of the contact person in a given company | Elektromechanický technik | Inherited |\n| Contact role (code) | data/ contacts/ people/ roles/ code | | a8e26a257d | Inherited |\n| Contact role start date | data/ contacts/ people/ roles/ validFrom | Date, when the contact person has been first identified in the role | 2021-03-15T23:36:03+00:00 | Inherited |\n| Contact role end date | data/ contacts/ people/ roles/ validTo | | 2021-03-15T23:36:03+00:00 | No |\n| Contact department text | data/ contacts/ departments/ roles/ text | | ABC123 | Inherited |\n| Contact department code | data/ contacts/ departments/ roles/ code | | Handyman | Inherited |\n| Contact department start date | data/ contacts/ departments/ roles/ validFrom | | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Contact department end date | data/ contacts/ departments/ roles/ validTo | | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number unique ID | data/ contacts/ phoneNumbers/ guid | Technical phone number ID | 84811132-1830-4278-1934-0a78f7636a02 | Inherited |\n| Phone number first entry | data/ contacts/ phoneNumbers/ createdAt | Date on which the phone number has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Phone number last update | data/ contacts/ phoneNumbers/ updatedAt | Last known update of the phone number | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number primary | data/ contacts/ phoneNumbers/ isPrimary | 3 most credible phone numbers (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Phone number confidence | data/ contacts/ phoneNumbers/ confidence | Contact-to-company link confidence | 0.98 | Inherited |\n| Phone number private | data/ contacts/ phoneNumbers/ isPrivate | When TRUE, the phone number has been identified as potentially linked to a specific individual (as opposed to company generic contact) | True | No |\n| Phone number source URL | data/ contacts/ phoneNumbers/ sources/ url | Where has the phone number been found | https://www.zivefirmy.cz/mapro_f1072996?cz=548 | Inherited |\n| Phone number last validity check | data/ contacts/ phoneNumbers/ sources/ lastCheckedAt | Date of last check, when the phone number has been found on the source | 2022-02-16T12:23:52+00:00 | Inherited |\n| Phone number source (code) | data/ contacts/ phoneNumbers/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-zivefirmycz | Inherited |\n| Phone number source (label) | data/ contacts/ phoneNumbers/ sources/ name | Name of the source of information | Zivefirmy.cz | No |\n| Phone number linked contact person ID | data/ contacts/ phoneNumbers/ person/ id | Internal person reference linking the phone number to a person | 42619 | Inherited |\n| Phone number | data/ contacts/ phoneNumbers/ value | The actual phone number | 00420585157811 | Inherited |\n| Email unique ID | data/ contacts/ emails/ guid | TBD | f52f6f95-a039-e93d-08cc-b05a62569c5c | Inherited |\n| Email first entry | data/ contacts/ emails/ createdAt | Date on which the email has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Email last update | data/ contacts/ emails/ updatedAt | Last known update of the email address | 2022-03-04T08:58:08.17+00:00 | No |\n| Email primary | data/ contacts/ emails/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Email confidence | data/ contacts/ emails/ confidence | | 0.98 | Inherited |\n| Email private | data/ contacts/ emails/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Email source URL | data/ contacts/ emails/ sources/ url | Where has the email address been found | https://www.mapro.cz/kontakt/mapro-cz/ | Inherited |\n| Email last validity check | data/ contacts/ emails/ sources/ lastCheckedAt | Date of last check, when the email address has been found on the source | 2022-03-04T08:58:08+00:00 | Inherited |\n| Email source (code) | data/ contacts/ emails/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-uradprace | Inherited |\n| Email source (label) | data/ contacts/ emails/ sources/ name | Name of the source of information | Úřad Práce ČR | No |\n| Email linked contact person ID | data/ contacts/ emails/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Email | data/ contacts/ emails/ value | The actual email address | jelinkova@mapro.cz | Inherited |\n| Website unique ID | data/ contacts/ websites/ guid | Uniqe ID of the specific website | 49307135-52cc-b9bb-4415-e0525bc858d5 | Inherited |\n| Website first entry | data/ contacts/ websites/ createdAt | First date when the website was identified and linked to the company | 2022-02-08T08:35:56.607+00:00 | Inherited |\n| Website last update | data/ contacts/ websites/ updatedAt | Latest update of the website database entry | 2022-02-08T08:35:56.607+00:00 | No |\n| Website primary | data/ contacts/ websites/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Website confidence | data/ contacts/ websites/ confidence | How confident are we that the website belongs to this company (probabilistic matching used) | 0.99 | Inherited |\n| website private | data/ contacts/ websites/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Website source URL | data/ contacts/ websites/ sources/ url | URL of the source, where we have found the website | https://www.edb.eu/czech-firm-119752-mapro-s-r-o/contact | Inherited |\n| Website last validity check | data/ contacts/ websites/ sources/ lastCheckedAt | Date of last check of the information availability on source | 2022-02-08T08:35:57+00:00 | Inherited |\n| Website source (code) | data/ contacts/ websites/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-edb | Inherited |\n| Website source (label) | data/ contacts/ websites/ sources/ name | Name of the source of information | Evropská databanka firem | No |\n| Website linked contact person ID | data/ contacts/ websites/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Website | data/ contacts/ websites/ value | The actual website URL | http://mapro.cz | Inherited |\n| Social media name (code) | data/ contacts/ socialMedia/ type/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account unique ID | data/ contacts/ socialMedia/ guid | Uniqe ID of the specific social media profile | c37707bb-8185-d709-10ba-8eb92e3113f2 | Inherited |\n| Social media account first entry | data/ contacts/ socialMedia/ createdAt | First date when the social media profile was identified and linked to the company | 2022-03-06T09:24:57.24+00:00 | Inherited |\n| Social media account last update | data/ contacts/ socialMedia/ updatedAt | Latest update of the social media profile database entry | 2022-03-06T09:24:57.24+00:00 | No |\n| Social media account primary | data/ contacts/ socialMedia/ isPrimary | Is this the primary profile for the specific social media for this company | True | No |\n| Social media account confidence | data/ contacts/ socialMedia/ confidence | How confident are we that the social media profile belongs to this company (probabilistic matching used) | 1 | Inherited |\n| Social media account private | data/ contacts/ socialMedia/ isPrivate | Is this social media profile personal (i.e., not a company profile, but individual person's profile) | True | No |\n| Social media account source URL | data/ contacts/ socialMedia/ sources/ url | | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |\n| Social media account last validity check | data/ contacts/ socialMedia/ sources/ lastCheckedAt | | 2021-03-15T23:01:19+00:00 | Inherited |\n| Social media account source (code) | data/ contacts/ socialMedia/ sources/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account source (label) | data/ contacts/ socialMedia/ sources/ name | Social media name | Linkedin | No |\n| Social media account linked contact person ID | data/ contacts/ socialMedia/ person/ id | Internal person reference linking the LinkedIn account to a person | 207342 | Inherited |\n| Social media account | data/ contacts/ socialMedia/ value | The actual LinkedIn profile URL | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get contacts for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get contacts for." } }, { "name": "Types", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Companies.DataStructures.Models.Contacts.v4.ContactType" }, "nullable": true } }, { "name": "Sources", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "LastCheck.From", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "LastCheck.To", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Updated.CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPrivate", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "IsPrimary", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v2/companies/{nationalIn}/tags/{tagUid}": { "post": { "tags": [ "Tags" ], "summary": "Add Tag to company", "description": "Add tag to a specific company. If the company already has the tag, its description is replaced; omitting the description removes it.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Unique Id of the company.", "required": true, "schema": { "type": "string", "description": "Unique Id of the company.", "nullable": true } }, { "name": "tagUid", "in": "path", "description": "Unique ID of the tag.", "required": true, "schema": { "type": "string", "description": "Unique ID of the tag.", "format": "uuid" } }, { "name": "description", "in": "query", "description": "Description for link between the tag and company.", "schema": { "type": "string", "description": "Description for link between the tag and company.", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] }, "delete": { "tags": [ "Tags" ], "summary": "Remove Tag from company", "description": "Removes a specific tag from the company.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Unique Id of the company", "required": true, "schema": { "type": "string", "description": "Unique Id of the company", "nullable": true } }, { "name": "tagUid", "in": "path", "description": "Unique ID of the tag", "required": true, "schema": { "type": "string", "description": "Unique ID of the tag", "format": "uuid" } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v2/companies/{nationalIn}/tags": { "get": { "tags": [ "Tags" ], "summary": "Get Tags from company", "description": "Returns list of tags for a specific company.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Unique Id of the company", "required": true, "schema": { "type": "string", "description": "Unique Id of the company", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.CompanyTagDto" } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/bank-accounts": { "get": { "tags": [ "Obsolete" ], "summary": "Bank Accounts (nationalIn)", "description": "Dataset description:\n\nBank accounts are useful as identifiers (unique across companies) and at the same time a bank account at a certain financial institution signals the focus of the company on international trade.\nFinancial institutions among our clients can build useful segmentations with transition timeline between the banks.\n\nAvailability:\n\ncz, sk\n\nDataset updates:\n\nDataset is updated on a weekly to monthly basis\n\nSelected use cases:\n\n- validate your banking data or use your transaction data to match customers to our data\n- monitor VAT payer status using bank accounts published in VAT registries\n- segment companies using multiple banks and/or competing banks\n- segment companies likely engaging into export/import activities using established foreign/global banks\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated? |\n|----------------------------------|-------------------------------------|----------------------------------------------------------------------|-----------------------------|-------------------|\n| Entity unique ID | data/ company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-14615100 | Inherited |\n| Bank account in local format | data/ bankAccounts/ accountNumber | account number in local country format | 1152220360277/0100 | No |\n| Bank account identification date | data/ bankAccounts/ validFrom | first date on which the account has been identified | 2018-03-05 | Inherited |\n| Bank account last valid date | data/ bankAccounts/ validTo | date when the bank account was cancelled | 2019-03-05 | No |\n| Bank account in IBAN format | data/ bankAccounts/ iban | | CZ8901000001152220360277 | No |\n| Local bank identification code | data/ bankAccounts/ bank/ code | Enumeration bank identification code for api/ v3/ companies/ banks | 0100 | Inherited |\n| Bank name | data/ bankAccounts/ bank/ name | local bank name | Komerční banka | No |\n| Bank logo | data/ bankAccounts/ bank/ icon/ url | | https://www.test.cz/img.jpg | No |\n| Source of bank account (code) | data/ bankAccounts/ sources/ code | Source enum code for /api/v3/Sources | cz-adis | Inherited |\n| Source of bank account (name) | data/ bankAccounts/ sources/ name | on which source has the account been identified | Registr plátců DPH | No |", "parameters": [ { "name": "nationalIn", "in": "path", "description": "NationalIn identifier as a string.", "required": true, "schema": { "type": "string", "description": "NationalIn identifier as a string." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/bank-accounts": { "get": { "tags": [ "Obsolete" ], "summary": "Bank Accounts", "description": "Dataset description:\n\nBank accounts are useful as identifiers (unique across companies) and at the same time a bank account at a certain financial institution signals the focus of the company on international trade.\nFinancial institutions among our clients can build useful segmentations with transition timeline between the banks.\n\nAvailability:\n\ncz, sk\n\nDataset updates:\n\nDataset is updated on a weekly to monthly basis\n\nSelected use cases:\n\n- validate your banking data or use your transaction data to match customers to our data\n- monitor VAT payer status using bank accounts published in VAT registries\n- segment companies using multiple banks and/or competing banks\n- segment companies likely engaging into export/import activities using established foreign/global banks\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated? |\n|----------------------------------|-------------------------------------|----------------------------------------------------------------------|-----------------------------|-------------------|\n| Entity unique ID | data/ company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-14615100 | Inherited |\n| Bank account in local format | data/ bankAccounts/ accountNumber | account number in local country format | 1152220360277/0100 | No |\n| Bank account identification date | data/ bankAccounts/ validFrom | first date on which the account has been identified | 2018-03-05 | Inherited |\n| Bank account last valid date | data/ bankAccounts/ validTo | date when the bank account was cancelled | 2019-03-05 | No |\n| Bank account in IBAN format | data/ bankAccounts/ iban | | CZ8901000001152220360277 | No |\n| Local bank identification code | data/ bankAccounts/ bank/ code | Enumeration bank identification code for api/ v3/ companies/ banks | 0100 | Inherited |\n| Bank name | data/ bankAccounts/ bank/ name | local bank name | Komerční banka | No |\n| Bank logo | data/ bankAccounts/ bank/ icon/ url | | https://www.test.cz/img.jpg | No |\n| Source of bank account (code) | data/ bankAccounts/ sources/ code | Source enum code for /api/v3/Sources | cz-adis | Inherited |\n| Source of bank account (name) | data/ bankAccounts/ sources/ name | on which source has the account been identified | Registr plátců DPH | No |", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/bank-accounts": { "get": { "tags": [ "Company Collection Request" ], "summary": "Bank Accounts", "description": "Dataset description:\n\nBank accounts are useful as identifiers (unique across companies) and at the same time a bank account at a certain financial institution signals the focus of the company on international trade.\nFinancial institutions among our clients can build useful segmentations with transition timeline between the banks.\n\nAvailability:\n\ncz, sk\n\nDataset updates:\n\nDataset is updated on a weekly to monthly basis\n\nSelected use cases:\n\n- validate your banking data or use your transaction data to match customers to our data\n- monitor VAT payer status using bank accounts published in VAT registries\n- segment companies using multiple banks and/or competing banks\n- segment companies likely engaging into export/import activities using established foreign/global banks\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated? |\n|----------------------------------|-------------------------------------|----------------------------------------------------------------------|-----------------------------|-------------------|\n| Entity unique ID | data/ company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-14615100 | Inherited |\n| Bank account in local format | data/ bankAccounts/ accountNumber | account number in local country format | 1152220360277/0100 | No |\n| Bank account identification date | data/ bankAccounts/ validFrom | first date on which the account has been identified | 2018-03-05 | Inherited |\n| Bank account last valid date | data/ bankAccounts/ validTo | date when the bank account was cancelled | 2019-03-05 | No |\n| Bank account in IBAN format | data/ bankAccounts/ iban | | CZ8901000001152220360277 | No |\n| Local bank identification code | data/ bankAccounts/ bank/ code | Enumeration bank identification code for api/ v3/ companies/ banks | 0100 | Inherited |\n| Bank name | data/ bankAccounts/ bank/ name | local bank name | Komerční banka | No |\n| Bank logo | data/ bankAccounts/ bank/ icon/ url | | https://www.test.cz/img.jpg | No |\n| Source of bank account (code) | data/ bankAccounts/ sources/ code | Source enum code for /api/v3/Sources | cz-adis | Inherited |\n| Source of bank account (name) | data/ bankAccounts/ sources/ name | on which source has the account been identified | Registr plátců DPH | No |", "parameters": [ { "name": "BankCode", "in": "query", "description": "Request bank accounts related to a specific bank.", "schema": { "type": "string", "description": "Request bank accounts related to a specific bank.", "nullable": true } }, { "name": "LatestOnly", "in": "query", "description": "Request only latest company's bank account from every bank.", "schema": { "type": "boolean", "description": "Request only latest company's bank account from every bank." } }, { "name": "Sources", "in": "query", "description": "Request bank account data from specific sources.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Request bank account data from specific sources.", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "ValidFrom", "in": "query", "description": "The start date to filter the list of bank accounts by.", "schema": { "type": "string", "description": "The start date to filter the list of bank accounts by.", "format": "date-time", "nullable": true } }, { "name": "ValidTo", "in": "query", "description": "The end date to filter the list of bank accounts by.", "schema": { "type": "string", "description": "The end date to filter the list of bank accounts by.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/bank-accounts": { "get": { "tags": [ "Company Single Request" ], "summary": "Bank Accounts", "description": "Dataset description:\n\nBank accounts are useful as identifiers (unique across companies) and at the same time a bank account at a certain financial institution signals the focus of the company on international trade.\nFinancial institutions among our clients can build useful segmentations with transition timeline between the banks.\n\nAvailability:\n\ncz, sk\n\nDataset updates:\n\nDataset is updated on a weekly to monthly basis\n\nSelected use cases:\n\n- validate your banking data or use your transaction data to match customers to our data\n- monitor VAT payer status using bank accounts published in VAT registries\n- segment companies using multiple banks and/or competing banks\n- segment companies likely engaging into export/import activities using established foreign/global banks\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated? |\n|----------------------------------|-------------------------------------|----------------------------------------------------------------------|-----------------------------|-------------------|\n| Entity unique ID | data/ company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-14615100 | Inherited |\n| Bank account in local format | data/ bankAccounts/ accountNumber | account number in local country format | 1152220360277/0100 | No |\n| Bank account identification date | data/ bankAccounts/ validFrom | first date on which the account has been identified | 2018-03-05 | Inherited |\n| Bank account last valid date | data/ bankAccounts/ validTo | date when the bank account was cancelled | 2019-03-05 | No |\n| Bank account in IBAN format | data/ bankAccounts/ iban | | CZ8901000001152220360277 | No |\n| Local bank identification code | data/ bankAccounts/ bank/ code | Enumeration bank identification code for api/ v3/ companies/ banks | 0100 | Inherited |\n| Bank name | data/ bankAccounts/ bank/ name | local bank name | Komerční banka | No |\n| Bank logo | data/ bankAccounts/ bank/ icon/ url | | https://www.test.cz/img.jpg | No |\n| Source of bank account (code) | data/ bankAccounts/ sources/ code | Source enum code for /api/v3/Sources | cz-adis | Inherited |\n| Source of bank account (name) | data/ bankAccounts/ sources/ name | on which source has the account been identified | Registr plátců DPH | No |", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get bank accounts for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get bank accounts for." } }, { "name": "BankCode", "in": "query", "description": "Request bank accounts related to a specific bank.", "schema": { "type": "string", "description": "Request bank accounts related to a specific bank.", "nullable": true } }, { "name": "LatestOnly", "in": "query", "description": "Request only latest bank account data.", "schema": { "type": "boolean", "description": "Request only latest bank account data." } }, { "name": "Sources", "in": "query", "description": "Request bank account data from specific sources.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Request bank account data from specific sources.", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "ValidFrom", "in": "query", "description": "The start date to filter the list of bank accounts by.", "schema": { "type": "string", "description": "The start date to filter the list of bank accounts by.", "format": "date-time", "nullable": true } }, { "name": "ValidTo", "in": "query", "description": "The end date to filter the list of bank accounts by.", "schema": { "type": "string", "description": "The end date to filter the list of bank accounts by.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/banks": { "get": { "tags": [ "Company Collection Request" ], "summary": "Banks", "description": "Gets all available banks information.", "parameters": [ { "name": "BankCode", "in": "query", "description": "Request bank accounts related to a specific bank.", "schema": { "type": "string", "description": "Request bank accounts related to a specific bank.", "nullable": true } }, { "name": "LatestOnly", "in": "query", "description": "Request only latest bank data.", "schema": { "type": "boolean", "description": "Request only latest bank data." } }, { "name": "Sources", "in": "query", "description": "Request bank account data from specific sources.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Request bank account data from specific sources.", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "ValidFrom", "in": "query", "description": "The start date to filter the list of bank by.", "schema": { "type": "string", "description": "The start date to filter the list of bank by.", "format": "date-time", "nullable": true } }, { "name": "ValidTo", "in": "query", "description": "The end date to filter the list of bank by.", "schema": { "type": "string", "description": "The end date to filter the list of bank by.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/banks": { "get": { "tags": [ "Company Single Request" ], "summary": "Banks", "description": "Gets all available banks information for given company.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get banks for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get banks for." } }, { "name": "BankCode", "in": "query", "description": "Request bank accounts related to a specific bank.", "schema": { "type": "string", "description": "Request bank accounts related to a specific bank.", "nullable": true } }, { "name": "LatestOnly", "in": "query", "description": "Request only latest bank account data.", "schema": { "type": "boolean", "description": "Request only latest bank account data." } }, { "name": "Sources", "in": "query", "description": "Request bank account data from specific sources.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Request bank account data from specific sources.", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "ValidFrom", "in": "query", "description": "The start date to filter the list of bank by.", "schema": { "type": "string", "description": "The start date to filter the list of bank by.", "format": "date-time", "nullable": true } }, { "name": "ValidTo", "in": "query", "description": "The end date to filter the list of bank by.", "schema": { "type": "string", "description": "The end date to filter the list of bank by.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/basic-infos": { "get": { "tags": [ "Company Single Request" ], "summary": "Basic Info (nationalIn)", "description": "Dataset description:\n\nBasic-info dataset lists all known company entities and entrepreneurs for the country market with registration details, registered HQ address, both inferred and self-declared industry classifications and health status.\nIf available, multiple registries are merged together to offer a unified view of the market. \n\nDataset updates:\n\nFor country markets where BizMachine performs data acquisition from the basic registries, we update on a daily basis. In remaining markets, the frequency varies between monthly and quarterly updates.\n\nSelected use cases:\n\n- enrich your CRM records and invoicing templates using offical details\n- segment your prospects based on keyword-search in self-descriptions\n- improve accuracy of industry focus by using self-declared categories\n- segment geographically using precise and structured address data\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated? |\n|-----------------------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|\n| Entity unique ID | data/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| National entity ID | data/ nationalIn | Local entity identifier (ICO in CZ) | 14615100 | Yes |\n| Company keywords | data/ keywords/ keywords | Keywords/ phrases associated with (describing) the entity | vstřikování plastů | No |\n| Company self-declared category (name) | data/ selfDeclaredCategory/ name | Categories from company catalogs/ yellow pages the company is assigned to | Prodej průmyslových strojů a vybavení | No |\n| Company self-declared category (code) | data/ selfDeclaredCategory/ code | | sd-f-005466 | Inherited |\n| Company name | data/ name | Official entity name | MAPRO spol. s r.o. | No |\n| Company VAT ID | data/ vatIn | VAT identification ID of the company | CZ14615100 | No |\n| Company income tax ID | data/ taxIn | Income tax identification ID of the company | CZ14615100 | No |\n| Company logo URL | data/ logo/ URL | Link to a company logo | https://www.logobox.cz/getimage.ashx?id=cz14615100&size=medium&error404=true | Inherited |\n| Company founding date | data/ establishedAt | foundation date of the company | 1991-01-25T00:00:00+00:00 | No |\n| Company disestablishmnet date | data/ disestablishedAt | disestablishment date of the company | 1991-01-25T00:00:00+00:00 | No |\n| Company closing date | data/ closedAt | closing date of the company | 1991-01-25T00:00:00+00:00 | No |\n| Court of company registration | data/ registration/ court/ name | court where the company registration file is held | Krajský soud v Ostravě | Inherited |\n| Court registration date | data/ registration/ createdAt | | 1991-01-25T00:00:00+00:00 | No |\n| Company registration file ID | data/ registration/ fileNumber | company registration file identification | C 265 | No |\n| Link to company register | data/ registration/ recordUrl | Link to company information in business register | https://or.justice.cz/ias/ui/rejstrik-$firma?ico=14615100&jenPlatne=VSECHNY | Inherited |\n| Type of the registration creator | data/ registration/ createdBy/ type | | person | No |\n| Unique ID of the creator | data/ registration/ createdBy/ uniqueId | | cz-person-12345 | No |\n| Registered capital amount | data/ registeredCapital/ amount | | 100 | No |\n| Registered capital currency | data/ registeredCapital/ currency | | CZK | No |\n| Deregistration date | data/ deregistration/ createdAt | | 1991-01-25T00:00:00+00:00 | Inherited |\n| Deregistration method | data/ deregistration/ method | | Cancellation | No |\n| Company health ID | data/ health/ code | | AA | Inherited |\n| Company health name | data/ health/ name | Company health in terms of ability to do business | In business | No |\n| Legal form ID | data/ legalForm/ code | Enumeration legal form code for /api/ v3/ companies/ basic/ legal-forms | 112 | Inherited |\n| Legal form | data/ legalForm/ name | Legal form name | Limited liability company | No |\n| Institutional sector ID | data/ institutionalSector/ code | | 11003 | Inherited |\n| Institutional sector | data/ institutionalSector/ name | Private/public, financial/non-financial, domestic/foreign entity | Non-financial national private corporations | No |\n| HQ Address ID | data/ address/ uniqueId | | cz-address-123456 | No |\n| HQ address | data/ address/ text | headqurater address as a text string | Bystrovany 211, Bystrovany, 77900 | Inherited |\n| HQ address GPS latitude | data/ address/ coordinates/ latitude | GPS latitude coordianate | 49.5897501781 | Inherited |\n| HQ address GPS longitude | data/ address/ coordinates/ longitude | GPS longitude coordianate | 17.3141371244 | Inherited |\n| HQ street name | data/ address/ streetName | | Na Vrchu | No |\n| HQ street number | data/ address/ streetNumber | Building number | 211 | No |\n| HQ city | data/ address/ city | City/village | Bystrovany | No |\n| HQ ZIP code | data/ address/ postalCode | ZIP code | 77900 | No |\n| HQ Locality ID | data/ address/ locality/ code | Code from smallest child in Locality tree, e.g. City District | 544256 | Inherited |\n| HQ Locality name | data/ address/ locality/ name | Name of smallest child in Locality tree, e.g. City District | České Budějovice | Inherited |\n| HQ city part | data/ address/ countrySpecific/ CZ/ cityPart | city part specific to Czechia, based on RUIAN nomenclature | Praha 10 | No |\n| HQ city district | data/ address/ countrySpecific/ CZ/ cityDistrict | | Žižkov | No |\n| HQ orientation number | data/ address/ countrySpecific/ CZ/ orientationNumber | | 123 | No |\n| HQ house number | data/ address/ countrySpecific/ CZ/ houseNumber | Building number | 211 | No |\n| HQ is evidence number | data/ address/ countrySpecific/ CZ/ isEvidenceNumber | | True | No |\n| Czech address point | data/ address/ countrySpecific/ cz/ ruian/ addressPointNumber | \"Kod adresniho mista\" as recorded by RUIAN | 25259300 | No |\n| Czech building ID | data/ address/ countrySpecific/ cz/ ruian/ buildingNumber | Building identificiation (unique across the whole Czechia) as recorded by RUIAN | 24791881 | No |\n| Czech street number | data/ address/ countrySpecific/ cz/ ruian/ streetNumber | | 123 | No |\n| Czech city borough name | data/ address/ countrySpecific/ cz/ ruian/ cityBoroughNumber | | 123 | No |\n| Czech city district number | data/ address/ countrySpecific/ cz/ ruian/ cityDistrictNumber | | 123 | No |\n| Czech municipality part ID | data/ address/ countrySpecific/ cz/ ruian/ municipalityPartNumber | Czechia-specific parameter | 16691 | No |\n| Czech municipality ID | data/ address/ countrySpecific/ cz/ ruian/ municipalityNumber | Czechia-specific parameter | 547026 | No |\n| Czech settlement unit ID | data/ address/ countrySpecific/ cz/ ruian/ basicSettlementUnitNumber | Czechia-specific parameter | 16691 | No |\n| Czech cadaster area ID | data/ address/ countrySpecific/ cz/ ruian/ cadasterAreaNumber | Czechia-specific parameter | 616699 | No |\n| Czech plot number | data/ address/ countrySpecific/ cz/ ruian/ plotNumber | | 86607039010 | No |\n| Link to Czech building register profile | data/ address/ countrySpecific/ cz/ ruian/ url | Link to building speifications in RUIAN | https://vdp.cuzk.cz/vdp/ruian/adresnimista/25259300 | No |\n| Czech building type ID | data/ address/ countrySpecific/ cz/ purposeTypes/ code | | 0003 | No |\n| Czech building type name | data/ address/ countrySpecific/ cz/ purposeTypes/ name | purpose for which the building is meant to be used | office | No |\n| Slovak building type ID | data/ address/ countrySpecific/ sk/ purposeTypes/ code | | 0003 | No |\n| Slovak building type name | data/ address/ countrySpecific/ sk/ purposeTypes/ name | purpose for which the building is meant to be used | office | No |\n| Company self description | data/ selfDescription | free text, which the entity has posted in a business catalog, on website, on LinkedIn and similar sources and which describes what the entity does | Prodej technologií pro vstřikování plastů značek Zhafir a Haitian. Zabýváme se kompletní průmyslovou automatizací. Zajišťujeme záruční i pozáruční servis všech technologií, které naše firma dodává. Nabízíme školení pracovníku pro práci se stroji na vstřikování plastů. | No |\n| Is company a verified VAT payer | data/ isVerifiedVatPayer | | | No |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "An international Company identifier as a string.", "required": true, "schema": { "type": "string", "description": "An international Company identifier as a string." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/basic-infos": { "get": { "tags": [ "Company Collection Request" ], "summary": "Basic Info", "description": "Dataset description:\n\nBasic-info dataset lists all known company entities and entrepreneurs for the country market with registration details, registered HQ address, both inferred and self-declared industry classifications and health status.\nIf available, multiple registries are merged together to offer a unified view of the market. \n\nDataset updates:\n\nFor country markets where BizMachine performs data acquisition from the basic registries, we update on a daily basis. In remaining markets, the frequency varies between monthly and quarterly updates.\n\nSelected use cases:\n\n- enrich your CRM records and invoicing templates using offical details\n- segment your prospects based on keyword-search in self-descriptions\n- improve accuracy of industry focus by using self-declared categories\n- segment geographically using precise and structured address data\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated? |\n|-----------------------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|\n| Entity unique ID | data/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| National entity ID | data/ nationalIn | Local entity identifier (ICO in CZ) | 14615100 | Yes |\n| Company keywords | data/ keywords/ keywords | Keywords/ phrases associated with (describing) the entity | vstřikování plastů | No |\n| Company self-declared category (name) | data/ selfDeclaredCategory/ name | Categories from company catalogs/ yellow pages the company is assigned to | Prodej průmyslových strojů a vybavení | No |\n| Company self-declared category (code) | data/ selfDeclaredCategory/ code | | sd-f-005466 | Inherited |\n| Company name | data/ name | Official entity name | MAPRO spol. s r.o. | No |\n| Company VAT ID | data/ vatIn | VAT identification ID of the company | CZ14615100 | No |\n| Company income tax ID | data/ taxIn | Income tax identification ID of the company | CZ14615100 | No |\n| Company logo URL | data/ logo/ URL | Link to a company logo | https://www.logobox.cz/getimage.ashx?id=cz14615100&size=medium&error404=true | Inherited |\n| Company founding date | data/ establishedAt | foundation date of the company | 1991-01-25T00:00:00+00:00 | No |\n| Company disestablishmnet date | data/ disestablishedAt | disestablishment date of the company | 1991-01-25T00:00:00+00:00 | No |\n| Company closing date | data/ closedAt | closing date of the company | 1991-01-25T00:00:00+00:00 | No |\n| Court of company registration | data/ registration/ court/ name | court where the company registration file is held | Krajský soud v Ostravě | Inherited |\n| Court registration date | data/ registration/ createdAt | | 1991-01-25T00:00:00+00:00 | No |\n| Company registration file ID | data/ registration/ fileNumber | company registration file identification | C 265 | No |\n| Link to company register | data/ registration/ recordUrl | Link to company information in business register | https://or.justice.cz/ias/ui/rejstrik-$firma?ico=14615100&jenPlatne=VSECHNY | Inherited |\n| Type of the registration creator | data/ registration/ createdBy/ type | | person | No |\n| Unique ID of the creator | data/ registration/ createdBy/ uniqueId | | cz-person-12345 | No |\n| Registered capital amount | data/ registeredCapital/ amount | | 100 | No |\n| Registered capital currency | data/ registeredCapital/ currency | | CZK | No |\n| Deregistration date | data/ deregistration/ createdAt | | 1991-01-25T00:00:00+00:00 | Inherited |\n| Deregistration method | data/ deregistration/ method | | Cancellation | No |\n| Company health ID | data/ health/ code | | AA | Inherited |\n| Company health name | data/ health/ name | Company health in terms of ability to do business | In business | No |\n| Legal form ID | data/ legalForm/ code | Enumeration legal form code for /api/ v3/ companies/ basic/ legal-forms | 112 | Inherited |\n| Legal form | data/ legalForm/ name | Legal form name | Limited liability company | No |\n| Institutional sector ID | data/ institutionalSector/ code | | 11003 | Inherited |\n| Institutional sector | data/ institutionalSector/ name | Private/public, financial/non-financial, domestic/foreign entity | Non-financial national private corporations | No |\n| HQ Address ID | data/ address/ uniqueId | | cz-address-123456 | No |\n| HQ address | data/ address/ text | headqurater address as a text string | Bystrovany 211, Bystrovany, 77900 | Inherited |\n| HQ address GPS latitude | data/ address/ coordinates/ latitude | GPS latitude coordianate | 49.5897501781 | Inherited |\n| HQ address GPS longitude | data/ address/ coordinates/ longitude | GPS longitude coordianate | 17.3141371244 | Inherited |\n| HQ street name | data/ address/ streetName | | Na Vrchu | No |\n| HQ street number | data/ address/ streetNumber | Building number | 211 | No |\n| HQ city | data/ address/ city | City/village | Bystrovany | No |\n| HQ ZIP code | data/ address/ postalCode | ZIP code | 77900 | No |\n| HQ Locality ID | data/ address/ locality/ code | Code from smallest child in Locality tree, e.g. City District | 544256 | Inherited |\n| HQ Locality name | data/ address/ locality/ name | Name of smallest child in Locality tree, e.g. City District | České Budějovice | Inherited |\n| HQ city part | data/ address/ countrySpecific/ CZ/ cityPart | city part specific to Czechia, based on RUIAN nomenclature | Praha 10 | No |\n| HQ city district | data/ address/ countrySpecific/ CZ/ cityDistrict | | Žižkov | No |\n| HQ orientation number | data/ address/ countrySpecific/ CZ/ orientationNumber | | 123 | No |\n| HQ house number | data/ address/ countrySpecific/ CZ/ houseNumber | Building number | 211 | No |\n| HQ is evidence number | data/ address/ countrySpecific/ CZ/ isEvidenceNumber | | True | No |\n| Czech address point | data/ address/ countrySpecific/ cz/ ruian/ addressPointNumber | \"Kod adresniho mista\" as recorded by RUIAN | 25259300 | No |\n| Czech building ID | data/ address/ countrySpecific/ cz/ ruian/ buildingNumber | Building identificiation (unique across the whole Czechia) as recorded by RUIAN | 24791881 | No |\n| Czech street number | data/ address/ countrySpecific/ cz/ ruian/ streetNumber | | 123 | No |\n| Czech city borough name | data/ address/ countrySpecific/ cz/ ruian/ cityBoroughNumber | | 123 | No |\n| Czech city district number | data/ address/ countrySpecific/ cz/ ruian/ cityDistrictNumber | | 123 | No |\n| Czech municipality part ID | data/ address/ countrySpecific/ cz/ ruian/ municipalityPartNumber | Czechia-specific parameter | 16691 | No |\n| Czech municipality ID | data/ address/ countrySpecific/ cz/ ruian/ municipalityNumber | Czechia-specific parameter | 547026 | No |\n| Czech settlement unit ID | data/ address/ countrySpecific/ cz/ ruian/ basicSettlementUnitNumber | Czechia-specific parameter | 16691 | No |\n| Czech cadaster area ID | data/ address/ countrySpecific/ cz/ ruian/ cadasterAreaNumber | Czechia-specific parameter | 616699 | No |\n| Czech plot number | data/ address/ countrySpecific/ cz/ ruian/ plotNumber | | 86607039010 | No |\n| Link to Czech building register profile | data/ address/ countrySpecific/ cz/ ruian/ url | Link to building speifications in RUIAN | https://vdp.cuzk.cz/vdp/ruian/adresnimista/25259300 | No |\n| Czech building type ID | data/ address/ countrySpecific/ cz/ purposeTypes/ code | | 0003 | No |\n| Czech building type name | data/ address/ countrySpecific/ cz/ purposeTypes/ name | purpose for which the building is meant to be used | office | No |\n| Slovak building type ID | data/ address/ countrySpecific/ sk/ purposeTypes/ code | | 0003 | No |\n| Slovak building type name | data/ address/ countrySpecific/ sk/ purposeTypes/ name | purpose for which the building is meant to be used | office | No |\n| Company self description | data/ selfDescription | free text, which the entity has posted in a business catalog, on website, on LinkedIn and similar sources and which describes what the entity does | Prodej technologií pro vstřikování plastů značek Zhafir a Haitian. Zabýváme se kompletní průmyslovou automatizací. Zajišťujeme záruční i pozáruční servis všech technologií, které naše firma dodává. Nabízíme školení pracovníku pro práci se stroji na vstřikování plastů. | No |\n| Is company a verified VAT payer | data/ isVerifiedVatPayer | | | No |\n\n", "parameters": [ { "name": "Health.Code", "in": "query", "description": "Collection of health codes.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Collection of health codes.", "nullable": true } }, { "name": "LegalForms.Code", "in": "query", "description": "Collection of legal form codes.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Collection of legal form codes.", "nullable": true } }, { "name": "EstablishedAt.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "EstablishedAt.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/connected-companies": { "get": { "tags": [ "Company Single Request" ], "summary": "Connected Companies (nationalIn)", "description": "Dataset description:\n\nDataset lists companies related to a given company via one or many connections:\n\n - ownership link (a person owns both companies, a company owns the connected company or vice versa)\n - statutory (both connected companies share a statutory representative)\n\nOwnership chains can span across an ownership hierarchy, connecting companies which are connected through a third entity they both have a share in. For some selected ownership connections (typically depending on legal form) an exact share cannot be retrieved.\nAs statutories can hold different roles in either of the connected companies, \"inCompany\" and \"inConnectedCompany\" roles are distinguished.\n\nThe dataset is naturally historized and some connections are invalid, having a non-empty data/connectedCompanies/company/activeTo node. This allows the user to reconstruct historical version of the company network.\n\nAvailability:\n\ncz, sk\n\nDataset updates:\n\nDataset is updated on a weekly basis\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|------------------------------------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|--------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| Connected entity unique ID | data/ connectedCompanies/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID of the connected entity | cz-company-04732936 | Yes |\n| Connected entity national ID | data/ connectedCompanies/ company/ nationalIn | Local entity identifier (ICO in CZ) of the connected entity | 4732936 | Yes |\n| Connected entity company name | data/ connectedCompanies/ company/ name | | Minerva Capital a.s. | No |\n| Type of relationship between connected entities (code) | data/ connectedCompanies/ relationshipType/ code | Enumeration code for /api/v3/companies/relationship-types | other | Yes |\n| Type of relationship between connected entities (label) | data/ connectedCompanies/ relationshipType/ name | Description of the connection type between entities | Jiné | No |\n| Any active connected entities relationship start date | data/ connectedCompanies/ activeFrom | When has the relationship between the entities been established (the \"oldest\" of all connections) | 2020-11-09T00:00:00+00:00 | Yes |\n| Any active connected entities relationship end date | data/ connectedCompanies/ activeTo | When has the relationship between the entities ended | 2020-11-09T00:00:00+00:00 | No |\n| Distance | data/ connectedCompanies/ distance | | 0.5 | No |\n| Connector entity unique ID | data/ connectedCompanies/ connections/ uniqueID | Unique ID of the connecting element between the connecting entities | cz-person-n5340564926533919046 | Inherited |\n| Connector company natinonal ID | data/ connectedCompanies/ connections/ nationalIn | National ID of the connecting element between the connecting entities | 12345678 | Inherited |\n| Connector entity name | data/ connectedCompanies/ connections/ name | | Martin Lucký | Inherited |\n| Type of connector entity (legal, private) | data/ connectedCompanies/ connections/ type | | Person | Inherited |\n| Specific connection between connected companies start date | data/ connectedCompanies/ connections/ activeFrom | Since when does this particular connection exist | 2020-11-09T00:00:00+00:00 | Inherited |\n| Date of when the connections stopped being active | data/ connectedCompanies/ connections/ activeTo | | 2020-11-09T00:00:00+00:00 | No |\n| Role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany | Recursive object | | No |\n| Type of role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany/ type | | Statutory | Inherited |\n| Connector entity role in queried company start date | data/ connectedCompanies/ connections/ roles/ inCompany/ activeFrom | Date on which the connector entity became active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | Inherited |\n| Connector entity role in queried company ended date | data/ connectedCompanies/ connections/ roles/ inCompany/ activeTo | Date on which the connector entity stopped being active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | No |\n| Type of connection | data/ connectedCompanies/ connections/ roles/ inCompany/ connectionType/ code | | partner | Inherited |\n| Ownership share of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany/ share | | 1.0 | Inherited |\n| Role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany/ text/ value | | Jednatel | Inherited |\n| Type of role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ type | | Statutory | Inherited |\n| Connector entity role in queried company start date | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ activeFrom | Date on which the connector entity became active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | Inherited |\n| Connector entity role in queried company ended date | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ activeTo | Date on which the connector entity stopped being active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | No |\n| Type of connection | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ connectionType/ code | | partner | Inherited |\n| Ownership share of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ share | | 1.0 | Inherited |\n| Role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ text/ value | | Jednatel | Inherited |\n| Role of connector entity in the connected company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany | Recursive object | | No |\n| Technical item | data/ connectedCompanies/ metrics/ revenue/ type | Polymorphic identifier | CategoryValueCurrency | Inherited |\n| Revenue (category) of connected company validity start | data/ connectedCompanies/ metrics/ revenue/ validFrom | | 2020-01-01T00:00:00+00:00 | Inherited |\n| Revenue (category) of connected company validity end | data/ connectedCompanies/ metrics/ revenue/ validTo | | 2020-12-31T00:00:00+00:00 | No |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company unique identifier to get connected companies data for.", "required": true, "schema": { "type": "string", "description": "Company unique identifier to get connected companies data for." } }, { "name": "IncludeMetricsRevenue", "in": "query", "description": "Should the data include company revenue metrics.", "schema": { "type": "boolean", "description": "Should the data include company revenue metrics." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/connected-companies": { "get": { "tags": [ "Company Collection Request" ], "summary": "Connected companies", "description": "Dataset description:\n\nDataset lists companies related to a given company via one or many connections:\n\n - ownership link (a person owns both companies, a company owns the connected company or vice versa)\n - statutory (both connected companies share a statutory representative)\n\nOwnership chains can span across an ownership hierarchy, connecting companies which are connected through a third entity they both have a share in. For some selected ownership connections (typically depending on legal form) an exact share cannot be retrieved.\nAs statutories can hold different roles in either of the connected companies, \"inCompany\" and \"inConnectedCompany\" roles are distinguished.\n\nThe dataset is naturally historized and some connections are invalid, having a non-empty data/connectedCompanies/company/activeTo node. This allows the user to reconstruct historical version of the company network.\n\nAvailability:\n\ncz, sk\n\nDataset updates:\n\nDataset is updated on a weekly basis\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|------------------------------------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|--------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| Connected entity unique ID | data/ connectedCompanies/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID of the connected entity | cz-company-04732936 | Yes |\n| Connected entity national ID | data/ connectedCompanies/ company/ nationalIn | Local entity identifier (ICO in CZ) of the connected entity | 4732936 | Yes |\n| Connected entity company name | data/ connectedCompanies/ company/ name | | Minerva Capital a.s. | No |\n| Type of relationship between connected entities (code) | data/ connectedCompanies/ relationshipType/ code | Enumeration code for /api/v3/companies/relationship-types | other | Yes |\n| Type of relationship between connected entities (label) | data/ connectedCompanies/ relationshipType/ name | Description of the connection type between entities | Jiné | No |\n| Any active connected entities relationship start date | data/ connectedCompanies/ activeFrom | When has the relationship between the entities been established (the \"oldest\" of all connections) | 2020-11-09T00:00:00+00:00 | Yes |\n| Any active connected entities relationship end date | data/ connectedCompanies/ activeTo | When has the relationship between the entities ended | 2020-11-09T00:00:00+00:00 | No |\n| Distance | data/ connectedCompanies/ distance | | 0.5 | No |\n| Connector entity unique ID | data/ connectedCompanies/ connections/ uniqueID | Unique ID of the connecting element between the connecting entities | cz-person-n5340564926533919046 | Inherited |\n| Connector company natinonal ID | data/ connectedCompanies/ connections/ nationalIn | National ID of the connecting element between the connecting entities | 12345678 | Inherited |\n| Connector entity name | data/ connectedCompanies/ connections/ name | | Martin Lucký | Inherited |\n| Type of connector entity (legal, private) | data/ connectedCompanies/ connections/ type | | Person | Inherited |\n| Specific connection between connected companies start date | data/ connectedCompanies/ connections/ activeFrom | Since when does this particular connection exist | 2020-11-09T00:00:00+00:00 | Inherited |\n| Date of when the connections stopped being active | data/ connectedCompanies/ connections/ activeTo | | 2020-11-09T00:00:00+00:00 | No |\n| Role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany | Recursive object | | No |\n| Type of role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany/ type | | Statutory | Inherited |\n| Connector entity role in queried company start date | data/ connectedCompanies/ connections/ roles/ inCompany/ activeFrom | Date on which the connector entity became active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | Inherited |\n| Connector entity role in queried company ended date | data/ connectedCompanies/ connections/ roles/ inCompany/ activeTo | Date on which the connector entity stopped being active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | No |\n| Type of connection | data/ connectedCompanies/ connections/ roles/ inCompany/ connectionType/ code | | partner | Inherited |\n| Ownership share of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany/ share | | 1.0 | Inherited |\n| Role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inCompany/ text/ value | | Jednatel | Inherited |\n| Type of role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ type | | Statutory | Inherited |\n| Connector entity role in queried company start date | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ activeFrom | Date on which the connector entity became active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | Inherited |\n| Connector entity role in queried company ended date | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ activeTo | Date on which the connector entity stopped being active in its role in the queried company. | 2020-11-09T00:00:00+00:00 | No |\n| Type of connection | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ connectionType/ code | | partner | Inherited |\n| Ownership share of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ share | | 1.0 | Inherited |\n| Role of connector entity in the queried company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany/ text/ value | | Jednatel | Inherited |\n| Role of connector entity in the connected company | data/ connectedCompanies/ connections/ roles/ inConnectedCompany | Recursive object | | No |\n| Technical item | data/ connectedCompanies/ metrics/ revenue/ type | Polymorphic identifier | CategoryValueCurrency | Inherited |\n| Revenue (category) of connected company validity start | data/ connectedCompanies/ metrics/ revenue/ validFrom | | 2020-01-01T00:00:00+00:00 | Inherited |\n| Revenue (category) of connected company validity end | data/ connectedCompanies/ metrics/ revenue/ validTo | | 2020-12-31T00:00:00+00:00 | No |\n\n", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/contacts": { "get": { "tags": [ "Obsolete" ], "summary": "Contacts (nationalIn)", "description": "\nDataset description:\n\nContact details for the company split into phones, emails, urls and social media.\nDataset combines 2 levels of contact details - personal and generic.\nWhile generic contacts are isolated, typically like `info@company.com`, a personal contact (phones, emails or professional social media profiles) is linked to a person profile with name and role in the company.\n\n\nAll contact details are regularly verified and we guarantee availability on the source url within the previous 30 days, thereby complying with most GDPR policies. Personal contacts are verified on a weekly basis.\n\nAll our contact data originate from publicly available sources. We do not use any purchased contact lists from 3rd parties.\n\nA contact like `john.smith@company.com` may be considered generic when detailed information about the person (name,role) are not explicitly published on the website or our system is unable to link these into a single profile.\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nUpdates of our contacts differ across sources. While in contacts sourced from company websites are parsed and verified on a continuous basis, company catalogues and contacts coming from job postings follow weekly updates.\n\nSelected use cases:\n\n- avoid GDPR issues by having a publicly available source of your contact, ready to show when challenged\n- filter specific roles in your target company using our Role enumeration and approach only contacts you specifically need\n- increase conversion using our confidence indication and call the numbers we cross-validated across multiple data sources\n- monitor departures from your target company by taking advantage of our Linkedin update tracking / verification service\n\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-----------------------------------------------|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| Contact person ID | data/ contacts/ people/ id | Internal file ID to connect a person with phones, emails, etc. | 1 | Inherited |\n| Contact person unique ID | data/ contacts/ people/ uniqueId | | cz-person-ABC12345677 | Inherited |\n| Contact full name | data/ contacts/ people/ name/ text | Full name of the person (first & last) as a text string | Jiří Částka | Inherited |\n| Contact first name | data/ contacts/ people/ name/ firstName | First name of the contact person | Jiří | No |\n| Contact last name | data/ contacts/ people/ name/ lastName | Last name of the contact person | Částka | No |\n| Contact role (label) | data/ contacts/ people/ roles/ text | Role of the contact person in a given company | Elektromechanický technik | Inherited |\n| Contact role (code) | data/ contacts/ people/ roles/ code | | a8e26a257d | Inherited |\n| Contact role start date | data/ contacts/ people/ roles/ validFrom | Date, when the contact person has been first identified in the role | 2021-03-15T23:36:03+00:00 | Inherited |\n| Contact role end date | data/ contacts/ people/ roles/ validTo | | 2021-03-15T23:36:03+00:00 | No |\n| Contact department text | data/ contacts/ departments/ roles/ text | | ABC123 | Inherited |\n| Contact department code | data/ contacts/ departments/ roles/ code | | Handyman | Inherited |\n| Contact department start date | data/ contacts/ departments/ roles/ validFrom | | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Contact department end date | data/ contacts/ departments/ roles/ validTo | | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number unique ID | data/ contacts/ phoneNumbers/ guid | Technical phone number ID | 84811132-1830-4278-1934-0a78f7636a02 | Inherited |\n| Phone number first entry | data/ contacts/ phoneNumbers/ createdAt | Date on which the phone number has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Phone number last update | data/ contacts/ phoneNumbers/ updatedAt | Last known update of the phone number | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number primary | data/ contacts/ phoneNumbers/ isPrimary | 3 most credible phone numbers (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Phone number confidence | data/ contacts/ phoneNumbers/ confidence | Contact-to-company link confidence | 0.98 | Inherited |\n| Phone number private | data/ contacts/ phoneNumbers/ isPrivate | When TRUE, the phone number has been identified as potentially linked to a specific individual (as opposed to company generic contact) | True | No |\n| Phone number source URL | data/ contacts/ phoneNumbers/ sources/ url | Where has the phone number been found | https://www.zivefirmy.cz/mapro_f1072996?cz=548 | Inherited |\n| Phone number last validity check | data/ contacts/ phoneNumbers/ sources/ lastCheckedAt | Date of last check, when the phone number has been found on the source | 2022-02-16T12:23:52+00:00 | Inherited |\n| Phone number source (code) | data/ contacts/ phoneNumbers/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-zivefirmycz | Inherited |\n| Phone number source (label) | data/ contacts/ phoneNumbers/ sources/ name | Name of the source of information | Zivefirmy.cz | No |\n| Phone number linked contact person ID | data/ contacts/ phoneNumbers/ person/ id | Internal person reference linking the phone number to a person | 42619 | Inherited |\n| Phone number | data/ contacts/ phoneNumbers/ value | The actual phone number | 00420585157811 | Inherited |\n| Email unique ID | data/ contacts/ emails/ guid | TBD | f52f6f95-a039-e93d-08cc-b05a62569c5c | Inherited |\n| Email first entry | data/ contacts/ emails/ createdAt | Date on which the email has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Email last update | data/ contacts/ emails/ updatedAt | Last known update of the email address | 2022-03-04T08:58:08.17+00:00 | No |\n| Email primary | data/ contacts/ emails/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Email confidence | data/ contacts/ emails/ confidence | | 0.98 | Inherited |\n| Email private | data/ contacts/ emails/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Email source URL | data/ contacts/ emails/ sources/ url | Where has the email address been found | https://www.mapro.cz/kontakt/mapro-cz/ | Inherited |\n| Email last validity check | data/ contacts/ emails/ sources/ lastCheckedAt | Date of last check, when the email address has been found on the source | 2022-03-04T08:58:08+00:00 | Inherited |\n| Email source (code) | data/ contacts/ emails/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-uradprace | Inherited |\n| Email source (label) | data/ contacts/ emails/ sources/ name | Name of the source of information | Úřad Práce ČR | No |\n| Email linked contact person ID | data/ contacts/ emails/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Email | data/ contacts/ emails/ value | The actual email address | jelinkova@mapro.cz | Inherited |\n| Website unique ID | data/ contacts/ websites/ guid | Uniqe ID of the specific website | 49307135-52cc-b9bb-4415-e0525bc858d5 | Inherited |\n| Website first entry | data/ contacts/ websites/ createdAt | First date when the website was identified and linked to the company | 2022-02-08T08:35:56.607+00:00 | Inherited |\n| Website last update | data/ contacts/ websites/ updatedAt | Latest update of the website database entry | 2022-02-08T08:35:56.607+00:00 | No |\n| Website primary | data/ contacts/ websites/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Website confidence | data/ contacts/ websites/ confidence | How confident are we that the website belongs to this company (probabilistic matching used) | 0.99 | Inherited |\n| website private | data/ contacts/ websites/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Website source URL | data/ contacts/ websites/ sources/ url | URL of the source, where we have found the website | https://www.edb.eu/czech-firm-119752-mapro-s-r-o/contact | Inherited |\n| Website last validity check | data/ contacts/ websites/ sources/ lastCheckedAt | Date of last check of the information availability on source | 2022-02-08T08:35:57+00:00 | Inherited |\n| Website source (code) | data/ contacts/ websites/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-edb | Inherited |\n| Website source (label) | data/ contacts/ websites/ sources/ name | Name of the source of information | Evropská databanka firem | No |\n| Website linked contact person ID | data/ contacts/ websites/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Website | data/ contacts/ websites/ value | The actual website URL | http://mapro.cz | Inherited |\n| Social media name (code) | data/ contacts/ socialMedia/ type/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account unique ID | data/ contacts/ socialMedia/ guid | Uniqe ID of the specific social media profile | c37707bb-8185-d709-10ba-8eb92e3113f2 | Inherited |\n| Social media account first entry | data/ contacts/ socialMedia/ createdAt | First date when the social media profile was identified and linked to the company | 2022-03-06T09:24:57.24+00:00 | Inherited |\n| Social media account last update | data/ contacts/ socialMedia/ updatedAt | Latest update of the social media profile database entry | 2022-03-06T09:24:57.24+00:00 | No |\n| Social media account primary | data/ contacts/ socialMedia/ isPrimary | Is this the primary profile for the specific social media for this company | True | No |\n| Social media account confidence | data/ contacts/ socialMedia/ confidence | How confident are we that the social media profile belongs to this company (probabilistic matching used) | 1 | Inherited |\n| Social media account private | data/ contacts/ socialMedia/ isPrivate | Is this social media profile personal (i.e., not a company profile, but individual person's profile) | True | No |\n| Social media account source URL | data/ contacts/ socialMedia/ sources/ url | | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |\n| Social media account last validity check | data/ contacts/ socialMedia/ sources/ lastCheckedAt | | 2021-03-15T23:01:19+00:00 | Inherited |\n| Social media account source (code) | data/ contacts/ socialMedia/ sources/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account source (label) | data/ contacts/ socialMedia/ sources/ name | Social media name | Linkedin | No |\n| Social media account linked contact person ID | data/ contacts/ socialMedia/ person/ id | Internal person reference linking the LinkedIn account to a person | 207342 | Inherited |\n| Social media account | data/ contacts/ socialMedia/ value | The actual LinkedIn profile URL | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company unique identifier to get company contacts data for.", "required": true, "schema": { "type": "string", "description": "Company unique identifier to get company contacts data for." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/contacts": { "get": { "tags": [ "Obsolete" ], "summary": "Contacts", "description": "\nDataset description:\n\nContact details for the company split into phones, emails, urls and social media.\nDataset combines 2 levels of contact details - personal and generic.\nWhile generic contacts are isolated, typically like `info@company.com`, a personal contact (phones, emails or professional social media profiles) is linked to a person profile with name and role in the company.\n\n\nAll contact details are regularly verified and we guarantee availability on the source url within the previous 30 days, thereby complying with most GDPR policies. Personal contacts are verified on a weekly basis.\n\nAll our contact data originate from publicly available sources. We do not use any purchased contact lists from 3rd parties.\n\nA contact like `john.smith@company.com` may be considered generic when detailed information about the person (name,role) are not explicitly published on the website or our system is unable to link these into a single profile.\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nUpdates of our contacts differ across sources. While in contacts sourced from company websites are parsed and verified on a continuous basis, company catalogues and contacts coming from job postings follow weekly updates.\n\nSelected use cases:\n\n- avoid GDPR issues by having a publicly available source of your contact, ready to show when challenged\n- filter specific roles in your target company using our Role enumeration and approach only contacts you specifically need\n- increase conversion using our confidence indication and call the numbers we cross-validated across multiple data sources\n- monitor departures from your target company by taking advantage of our Linkedin update tracking / verification service\n\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-----------------------------------------------|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-14615100 | Yes |\n| Contact person ID | data/ contacts/ people/ id | Internal file ID to connect a person with phones, emails, etc. | 1 | Inherited |\n| Contact person unique ID | data/ contacts/ people/ uniqueId | | cz-person-ABC12345677 | Inherited |\n| Contact full name | data/ contacts/ people/ name/ text | Full name of the person (first & last) as a text string | Jiří Částka | Inherited |\n| Contact first name | data/ contacts/ people/ name/ firstName | First name of the contact person | Jiří | No |\n| Contact last name | data/ contacts/ people/ name/ lastName | Last name of the contact person | Částka | No |\n| Contact role (label) | data/ contacts/ people/ roles/ text | Role of the contact person in a given company | Elektromechanický technik | Inherited |\n| Contact role (code) | data/ contacts/ people/ roles/ code | | a8e26a257d | Inherited |\n| Contact role start date | data/ contacts/ people/ roles/ validFrom | Date, when the contact person has been first identified in the role | 2021-03-15T23:36:03+00:00 | Inherited |\n| Contact role end date | data/ contacts/ people/ roles/ validTo | | 2021-03-15T23:36:03+00:00 | No |\n| Contact department text | data/ contacts/ departments/ roles/ text | | ABC123 | Inherited |\n| Contact department code | data/ contacts/ departments/ roles/ code | | Handyman | Inherited |\n| Contact department start date | data/ contacts/ departments/ roles/ validFrom | | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Contact department end date | data/ contacts/ departments/ roles/ validTo | | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number unique ID | data/ contacts/ phoneNumbers/ guid | Technical phone number ID | 84811132-1830-4278-1934-0a78f7636a02 | Inherited |\n| Phone number first entry | data/ contacts/ phoneNumbers/ createdAt | Date on which the phone number has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Phone number last update | data/ contacts/ phoneNumbers/ updatedAt | Last known update of the phone number | 2022-03-04T08:58:08.17+00:00 | No |\n| Phone number primary | data/ contacts/ phoneNumbers/ isPrimary | 3 most credible phone numbers (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Phone number confidence | data/ contacts/ phoneNumbers/ confidence | Contact-to-company link confidence | 0.98 | Inherited |\n| Phone number private | data/ contacts/ phoneNumbers/ isPrivate | When TRUE, the phone number has been identified as potentially linked to a specific individual (as opposed to company generic contact) | True | No |\n| Phone number source URL | data/ contacts/ phoneNumbers/ sources/ url | Where has the phone number been found | https://www.zivefirmy.cz/mapro_f1072996?cz=548 | Inherited |\n| Phone number last validity check | data/ contacts/ phoneNumbers/ sources/ lastCheckedAt | Date of last check, when the phone number has been found on the source | 2022-02-16T12:23:52+00:00 | Inherited |\n| Phone number source (code) | data/ contacts/ phoneNumbers/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-zivefirmycz | Inherited |\n| Phone number source (label) | data/ contacts/ phoneNumbers/ sources/ name | Name of the source of information | Zivefirmy.cz | No |\n| Phone number linked contact person ID | data/ contacts/ phoneNumbers/ person/ id | Internal person reference linking the phone number to a person | 42619 | Inherited |\n| Phone number | data/ contacts/ phoneNumbers/ value | The actual phone number | 00420585157811 | Inherited |\n| Email unique ID | data/ contacts/ emails/ guid | TBD | f52f6f95-a039-e93d-08cc-b05a62569c5c | Inherited |\n| Email first entry | data/ contacts/ emails/ createdAt | Date on which the email has been identified for the first time | 2022-03-04T08:58:08.17+00:00 | Inherited |\n| Email last update | data/ contacts/ emails/ updatedAt | Last known update of the email address | 2022-03-04T08:58:08.17+00:00 | No |\n| Email primary | data/ contacts/ emails/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Email confidence | data/ contacts/ emails/ confidence | | 0.98 | Inherited |\n| Email private | data/ contacts/ emails/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Email source URL | data/ contacts/ emails/ sources/ url | Where has the email address been found | https://www.mapro.cz/kontakt/mapro-cz/ | Inherited |\n| Email last validity check | data/ contacts/ emails/ sources/ lastCheckedAt | Date of last check, when the email address has been found on the source | 2022-03-04T08:58:08+00:00 | Inherited |\n| Email source (code) | data/ contacts/ emails/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-uradprace | Inherited |\n| Email source (label) | data/ contacts/ emails/ sources/ name | Name of the source of information | Úřad Práce ČR | No |\n| Email linked contact person ID | data/ contacts/ emails/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Email | data/ contacts/ emails/ value | The actual email address | jelinkova@mapro.cz | Inherited |\n| Website unique ID | data/ contacts/ websites/ guid | Uniqe ID of the specific website | 49307135-52cc-b9bb-4415-e0525bc858d5 | Inherited |\n| Website first entry | data/ contacts/ websites/ createdAt | First date when the website was identified and linked to the company | 2022-02-08T08:35:56.607+00:00 | Inherited |\n| Website last update | data/ contacts/ websites/ updatedAt | Latest update of the website database entry | 2022-02-08T08:35:56.607+00:00 | No |\n| Website primary | data/ contacts/ websites/ isPrimary | 3 most credible emails (with the highest confidence) per company are referenced as \"primary\" | True | No |\n| Website confidence | data/ contacts/ websites/ confidence | How confident are we that the website belongs to this company (probabilistic matching used) | 0.99 | Inherited |\n| website private | data/ contacts/ websites/ isPrivate | Has thise email address been identfied as possible belonging to a specific individual (as opposed to company generic)? | True | No |\n| Website source URL | data/ contacts/ websites/ sources/ url | URL of the source, where we have found the website | https://www.edb.eu/czech-firm-119752-mapro-s-r-o/contact | Inherited |\n| Website last validity check | data/ contacts/ websites/ sources/ lastCheckedAt | Date of last check of the information availability on source | 2022-02-08T08:35:57+00:00 | Inherited |\n| Website source (code) | data/ contacts/ websites/ sources/ code | Enumeration code for information source at /api/v3/Sources | cz-edb | Inherited |\n| Website source (label) | data/ contacts/ websites/ sources/ name | Name of the source of information | Evropská databanka firem | No |\n| Website linked contact person ID | data/ contacts/ websites/ person/ id | Internal person reference linking the email to a person | 42619 | Inherited |\n| Website | data/ contacts/ websites/ value | The actual website URL | http://mapro.cz | Inherited |\n| Social media name (code) | data/ contacts/ socialMedia/ type/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account unique ID | data/ contacts/ socialMedia/ guid | Uniqe ID of the specific social media profile | c37707bb-8185-d709-10ba-8eb92e3113f2 | Inherited |\n| Social media account first entry | data/ contacts/ socialMedia/ createdAt | First date when the social media profile was identified and linked to the company | 2022-03-06T09:24:57.24+00:00 | Inherited |\n| Social media account last update | data/ contacts/ socialMedia/ updatedAt | Latest update of the social media profile database entry | 2022-03-06T09:24:57.24+00:00 | No |\n| Social media account primary | data/ contacts/ socialMedia/ isPrimary | Is this the primary profile for the specific social media for this company | True | No |\n| Social media account confidence | data/ contacts/ socialMedia/ confidence | How confident are we that the social media profile belongs to this company (probabilistic matching used) | 1 | Inherited |\n| Social media account private | data/ contacts/ socialMedia/ isPrivate | Is this social media profile personal (i.e., not a company profile, but individual person's profile) | True | No |\n| Social media account source URL | data/ contacts/ socialMedia/ sources/ url | | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |\n| Social media account last validity check | data/ contacts/ socialMedia/ sources/ lastCheckedAt | | 2021-03-15T23:01:19+00:00 | Inherited |\n| Social media account source (code) | data/ contacts/ socialMedia/ sources/ code | Enumeration code for information source at /api/v3/Sources | linkedin | Inherited |\n| Social media account source (label) | data/ contacts/ socialMedia/ sources/ name | Social media name | Linkedin | No |\n| Social media account linked contact person ID | data/ contacts/ socialMedia/ person/ id | Internal person reference linking the LinkedIn account to a person | 207342 | Inherited |\n| Social media account | data/ contacts/ socialMedia/ value | The actual LinkedIn profile URL | https://www.linkedin.com/in/ale%C5%A1-krac%C3%ADk-b8a1421a7 | Inherited |\n\n", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/indicators": { "get": { "tags": [ "Company Single Request" ], "summary": "Indicators (nationalIn)", "description": "\nDataset description:\n\nIndicators describe how a company ranks in a selected topic when compared to other companies. Each indicator is a summary of multiple individual drivers.\n\nSome commonly available indicators are:\n\n**Activity** evaluates how \"alive\" a company is. Drivers such as hiring, self-promotion, report submission, media coverage, website status enter the indicator.\n**Reachability** evaluates how a company publishes and updates its contact information, effectively allowing the outer world to get in touch.\n**Growth** evaluates metrics and activity describing dynamics of the company. Drivers typically include changes in revenue, staff, purchase of assets.\n\nAvailability:\n\ncz,de\n\nDataset updates:\n\nIndicators are recalculated on a weekly basis.\n\nSelected use cases:\n\n- remove shell or SPV companies from your portfolio by filtering on Activity\n- identify opportunities for your sales using Growth\n- increase conversions and acquisition speed using Reachability\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------|-----------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-61503339 | Yes |\n| Activity indicator value | data/ indicators/ activity/ timeline/ value | Position on a scale from 0 (worst) to 100 | 46 | Inherited |\n| Activity indicator driver (code) | data/ indicators/ activity/ timeline/ drivers/ code | Source enum code for /api/v3/companies/enums/indicator-drivers (multiple drivers allowed) | MRK00054 | Inherited |\n| Activity indicator driver weight | data/ indicators/ activity/ timeline/ drivers/ weight | How many \"points\" does the driver contribute to the indicator (multiple drivers allowed) | 15 | Inherited |\n| Activity indicator driver (label) | data/ indicators/ activity/ timeline/ drivers/ name | Name of the contributing driver | Google profile | Inherited |\n| Activity indicator driver validity start | data/ indicators/ activity/ timeline/ validFrom | When was the driver identified | 2022-03-13T00:00:00+00:00 | Inherited |\n| Activity indicator driver validity end | data/ indicators/ activity/ timeline/ validTo | | 2022-03-13T00:00:00+00:00 | No |\n| Reachability indicator value | data/ indicators/ reachability/ timeline/ value | Position on a scale from 0 (worst) to 100 | 51 | Inherited |\n| Reachability indicator driver (code) | data/ indicators/ reachability/ timeline/ drivers/ code | Source enum code for /api/v3/companies/enums/indicator-drivers (multiple drivers allowed) | MRK00124 | Inherited |\n| Reachability indicator driver weight | data/ indicators/ reachability/ timeline/ drivers/ weight | How many \"points\" does the driver contribute to the indicator (multiple drivers allowed) | -60 | Inherited |\n| Reachability indicator driver (label) | data/ indicators/ reachability/ timeline/ drivers/ name | Name of the contributing driver | HQ at frequented address (risk of SPV) | Inherited |\n| Reachability indicator driver validity start | data/ indicators/ reachability/ timeline/ validFrom | When was the driver identified | 2022-03-13T00:00:00+00:00 | Inherited |\n| Reachability indicator driver validity end | data/ indicators/ reachability/ timeline/ validTo | | 2022-03-13T00:00:00+00:00 | No |\n| Growth indicator value | data/ indicators/ growth/ timeline/ value | Position on a scale from 0 (worst) to 100 | 62 | Inherited |\n| Growth indicator driver (code) | data/ indicators/ growth/ timeline/ drivers/ code | Source enum code for /api/v3/companies/enums/indicator-drivers (multiple drivers allowed) | MRK00051 | Inherited |\n| Growth indicator driver weight | data/ indicators/ growth/ timeline/ drivers/ weight | How many \"points\" does the driver contribute to the indicator (multiple drivers allowed) | 36 | Inherited |\n| Growth indicator driver (label) | data/ indicators/ growth/ timeline/ drivers/ name | Name of the contributing driver | Very intensive hiring activity during last 6 months | Inherited |\n| Growth indicator driver validity start | data/ indicators/ growth/ timeline/ validFrom | When was the driver identified | 2022-03-13T00:00:00+00:00 | Inherited |\n| Growth indicator driver validity end | data/ indicators/ growth/ timeline/ validTo | | 2022-03-13T00:00:00+00:00 | No |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company unique identifier to get owned companies data for.", "required": true, "schema": { "type": "string", "description": "Company unique identifier to get owned companies data for." } }, { "name": "includeExpired", "in": "query", "description": "Specifies whether or not expired indicators are included in result set.", "schema": { "type": "boolean", "description": "Specifies whether or not expired indicators are included in result set.", "default": false } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/indicators": { "get": { "tags": [ "Company Collection Request" ], "summary": "Indicators", "description": "\nDataset description:\n\nIndicators describe how a company ranks in a selected topic when compared to other companies. Each indicator is a summary of multiple individual drivers.\n\nSome commonly available indicators are:\n\n**Activity** evaluates how \"alive\" a company is. Drivers such as hiring, self-promotion, report submission, media coverage, website status enter the indicator.\n**Reachability** evaluates how a company publishes and updates its contact information, effectively allowing the outer world to get in touch.\n**Growth** evaluates metrics and activity describing dynamics of the company. Drivers typically include changes in revenue, staff, purchase of assets.\n\nAvailability:\n\ncz,de\n\nDataset updates:\n\nIndicators are recalculated on a weekly basis.\n\nSelected use cases:\n\n- remove shell or SPV companies from your portfolio by filtering on Activity\n- identify opportunities for your sales using Growth\n- increase conversions and acquisition speed using Reachability\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------|-----------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-61503339 | Yes |\n| Activity indicator value | data/ indicators/ activity/ timeline/ value | Position on a scale from 0 (worst) to 100 | 46 | Inherited |\n| Activity indicator driver (code) | data/ indicators/ activity/ timeline/ drivers/ code | Source enum code for /api/v3/companies/enums/indicator-drivers (multiple drivers allowed) | MRK00054 | Inherited |\n| Activity indicator driver weight | data/ indicators/ activity/ timeline/ drivers/ weight | How many \"points\" does the driver contribute to the indicator (multiple drivers allowed) | 15 | Inherited |\n| Activity indicator driver (label) | data/ indicators/ activity/ timeline/ drivers/ name | Name of the contributing driver | Google profile | Inherited |\n| Activity indicator driver validity start | data/ indicators/ activity/ timeline/ validFrom | When was the driver identified | 2022-03-13T00:00:00+00:00 | Inherited |\n| Activity indicator driver validity end | data/ indicators/ activity/ timeline/ validTo | | 2022-03-13T00:00:00+00:00 | No |\n| Reachability indicator value | data/ indicators/ reachability/ timeline/ value | Position on a scale from 0 (worst) to 100 | 51 | Inherited |\n| Reachability indicator driver (code) | data/ indicators/ reachability/ timeline/ drivers/ code | Source enum code for /api/v3/companies/enums/indicator-drivers (multiple drivers allowed) | MRK00124 | Inherited |\n| Reachability indicator driver weight | data/ indicators/ reachability/ timeline/ drivers/ weight | How many \"points\" does the driver contribute to the indicator (multiple drivers allowed) | -60 | Inherited |\n| Reachability indicator driver (label) | data/ indicators/ reachability/ timeline/ drivers/ name | Name of the contributing driver | HQ at frequented address (risk of SPV) | Inherited |\n| Reachability indicator driver validity start | data/ indicators/ reachability/ timeline/ validFrom | When was the driver identified | 2022-03-13T00:00:00+00:00 | Inherited |\n| Reachability indicator driver validity end | data/ indicators/ reachability/ timeline/ validTo | | 2022-03-13T00:00:00+00:00 | No |\n| Growth indicator value | data/ indicators/ growth/ timeline/ value | Position on a scale from 0 (worst) to 100 | 62 | Inherited |\n| Growth indicator driver (code) | data/ indicators/ growth/ timeline/ drivers/ code | Source enum code for /api/v3/companies/enums/indicator-drivers (multiple drivers allowed) | MRK00051 | Inherited |\n| Growth indicator driver weight | data/ indicators/ growth/ timeline/ drivers/ weight | How many \"points\" does the driver contribute to the indicator (multiple drivers allowed) | 36 | Inherited |\n| Growth indicator driver (label) | data/ indicators/ growth/ timeline/ drivers/ name | Name of the contributing driver | Very intensive hiring activity during last 6 months | Inherited |\n| Growth indicator driver validity start | data/ indicators/ growth/ timeline/ validFrom | When was the driver identified | 2022-03-13T00:00:00+00:00 | Inherited |\n| Growth indicator driver validity end | data/ indicators/ growth/ timeline/ validTo | | 2022-03-13T00:00:00+00:00 | No |\n\n", "parameters": [ { "name": "IncludeExpired", "in": "query", "description": "If set to true expired timeline entries will be returned; otherwise only valid ones are returned.", "schema": { "type": "boolean", "description": "If set to true expired timeline entries will be returned; otherwise only valid ones are returned." } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/metrics": { "get": { "tags": [ "Company Single Request" ], "summary": "Metrics (nationalIn)", "description": "Dataset description:\n\nMetrics provide convenient summaries across other available datasets. Some metrics are taken from other datasets at face value (typically basic financials).\n\nEvery company metric has a \"timeline\" array. The array contains elements with metric value and time interval in which metric value is relevant.\n\nEvery metric can have its specific metric value type. Possible metric types are:\n- CategoryValueCurrency\n- Category\n- ValueRatio\n- ValueBool\n- ValueCurrency\n- Value\n- ValueRange\n- ValueRangeCurrency\n- ValueRangeRatio\n\nAvailability:\n\ncz, sk, hu\n\nAvailablity of metrics across markets differs significnatly. The below applies to cz only:\n\n| Metric | Metric Type | Description |\n|-----------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `agriculturalLandMetersSquared` | Value | Total land farmed by company in square meters. |\n| `agriculturalSubsidiesRecipientYearly` | ValueCurrency | Agricultural subsidies which company received per calendar year; subset of `subsidiesRecipientYearly`. |\n| `capitalIntensityRatio` | ValueRatio | Total company assets divided by total revenues. Lower the ratio, the less capital company needs to invest to run its business. |\n| `connectedCompaniesAggregatedEmployees` | ValueRange | Connected companies' aggregated employees | \n| `connectedCompaniesAggregatedRevenues` | ValueRangeCurrency _or_ ValueCurrency | Connected companies' aggregated revenues |\n| `connectedCompaniesCount` | Value | Connected companies count |\n| `costOfGoodsSold` | ValueCurrency | Sourced directly from financial statements. (The direct costs of producing the goods sold by a company. It includes the cost of the materials and labor directly used to create the good. It excludes indirect expenses, such as distribution and sales force costs.) |\n| `ebit` | ValueCurrency | Sourced directly from financial statements. Profit before interests and taxes. |\n| `ebitda` | ValueCurrency | Profit before interest, taxes, deprecation and amortization. Calculated from ebit plus D&A. |\n| `ebitMargin` | ValueRatio | Calculated ratio of ebit to total revenue. (Lower ebit margin means reduction in revenue or higher cost management. Higher ebit margin means more profitable business or more efficient cost management.) |\n| `employees` | Category | Total number of employees expressed by category code. Employee ranges are sourced from Czech Statistical Office as reported by Czech Social Security Administration with approximately few months delay. |\n| `employees12MonthsAvgGrowth` | ValueRatio | Change in the number of employees over the last 12 months. If calculated from range, the middle value of the interval is used for the computation |\n| `employees24MonthsAvgGrowth` | ValueRatio | Change in the number of employees over the last 24 months. If calculated from range, the middle value of the interval is used for the computation |\n| `foreignOwnershipShare` | ValueRatio | Share of owners of the company residing in other countries than Czechia. |\n| `isExporter` | ValueBool | Boolean value indicating whether company is likely exporter; based on a set of various features. |\n| `isFarmer` | ValueBool | Boolean value indicating whether the underlying company is likely a farmer; based on a set of various features. |\n| `isImporter` | ValueBool | Boolean value indicating whether company is likely importer; based on a set of various features. |\n| `latestFinancialsAvailable` | Value | Year from which the latest financials are available. (Note that when the accounting period ends for example in March 2019, the value of this metric can be 2018 as most of the value generated by the given company were generated in that year.) |\n| `netProfit` | ValueCurrency | Sourced directly from the financial statements. |\n| `netProfitMargin` | ValueRatio | Ratio of net profit to total revenue. (0.1 profit margin means for each $1 of revenue the company earns $0.10 in net profit.) |\n| `openJobCountCurrentAnnonce` | Value | Number of company's current job openings advertised on the \"annonce.cz\" website. |\n| `openJobCountCurrentJobsCz` | Value | Number of company's current job openings advertised on the \"jobs.cz\" website. |\n| `openJobCountCurrentLaborOfficeCz` | Value | Number of company's current job openings advertised on the \"uradprace.cz\" website. |\n| `openJobCountCurrentPraceCz` | Value | Number of company's current job openings advertised on the \"prace.cz\" website. |\n| `openJobCountCurrentProfesiaCz` | Value | Number of company's current job openings advertised on the \"profesia.cz\" website. |\n| `openJobCountCurrentProfesiaSk` | Value | Number of company's current job openings advertised on the \"profesia.sk\" website. |\n| `openJobCountCurrentStartupJobs` | Value | Number of company's current job openings advertised on the \"startupjobs.cz\" website. |\n| `openJobCountCurrentTotal` | Value | Sum of all company's current job openings advertised on all monitored websites such as \"prace.cz\", \"jobs.cz\" etc. |\n| `openJobCountMonthly` | Value | Number of company's open job by specific months. |\n| `openJobCount12MonthsAverage` | Value | Average of company's open jobs per year. Calculated as simple average of the last 12 months. |\n| `openJobCountCurrentTo12MonthsAverage` | ValueRatio | Ratio of _openJobCountCurrentTotal_ to _openJobCount12MonthsAverage_. |\n| `openJobCountCurrentTotalToEmployees` | ValueRangeRatio | Sum of all company's job current openings divided by total number of employees. Result is in lower and upper bound since number of employees are expressed by category code referring to a value range. |\n| `personnelMonthlyCostPerEmployee` | ValueRangeCurrency | Personnel cost divided by 12 (months) and by number of employees. Result is in lower and upper bound since number of employees are expressed by category code referring to a value range. |\n| `personnelCost` | ValueCurrency | Sourced directly from financial statements. (Total amount of money (including taxes, social security insurance etc.) payable by employer to employees.) |\n| `privateOwnershipShare` | ValueRatio | Sum of natural persons' shares in the company. (Only direct ownership is taken into account.) |\n| `publicContractsBuyerLast12Months` | ValueCurrency | Sum of values of public contracts from the last 12 months where a company appears as buyer. |\n| `publicContractsBuyerYearly` | ValueCurrency | Sum of values of public contracts where a company appears as buyer, per calendar year. |\n| `publicContractsSupplierLast12Months` | ValueCurrency | Value of public contracts from the last 12 months where a company appears as supplier. |\n| `publicContractsSupplierYearly` | ValueCurrency | Sum of values of public contracts where a company appears as supplier, per calendar year. |\n| `publicOwnershipShare` | ValueRatio | Ratio of public ownership share in the company. Mostly based on institutional sector of the company as sourced from the Czech Statistical Office. |\n| `registeredCapital` | ValueCurrency | Registered capital sourced from Business Register. |\n| `revenue` | Category or CategoryValueCurrency | Total revenues, either sourced directly from financial statements where available or as reported to the Czech Statistical Office. |\n| `revenueGrowth` | ValueRatio | Increase, or decrease, in a company’s sales between two periods. Formula is (_total revenue t0_ - _total revenue t-1) - 1 |\n| `revenuePerEmployee` | ValueRangeCurrency | Ratio of total revenue to number of employees.((Roughly measures how much money each employee generates for the company.) |\n| `subsidiesRecipientLast12Months` | ValueCurrency | Subsidies which company received in the last 12 months. |\n| `subsidiesRecipientYearly` | ValueCurrency | Subsidies which company received per calendar year. |\n| `valueAddedRatio` | ValueRatio | Calculated as _value added_ divided by _total revenues_. _Value added_ is sourced directly from financial statements, roughly as _operating revenues_ minus _operating expenses_. |\n| `vehiclesOperatedTotal` | Value | Total number of company's operated vehicles. |\n| `vehiclesOwnedTotal` | Value | Total number of company's owned vehicles. |\n| `vehiclesRegistered12Months` | Value | Number of company's vehicles registered in last 12 months. |\n| `vehiclesRegistered12MonthsChange` | ValueRatio | Ratio of change in number of registered vehicles in 12 months. |\n| `whiteCollar` | ValueRatio | A Bizmachine estimate of the white collar workers in the company based on various features of the company. |\nDataset updates:\n\nMetrics are updated at varying frequency as each metric is computed as a summary/aggregate of one of our other datasets (f.e. vehicle related metrics depend on the update of the vehicles dataset). Please follow documentation of other datasets to learn their updates.\n\nSelected use cases:\n\n- segment companies by size using multiple criteria (revenue, assets, hiring, fleet size)\n- compute trend of metrics in time\n- compute your own ratios (vehicles per employee, white collar employees, employee turnaround from hiring)\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-----------------------------------------|---------------------------------------------------------------|----------------------------------------------------------------------------------|-------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-46965823 | Yes |\n| Company metric name | data/ company/ metrics/ metricName/ name | Name of the metric | Connected companies' aggregated employees | Yes |\n| Company metric parameter 1 | data/ company/ metrics/ metricName/ timeline/ lowerBound | | 150 | No |\n| Company metric parameter N | data/ company/ metrics/ metricName/ timeline/ upperBound | | 298 | No |\n| Type of company metric | data/ company/ metrics/ metricName/ timeline/ type | | ValueRange | Yes |\n| Company metric current value start date | data/ company/ metrics/ metricName/ timeline/ validFrom | First date when the current value of metric has been identified | 2018-06-01T00:00:00+00:00 | Yes |\n| Company metric current value end date | data/ company/ metrics/ metricName/ timeline/ validTo | Last date when the current value of metric has been identified | 2018-06-01T00:00:00+00:00 | No |\n| Company metric category code | data/ company/ metrics/ metricName/ timeline/ category/ code | | 19 | No |\n| Company metric category with value | data/ company/ metrics/ metricName/ timeline/ value/ amount | | 27560000.0 | No |\n| Company metric category with currency | data/ company/ metrics/ metricName/ timeline/ value/ currency | | CZK | No |\n| Company metric value | data/ company/ metrics/ metricName/ timeline/ value | Can be number or a boolean | 1000 | No |\n| Company metric unit of value | data/ company/ metrics/ metricName/ timeline/ value/ unit | | m2 | No |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "NationalIn identifier as a string.", "required": true, "schema": { "type": "string", "description": "NationalIn identifier as a string." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/metrics": { "get": { "tags": [ "Company Collection Request" ], "summary": "Metrics", "description": "Dataset description:\n\nMetrics provide convenient summaries across other available datasets. Some metrics are taken from other datasets at face value (typically basic financials).\n\nEvery company metric has a \"timeline\" array. The array contains elements with metric value and time interval in which metric value is relevant.\n\nEvery metric can have its specific metric value type. Possible metric types are:\n- CategoryValueCurrency\n- Category\n- ValueRatio\n- ValueBool\n- ValueCurrency\n- Value\n- ValueRange\n- ValueRangeCurrency\n- ValueRangeRatio\n\nAvailability:\n\ncz, sk, hu\n\nAvailablity of metrics across markets differs significnatly. The below applies to cz only:\n\n| Metric | Metric Type | Description |\n|-----------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `agriculturalLandMetersSquared` | Value | Total land farmed by company in square meters. |\n| `agriculturalSubsidiesRecipientYearly` | ValueCurrency | Agricultural subsidies which company received per calendar year; subset of `subsidiesRecipientYearly`. |\n| `capitalIntensityRatio` | ValueRatio | Total company assets divided by total revenues. Lower the ratio, the less capital company needs to invest to run its business. |\n| `connectedCompaniesAggregatedEmployees` | ValueRange | Connected companies' aggregated employees | \n| `connectedCompaniesAggregatedRevenues` | ValueRangeCurrency _or_ ValueCurrency | Connected companies' aggregated revenues |\n| `connectedCompaniesCount` | Value | Connected companies count |\n| `costOfGoodsSold` | ValueCurrency | Sourced directly from financial statements. (The direct costs of producing the goods sold by a company. It includes the cost of the materials and labor directly used to create the good. It excludes indirect expenses, such as distribution and sales force costs.) |\n| `ebit` | ValueCurrency | Sourced directly from financial statements. Profit before interests and taxes. |\n| `ebitda` | ValueCurrency | Profit before interest, taxes, deprecation and amortization. Calculated from ebit plus D&A. |\n| `ebitMargin` | ValueRatio | Calculated ratio of ebit to total revenue. (Lower ebit margin means reduction in revenue or higher cost management. Higher ebit margin means more profitable business or more efficient cost management.) |\n| `employees` | Category | Total number of employees expressed by category code. Employee ranges are sourced from Czech Statistical Office as reported by Czech Social Security Administration with approximately few months delay. |\n| `employees12MonthsAvgGrowth` | ValueRatio | Change in the number of employees over the last 12 months. If calculated from range, the middle value of the interval is used for the computation |\n| `employees24MonthsAvgGrowth` | ValueRatio | Change in the number of employees over the last 24 months. If calculated from range, the middle value of the interval is used for the computation |\n| `foreignOwnershipShare` | ValueRatio | Share of owners of the company residing in other countries than Czechia. |\n| `isExporter` | ValueBool | Boolean value indicating whether company is likely exporter; based on a set of various features. |\n| `isFarmer` | ValueBool | Boolean value indicating whether the underlying company is likely a farmer; based on a set of various features. |\n| `isImporter` | ValueBool | Boolean value indicating whether company is likely importer; based on a set of various features. |\n| `latestFinancialsAvailable` | Value | Year from which the latest financials are available. (Note that when the accounting period ends for example in March 2019, the value of this metric can be 2018 as most of the value generated by the given company were generated in that year.) |\n| `netProfit` | ValueCurrency | Sourced directly from the financial statements. |\n| `netProfitMargin` | ValueRatio | Ratio of net profit to total revenue. (0.1 profit margin means for each $1 of revenue the company earns $0.10 in net profit.) |\n| `openJobCountCurrentAnnonce` | Value | Number of company's current job openings advertised on the \"annonce.cz\" website. |\n| `openJobCountCurrentJobsCz` | Value | Number of company's current job openings advertised on the \"jobs.cz\" website. |\n| `openJobCountCurrentLaborOfficeCz` | Value | Number of company's current job openings advertised on the \"uradprace.cz\" website. |\n| `openJobCountCurrentPraceCz` | Value | Number of company's current job openings advertised on the \"prace.cz\" website. |\n| `openJobCountCurrentProfesiaCz` | Value | Number of company's current job openings advertised on the \"profesia.cz\" website. |\n| `openJobCountCurrentProfesiaSk` | Value | Number of company's current job openings advertised on the \"profesia.sk\" website. |\n| `openJobCountCurrentStartupJobs` | Value | Number of company's current job openings advertised on the \"startupjobs.cz\" website. |\n| `openJobCountCurrentTotal` | Value | Sum of all company's current job openings advertised on all monitored websites such as \"prace.cz\", \"jobs.cz\" etc. |\n| `openJobCountMonthly` | Value | Number of company's open job by specific months. |\n| `openJobCount12MonthsAverage` | Value | Average of company's open jobs per year. Calculated as simple average of the last 12 months. |\n| `openJobCountCurrentTo12MonthsAverage` | ValueRatio | Ratio of _openJobCountCurrentTotal_ to _openJobCount12MonthsAverage_. |\n| `openJobCountCurrentTotalToEmployees` | ValueRangeRatio | Sum of all company's job current openings divided by total number of employees. Result is in lower and upper bound since number of employees are expressed by category code referring to a value range. |\n| `personnelMonthlyCostPerEmployee` | ValueRangeCurrency | Personnel cost divided by 12 (months) and by number of employees. Result is in lower and upper bound since number of employees are expressed by category code referring to a value range. |\n| `personnelCost` | ValueCurrency | Sourced directly from financial statements. (Total amount of money (including taxes, social security insurance etc.) payable by employer to employees.) |\n| `privateOwnershipShare` | ValueRatio | Sum of natural persons' shares in the company. (Only direct ownership is taken into account.) |\n| `publicContractsBuyerLast12Months` | ValueCurrency | Sum of values of public contracts from the last 12 months where a company appears as buyer. |\n| `publicContractsBuyerYearly` | ValueCurrency | Sum of values of public contracts where a company appears as buyer, per calendar year. |\n| `publicContractsSupplierLast12Months` | ValueCurrency | Value of public contracts from the last 12 months where a company appears as supplier. |\n| `publicContractsSupplierYearly` | ValueCurrency | Sum of values of public contracts where a company appears as supplier, per calendar year. |\n| `publicOwnershipShare` | ValueRatio | Ratio of public ownership share in the company. Mostly based on institutional sector of the company as sourced from the Czech Statistical Office. |\n| `registeredCapital` | ValueCurrency | Registered capital sourced from Business Register. |\n| `revenue` | Category or CategoryValueCurrency | Total revenues, either sourced directly from financial statements where available or as reported to the Czech Statistical Office. |\n| `revenueGrowth` | ValueRatio | Increase, or decrease, in a company’s sales between two periods. Formula is (_total revenue t0_ - _total revenue t-1) - 1 |\n| `revenuePerEmployee` | ValueRangeCurrency | Ratio of total revenue to number of employees.((Roughly measures how much money each employee generates for the company.) |\n| `subsidiesRecipientLast12Months` | ValueCurrency | Subsidies which company received in the last 12 months. |\n| `subsidiesRecipientYearly` | ValueCurrency | Subsidies which company received per calendar year. |\n| `valueAddedRatio` | ValueRatio | Calculated as _value added_ divided by _total revenues_. _Value added_ is sourced directly from financial statements, roughly as _operating revenues_ minus _operating expenses_. |\n| `vehiclesOperatedTotal` | Value | Total number of company's operated vehicles. |\n| `vehiclesOwnedTotal` | Value | Total number of company's owned vehicles. |\n| `vehiclesRegistered12Months` | Value | Number of company's vehicles registered in last 12 months. |\n| `vehiclesRegistered12MonthsChange` | ValueRatio | Ratio of change in number of registered vehicles in 12 months. |\n| `whiteCollar` | ValueRatio | A Bizmachine estimate of the white collar workers in the company based on various features of the company. |\nDataset updates:\n\nMetrics are updated at varying frequency as each metric is computed as a summary/aggregate of one of our other datasets (f.e. vehicle related metrics depend on the update of the vehicles dataset). Please follow documentation of other datasets to learn their updates.\n\nSelected use cases:\n\n- segment companies by size using multiple criteria (revenue, assets, hiring, fleet size)\n- compute trend of metrics in time\n- compute your own ratios (vehicles per employee, white collar employees, employee turnaround from hiring)\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-----------------------------------------|---------------------------------------------------------------|----------------------------------------------------------------------------------|-------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-46965823 | Yes |\n| Company metric name | data/ company/ metrics/ metricName/ name | Name of the metric | Connected companies' aggregated employees | Yes |\n| Company metric parameter 1 | data/ company/ metrics/ metricName/ timeline/ lowerBound | | 150 | No |\n| Company metric parameter N | data/ company/ metrics/ metricName/ timeline/ upperBound | | 298 | No |\n| Type of company metric | data/ company/ metrics/ metricName/ timeline/ type | | ValueRange | Yes |\n| Company metric current value start date | data/ company/ metrics/ metricName/ timeline/ validFrom | First date when the current value of metric has been identified | 2018-06-01T00:00:00+00:00 | Yes |\n| Company metric current value end date | data/ company/ metrics/ metricName/ timeline/ validTo | Last date when the current value of metric has been identified | 2018-06-01T00:00:00+00:00 | No |\n| Company metric category code | data/ company/ metrics/ metricName/ timeline/ category/ code | | 19 | No |\n| Company metric category with value | data/ company/ metrics/ metricName/ timeline/ value/ amount | | 27560000.0 | No |\n| Company metric category with currency | data/ company/ metrics/ metricName/ timeline/ value/ currency | | CZK | No |\n| Company metric value | data/ company/ metrics/ metricName/ timeline/ value | Can be number or a boolean | 1000 | No |\n| Company metric unit of value | data/ company/ metrics/ metricName/ timeline/ value/ unit | | m2 | No |\n\n", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/nace-codes": { "get": { "tags": [ "Obsolete" ], "summary": "NACE Codes", "description": "\nDataset description:\n\nNACE codes are a system of European industry classification. Most commonly a national statistical authority is responsible for maintaining NACE enumeration and assignment of companies into or multiple NACE categories.\nIn addition to collection of official datasets, BizMachine uses an AI model (cz only) to classify the company into a \"true\" NACE code given free-text description on the website or other company catalogues. Such codes are available in the dataset as \"identified\"\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nDataset is updated on a monthly basis\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|--------------------------------------------|-----------------------------------|----------------------------------------------------------------------------------|---------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-05450641 | Yes |\n| Source(s) of primary NACE data (code) | data/ nace/ primary/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of primary NACE data (label) | data/ nace/ primary/ source/ name | | Český statistický úřad | No |\n| Primary NACE validated | data/ nace/ primary/ isVerified | NACE validated using an alternative source | False | No |\n| Primary NACE (code) | data/ nace/ primary/ code | NACE enumeration for /api/v3/nace-codes | 74 | Yes |\n| Primary NACE (label) | data/ nace/ primary/ name | Name of the NACE as published by public administration | Other professional, scientific and technical activities | No |\n| Confidence in identified NACE code | data/ nace/ primary/ confidence | | 0.9 | Inherited |\n| Primary NACE identification method | data/ nace/ primary/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Source(s) of non-primary NACE data (code) | data/ nace/ other/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of non-primary NACE data (label) | data/ nace/ other/ source/ name | | Český statistický úřad | No |\n| Non-primary NACE validated | data/ nace/ other/ isVerified | NACE validated using an alternative source | False | No |\n| Non-primary NACE (code) | data/ nace/ other/ code | NACE enumeration for /api/v3/nace-codes | 6820 | Yes |\n| Non-primary NACE (label) | data/ nace/ other/ name | | Renting and operating of own or leased real estate | No |\n| Non-primary NACE identification method | data/ nace/ other/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Confidence in identified NACE code | data/ nace/ other/ confidence | | 0.9 | No |\n\n", "parameters": [ { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/nace-codes": { "get": { "tags": [ "Obsolete" ], "summary": "NACE Codes (nationalIn)", "description": "\nDataset description:\n\nNACE codes are a system of European industry classification. Most commonly a national statistical authority is responsible for maintaining NACE enumeration and assignment of companies into or multiple NACE categories.\nIn addition to collection of official datasets, BizMachine uses an AI model (cz only) to classify the company into a \"true\" NACE code given free-text description on the website or other company catalogues. Such codes are available in the dataset as \"identified\"\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nDataset is updated on a monthly basis\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|--------------------------------------------|-----------------------------------|----------------------------------------------------------------------------------|---------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-05450641 | Yes |\n| Source(s) of primary NACE data (code) | data/ nace/ primary/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of primary NACE data (label) | data/ nace/ primary/ source/ name | | Český statistický úřad | No |\n| Primary NACE validated | data/ nace/ primary/ isVerified | NACE validated using an alternative source | False | No |\n| Primary NACE (code) | data/ nace/ primary/ code | NACE enumeration for /api/v3/nace-codes | 74 | Yes |\n| Primary NACE (label) | data/ nace/ primary/ name | Name of the NACE as published by public administration | Other professional, scientific and technical activities | No |\n| Confidence in identified NACE code | data/ nace/ primary/ confidence | | 0.9 | Inherited |\n| Primary NACE identification method | data/ nace/ primary/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Source(s) of non-primary NACE data (code) | data/ nace/ other/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of non-primary NACE data (label) | data/ nace/ other/ source/ name | | Český statistický úřad | No |\n| Non-primary NACE validated | data/ nace/ other/ isVerified | NACE validated using an alternative source | False | No |\n| Non-primary NACE (code) | data/ nace/ other/ code | NACE enumeration for /api/v3/nace-codes | 6820 | Yes |\n| Non-primary NACE (label) | data/ nace/ other/ name | | Renting and operating of own or leased real estate | No |\n| Non-primary NACE identification method | data/ nace/ other/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Confidence in identified NACE code | data/ nace/ other/ confidence | | 0.9 | No |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company unique identifier to get company data for.", "required": true, "schema": { "type": "string", "description": "Company unique identifier to get company data for." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/nace-codes": { "get": { "tags": [ "Company Collection Request" ], "summary": "NACE Codes", "description": "\nDataset description:\n\nNACE codes are a system of European industry classification. Most commonly a national statistical authority is responsible for maintaining NACE enumeration and assignment of companies into or multiple NACE categories.\nIn addition to collection of official datasets, BizMachine uses an AI model (cz only) to classify the company into a \"true\" NACE code given free-text description on the website or other company catalogues. Such codes are available in the dataset as \"identified\"\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nDataset is updated on a monthly basis\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|--------------------------------------------|-----------------------------------|----------------------------------------------------------------------------------|---------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-05450641 | Yes |\n| Source(s) of primary NACE data (code) | data/ nace/ primary/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of primary NACE data (label) | data/ nace/ primary/ source/ name | | Český statistický úřad | No |\n| Primary NACE validated | data/ nace/ primary/ isVerified | NACE validated using an alternative source | False | No |\n| Primary NACE (code) | data/ nace/ primary/ code | NACE enumeration for /api/v3/nace-codes | 74 | Yes |\n| Primary NACE (label) | data/ nace/ primary/ name | Name of the NACE as published by public administration | Other professional, scientific and technical activities | No |\n| Confidence in identified NACE code | data/ nace/ primary/ confidence | | 0.9 | Inherited |\n| Primary NACE identification method | data/ nace/ primary/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Source(s) of non-primary NACE data (code) | data/ nace/ other/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of non-primary NACE data (label) | data/ nace/ other/ source/ name | | Český statistický úřad | No |\n| Non-primary NACE validated | data/ nace/ other/ isVerified | NACE validated using an alternative source | False | No |\n| Non-primary NACE (code) | data/ nace/ other/ code | NACE enumeration for /api/v3/nace-codes | 6820 | Yes |\n| Non-primary NACE (label) | data/ nace/ other/ name | | Renting and operating of own or leased real estate | No |\n| Non-primary NACE identification method | data/ nace/ other/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Confidence in identified NACE code | data/ nace/ other/ confidence | | 0.9 | No |\n\n", "parameters": [ { "name": "Code", "in": "query", "description": "Specific NACE code to search by.", "schema": { "type": "string", "description": "Specific NACE code to search by.", "nullable": true } }, { "name": "Type", "in": "query", "description": "Type of the NACE code.", "schema": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Company.Models.NaceCodes.Enums.NaceTypeEnum" } }, { "name": "IsPrimary", "in": "query", "description": "Should the return data contain only primary NACE codes?", "schema": { "type": "boolean", "description": "Should the return data contain only primary NACE codes?", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/nace-codes": { "get": { "tags": [ "Company Single Request" ], "summary": "NACE Codes", "description": "\nDataset description:\n\nNACE codes are a system of European industry classification. Most commonly a national statistical authority is responsible for maintaining NACE enumeration and assignment of companies into or multiple NACE categories.\nIn addition to collection of official datasets, BizMachine uses an AI model (cz only) to classify the company into a \"true\" NACE code given free-text description on the website or other company catalogues. Such codes are available in the dataset as \"identified\"\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nDataset is updated on a monthly basis\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|--------------------------------------------|-----------------------------------|----------------------------------------------------------------------------------|---------------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-05450641 | Yes |\n| Source(s) of primary NACE data (code) | data/ nace/ primary/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of primary NACE data (label) | data/ nace/ primary/ source/ name | | Český statistický úřad | No |\n| Primary NACE validated | data/ nace/ primary/ isVerified | NACE validated using an alternative source | False | No |\n| Primary NACE (code) | data/ nace/ primary/ code | NACE enumeration for /api/v3/nace-codes | 74 | Yes |\n| Primary NACE (label) | data/ nace/ primary/ name | Name of the NACE as published by public administration | Other professional, scientific and technical activities | No |\n| Confidence in identified NACE code | data/ nace/ primary/ confidence | | 0.9 | Inherited |\n| Primary NACE identification method | data/ nace/ primary/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Source(s) of non-primary NACE data (code) | data/ nace/ other/ source/ code | Source enum code for /api/v3/Sources | cz-czso | Inherited |\n| Source(s) of non-primary NACE data (label) | data/ nace/ other/ source/ name | | Český statistický úřad | No |\n| Non-primary NACE validated | data/ nace/ other/ isVerified | NACE validated using an alternative source | False | No |\n| Non-primary NACE (code) | data/ nace/ other/ code | NACE enumeration for /api/v3/nace-codes | 6820 | Yes |\n| Non-primary NACE (label) | data/ nace/ other/ name | | Renting and operating of own or leased real estate | No |\n| Non-primary NACE identification method | data/ nace/ other/ type | Is the NACE found on source or probabilisticaly determined (Source/Identified) | Source | Yes |\n| Confidence in identified NACE code | data/ nace/ other/ confidence | | 0.9 | No |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get NACE codes for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get NACE codes for." } }, { "name": "Code", "in": "query", "description": "Specific NACE code to search by.", "schema": { "type": "string", "description": "Specific NACE code to search by.", "nullable": true } }, { "name": "Type", "in": "query", "description": "Type of the NACE code.", "schema": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Company.Models.NaceCodes.Enums.NaceTypeEnum" } }, { "name": "IsPrimary", "in": "query", "description": "Should the return data contain only primary NACE codes?", "schema": { "type": "boolean", "description": "Should the return data contain only primary NACE codes?", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/owned-companies": { "get": { "tags": [ "Company Single Request" ], "summary": "Owned Companies (nationalIn)", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------------------------------------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-45274649 | Yes |\n| Owned entity unique ID | data/ ownedCompanies/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-00128201 | Inherited |\n| Owned entity national ID | data/ ownedCompanies/ nationalIn | Local entity identifier (ICO in CZ) | 00128201 | Inherited |\n| Owned entity name | data/ ownedCompanies/ name | | ŠKODA PRAHA a.s. | Inherited |\n| Owned entity HQ address (code) | data/ ownedCompanies/ address/ uniqueId | Enumeration location unique ID for /api/v3/Addresses/ | cz-address-ruian-025583697 | Inherited |\n| Owned entity HQ address (text) | data/ ownedCompanies/ address/ text | headquarter address as a text string | Duhová 1444/2, Praha, 14000 | No |\n| Owned entity HQ address GPS latitude | data/ ownedCompanies/ address/ coordinates/ latitude | GPS latitude coordianate | 50.0492642173 | No |\n| Owned entity HQ address GPS longitude | data/ ownedCompanies/ address/ coordinates/ longitude | GPS longitude coordianate | 14.4519368372 | No |\n| Owned entity HQ address street name | data/ ownedCompanies/ address/ coordinates/ StreetName | | Duhová | No |\n| Owned entity HQ street number | data/ ownedCompanies/ address/ streetNumber | Building number | 211 | No |\n| Owned entity HQ city | data/ ownedCompanies/ address/ city | City/village | Bystrovany | No |\n| Owned entity HQ ZIP code | data/ ownedCompanies/ address/ postalCode | ZIP code | 77900 | No |\n| Owned entity HQ locality (code) | data/ ownedCompanies/ address/ locality/ code | Enumeration for /api/v3/enums/localities | 500119 | No |\n| Owned entity HQ locality (label) | data/ ownedCompanies/ address/ locality/ name | | Praha 4 | No |\n| Owned entity HQ city part (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ cityPart | city part specific to Czechia, based on RUIAN nomenclature | Michle | No |\n| Owned entity HQ city district (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ cityDistrict | city district specific to Czechia, based on RUIAN nomenclature | Praha 4 | No |\n| Owned entity HQ orientation number (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ orientationNumber | Quick orientation building number | 2 | No |\n| Owned entity HQ house number (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ houseNumber | Building number | 1444 | No |\n| Owned entity HQ address Czech-specific data | data/ ownedCompanies/ address/ countrySpecific/ CZ/ ruian/ | multiple items from RUIAN | | No |\n| Owned entity HQ link to Czech building register profile (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ ruian/ url | Link to building specifications in RUIAN | https://vdp.cuzk.cz/vdp/ruian/adresnimista/25259300 | No |\n| Owned entity HQ building type (code) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ purposeTypes/ code | Enumeration building type for /api/v3/purpose-types | offices | No |\n| Owned entity HQ building type (label) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ purposeTypes/ name | Purpose for which the building is meant to be used | Offices | No |\n| Owned entity type | data/ ownedCompanies/ type | Legal form category of owned entity | Company | Yes |\n| Ownership share in owned entity | data/ ownedCompanies/ share | 0-100% | 1 | No |\n| Owner role in owned entity | data/ ownedCompanies/ role | | akcionář | No |\n| Ownership start date | data/ ownedCompanies/ validFrom | | 2005-12-13T00:00:00+00:00 | Inherited |\n| Ownership end date | data/ ownedCompanies/ validTo | | 2020-08-21T00:00:00+00:00 | No |\n| Ownership data source (code) | data/ ownedCompanies/ source/ code | Source enum code for /api/v3/Sources | cz-or | Inherited |\n| Ownership data source (label) | data/ ownedCompanies/ source/ name | | Obchodní rejstřík | No |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company unique identifier to get owned companies data for.", "required": true, "schema": { "type": "string", "description": "Company unique identifier to get owned companies data for." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/owned-companies": { "get": { "tags": [ "Company Collection Request" ], "summary": "Owned Companies", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------------------------------------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-45274649 | Yes |\n| Owned entity unique ID | data/ ownedCompanies/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-00128201 | Inherited |\n| Owned entity national ID | data/ ownedCompanies/ nationalIn | Local entity identifier (ICO in CZ) | 00128201 | Inherited |\n| Owned entity name | data/ ownedCompanies/ name | | ŠKODA PRAHA a.s. | Inherited |\n| Owned entity HQ address (code) | data/ ownedCompanies/ address/ uniqueId | Enumeration location unique ID for /api/v3/Addresses/ | cz-address-ruian-025583697 | Inherited |\n| Owned entity HQ address (text) | data/ ownedCompanies/ address/ text | headquarter address as a text string | Duhová 1444/2, Praha, 14000 | No |\n| Owned entity HQ address GPS latitude | data/ ownedCompanies/ address/ coordinates/ latitude | GPS latitude coordianate | 50.0492642173 | No |\n| Owned entity HQ address GPS longitude | data/ ownedCompanies/ address/ coordinates/ longitude | GPS longitude coordianate | 14.4519368372 | No |\n| Owned entity HQ address street name | data/ ownedCompanies/ address/ coordinates/ StreetName | | Duhová | No |\n| Owned entity HQ street number | data/ ownedCompanies/ address/ streetNumber | Building number | 211 | No |\n| Owned entity HQ city | data/ ownedCompanies/ address/ city | City/village | Bystrovany | No |\n| Owned entity HQ ZIP code | data/ ownedCompanies/ address/ postalCode | ZIP code | 77900 | No |\n| Owned entity HQ locality (code) | data/ ownedCompanies/ address/ locality/ code | Enumeration for /api/v3/enums/localities | 500119 | No |\n| Owned entity HQ locality (label) | data/ ownedCompanies/ address/ locality/ name | | Praha 4 | No |\n| Owned entity HQ city part (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ cityPart | city part specific to Czechia, based on RUIAN nomenclature | Michle | No |\n| Owned entity HQ city district (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ cityDistrict | city district specific to Czechia, based on RUIAN nomenclature | Praha 4 | No |\n| Owned entity HQ orientation number (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ orientationNumber | Quick orientation building number | 2 | No |\n| Owned entity HQ house number (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ houseNumber | Building number | 1444 | No |\n| Owned entity HQ address Czech-specific data | data/ ownedCompanies/ address/ countrySpecific/ CZ/ ruian/ | multiple items from RUIAN | | No |\n| Owned entity HQ link to Czech building register profile (country specific) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ ruian/ url | Link to building specifications in RUIAN | https://vdp.cuzk.cz/vdp/ruian/adresnimista/25259300 | No |\n| Owned entity HQ building type (code) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ purposeTypes/ code | Enumeration building type for /api/v3/purpose-types | offices | No |\n| Owned entity HQ building type (label) | data/ ownedCompanies/ address/ countrySpecific/ CZ/ purposeTypes/ name | Purpose for which the building is meant to be used | Offices | No |\n| Owned entity type | data/ ownedCompanies/ type | Legal form category of owned entity | Company | Yes |\n| Ownership share in owned entity | data/ ownedCompanies/ share | 0-100% | 1 | No |\n| Owner role in owned entity | data/ ownedCompanies/ role | | akcionář | No |\n| Ownership start date | data/ ownedCompanies/ validFrom | | 2005-12-13T00:00:00+00:00 | Inherited |\n| Ownership end date | data/ ownedCompanies/ validTo | | 2020-08-21T00:00:00+00:00 | No |\n| Ownership data source (code) | data/ ownedCompanies/ source/ code | Source enum code for /api/v3/Sources | cz-or | Inherited |\n| Ownership data source (label) | data/ ownedCompanies/ source/ name | | Obchodní rejstřík | No |\n\n", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/owners": { "get": { "tags": [ "Obsolete" ], "summary": "Owners (nationalIn)", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------|-------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-46965823 | Yes |\n| Owner person name | data/ owners/ name | | Ing. Boris Lucký | Yes |\n| Source of the information of ownership | data/ owners/ source | | cz-or | Yes |\n| Owner person date of birth | data/ owners/ dateOfBirth | | 1955-11-16 | No |\n| Owner person registered address | data/ owners/ address/ uniqueId | Source enum code for /api/v3/Addresses/ | cz-address-ruian-023250674 | Inherited |\n| Unique pseudonymized person ID | data/ owners/ uniqueId | | cz-person-3902469372372050907 | Inherited |\n| Type of owner person (legal, private) | data/ owners/ type | | Person | Yes |\n| Ownership share | data/ owners/ share | | 0.55 | No |\n| Ownership start date | data/ owners/ validFrom | | 1997-04-14 | Yes |\n| Ownership end date | data/ owners/ validTo | | 1997-04-14 | No |\n| Owner role | data/ owners/ role/ value | | společník s vkladem | Inherited |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "An international Company identifier as a string.", "required": true, "schema": { "type": "string", "description": "An international Company identifier as a string." } }, { "name": "IncludeConnectedCompanies", "in": "query", "description": "Should data include connected companies.", "schema": { "type": "boolean", "description": "Should data include connected companies." } }, { "name": "IncludePreviousOwners", "in": "query", "description": "Sets whether or not previous owners are included in the results, default is .", "schema": { "type": "boolean", "description": "Sets whether or not previous owners are included in the results, default is ." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/owners": { "get": { "tags": [ "Obsolete" ], "summary": "Owners", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------|-------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-46965823 | Yes |\n| Owner person name | data/ owners/ name | | Ing. Boris Lucký | Yes |\n| Source of the information of ownership | data/ owners/ source | | cz-or | Yes |\n| Owner person date of birth | data/ owners/ dateOfBirth | | 1955-11-16 | No |\n| Owner person registered address | data/ owners/ address/ uniqueId | Source enum code for /api/v3/Addresses/ | cz-address-ruian-023250674 | Inherited |\n| Unique pseudonymized person ID | data/ owners/ uniqueId | | cz-person-3902469372372050907 | Inherited |\n| Type of owner person (legal, private) | data/ owners/ type | | Person | Yes |\n| Ownership share | data/ owners/ share | | 0.55 | No |\n| Ownership start date | data/ owners/ validFrom | | 1997-04-14 | Yes |\n| Ownership end date | data/ owners/ validTo | | 1997-04-14 | No |\n| Owner role | data/ owners/ role/ value | | společník s vkladem | Inherited |\n\n", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/owners": { "get": { "tags": [ "Company Collection Request" ], "summary": "Owners", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------|-------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-46965823 | Yes |\n| Owner person name | data/ owners/ name | | Ing. Boris Lucký | Yes |\n| Source of the information of ownership | data/ owners/ source | | cz-or | Yes |\n| Owner person date of birth | data/ owners/ dateOfBirth | | 1955-11-16 | No |\n| Owner person registered address | data/ owners/ address/ uniqueId | Source enum code for /api/v3/Addresses/ | cz-address-ruian-023250674 | Inherited |\n| Unique pseudonymized person ID | data/ owners/ uniqueId | | cz-person-3902469372372050907 | Inherited |\n| Type of owner person (legal, private) | data/ owners/ type | | Person | Yes |\n| Ownership share | data/ owners/ share | | 0.55 | No |\n| Ownership start date | data/ owners/ validFrom | | 1997-04-14 | Yes |\n| Ownership end date | data/ owners/ validTo | | 1997-04-14 | No |\n| Owner role | data/ owners/ role/ value | | společník s vkladem | Inherited |\n\n", "parameters": [ { "name": "Type", "in": "query", "description": "Restrict the response to only owners of this type.", "schema": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Company.Models.Owners.Enums.OwnerEntityType" } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "ValidFrom", "in": "query", "description": "The start date to filter the list of owners by.", "schema": { "type": "string", "description": "The start date to filter the list of owners by.", "format": "date-time", "nullable": true } }, { "name": "ValidTo", "in": "query", "description": "The end date to filter the list of owners by.", "schema": { "type": "string", "description": "The end date to filter the list of owners by.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/owners": { "get": { "tags": [ "Company Single Request" ], "summary": "Owners", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------|-------------------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | BizMachine identifier combining country and entity type information and local ID | cz-company-46965823 | Yes |\n| Owner person name | data/ owners/ name | | Ing. Boris Lucký | Yes |\n| Source of the information of ownership | data/ owners/ source | | cz-or | Yes |\n| Owner person date of birth | data/ owners/ dateOfBirth | | 1955-11-16 | No |\n| Owner person registered address | data/ owners/ address/ uniqueId | Source enum code for /api/v3/Addresses/ | cz-address-ruian-023250674 | Inherited |\n| Unique pseudonymized person ID | data/ owners/ uniqueId | | cz-person-3902469372372050907 | Inherited |\n| Type of owner person (legal, private) | data/ owners/ type | | Person | Yes |\n| Ownership share | data/ owners/ share | | 0.55 | No |\n| Ownership start date | data/ owners/ validFrom | | 1997-04-14 | Yes |\n| Ownership end date | data/ owners/ validTo | | 1997-04-14 | No |\n| Owner role | data/ owners/ role/ value | | společník s vkladem | Inherited |\n\n", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get owners for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get owners for." } }, { "name": "Type", "in": "query", "description": "Restrict the response to only owners of this type.", "schema": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Company.Models.Owners.Enums.OwnerEntityType" } }, { "name": "ValidFrom", "in": "query", "description": "The start date to filter the list of owners by.", "schema": { "type": "string", "description": "The start date to filter the list of owners by.", "format": "date-time", "nullable": true } }, { "name": "ValidTo", "in": "query", "description": "The end date to filter the list of owners by.", "schema": { "type": "string", "description": "The end date to filter the list of owners by.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/risks": { "get": { "tags": [ "Obsolete" ], "summary": "Risks (nationalIn)", "description": "Dataset description:\n\nDataset contains list of risks associated with a company. Each type of a risk is entered as unique property under node `risks` and it's name should match entry in dictionary of `risk-types`. Risk may form a timeline and can be assigned and removed over time.\n\nDataset updates:\n\nDataset is updated on a bi-weekly basis, with selected events updated daily.\n\nSelected use cases:\n\n- filter out companies affected by different risk events\n- mitigate secondary risk by observing risks in connected companies network\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Always populated? | Path | Item description | Example | Always populated? |\n|------------------------------|-------------------|-----------------------------------------------------------|--------------------------------------------------------------------------|---------------------------|-------------------|\n| Entity unique ID | Yes | company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-45309183 | Yes |\n| Risk label | No | risks/ riskName/ name | name of the risk | Bankrot | No |\n| Risk severity | Inherited | risks/ riskName/ timeline/ severity | how \"bad\" is the risk for a given stage (0 = none, 1 = low, 10 = high) | 10 | Inherited |\n| Risk start date | Inherited | risks/ riskName/ timeline/ validFrom | since when is the entity in this stage | 2022-03-03T00:00:00+00:00 | Inherited |\n| Risk end date | No | risks/ riskName/ timeline/ validTo | | 2022-03-03T00:00:00+00:00 | No |\n| Connected company ID | Inherited | risks/ riskName/ timeline/ connectedCompanies/ uniqueId | | cz-company-14615100 | Inherited |\n| Connected company NationalIN | Inherited | risks/ riskName/ timeline/ connectedCompanies/ nationalIn | | 14615100 | Inherited |\n| Connected company name | No | risks/ riskName/ timeline/ connectedCompanies/ name | | Firma s.r.o. | No |\n| Source of risk data (code) | Inherited | risks/ bankruptcy/ timeline/ sources/ code | Enumeration code of information source for /api/v3/Sources | cz-isir | Inherited |\n| Source of risk data (label) | No | risks/ bankruptcy/ timeline/ sources/ name | name of the information source | Insolvenční rejstřík | No |", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company unique identifier to get company risks data for.", "required": true, "schema": { "type": "string", "description": "Company unique identifier to get company risks data for." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/risks": { "get": { "tags": [ "Obsolete" ], "summary": "Risks", "description": "Dataset description:\n\nDataset contains list of risks associated with a company. Each type of a risk is entered as unique property under node `risks` and it's name should match entry in dictionary of `risk-types`. Risk may form a timeline and can be assigned and removed over time.\n\nDataset updates:\n\nDataset is updated on a bi-weekly basis, with selected events updated daily.\n\nSelected use cases:\n\n- filter out companies affected by different risk events\n- mitigate secondary risk by observing risks in connected companies network\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Always populated? | Path | Item description | Example | Always populated? |\n|------------------------------|-------------------|-----------------------------------------------------------|--------------------------------------------------------------------------|---------------------------|-------------------|\n| Entity unique ID | Yes | company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-45309183 | Yes |\n| Risk label | No | risks/ riskName/ name | name of the risk | Bankrot | No |\n| Risk severity | Inherited | risks/ riskName/ timeline/ severity | how \"bad\" is the risk for a given stage (0 = none, 1 = low, 10 = high) | 10 | Inherited |\n| Risk start date | Inherited | risks/ riskName/ timeline/ validFrom | since when is the entity in this stage | 2022-03-03T00:00:00+00:00 | Inherited |\n| Risk end date | No | risks/ riskName/ timeline/ validTo | | 2022-03-03T00:00:00+00:00 | No |\n| Connected company ID | Inherited | risks/ riskName/ timeline/ connectedCompanies/ uniqueId | | cz-company-14615100 | Inherited |\n| Connected company NationalIN | Inherited | risks/ riskName/ timeline/ connectedCompanies/ nationalIn | | 14615100 | Inherited |\n| Connected company name | No | risks/ riskName/ timeline/ connectedCompanies/ name | | Firma s.r.o. | No |\n| Source of risk data (code) | Inherited | risks/ bankruptcy/ timeline/ sources/ code | Enumeration code of information source for /api/v3/Sources | cz-isir | Inherited |\n| Source of risk data (label) | No | risks/ bankruptcy/ timeline/ sources/ name | name of the information source | Insolvenční rejstřík | No |", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/risks": { "get": { "tags": [ "Company Collection Request" ], "summary": "Risks", "description": "Dataset description:\n\nDataset contains list of risks associated with a company. Each type of a risk is entered as unique property under node `risks` and it's name should match entry in dictionary of `risk-types`. Risk may form a timeline and can be assigned and removed over time.\n\nDataset updates:\n\nDataset is updated on a bi-weekly basis, with selected events updated daily.\n\nSelected use cases:\n\n- filter out companies affected by different risk events\n- mitigate secondary risk by observing risks in connected companies network\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Always populated? | Path | Item description | Example | Always populated? |\n|------------------------------|-------------------|-----------------------------------------------------------|--------------------------------------------------------------------------|---------------------------|-------------------|\n| Entity unique ID | Yes | company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-45309183 | Yes |\n| Risk label | No | risks/ riskName/ name | name of the risk | Bankrot | No |\n| Risk severity | Inherited | risks/ riskName/ timeline/ severity | how \"bad\" is the risk for a given stage (0 = none, 1 = low, 10 = high) | 10 | Inherited |\n| Risk start date | Inherited | risks/ riskName/ timeline/ validFrom | since when is the entity in this stage | 2022-03-03T00:00:00+00:00 | Inherited |\n| Risk end date | No | risks/ riskName/ timeline/ validTo | | 2022-03-03T00:00:00+00:00 | No |\n| Connected company ID | Inherited | risks/ riskName/ timeline/ connectedCompanies/ uniqueId | | cz-company-14615100 | Inherited |\n| Connected company NationalIN | Inherited | risks/ riskName/ timeline/ connectedCompanies/ nationalIn | | 14615100 | Inherited |\n| Connected company name | No | risks/ riskName/ timeline/ connectedCompanies/ name | | Firma s.r.o. | No |\n| Source of risk data (code) | Inherited | risks/ bankruptcy/ timeline/ sources/ code | Enumeration code of information source for /api/v3/Sources | cz-isir | Inherited |\n| Source of risk data (label) | No | risks/ bankruptcy/ timeline/ sources/ name | name of the information source | Insolvenční rejstřík | No |", "parameters": [ { "name": "Code", "in": "query", "description": "Specific risk code to search by.", "schema": { "type": "string", "description": "Specific risk code to search by.", "nullable": true } }, { "name": "Sources", "in": "query", "description": "Collection of source codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Collection of source codes to search by.", "nullable": true } }, { "name": "LatestOnly", "in": "query", "description": "Should the return data contain only latest entries?", "schema": { "type": "boolean", "description": "Should the return data contain only latest entries?" } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/risks": { "get": { "tags": [ "Company Single Request" ], "summary": "Risks", "description": "Dataset description:\n\nDataset contains list of risks associated with a company. Each type of a risk is entered as unique property under node `risks` and it's name should match entry in dictionary of `risk-types`. Risk may form a timeline and can be assigned and removed over time.\n\nDataset updates:\n\nDataset is updated on a bi-weekly basis, with selected events updated daily.\n\nSelected use cases:\n\n- filter out companies affected by different risk events\n- mitigate secondary risk by observing risks in connected companies network\n\n\n\nEndpoint variables description:\n\n| Item commercial name | Always populated? | Path | Item description | Example | Always populated? |\n|------------------------------|-------------------|-----------------------------------------------------------|--------------------------------------------------------------------------|---------------------------|-------------------|\n| Entity unique ID | Yes | company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-45309183 | Yes |\n| Risk label | No | risks/ riskName/ name | name of the risk | Bankrot | No |\n| Risk severity | Inherited | risks/ riskName/ timeline/ severity | how \"bad\" is the risk for a given stage (0 = none, 1 = low, 10 = high) | 10 | Inherited |\n| Risk start date | Inherited | risks/ riskName/ timeline/ validFrom | since when is the entity in this stage | 2022-03-03T00:00:00+00:00 | Inherited |\n| Risk end date | No | risks/ riskName/ timeline/ validTo | | 2022-03-03T00:00:00+00:00 | No |\n| Connected company ID | Inherited | risks/ riskName/ timeline/ connectedCompanies/ uniqueId | | cz-company-14615100 | Inherited |\n| Connected company NationalIN | Inherited | risks/ riskName/ timeline/ connectedCompanies/ nationalIn | | 14615100 | Inherited |\n| Connected company name | No | risks/ riskName/ timeline/ connectedCompanies/ name | | Firma s.r.o. | No |\n| Source of risk data (code) | Inherited | risks/ bankruptcy/ timeline/ sources/ code | Enumeration code of information source for /api/v3/Sources | cz-isir | Inherited |\n| Source of risk data (label) | No | risks/ bankruptcy/ timeline/ sources/ name | name of the information source | Insolvenční rejstřík | No |", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get risks for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get risks for." } }, { "name": "Code", "in": "query", "description": "Specific risk code to search by.", "schema": { "type": "string", "description": "Specific risk code to search by.", "nullable": true } }, { "name": "Sources", "in": "query", "description": "Collection of source codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Collection of source codes to search by.", "nullable": true } }, { "name": "LatestOnly", "in": "query", "description": "Should the return data contain only latest entries?", "schema": { "type": "boolean", "description": "Should the return data contain only latest entries?" } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/{nationalIn}/statutories": { "get": { "tags": [ "Company Single Request" ], "summary": "Statutories (nationalIn)", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-------------------------------------------|----------------------------------|------------------------------------------------------|---------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-14615100 | Yes |\n| Type of statutory person (legal, private) | data/ statutories/ type | is the statutory a physical person or a legal entity | Person | Yes |\n| Statutory role | data/ statutories/ role | role in which the statutory represents the entity | jednatel | Yes |\n| Statutory role start date | data/ statutories/ validFrom | since when has the statutory assumed the role | 2020-11-09 | Yes |\n| Statutory role end date | data/ statutories/ validTo | until when was the statutory active in the role | 2020-11-09 | No |\n| Source(s) of statutory data (code) | data/ statutories/ sources/ code | Source enum code for /api/v3/Sources | cz-or | Inherited |\n| Source(s) of statutory data (label) | data/ statutories/ sources/ name | | Obchodni rejstrik | No |", "parameters": [ { "name": "nationalIn", "in": "path", "description": "NationalIn identifier as a string.", "required": true, "schema": { "type": "string", "description": "NationalIn identifier as a string." } }, { "name": "IncludeConnectedCompanies", "in": "query", "description": "Should data include connected companies.", "schema": { "type": "boolean", "description": "Should data include connected companies." } }, { "name": "IncludePreviousOwners", "in": "query", "description": "Sets whether or not previous owners are included in the results, default is .", "schema": { "type": "boolean", "description": "Sets whether or not previous owners are included in the results, default is ." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/companies/statutories": { "get": { "tags": [ "Company Collection Request" ], "summary": "Statutories", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-------------------------------------------|----------------------------------|------------------------------------------------------|---------------------|------------------|\n| Entity unique ID | data/ company/ uniqueId | unique company ID (to match with other datatsets) | cz-company-14615100 | Yes |\n| Type of statutory person (legal, private) | data/ statutories/ type | is the statutory a physical person or a legal entity | Person | Yes |\n| Statutory role | data/ statutories/ role | role in which the statutory represents the entity | jednatel | Yes |\n| Statutory role start date | data/ statutories/ validFrom | since when has the statutory assumed the role | 2020-11-09 | Yes |\n| Statutory role end date | data/ statutories/ validTo | until when was the statutory active in the role | 2020-11-09 | No |\n| Source(s) of statutory data (code) | data/ statutories/ sources/ code | Source enum code for /api/v3/Sources | cz-or | Inherited |\n| Source(s) of statutory data (label) | data/ statutories/ sources/ name | | Obchodni rejstrik | No |", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/suggest": { "get": { "tags": [ "Search" ], "summary": "Company Search", "description": "Search for suggestion list of companies matching suggestionParameters.", "parameters": [ { "name": "dataset", "in": "path", "description": "Target dataset scope.", "required": true, "schema": { "type": "string", "description": "Target dataset scope.", "nullable": true } }, { "name": "Query", "in": "query", "description": "Query string to search for in data.", "required": true, "schema": { "type": "string", "description": "Query string to search for in data." } }, { "name": "FieldsToSearch", "in": "query", "description": "Collection of fields to search in.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Collection of fields to search in.", "nullable": true } }, { "name": "Limit", "in": "query", "description": "Number of results to return. Default is 5.", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "description": "Number of results to return. Default is 5.", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.SuggestedCompanyDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/technologies": { "get": { "tags": [ "Company Collection Request" ], "summary": "Technologies (restricted)", "description": "Gets all available technologies information based on the filter.", "parameters": [ { "name": "TechnologiesCodes", "in": "query", "description": "Specific technology codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Specific technology codes to search by.", "nullable": true } }, { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/technologies": { "get": { "tags": [ "Company Single Request" ], "summary": "Technologies (restricted)", "description": "Gets all available technologies information for given company.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "Company national identifier to get technologies for.", "required": true, "schema": { "type": "string", "description": "Company national identifier to get technologies for." } }, { "name": "TechnologiesCodes", "in": "query", "description": "Specific technology codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Specific technology codes to search by.", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/contracts": { "get": { "tags": [ "Contracts" ], "summary": "Contracts", "description": "\nDataset description:\n\nDataset focuses on publicly available contracts between private companies and publicly owned companies or public authorities. Publication of the contract in a open portal is legally required.\nScope of contracts available is defined by the local legislation.\n\nAvailability:\n\ncz\n\nDataset updates:\n\nDataset is updated weekly\n\nSelected use cases:\n\n- find contracts of your competitors and their validity range\n- make a market sizing of how much is spent by public authorities in a given area\n- see which companies are heavily dependent on public finances \n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|------------------------------------------|-----------------------------|------------------------------------------------------------|---------------------------------------------------------------------------------------|------------------|\n| Contract unique ID | data/ uniqueId | ID unique across countries | cz-contract-regsmluv-0019898135 | Yes |\n| Contract source URL | data/ url | | https://smlouvy.gov.cz/smlouva/19898135 | Yes |\n| Contract version | data/ version | | 1 | No |\n| Contract title | data/ title | | Dodatek č. 4 ke smlouvě na stravenky - zvýšení nominální hodnoty. ID SMLOUVY: 2291658 | Yes |\n| Contract summary | data/ summary | | Tato smlouva stanovuje podmínky partnerství mezi Krajem Vysočina a ... | No |\n| Contract content | data/ content | | Smlouva o partnerstvi k projektu Potravinova pomoc dětem v Kraji Vysočina. | No |\n| Contract validity state | data/ state | | valid | Yes |\n| Contract publishing date | data/ publishedAt | | 2022-04-04T17:00:21+00:00 | Yes |\n| Contract signature date | data/ signature/ createdAt | | 2022-04-04T00:00:00+00:00 | Yes |\n| Original language of the contract | data/ originalLanguage | | cs | No |\n| Contract value currency | data/ value/ currency | | CZK | Inherited |\n| Contract value amount | data/ value/ amount | | 63530 | Inherited |\n| Contract VAT amount | data/ value/ vat | | 0 | Inherited |\n| Contract value currency | data/ values/ currency | | CZK | Inherited |\n| Contract value amount | data/ values/ amount | | 63530 | Inherited |\n| Contract VAT amount | data/ values/ vat | | 0 | Inherited |\n| Contract value type | data/ values/ type | | vatIncluded | No |\n| Contract validity start date | data/ validFrom | | 2022-04-04T17:00:21+00:00 | Yes |\n| Contract validity end date | data/ validTo | | null | No |\n| Contract buyer party entity unique ID | data/ buyers/ uniqueId | | cz-company-67985904 | Inherited |\n| Contract buyer party national ID | data/ buyers/ nationalIn | | 67985904 | Inherited |\n| Contract buyer party entity name | data/ buyers/ name | | Ústav živočišné fyziologie a genetiky AV ČR, v. v. i. | No |\n| Contract supplier party entity unique ID | data/ suppliers/ uniqueId | | cz-company-24745391 | Inherited |\n| Contract supplier party national ID | data/ suppliers/ nationalIn | | 24745391 | Inherited |\n| Contract supplier party entity name | data/ suppliers/ name | | Edenred CZ s.r.o. | No |\n| Contract party entity national ID | data/ parties/ nationalIn | | 67985904 | Inherited |\n| Contract party entity unique ID | data/ parties/ uniqueId | | cz-company-67985904 | Inherited |\n| Contract party entity type | data/ parties/ type | | Company | Inherited |\n| Contract party publisher flag | data/ parties/ isPublisher | Is this the entity, which has published the contract | True | Inherited |\n| Contract party recipient flag | data/ parties/ isRecipient | Is this entity recipient of the contracted product/service | False | Inherited |\n| Contract party name | data/ parties/ name | | Firma s.r.o. | No |\n\n", "parameters": [ { "name": "Company.NationalIn", "in": "query", "description": "National IN of Company for requested Contracts.", "schema": { "type": "string", "description": "National IN of Company for requested Contracts.", "nullable": true } }, { "name": "Company.Role", "in": "query", "description": "Role of Company in requested Contracts as a BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.RoleCode.", "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.RoleCode" } }, { "name": "Published.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Published.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContractDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContractDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/custom-data": { "get": { "tags": [ "Custom Data" ], "summary": "Custom Data", "description": "Finds custom data based on input parameters.>", "parameters": [ { "name": "Keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "NationalIn", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "CompanyTag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Type", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.GetCustomDataEntryDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.GetCustomDataEntryDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/eshops": { "get": { "tags": [ "EShops" ], "summary": "E-Shops", "description": "Dataset description:\n\nEShops dataset lists all domains classified as e-commerce sites. Classification is based on site keywords, features (basket, specific URLs) and technologies used.\n\nAdditionally, a domain is listed in the EShops country market if it is featured on any of the major local e-commerce marketplaces (for example idealo.de for DE, emag.hu for HU, heureka.cz for CZ, ...) **and** if it is operated by a Company entity registered on the local market.\nDomains listed on marketplaces are typically suplemented with a number of popularity metrics and category details to be found in the sources node. \n\n> **WARNING**: Top level domains (.net, .cz, .sk) are not decisive when assigning a domain to the datasets.\n\n> **WARNING**: An EShop is not required to be linked to a Company if missing an unambiguous reference on its terms and conditions page.\n\nAvailability:\n\ncz, sk, hu\n\nDataset updates:\n\nWebsites running the eshops are re-visited on a monthly basis, their health status and operation are checked continuously.\nData from e-commerce catalogues and marketplaces are updated on a weekly to monthly basis.\n\nSelected use cases:\n\n- segment rising stars of e-commerce by unique metrics like review growth or visits growth\n- segment your competitors portfolio using our technology, payment and delivery providers data\n- find attributes, health and decision makers in a company running the EShop\n- have a full market view of e-commerce\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------|----------------------------------------------|----------------------------------------------------------------------------------------------------------|-------------------------------------|------------------|\n| eshop unique ID | data/ uniqueId | ID unique across countries | cz-eshop-12225 | Yes |\n| eshop operator entity unique ID | data/ company/ uniqueId | Entity registered as operator of the e-shop (party responsible vs. customers) ID unique across countries | cz-company-26155559 | Yes |\n| eshop operator entity national ID | data/ company/ nationalIn | Entity registered as operator of the e-shop (party responsible vs. customers) national ID | 26155559 | No |\n| eshop operator entity name | data/ company/ name | Entity registered as operator of the e-shop (party responsible vs. customers) name | KULINA Group, a.s. | No |\n| eshop name | data/ name | Synthesized e-shop name, typically shortened URL | Chefshop.cz | No |\n| eshop activity status | data/ status | Activity evaluated by BizMachine | active | Yes |\n| eshop URL | data/ url | | http://chefshop.cz | Yes |\n| A localized description of the e-shop. | data/ description | | E-shop for tractors. | No |\n| eshop technological platform (code) | data/ technologies/ code | Enumeration for /api/v3/eshops/enums/features | shoptet-7cd4 | Inherited |\n| eshop technological platform (label) | data/ technologies/ name | | shoptet | No |\n| eshop payment method (code) | data/ paymentOptions/ code | Enumeration for /api/v3/eshops/enums/features | paypal-7922 | Inherited |\n| eshop payment method (label) | data/ paymentOptions/ name | | PayPal | No |\n| eshop delivery method (code) | data/ deliveryOptions/ code | Enumeration for /api/v3/eshops/enums/features | dpd-5775 | Inherited |\n| eshop delivery method (label) | data/ deliveryOptions/ name | | DPD | No |\n| Source of eshop data (code) | data/ sources/ code | Source enum code for /api/v3/Sources | cz-zbozicz | Inherited |\n| Source of eshop data (label) | data/ sources/ name | | Zboží.cz | No |\n| Record URL on source | data/ sources/ url | Typically aggregator | https://www.zbozi.cz/obchod/115266/ | Inherited |\n| eshop attribute on source (code) | data/ sources/ attributes/ code | Enumeration for /api/v3/eshops/enums/features | cz-heureka_gold_badge | Inherited |\n| eshop attribute on source (label) | data/ sources/ attributes/ name | | Gold badge | No |\n| eshop total ratings on source | data/ sources/ metrics/ ratingCountTotal | Total rating count (ever recorded) on source (aggregator) | 743 | No |\n| eshop rating value on source | data/ sources/ metrics/ ratingValue | Normalized rating value on source (0-1) | 0.97 | No |\n| eshop rating count change absolute | data/ sources/ metrics/ ratingCountIncrement | Absolute change in ratings over the last 90 days | 46 | No |\n| eshop rating count change relative | data/ sources/ metrics/ ratingCountChangePct | Relative change in ratings over the last 90 days | 0.07 | No |\n| Delivery duration in days. | data/ sources/ metrics/ deliveryDurationDays | | 7 | No |\n| The date of the last rating. | data/ sources/ metrics/ lastRatedAt | | 2022-04-04T17:00:21+00:00 | No |\n| A numerical count of products. | data/ sources/ metrics/ productCount | | 180 | No |\n| eshop product category (code) | data/ sources/ productCategories/ code | Enumeration code for /api/v3/eshops/enums/product-categories | cz-zbozi-3cajovekonvicefrenchp | Inherited |\n| eshop product category (label) | data/ sources/ productCategories/ name | Into which product categories is the eshop classified on source (aggregator) | Čajové konvice a french press | No |\n\n", "parameters": [ { "name": "Company.NationalIn", "in": "query", "description": "Request eshop related to the company's national identifier.", "schema": { "type": "string", "description": "Request eshop related to the company's national identifier.", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.GetEShopDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.GetEShopDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/events": { "get": { "tags": [ "Events" ], "summary": "Events", "description": "Dateset description:\n\nEvents describe changes in company health and risk status, management and important metrics. In selected markets, we also provide media coverage.\nThe media coverage is experimental as it relies on named-entity extraction techniques, which may produce false matches between article and company profile.\n\nDataset updates:\n\nEvents from official registries correspond with the registry updates which feed the company basic-info dataset. Typically we publish the event in the range of 1-3 days after it has been made available on the source.\nMedia events are followed daily, aiming at next-day publication. Events generated from other registries (VAT, insolvency, statistical office ie.) are more likely to occur weekly or monthly.\n\nAvailability:\n\ncz\n\nSelected use cases:\n\n- monitor riskiness of your customer portfolio exposure by filtering risk events on a daily basis and notify account owner\n- react to changes in key metrics (employee growth, important contract) by offering your services to expanding companies\n- monitor management changes and seize a moment to influence new decision makers\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|---------------------------------------------|----------------------------|---------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|------------------|\n| Event unique ID | data/ uniqueId | ID unique across countries | cz-event-696257de35fe8e23baa4 | Yes |\n| Event subject | data/ subject | Caption of the event | Connection with PRISKO a.s. has been removed | Yes |\n| Event summary | data/ summary | Short description of the event | Connection with PRISKO a.s. has been removed | No |\n| Event text | data/ text | Full text of the event (long esp. for media mentions) | Dlouho šlo o dva rozdílné a vzájemně nespolupracující světy – tradiční bankovní sektor… | No |\n| Event URL | data/ url | Url of the event on source, typically NOT populated for hard events | https://cc.cz/do-peti-let-bude-vyplata-kdykoliv-standard-hlasi-palmapp-startupu-s-tim-pomaha-i-ceska-sporitelna/ | No |\n| Event publishing date | data/ publishedAt | Publishing date used primarily for media mentions | 2022-04-29T11:14:59+00:00 | No |\n| Event start date | data/ startedAt | When did the event happen/ start happening | 2022-04-29T06:00:00+00:00 | Yes |\n| Event end date | data/ finishedtAt | If time bound, when did the event stop happening | 2022-04-29T06:00:00+00:00 | No |\n| Event expiry date | data/ expiresAt | | 2022-04-29T06:00:00+00:00 | No |\n| Event category (code) | data/ categories/ code | Enumeration for /api/v3/events/enums/categories | media | Inherited |\n| Event category (label) | data/ categories/ name | | Media mention | No |\n| Event severity | data/ severity | How significant is the event? Default value = 0 | 0 | No |\n| Entity involved in event entity national ID | data/ entities/ nationalIn | | 45244782 | Inherited |\n| Entity involved in event entity unique ID | data/ entities/ uniqueId | | cz-company-45244782 | Inherited |\n| Entity involved in event entity name | data/ entities/ name | | Česká spořitelna, a.s. | Inherited |\n| Role of the entity involved | data/ entities/ role/ code | | employee | Inherited |\n| Entity involved in event entity type | data/ entities/ type | Company/Person | Company | Inherited |\n\n", "parameters": [ { "name": "Company.NationalIn", "in": "query", "description": "A search based on company's national identifier.", "schema": { "type": "string", "description": "A search based on company's national identifier.", "nullable": true } }, { "name": "Company.Role", "in": "query", "description": "A collection of event role codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A collection of event role codes to search by.", "nullable": true } }, { "name": "Company.OnlyFollowed", "in": "query", "description": "A System.Boolean value indicating if the search should be targeted only for followed companies.", "schema": { "type": "boolean", "description": "A System.Boolean value indicating if the search should be targeted only for followed companies." } }, { "name": "Company.Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Category.Code", "in": "query", "description": "A collection of Event category codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A collection of Event category codes to search by.", "nullable": true } }, { "name": "Source.Code", "in": "query", "description": "A collection of source codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A collection of source codes to search by.", "nullable": true } }, { "name": "Started.From", "in": "query", "description": "Specify bottom date limit to search for events by Started At.", "schema": { "type": "string", "description": "Specify bottom date limit to search for events by Started At.", "format": "date-time", "nullable": true } }, { "name": "Started.To", "in": "query", "description": "Specify upper date limit to search for events by Started At.", "schema": { "type": "string", "description": "Specify upper date limit to search for events by Started At.", "format": "date-time", "nullable": true } }, { "name": "Feedback.Value", "in": "query", "description": "Feedback value.\r\n \r\nDefault value is `Positive` when not specified.", "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.Enum.FeedbackValueDto" } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetEventDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetEventDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/financials/reports": { "get": { "tags": [ "Financials" ], "summary": "Financials", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|------------------|\n| Financial report unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-financial-bs-812A8FC8D9AD0228F87C1EB5DBF0FC55 | Yes |\n| 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 |\n| Publishing entity national ID | data/ data/ company/ nationalIn | Entity, which has published (is the subject) of the financial report national ID | 14615100 | Yes |\n| Publishing entity name | data/ data/ company/ name | | MAPRO spol. s r.o. | No |\n| Financial report accounting standard (code) | data/ data/ standard/ code | Enumeration code for /api/v3/financials/reports/enums/standards | cas2016 | Yes |\n| Financial report accounting standard (label) | data/ data/ standard/ name | | Czech Accounting Standards 2016 | No |\n| Financial report type | data/ data/ type | Balance sheet, IncomeStatement | BalanceSheet | Yes |\n| 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 |\n| Financial report URL on source | data/ data/ url | | https://or.justice.cz/ias/ui/vypis-sl-detail?dokument=68106411&subjektId=215017&spis=820308 | No |\n| Financial report relevant keywords | data/ data/ content/ keywords | currently not used | null | No |\n| Financial report relevant free text | data/ data/ content/ text | currently not used | null | Inherited |\n| Financial report fiscal period year | data/ data/ period/ year | | 2020 | Yes |\n| Financial report fiscal period start date | data/ data/ period/ startedAt | | 2020-12-31T00:00:00+00:00 | No |\n| Financial report fiscal period end date | data/ data/ period/ finishedAt | | 2020-12-31T00:00:00+00:00 | No |\n| Financial report published date | data/ data/ publishedAt | | 2021-08-30T00:00:00+00:00 | No |\n| Financial auditor entity unique ID | data/ data/ audit/ company/ uniqueId | currently not used | cz-company-41186711 | Inherited |\n| Financial auditor entity national ID | data/ data/ audit/ company/ nationalIn | currently not used | 41186711 | Inherited |\n| Text of the audit | data/ data/ audit/ text | | Priloha je vyhotovena v souladu s obecne zavaznymi predpisy ... | No |\n| Financial item name on source | data/ data/ items/ sourceName | | AKTIVA CELKEM | No |\n| Financial item classification group | data/ data/ items/ rowReference | currently not used | A. | No |\n| Financial item standard name (code) | data/ data/ items/ financialItem/ code | Enumeration code for /api/v3/financials/reports/enums/items | BFID_16101 | Inherited |\n| Financial item standard name (label) | data/ data/ items/ financialItem/ name | | AKTIVA CELKEM | No |\n| Financial item netto value amount | data/ data/ items/ values/ netto/ amount | Netto value of assets and liabilities | 476213000 | No |\n| Financial item netto value currency | data/ data/ items/ values/ netto/ currency | | CZK | No |\n| Financial item confidence | data/ data/ items/ values/ confidence | How sure are we that the netto value is correct? (0-1) | 1 | Inherited |\n| Financial item brutto value amount | data/ data/ items/ values/ brutto/ amount | Brutto value of assets (only for balance sheet) | 532141000 | No |\n| Financial item brutto value currency | data/ data/ items/ values/ brutto/ currency | | CZK | No |\n| Financial item correction value amount | data/ data/ items/ values/ correction/ amount | Value adjustments for assets (difference between brutto and netto values) | 55928000 | No |\n| Financial item correction value currency | data/ data/ items/ values/ correction/ currency | | CZK | No |\n\n", "parameters": [ { "name": "Types", "in": "query", "description": "Collection of types of the financial report.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Models.FinancialReports.Enums.FinancialReportType" }, "description": "Collection of types of the financial report.", "nullable": true } }, { "name": "Company.NationalIn", "in": "query", "description": "Financial reports of specific company with national identifier.", "schema": { "type": "string", "description": "Financial reports of specific company with national identifier.", "nullable": true, "example": "05450641" } }, { "name": "Company.Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Period.Years", "in": "query", "description": "Collection of years of the period.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Collection of years of the period.", "nullable": true } }, { "name": "Standard.Codes", "in": "query", "description": "A collection of financial codes to search by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A collection of financial codes to search by.", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "LatestOnly", "in": "query", "description": "Filter data and return only latest reports of a company and type.", "schema": { "type": "boolean", "description": "Filter data and return only latest reports of a company and type." } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.GetFinancialReportDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.GetFinancialReportDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/job-postings": { "get": { "tags": [ "Job Posting" ], "summary": "Jobs", "description": "Dataset description:\n\nDataset lists available job postings/openings published on selected portals, provided these can be linked to a company operating on the local market. The coverage of portals/sources differs across country markets and so does the historical data. By default, we publish 12 months of history. Requesting more historical data is possible through your customer representative and is subject to additional fees.\nDetails of the advertised job position such as salary range, list of benefits etc. are subject to availability on the portal and our ability to provide such data in a structured form. In a large majority of cases, such data is available in the description field in its raw form.\n\nAll job postings are linked to the original URL. We validate availability of the job posting on a regular basis. If a URL is unavailable, deactivated or job posting is unpublished, we invalidate the record by populating the validTo field. This process has varying accuracy as each portal has a different unpublishing schedule. The user should expect some delay and minor inaccuracies. \n\nFor selected country markets, a classification model is applied to job postings, assigning a majority of them to one or more industry categories.\nJobpostings can be assigned to the ISCO classification tree, typically at official labour office portals.\n\n\nAvailability:\n\ncz,sk\n\nDataset updates:\n\nCommonly, job postings are fast flowing data and whenever technically feasible, we publish updates bi-weekly.\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|------------------|\n| Job posting unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-jobposting-jobscz2338769 | Yes |\n| Publishing entity unique ID | data/ data/ company/ uniqueId | Entity, which has published (is the subject) of the financial report BizMachine ID unique across countries | cz-company-14615100 | Yes |\n| Publishing entity national ID | data/ data/ company/ nationalIn | Entity, which has published (is the subject) of the financial report national ID | 14615100 | No |\n| Publishing entity name | data/ data/ company/ name | | MAPRO spol. s r.o. | No |\n| Job posting title | data/ data/ title | | SERVISNÍ TECHNIK vstřikovacích lisů na plasty | Yes |\n| Job posting description | data/ data/ description | | CO BUDETE DĚLAT:\\r\\nservisovat vstřikovací lisy na plasty a průmyslové roboty… | No |\n| Job posting URL on source | data/ data/ url | | https://www.jobs.cz/rpd/1588851798/?searchId=156be252-f353-4812-8f1b-c46974779d41&rps=233 | Yes |\n| Job posting keywords | data/ data/ keywords | currently not used | null | No |\n| Job posting category (code) | data/ data/ categories/ code | Enumeration code for /api/v3/job-postings/enums/categories | jcz29 | Inherited |\n| Job posting category (label) | data/ data/ categories/ name | | Machinery-related | No |\n| Job position location as on source | data/ data/ location/ text | | Bystrovany | Inherited |\n| Job position location processed code | data/ data/ location/ locality/ code | Enumeration code for /api/v3/enums/localities | null | Inherited |\n| Job position location processed name | data/ data/ location/ locality/ name | Enumeration name for /api/v3/enums/localities | null | Inherited |\n| Job salary as on source | data/ data/ salary/ text | currently not used | 16000.00 | Inherited |\n| Job salary processed lower bound amount | data/ data/ salary/ rangeValue/ lowerBound/ amount | currently not used | 16000 | Inherited |\n| Job salary processed lower bound currency | data/ data/ salary/ rangeValue/ lowerBound/ currency | currently not used | CZK | Inherited |\n| Job salary processed upper bound amount | data/ data/ salary/ rangeValue/ upperBound/ amount | currently not used | 16000 | Inherited |\n| Job salary processed upper bound currency | data/ data/ salary/ rangeValue/ upperBound/ currency | currently not used | CZK | Inherited |\n| Job salary processed periodicity | data/ data/ salary/ period | currently not used | monthly | Inherited |\n| Job salary single value amount | data/ data/ salary/ singleValue/ amount | currently not used | | Inherited |\n| Job salary single value currency | data/ data/ salary/ singleValue/ currency | currently not used | | Inherited |\n| Job posting validity start date | data/ data/ validFrom | | 2022-01-07T23:17:15.13994+00:00 | Yes |\n| Job posting validity end date | data/ data/ validTo | | 2022-03-08T23:52:39.62546+00:00 | No |\n| Job position isco classification (code) | data/ data/ isco/ code | Enumeration code for /api/v3/job-postings/enums/isco-codes (currently not used) | 01 | Inherited |\n| Job position isco classification (name) | data/ data/ isco/ name | Enumeration name for /api/v3/job-postings/enums/isco-codes (currently not used) | | Inherited |\n| Job position employment type | data/ data/ employmentType | Full-time, part-time, termed contract, etc. (currently not used) | unknown | No |\n| Job position number of shifts | data/ data/ shifts | How many shifts is the job worked in | 1 | No |\n| Job posting position count | data/ data/ positionsCount | currently not used (0 is the default value) | 0 | No |\n| Job posting benefits advertised (code) | data/ data/ benefits/ code | currently not used | meals | Inherited |\n| Job posting benefits advertised (name) | data/ data/ benefits/ name | currently not used | | No |\n| Job posting requirements (code) | data/ data/ requirements/ code | currently not used | null | Inherited |\n| Job posting requirements (name) | data/ data/ requirements/ name | currently not used | null | No |\n| Job posting requirements (value) | data/ data/ requirements/ value | currently not used | null | No |\n| Job posting contacts | data/ data/ contacts | currently not used | null | No |", "parameters": [ { "name": "Company.NationalIn", "in": "query", "description": "National identifier of the company.", "schema": { "type": "string", "description": "National identifier of the company.", "nullable": true } }, { "name": "Company.Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Categories.Code", "in": "query", "description": "A category code of the job.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A category code of the job.", "nullable": true } }, { "name": "Sources.Code", "in": "query", "description": "A source code of the job.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A source code of the job.", "nullable": true } }, { "name": "Source", "in": "query", "description": "Code of the job source.\r\nThis parameter is obsolete. Use Sources instead.", "schema": { "type": "string", "description": "Code of the job source.\r\nThis parameter is obsolete. Use Sources instead.", "nullable": true, "deprecated": true } }, { "name": "IncludeExpired", "in": "query", "description": "Should results include expired job postings? Default: false", "schema": { "type": "boolean", "description": "Should results include expired job postings? Default: false" } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.GetJobDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.GetJobDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/locations": { "get": { "tags": [ "Locations" ], "summary": "Locations", "description": "Dataset description:\n\nLocations are physical outlets or premises of the company in addition to its HQ.\n\nAvailability:\n\ncz, sk\n\nDataset updates:\n\nDataset is updated on a quarterly basis.\n\nSelected use cases:\n\n- compare your coverage with geographical distribution of your portfolios premises\n- segment locations by category\n- enrich your own locations dataset by official address points, GPS coordinates and other address features \n- see best rated premises at multiple social networks (google, facebook)\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-----------------------------------------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|------------------|\n| Location unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-location-BMPCZ00002613 | Yes |\n| Address unique ID | data/ data/ address/ uniqueId | BizMachine ID unique across countries | cz-address-other-5f1dd281fe71eeba5bcbfe92d78f4bf3 | Yes |\n| Address (text) | data/ data/ address/ text | Full address as a text string | Špitálské náměstí 3517/1a, Ústí nad Labem, okres Ústí nad Labem, Ústecký kraj, Česko | Yes |\n| Address GPS latitude | data/ data/ address/ coordinates/ latitude | | 50.6628916667 | Inherited |\n| Address GPS longitude | data/ data/ address/ coordinates/ longitude | | 14.0329444444 | Inherited |\n| Address street name | data/ data/ address/ streetName | | Třeboňská | No |\n| Address street number | data/ data/ address/ streetNumber | | 1002/91 | No |\n| Address city | data/ data/ address/ city | | Ústí nad Labem | No |\n| Address ZIP code | data/ data/ address/ postalCode | | 36005 | No |\n| Address locality (code) | data/ data/ address/ locality/ code | Enumeration code for /api/v3/enums/localities | 567892 | Inherited |\n| Address locality (label) | data/ data/ address/ locality/ name | | Ústí nad Labem-město | No |\n| Address Czech specific city part | data/ data/ address/ countrySpecific/ cz/ cityPart | | Nové Město | No |\n| Address Czech specific city district | data/ data/ address/ countrySpecific/ cz/ cityDistrict | | Praha 2 | No |\n| Address Czech specific orientation number | data/ data/ address/ countrySpecific/ cz/ orientationNumber | | 1 | No |\n| Address Czech specific house number | data/ data/ address/ countrySpecific/ cz/ houseNumber | | 1961 | No |\n| Address Czech specific is evidence number | data/ data/ address/ countrySpecific/ cz/ isEvidenceNumber | | true | No |\n| Address Czech specific address point number | data/ data/ address/ countrySpecific/ cz/ ruian/ addressPointNumber | Unique ID for each address point in CZ by RUIAN | 21735883 | No |\n| Address Czech specific building number | data/ data/ address/ countrySpecific/ cz/ ruian/ buildingNumber | Unique ID for each building in CZ by RUIAN | 21674825 | No |\n| Address Czech specific street number | data/ data/ address/ countrySpecific/ cz/ ruian/ streetNumber | | 470881 | No |\n| Address Czech specific city borough number | data/ data/ address/ countrySpecific/ cz/ ruian/ cityBoroughNumber | | 27 | No |\n| Address Czech specific city district number | data/ data/ address/ countrySpecific/ cz/ ruian/ cityDistrictNumber | | 27500089 | No |\n| Address Czech specific municipality part number | data/ data/ address/ countrySpecific/ cz/ ruian/ municipalityPartNumber | | 490148 | No |\n| Address Czech specific municipality number | data/ data/ address/ countrySpecific/ cz/ ruian/ municipalityNumber | | 554782 | No |\n| Address Czech specific basic settlement unit number | data/ data/ address/ countrySpecific/ cz/ ruian/ basicSettlementUnitNumber | | 127311 | No |\n| Address Czech specific cadaster area number | data/ data/ address/ countrySpecific/ cz/ ruian/ cadasterAreaNumber | | 727181 | No |\n| Address Czech specific cadaster plot number | data/ data/ address/ countrySpecific/ cz/ ruian/ plotNumber | | | No |\n| Address Czech specific RUIAN URL | data/ data/ address/ countrySpecific/ cz/ ruian/ url | | https://vdp.cuzk.cz/vdp/ruian/adresnimista/21735883 | No |\n| Address Czech specific building purpose (code) | data/ data/ address/ countrySpecific/ cz/ purposeTypes/ code | Enumeration code for /api/v3/enums/purpose-types | residential | No |\n| Address Czech specific building purpose (label) | data/ data/ address/ countrySpecific/ cz/ purposeTypes/ name | Enumeration name for /api/v3/enums/purpose-types | | No |\n| Address Slovak specific building purpose (code) | data/ data/ address/ countrySpecific/ sk/ purposeTypes/ code | Enumeration code for /api/v3/enums/purpose-types | residential | No |\n| Address Slovak specific building purpose (label) | data/ data/ address/ countrySpecific/ sk/ purposeTypes/ name | Enumeration name for /api/v3/enums/purpose-types | | No |\n| Location category (code) | data/ data/ categories/ code | Enumeration code for /api/v3/locations/enums/categories | cat00048 | Inherited |\n| Location category confidence | data/ data/ categories/ confidence | How certain are we that the location is correctly categorized (0-1) | 0.9 | Inherited |\n| Location category (label) | data/ data/ categories/ name | | Supermarkety | No |\n| Entity residing in the location unique ID | data/ data/ company/ uniqueId | BizMachine ID unique across countries | cz-company-45308314 | Inherited |\n| Entity residing in the location national ID | data/ data/ company/ nationalIn | | 45308314 | Inherited |\n| Entity residing in the location name | data/ data/ company/ name | | Tesco Stores ČR a.s. | No |\n| Location email | data/ data/ contacts/ emails/ value | | info@itesco.cz | No |\n| Location email data source | data/ data/ contacts/ emails/ sources | currently not used | null | No |\n| Location phone number | data/ data/ contacts/ phoneNumbers/ value | | 00420725337109 | No |\n| Location phone number data source | data/ data/ contacts/ phoneNumbers/ sources | currently not used | null | No |\n| Location website | data/ data/ contacts/ websites/ value | | https://itesco.cz/prodejny/obchody-tesco/supermarket-chomutov-chomutovka | No |\n| Location website data source | data/ data/ contacts/ websites/ sources | currently not used | null | No |\n| Location established at date | data/ data/ establishedAt | | 2010-09-30T00:00:00+00:00 | No |\n| Location name | data/ data/ name | | Tesco | Yes |\n| Location SharpGrid ID | data/ data/ locationIn | SharpGrid unique location ID | BMPCZ00054975 | Yes |\n| Location picture URL | data/ data/ pictures/ url | | https://d48-a.sdn.cz/d_48/c_img_G_C/ts6veO.jpeg?fl=res,1100,800,1, | Inherited |\n| Last check of the location picture | data/ data/ pictures/ lastCheckedAt | | | No |\n| Location picture source (code) | data/ data/ pictures/ source/ code | Enumeration code for /api/v3/enums/sources | cz-firmycz | Inherited |\n| Location picture source (label) | data/ data/ pictures/ source/ name | | Firmy.cz | No |\n| Location source (code) | data/ data/ sources/ code | Enumeration code for /api/v3/enums/sources | google | Inherited |\n| Location ID on source | data/ data/ sources/ externalId | Original record ID on source (can be used to find the record on the original source) | ChIJRa2d6QsbCkcReN3VCyI74NI | No |\n| Location URL on source | data/ data/ sources/ url | | https://www.google.com/maps/place/?q=place_id:ChIJRa2d6QsbCkcReN3VCyI74NI | No |\n| Location rating count on source | data/ data/ sources/ rating/ count | | 377 | Inherited |\n| Location rating value as shown on source | data/ data/ sources/ rating/ text/ value | | 3.6/5 | No |\n| Location rating value on source processed | data/ data/ sources/ rating/ value | | 3.6 | No |\n| Location source (label) | data/ data/ sources/ name | Typically multiple sources from which the location is algorithmically compiled | Google Maps | No |\n| Location type (code) | data/ data/ type/ code | Enumeration code for /api/v3/locations/enums/types | Physical | Inherited |\n| Location type (label) | data/ data/ type/ name | Physical or virtual location | Physical | No |\n\n", "parameters": [ { "name": "Company.NationalIn", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Company.Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Type.Code", "in": "query", "description": "Location type code.", "schema": { "type": "string", "description": "Location type code.", "nullable": true } }, { "name": "Category.Code", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "IncludeBuildingInformation", "in": "query", "description": "Should the return payload contain buildings information?", "schema": { "type": "boolean", "description": "Should the return payload contain buildings information?" } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.GetLocationDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.GetLocationDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/share": { "post": { "tags": [ "Share" ], "summary": "Share link", "description": "Generates a share link to the company.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "National identifier of the company to share.", "required": true, "schema": { "type": "string", "description": "National identifier of the company to share.", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Share details, like language or expiration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareCompanyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/companies/{nationalIn}/iframe": { "post": { "tags": [ "Share" ], "summary": "Share IFrame link", "description": "Generate share link for a company with IFrame settings.", "parameters": [ { "name": "nationalIn", "in": "path", "description": "National identifier of the company to share.", "required": true, "schema": { "type": "string", "description": "National identifier of the company to share.", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Share details, like language or expiration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareCompanyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/subsidies": { "get": { "tags": [ "Subsidies" ], "summary": "Subsidies", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|-------------------------------------|-----------------------------------------------------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|------------------|\n| Subsidy unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-subsidy-eusubn7459073792591038698 | Yes |\n| Subsidy title | data/ data/ title | Caption of the subsidy | Snížení emisí TZL odprášení odsunových cest jižní části Aglomerace AMO | No |\n| 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 |\n| 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 |\n| Subsidy recipient entity nationalIn | data/ data/ recipient/ nationalIn | | 45193258 | Inherited |\n| Subsidy recipient entity name | data/ data/ recipient/ name | | Liberty Ostrava a.s. | No |\n| Subsidy provider entity nationalIn | data/ data/ providers/ nationalIn | | 00551023 | Inherited |\n| Subsidy provider entity name | data/ data/ providers/ name | | Ministerstvo práce a sociálních věcí | No |\n| Subsidy start date | data/ data/ startedAt | | 2021-03-05T00:00:00+00:00 | No |\n| Subsidy end date | data/ data/ finishedAt | | 2021-03-05T00:00:00+00:00 | No |\n| Subsidy published date | data/ data/ publishedAt | | 2021-03-05T00:00:00+00:00 | No |\n| Subsidy program url | data/ data/ programme/ url | | null | No |\n| Subsidy program name | data/ data/ programme/ name | | OP ZP | No |\n| Subsidy priority url | data/ data/ priority/ url | | null | No |\n| 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 |\n| URL of the subsidy | data/ data/ url | | https://www.web.cz/image.jpg | No |\n| Subsidy signing person | data/ data/ signature/ person | currently not used | null | No |\n| Subsidy signature date | data/ data/ signature/ createdAt | | 2018-09-12T02:00:00+00:00 | No |\n| Subsidy budget chapter | data/ data/ budgetChapter | currently not used | null | No |\n| Subsidy allocation start date | data/ data/ allocations/ startedAt | | 2009-01-01T00:00:00+00:00 | No |\n| Subsidy allocation end date | data/ data/ allocations/ finishedAt | | null | No |\n| Subsidy requested amount | data/ data/ allocations/ values/ required/ amount | Subsidy amount requested by the recipient | 18200 | No |\n| Subsidy requested amount currency | data/ data/ allocations/ values/ required/ currency | | CZK | No |\n| Subsidy allocated amount | data/ data/ allocations/ values/ decided/ amount | Subsidy amount allocated to the recipient | 18200 | No |\n| Subsidy allocated amount currency | data/ data/ allocations/ values/ decided/ currency | | CZK | No |\n| Subsidy consumed amount | data/ data/ allocations/ values/ consumed/ amount | | 18200 | No |\n| Subsidy consumed amount currency | data/ data/ allocations/ values/ consumed/ currency | | CZK | No |\n| Subsidy released amount | data/ data/ allocations/ values/ released/ amount | Subsidy amount made available to the recipient | 18200 | No |\n| Subsidy consumed amount currency | data/ data/ allocations/ values/ released/ currency | | CZK | No |\n| Subsidy drawn amount | data/ data/ allocations/ values/ drawn/ amount | Subsidy amount drawn (cashed in) by the recipient | 18200 | No |\n| Subsidy drawn amount currency | data/ data/ allocations/ values/ drawn/ currency | | CZK | No |\n| 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 |\n| Subsidy refund amount currency | data/ data/ allocations/ values/ refunded/ currency | | null | No |\n| Subsidy EU co-financing share | data/ data/ allocations/ values/ euCofinancingRate | Share of subsidy provided by EU funds (0-1) | 0.3 | No |\n| Subsidy keywords | data/ data/ keywords | currenty not used | null | No |\n| Subsidy topics (code) | data/ data/ topics/ code | currenty not used | null | No |\n| Subsidy topics (name) | data/ data/ topics/ name | currenty not used | null | No |\n| Subsidy topics confidence | data/ data/ topics/ cofidence | currenty not used | null | No |\n\n", "parameters": [ { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Published.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Published.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Started.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Started.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Source.Code", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "Source.ExternalId", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "Company.NationalIn", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Company.Role", "in": "query", "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.Params.SubsidyCompanyRole" } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/tags/{tagId}/shares/{userEmail}": { "put": { "tags": [ "Tags" ], "summary": "Create Tag share", "description": "Creates tag share to given users.", "parameters": [ { "name": "tagId", "in": "path", "description": "Tag ID create a share for.", "required": true, "schema": { "type": "string", "description": "Tag ID create a share for.", "nullable": true } }, { "name": "userEmail", "in": "path", "description": "User email address.", "required": true, "schema": { "type": "string", "description": "User email address.", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Share details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.ShareToDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.ShareToDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.ShareToDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.ShareToDto" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.GetTagSharesDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto" } } } } }, "security": [ { "ApiKey": [ ] } ] }, "delete": { "tags": [ "Tags" ], "summary": "Remove Tag share", "description": "Removes existing tag share from specific tag, identified by System.Guid, and user identified by email.", "parameters": [ { "name": "tagId", "in": "path", "description": "Unique tag identifier.", "required": true, "schema": { "type": "string", "description": "Unique tag identifier.", "format": "uuid" } }, { "name": "userEmail", "in": "path", "description": "User email address.", "required": true, "schema": { "type": "string", "description": "User email address." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v2/tags": { "post": { "tags": [ "Tags" ], "summary": "Create new Tag", "description": "Creates new, empty, user Tag with provided details.", "parameters": [ { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Information about the tag to be added.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AddTagDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AddTagDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AddTagDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AddTagDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagDto" } } } } }, "security": [ { "ApiKey": [ ] } ] }, "get": { "tags": [ "Tags" ], "summary": "Get user Tags", "description": "If no user is send via parameters it will take currently logged user.\r\nReturns list of all available tags for specific user.", "parameters": [ { "name": "User.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Roles", "in": "query", "description": "Shares roles to request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagShareRoleDto" }, "description": "Shares roles to request.", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagDto" } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v2/tags/{uid}": { "delete": { "tags": [ "Tags" ], "summary": "Delete Tag", "description": "Delete tag based on tag's unique identifier.\r\nTo delete a tag, you must be owner of the tag or have sufficient permissions.", "parameters": [ { "name": "uid", "in": "path", "description": "Tag's unique identifier.", "required": true, "schema": { "type": "string", "description": "Tag's unique identifier.", "format": "uuid" } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v2/tags/{uid}/companies": { "patch": { "tags": [ "Tags" ], "summary": "Update Tag Companies", "description": "Updates Tag's companies using PATCH operation.\r\nAllowed operations: add, remove\r\nAllowed path: /companyTags\r\nMore details on how to construct Patch JSON can be found in Guides section.", "parameters": [ { "name": "uid", "in": "path", "description": "Tag's unique identifier.", "required": true, "schema": { "type": "string", "description": "Tag's unique identifier.", "format": "uuid" } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JsonPatchDocument with update.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation" }, "description": "JsonPatchDocument with update.", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation" }, "description": "JsonPatchDocument with update.", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation" }, "description": "JsonPatchDocument with update.", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation" }, "description": "JsonPatchDocument with update.", "nullable": true } } } }, "responses": { "200": { "description": "Successfully updated a tag" }, "201": { "description": "Successfully requested an update, tag is being updated asynchronously" }, "400": { "description": "Invalid payload" }, "404": { "description": "Tag does not exist" } }, "security": [ { "ApiKey": [ ] } ] }, "get": { "tags": [ "Tags" ], "summary": "Get Tag companies", "description": "Gets a list of companies currently having a specific tag.", "parameters": [ { "name": "uid", "in": "path", "description": "Unique identifier of the tag.", "required": true, "schema": { "type": "string", "description": "Unique identifier of the tag.", "format": "uuid" } }, { "name": "includeNonExisting", "in": "query", "description": "Should the results contain non-existing companies? (default: false).", "schema": { "type": "boolean", "description": "Should the results contain non-existing companies? (default: false)." } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/tenders": { "get": { "tags": [ "Tenders" ], "summary": "Tenders", "description": "Endpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------|-----------------------------------------------------|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------|\n| Tender unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-tender-85c30945748a4d99af6efd8b455e24c6 | Yes |\n| Tender main buyer unique ID | data/ data/ mainBuyer/ uniqueId | BizMachine entity ID unique across countries | cz-company-45245053 | Inherited |\n| Tender main buyer national ID | data/ data/ mainBuyer/ nationalIn | | 45245053 | Inherited |\n| Tender main buyer name | data/ data/ mainBuyer/ name | | ČESKÝ ROZHLAS | No |\n| Tender main buyer type | data/ data/ mainBuyer/ type | legal form category of the buying entity | Company | No |\n| Tender buyer unique ID | data/ data/ buyers/ uniqueId | BizMachine entity ID unique across countries | cz-company-45245053 | Inherited |\n| Tender buyer national ID | data/ data/ buyers/ nationalIn | | 45245053 | Inherited |\n| Tender buyer name | data/ data/ buyers/ name | | ČESKÝ ROZHLAS | No |\n| Tender buyer type | data/ data/ buyers/ type | | Company | No |\n| Tender keywords | data/ data/ keywords | Currently not used | null | No |\n| Tender URL on source | data/ data/ url | | https://vestnikverejnychzakazek.cz/SearchForm/SearchContract?contractNumber=Z2022-015653 | Yes |\n| Tender filed at date | data/ data/ filedAt | | 2021-05-20T14:57:10+00:00 | Yes |\n| Tender published at date | data/ data/ publishedAt | | 2021-05-20T14:57:10+00:00 | No |\n| Tender updated on source at date | data/ data/ updatedAt | | 2021-05-24T15:52:43+00:00 | No |\n| Tender bidding start date | data/ data/ bidding/ startedAt | | 2021-05-20T13:07:40+00:00 | No |\n| Tender bidding end date | data/ data/ bidding/ finishedAt | | 2021-06-21T10:00:00+00:00 | No |\n| Tender amount (precise value) | data/ data/ value/ singleValue/ amount | Currently not used | 100.0 | Inherited |\n| Tender amount (precise value) | data/ data/ value/ singleValue/ currency | Currently not used | CZK | Inherited |\n| Tender minimum amount VAT type | data/ data/ value/ rangeValue/ lowerBound/ type | Amount with/without VAT or unknown | VatUnknown | Inherited |\n| Tender minimum amount | data/ data/ value/ rangeValue/ lowerBound/ amount | Minimum amount linked to the tender (expected or offered) | 16500000 | Inherited |\n| Tender minimum amount currency | data/ data/ value/ rangeValue/ lowerBound/ currency | Minimum amount linked to the tender (expected or offered) | CZK | Inherited |\n| Tender maximum amount VAT type | data/ data/ value/ rangeValue/ upperBound/ type | Amount with/without VAT or unknown | VatUnknown | Inherited |\n| Tender maximum amount | data/ data/ value/ rangeValue/ upperBound/ amount | Maximum amount linked to the tender (expected or offered) | 16500000 | Inherited |\n| Tender maximum amount currency | data/ data/ value/ rangeValue/ upperBound/ currency | Maximum amount linked to the tender (expected or offered) | CZK | Inherited |\n| Tender supplier unique ID | data/ data/ suppliers/ uniqueId | Entity, which was awarded the deal BizMachine ID unique across countries | cz-company-00268577 | Inherited |\n| Tender supplier national ID | data/ data/ suppliers/ nationalIn | Company, which was awarded the deal national ID | 00268577 | Inherited |\n| Tender supplier name | data/ data/ suppliers/ name | Company, which was awarded the deal name | Siemens, s.r.o. | No |\n| Tender supplier type | data/ data/ suppliers/ type | Company/physical person | Company | Inherited |\n| Tender winning price VAT type | data/ data/ suppliers/ value/ type | Amount with/without VAT or unknown | VatUnknown | Inherited |\n| Tender winning price | data/ data/ suppliers/ value/ amount | Awarded price | 7165161 | Inherited |\n| Tender winning price currency | data/ data/ suppliers/ value/ currency | Awarded price currency | CZK | Inherited |\n| Tender bidder unique ID | data/ data/ bidders/ uniqueId | BizMachine entity ID unique across countries | cz-company-00268577 | Inherited |\n| Tender bidder national ID | data/ data/ bidders/ nationalIn | | 00268577 | Inherited |\n| Tender bidder name | data/ data/ bidders/ name | | Siemens, s.r.o. | No |\n| Tender bidder type | data/ data/ bidders/ type | Company/physical person | Company | Inherited |\n| Tender offer VAT type | data/ data/ bidders/ offer/ type | Amount with/without VAT or unknown | vatUnknown | Inherited |\n| Tender offer amount | data/ data/ bidders/ offer/ ammount | | 500 | Inherited |\n| Tender offer currency | data/ data/ bidders/ offer/ currency | | CZK | Inherited |\n| Tender title | data/ data/ title | Tender caption | Zateplení střech budov 17 a 58 v areálu Siemens, s.r.o., odštěpný závod Elektromotory Frenštát | Yes |\n| Tender summary | data/ data/ summary | Short tender summary | Předmětem tohoto projektu je rekonstrukce střešního pláště, výměna světlíků a systém na zajištění… | No |\n| Tender description | data/ data/ text | Long tender description | Zateplení střech budov 17 a 58 v areálu Siemens, s.r.o., odštěpný závod Elektromotory Frenštát Předmětem tohoto projektu… | Yes |\n| Tender primary cpv (label) | data/ data/ cpv/ primary/ name | Primary product code (cpv) listed for the tender | Electrical machinery, apparatus, equipment and consumables; lighting | No |\n| Tender primary cpv (code) | data/ data/ cpv/ primary/ code | Enumeration code for /api/v3/enums/cpv-codes | 31000000-6 | Inherited |\n| Tender non-primary cpv (label) | data/ data/ cpv/ others/ name | Non-primary product code (cpv) listed for the tender | Construction work for industrial buildings | No |\n| Tender non-primary cpv (code) | data/ data/ cpv/ others/ code | Enumeration code for /api/v3/enums/cpv-codes | 45213250-0 | Inherited |\n| Tender topics code | data/ data/ topics/ code | Currently not used | null | Inherited |\n| Tender topics confidence | data/ data/ topics/ confidence | | 0.9 | Inherited |\n| Tender topics name | data/ data/ topics/ name | | automotive | No |\n| Tender process state code | data/ data/ state/ code | | awarded | Inherited |\n| Tender process state name | data/ data/ state/ name | | awarded | No |\n| Tender locality (code) | data/ data/ locality/ code | Currently not used | null | Inherited |\n| Tender locality (label) | data/ data/ locality/ name | Currently not used | null | No |\n\n", "parameters": [ { "name": "States", "in": "query", "description": "A collection of state codes to search for tenders.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A collection of state codes to search for tenders.", "nullable": true } }, { "name": "Company.NationalIn", "in": "query", "description": "National In Company ID for requested Tenders.", "schema": { "type": "string", "description": "National In Company ID for requested Tenders.", "nullable": true } }, { "name": "Company.Role", "in": "query", "description": "Role of requested Tenders.", "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.Enums.RoleCode" } }, { "name": "Published.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Published.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "BiddingStarted.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "BiddingStarted.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "BiddingFinished.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "BiddingFinished.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Value.From", "in": "query", "description": "Value to search from.", "schema": { "type": "number", "description": "Value to search from.", "format": "double", "nullable": true } }, { "name": "Value.To", "in": "query", "description": "Value to search to.", "schema": { "type": "number", "description": "Value to search to.", "format": "double", "nullable": true } }, { "name": "Cpv.Primary", "in": "query", "description": "A collection of primary CPVs to search for.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A collection of primary CPVs to search for.", "nullable": true } }, { "name": "Cpv.Other", "in": "query", "description": "A collection of other CPVs to search for.", "schema": { "type": "array", "items": { "type": "string" }, "description": "A collection of other CPVs to search for.", "nullable": true } }, { "name": "Tags", "in": "query", "description": "Collection of Tag Uids to filter requested Tenders by only those which are listed on one of these tags.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Collection of Tag Uids to filter requested Tenders by only those which are listed on one of these tags.", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTenderDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTenderDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v4/vehicles": { "get": { "tags": [ "Vehicles" ], "summary": "Finds vehicles based on input search parameters defined by requestDto.", "description": "\nDataset description:\n\nVehicles dataset lists individual vehicles from the national registration authority and includes their technical parameters, model, roadworthiness inspections. Vehicles are linked to operator and owner company. BizMachine computes several metrics and estimates about the individual vehicle's lifetime.\n\n> **WARNING**: Vehicles registered before 2014 may be missing or have a limited coverage of operator and owner data.\n\nAvailability:\n\ncz\n\nDataset updates:\n\nVehicle data is updated on a monthly basis. Basic registration data is available at on the 6th day of month. Related datasets such as operator changes, inspections and metrics follow in the 15-18th day.\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|---------------------------------------------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|------------------|\n| Vehicle unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-vehicle-17336428 | Yes |\n| Vehicle VIN | data/data/vin | 17-digit alphanumeric VIN code unique for each vehicle | 4Y1SL65848Z411439 | No |\n| Vehicle long name | data/data/name | Long name as described in vehicle registry | ŠKODA ENYAQ 80 D0ON1AA ACEBJAL1FX2 NY | No |\n| Vehicle technical certificate number | data/data/certificateNumber | \"Technicky prukaz\" in Czech | UL969804 | No |\n| Vehicle category (code) | data/data/category/code | Enumeration code for /api/v3/vehicles/enums/categories | M1 | Inherited |\n| Vehicle category (label) | data/data/category/name | | Passenger vehicles with no more than eight seats and mass not exceeding 3.5 tons | No |\n| Vehicle make (code) | data/data/make/code | Enumeration code for /api/v3/vehicles/enums/makes | V0031 | No |\n| Vehicle make (text) | data/data/make/text | Vehicle make as gathered on the source | ŠKODA | No |\n| Vehicle make (label) | data/data/make/name | Vehicle make processed | ŠKODA | No |\n| Vehicle make logo URL | data/data/make/icon/url | | https://cdn.bizmachine.com/images/icons/car_brands/Skoda.png | Inherited |\n| Vehicle model (code) | data/data/model/code | Enumeration code for /api/v3/vehicles/enums/models | V1241 | No |\n| Vehicle model (text) | data/data/model/text | Vehicle model as gathered on the source | ENYAQ 80 | No |\n| Vehicle model (label) | data/data/model/name | Vehicle model processed | ENYAQ 80 | No |\n| Vehicle type (code) | data/data/type/code | Enumeration code for /api/v3/vehicles/enums/types | truck-van | No |\n| Vehicle type (text) | data/data/type/text | Vehicle model as gathered on the source | Nákladní automobil skříňový | No |\n| Vehicle type (label) | data/data/type/name | Vehicle model processed | truck-van | No |\n| Vehicle status when registered | data/data/status | New/ used | New | Yes |\n| Vehicle weight unit | data/data/weight/total/unit | | kg | No |\n| Vehicle weight | data/data/weight/total/value | | 2090 | No |\n| Vehicle height unit | data/data/height/total/unit | | cm | No |\n| Vehicle height | data/data/height/total/value | | 1511 | No |\n| Vehicle length unit | data/data/length/total/unit | | cm | No |\n| Vehicle length | data/data/length/total/value | | 4862 | No |\n| Vehicle width unit | data/data/width/total/unit | | cm | No |\n| Vehicle width | data/data/width/total/value | | 1864 | No |\n| Vehicle transmission type | data/data/transmissionType | | Automatic | No |\n| Vehicle axle count | data/data/axleCount | | 2 | No |\n| Vehicle max passenger capacity | data/data/maxPassengers | | 5 | No |\n| Vehicle chassis type code | data/data/chassisType/code | Enumeration code for /api/v4/vehicles/enums/chassis-types | other | Inherited |\n| Vehicle chassis type label | data/data/chassisType/name | | Bodywork that is not included in this list | No |\n| Vehicle max speed unit | data/data/maxSpeed/unit | | km/h | No |\n| Vehicle max speed value | data/data/maxSpeed/value | | 236 | No |\n| Vehicle engine power unit | data/data/engine/power/unit | | kW | No |\n| Vehicle engine power value | data/data/engine/power/value | | 147 | No |\n| Vehicle fuel type code | data/data/fuel/type/code | Enumeration code for /api/v4/vehicles/enums/fuel-types | dies | No |\n| Vehicle fuel type label | data/data/fuel/type/value | | Diesel | No |\n| Vehicle fuel consumption category code | data/data/consumption/category/code | Enumeration code for /api/v4/vehicles/enums/fuel-consumption-categories | 1 | No |\n| Vehicle fuel consumption category label | data/data/consumption/category/name | | Less than 5 l/100km | No |\n| Vehicle fuel consumption unit | data/data/consumption/unit | | l/100km | No |\n| Vehicle emissions unit | data/data/emissions/unit | | g/km | No |\n| Vehicle emissions value | data/data/emissions/value | | 146 | No |\n| Vehice color as on source | data/data/body/text | Color as recorded on source | BÍLÁ | No |\n| Vehicle first globally registered operator type | data/data/registrations/international/type | Currently not used | unknown | Inherited |\n| Vehicle first global registration validity start date | data/data/registrations/international/validFrom | Can be the same as first domestic registration if the first registration was domestic | 2019-07-17 | Inherited |\n| Vehicle first global registration validity end date | data/data/registrations/international/validTo | Currently not used | null | No |\n| Vehicle first domestic registrant unique entity ID | data/data/registrations/domestic/uniqueId | Registering operator BizMachine entity ID unique across countries | cz-company-01759299 | Inherited |\n| Vehicle first domestic registrant national entity ID | data/data/registrations/domestic/nationalIn | Registering operator national ID | 01759299 | No |\n| Vehicle first domestic registrant type | data/data/registrations/domestic/type | Registering operator company/ person | Company | Inherited |\n| Vehicle first domestic registration validity start date | data/data/registrations/domestic/validFrom | | 2022-03-31 | Inherited |\n| Vehicle first domestic registration validity end date | data/data/registrations/domestic/validTo | Currently not used | null | No |\n| Vehicle exact mileage unit | data/data/metrics/mileage/timeline/value/unit | | km | No |\n| Vehicle exact mileage value | data/data/metrics/mileage/timeline/value/value | | 62848 | No |\n| Vehicle guaranteed mileage category code | data/data/metrics/mileage/timeline/category/code | Enumeration code for /api/v4/vehicles/enums/fuel-consumption-categories | mil21_100 | Inherited |\n| Vehicle guaranteed mileage category label | data/data/metrics/mileage/timeline/category/name | | 21-100 ths. Km | No |\n| Vehicle guaranteed mileage metric type | data/data/metrics/mileage/timeline/type | What type of value should I expect for this metric (e.g., value with units) | ValueUnit | Inherited |\n| Vehicle guaranteed mileage period start date | data/data/metrics/mileage/timeline/validFrom | | 2021-03-08T00:00:00+00:00 | Inherited |\n| Vehicle guaranteed mileage period end date | data/data/metrics/mileage/timeline/validTo | | 2021-03-08T00:00:00+00:00 | No |\n| Vehicle estimated mileage category code | data/data/metrics/estMileage/timeline/category/code | Enumeration code for /api/v4/vehicles/enums/fuel-consumption-categories | mil21_100 | Inherited |\n| Vehicle estimated mileage category label | data/data/metrics/estMileage/timeline/category/name | | 21-100 ths. Km | No |\n| Vehicle estimated mileage metric type | data/data/metrics/estMileage/timeline/type | What type of value should I expect for this metric (e.g., value with units) | ValueUnit | Inherited |\n| Vehicle estimated mileage period start date | data/data/metrics/estMileage/timeline/validFrom | | 2021-03-08T00:00:00+00:00 | Inherited |\n| Vehicle estimated mileage period end date | data/data/metrics/estMileage/timeline/validTo | | 2021-03-08T00:00:00+00:00 | No |\n| Vehicle inspection type code | data/data/inspections/code | Enumeration code for /api/v4/vehicles/enums/inspections | reg | Inherited |\n| Vehicle inspection type label | data/data/inspections/name | Emissions, roadworthiness, registration or other types of inspections | Registration Inspection | No |\n| Vehicle inspection validity start date | data/data/inspections/validFrom | | 2021-03-08T00:00:00 | Inherited |\n| Vehicle inspection validity end date | data/data/inspections/validTo | | 2021-12-17T00:00:00 | No |\n| Vehicle inspection result code | data/data/inspections/result/code | Enumeration code for /api/v4/vehicles/enums/inspection-results | rw | Inherited |\n| Vehicle inspection result label | data/data/inspections/result/name | | Roadworthy | No |\n| Vehicle inspection protocol ID | data/data/inspections/protocolId | | CZ-3843-21-09-1497 | No |\n| Vehicle inspection identified issues | data/data/inspections/issues | Currently not used | NULL | No |\n| Vehicle registered owner type | data/data/owners/type | Company/ person | Company | Inherited |\n| Vehicle registered owner entity unique ID | data/data/owners/uniqueId | BizMachine entity ID unique across countries | cz-company-15886492 | Inherited |\n| Vehicle registered owner entity national ID | data/data/owners/nationalIn | | 15886492 | Inherited |\n| Vehicle registered owner entity name | data/data/owners/name | | UniCredit Leasing CZ, a.s. | No |\n| Vehicle registered owner registration start date | data/data/owners/validFrom | | 2018-03-31 | Inherited |\n| Vehicle registered owner registration end date | data/data/owners/validTo | | 2022-03-31 | No |\n| Vehicle and registered owner attributes code | data/data/owners/attributes/code | Enumeration code for /api/v3/vehicles/enums/attributes | NEW | Inherited |\n| Vehicle and registered owner attributes label | data/data/owners/attributes/name | Attributes of the relationship between the owner and the vehicle (e.g., acquired new) | NEW | No |\n| Vehicle registered operator type | data/data/operators/type | | Company | Inherited |\n| Vehicle registered operator entity unique ID | data/data/operators/uniqueId | BizMachine entity ID unique across countries | cz-company-06618286 | Inherited |\n| Vehicle registered operator entity national ID | data/data/operators/nationalIn | | 06618286 | Inherited |\n| Vehicle registered operator entity name | data/data/operators/name | | Účetnictví B i S s.r.o. | No |\n| Vehicle registered operator registration start date | data/data/operators/validFrom | | 2020-03-31 | Inherited |\n| Vehicle registered operator registration end date | data/data/operators/validTo | | 2022-05-15 | No |\n| Vehicle and registered operator attributes code | data/data/operators/attributes/code | Enumeration code for /api/v3/vehicles/enums/attributes | LEASED | Inherited |\n| Vehicle and registered operator attributes label | data/data/operators/attributes/name | Attributes of the relationship between the operator and the vehicle (e.g., leased) | Leased | No |\n| Vehicle attribute (code) | data/data/attributes/code | Enumeration code for /api/v3/vehicles/enums/attributes | LEASED | Inherited |\n| Vehicle attribute (label) | data/data/attributes/name | Describe various \"qualities\" of the vehicle, or of the relationship vehicle - company | Leased | No |\n\n", "parameters": [ { "name": "Tag.Uid", "in": "query", "description": "Unique identifier.", "schema": { "type": "string", "description": "Unique identifier.", "format": "uuid", "nullable": true } }, { "name": "Company.UniqueId", "in": "query", "description": "Company unique identifier to search for.", "schema": { "type": "string", "description": "Company unique identifier to search for.", "nullable": true } }, { "name": "Company.SearchScope", "in": "query", "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Params.OwnershipOperationSearchScopeDto" } }, { "name": "Vin", "in": "query", "description": "VIN number of the vehicle to search for.", "schema": { "type": "string", "description": "VIN number of the vehicle to search for.", "nullable": true } }, { "name": "FirstDomesticRegistration.From", "in": "query", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "schema": { "type": "string", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "format": "date-time", "nullable": true } }, { "name": "FirstDomesticRegistration.To", "in": "query", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "schema": { "type": "string", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "format": "date-time", "nullable": true } }, { "name": "FirstRegistration.From", "in": "query", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "schema": { "type": "string", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "format": "date-time", "nullable": true } }, { "name": "FirstRegistration.To", "in": "query", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "schema": { "type": "string", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "format": "date-time", "nullable": true } }, { "name": "Registered.From", "in": "query", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "schema": { "type": "string", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "format": "date-time", "nullable": true } }, { "name": "Registered.To", "in": "query", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "schema": { "type": "string", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "format": "date-time", "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "CategoryCodes", "in": "query", "description": "Search by vehicle categories codes.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Search by vehicle categories codes.", "nullable": true } }, { "name": "MakeCodes", "in": "query", "description": "Search by vehicle make codes.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Search by vehicle make codes.", "nullable": true } }, { "name": "ModelCodes", "in": "query", "description": "Search by vehicle model codes.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Search by vehicle model codes.", "nullable": true } }, { "name": "TypeCodes", "in": "query", "description": "Search by vehicle type codes.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Search by vehicle type codes.", "nullable": true } }, { "name": "Statuses", "in": "query", "description": "Search by vehicle statuses.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Vehicles.DataStructures.Enums.VehicleStatus" }, "description": "Search by vehicle statuses.", "nullable": true } }, { "name": "AttributeCodes", "in": "query", "description": "Search by vehicle attribute codes.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Search by vehicle attribute codes.", "nullable": true } }, { "name": "EstimatedOperatingArea", "in": "query", "description": "Search by the estimated operating area of the vehicle, as locality codes. A broader\r\nlocality also matches vehicles whose estimated operating area sits anywhere below it in\r\nthe locality tree, so filtering by a region returns vehicles estimated to operate in any\r\nof its districts.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Search by the estimated operating area of the vehicle, as locality codes. A broader\r\nlocality also matches vehicles whose estimated operating area sits anywhere below it in\r\nthe locality tree, so filtering by a region returns vehicles estimated to operate in any\r\nof its districts.", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.VehiclesDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.VehiclesDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/{dataset}/v3/vehicles": { "get": { "tags": [ "Obsolete" ], "summary": "Vehicles", "description": "Dataset description:\n\nVehicles dataset lists individual vehicles from the national registration authority and includes their technical parameters, model, roadworthiness inspections. Vehicles are linked to operator and owner company. BizMachine computes several metrics and estimates about the individual vehicle's lifetime.\n\n> :warning: Vehicles registered before 2014 may be missing or have a limited coverage of operator and owner data trail.\n\nAvailability:\n\ncz\n\nDataset updates:\n\nVehicle data is updated on a monthly basis. Basic registration data is available at on the 6th day of month. Related datasets such as operator changes, inspections and metrics follow in the 15-18th day.\n\n\nEndpoint variables description:\n\n| Item commercial name | Path | Item description | Example | Always populated |\n|----------------------------------------------------------|--------------------------------------------------------------|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|------------------|\n| Vehicle unique ID | data/ data/ uniqueId | BizMachine ID unique across countries | cz-vehicle-123456 | Yes |\n| Vehicle VIN | data/ data/ vin | 17-digit alphanumeric VIN code unique for each vehicle | 4Y1SL65848Z411439 | No |\n| Vehicle long name | data/ data/ name | Long name as described in vehicle registry | ŠKODA ENYAQ 80 D0ON1AA ACEBJAL1FX2 NY | No |\n| Vehicle technical certificate number | data/ data/ certificateNumber | \"Technicky prukaz\" in Czech | UL969804 | No |\n| Vehicle category (code) | data/ data/ category/ code | Enumeration code for /api/v3/vehicles/enums/categories | M1 | Inherited |\n| Vehicle category (label) | data/ data/ category/ name | | Passenger vehicles with no more than eight seats and mass not exceeding 3.5 tons | No |\n| Vehicle make (code) | data/ data/ make/ code | Enumeration code for /api/v3/vehicles/enums/makes | V0031 | No |\n| Vehicle make (text) | data/ data/ make/ text | Vehicle make as gathered on the source | ŠKODA | No |\n| Vehicle make (label) | data/ data/ make/ name | Vehicle make processed | ŠKODA | No |\n| Vehicle make logo URL | data/ data/ make/ icon/ url | | https://cdn.bizmachine.com/images/icons/car_brands/Skoda.png | Inherited |\n| Vehicle model (code) | data/ data/ model/ code | Enumeration code for /api/v3/vehicles/enums/models | V1241 | No |\n| Vehicle model (text) | data/ data/ model/ text | Vehicle model as gathered on the source | ENYAQ 80 | No |\n| Vehicle model (label) | data/ data/ model/ name | Vehicle model processed | ENYAQ 80 | No |\n| Vehicle type (text) | data/ data/ type/ code | | pass-sedan | Inherited |\n| Vehicle type (label) | data/ data/ type/ name | | OSOBNÍ SEDAN | No |\n| Vehicle status when registered | data/ status | New/ used | New | Yes |\n| Vehicle weight unit | data/ data/ weight/ total/ unit | | kg | No |\n| Vehicle weight | data/ data/ weight/ total/ value | | 2090 | No |\n| Vehicle engine displacement unit | data/ data/ engine/ displacement/ unit | | cm3 | No |\n| Vehicle engine displacement value | data/ data/ engine/ displacement/ value | | 1893 | No |\n| Vehicle engine fuel type | data/ data/ engine/ fuelType | | dies | No |\n| Vehicle body | data/ data/ body/ color | | ČERNÁ | Inherited |\n| Vehicle first globally registered operator type | data/ data/ registrations/ international/ type | Currently not used | unknown | No |\n| Vehicle first global registration termination method | data/ data/ registrations/ international/ terminationMethod | Currently not used | null | No |\n| Vehicle first global registration address | data/ data/ registrations/ international/ address/ text | Currently not used | null | No |\n| Vehicle first global registration valid from date | data/ data/ registrations/ international/ validFrom | Can be the same as first domestic registration if the first registration was domestic | 2019-07-17 | Inherited |\n| Vehicle first global registration valid till date | data/ data/ registrations/ international/ validTo | Currently not used | null | No |\n| Vehicle first domestic registrant national entity ID | data/ data/ registrations/ domestic/ nationalIn | Registering operator national ID | 01759299 | Inherited |\n| Vehicle first domestic registrant unique entity ID | data/ data/ registrations/ domestic/ uniqueId | Registering operator BizMachine entity ID unique across countries | cz-company-01759299 | Inherited |\n| Vehicle first domestic registrant type | data/ data/ registrations/ domestic/ type | Registering operator company/ person | Company | No |\n| Vehicle first domestic registration address as on source | data/ data/ registrations/ domestic/ address/ text | Typically registration district | ŠUMPERK | No |\n| Vehicle first domestic registration locality (code) | data/ data/ registrations/ domestic/ address/ locality/ code | Enumeration code for /api/v3/enums/localities | CZ0715 | Inherited |\n| Vehicle first domestic registration locality (label) | data/ data/ registrations/ domestic/ address/ locality/ name | Typically registration district | Šumperk | No |\n| Vehicle first domestic registration valid from date | data/ data/ registrations/ domestic/ validFrom | | 2022-03-31 | Inherited |\n| Vehicle first domestic registration valid till date | data/ data/ registrations/ domestic/ validTo | Currently not used | null | No |\n| Vehicle registered owner type | data/ data/ owners/ type | Company/ person | Company | Inherited |\n| Vehicle registered owner entity unique ID | data/ data/ owners/ uniqueId | BizMachine entity ID unique across countries | cz-company-15886492 | Inherited |\n| Vehicle registered owner entity national ID | data/ data/ owners/ nationalIn | | 15886492 | No |\n| Vehicle registered owner entity name | data/ data/ owners/ name | | UniCredit Leasing CZ, a.s. | No |\n| Vehicle registered owner registration start date | data/ data/ owners/ validFrom | | 2022-03-31 | Inherited |\n| Vehicle registered owner registration end date | data/ data/ owners/ validTo | Currently not used | null | No |\n| Vehicle registered operator type | data/ data/ operators/ type | | Company | Inherited |\n| Vehicle registered operator entity unique ID | data/ data/ operators/ uniqueId | BizMachine entity ID unique across countries | cz-company-06618286 | Inherited |\n| Vehicle registered operator entity national ID | data/ data/ operators/ nationalIn | | 06618286 | No |\n| Vehicle registered operator entity name | data/ data/ operators/ name | | Účetnictví B i S s.r.o. | No |\n| Vehicle registered operator registration start date | data/ data/ operators/ validFrom | | 2022-03-31 | Inherited |\n| Vehicle registered operator registration end date | data/ data/ operators/ validTo | Currently not used | null | No |\n| Vehicle attribute (code) | data/ data/ attributes/ code | Enumeration code for /api/v3/vehicles/enums/attributes | LEASED | Inherited |\n| Vehicle attribute (label) | data/ data/ attributes/ name | Describe various \"qualities\" of the vehicle, or of the relationship vehicle - company | Leased | No |\n\n", "parameters": [ { "name": "Company.SearchScope", "in": "query", "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Params.VehicleNationalInSearchScope" } }, { "name": "Company.NationalIn", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Vin", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "FirstDomesticRegistration.From", "in": "query", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "schema": { "type": "string", "description": "Bottom filtering bound to filter by.\r\nThis lower bound is included in the results.", "format": "date-time", "nullable": true } }, { "name": "FirstDomesticRegistration.To", "in": "query", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "schema": { "type": "string", "description": "Upper filtering bound to filter by.\r\nUpper bound is not included in the results.", "format": "date-time", "nullable": true } }, { "name": "CategoryCodes", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "MakeCodes", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "ModelCodes", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "TypeCodes", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "Statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.VehicleStatus" }, "nullable": true } }, { "name": "AttributeCodes", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, { "name": "Updated.From", "in": "query", "description": "Search data by System.DateTimeOffset starting from this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset starting from this value.", "format": "date-time", "nullable": true } }, { "name": "Updated.To", "in": "query", "description": "Search data by System.DateTimeOffset up to this value.", "schema": { "type": "string", "description": "Search data by System.DateTimeOffset up to this value.", "format": "date-time", "nullable": true } }, { "name": "Offset", "in": "query", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "schema": { "type": "integer", "description": "Allows to specify offset from where to start streaming results.\r\nDefault value: 0", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Allows to specify limit of returned data.", "schema": { "type": "integer", "description": "Allows to specify limit of returned data.", "format": "int32", "default": 200 } }, { "name": "SortBy", "in": "query", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "schema": { "type": "string", "description": "Sorting order and field to sort by in format [sorting-order]([property-name])\r\nValid orders: desc, asc.\r\n \r\nExample: desc(createdAt)", "nullable": true } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto" } } } } }, "deprecated": true, "security": [ { "ApiKey": [ ] } ] } } }, "components": { "schemas": { "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.CoordinatesDto": { "type": "object", "properties": { "latitude": { "type": "number", "description": "GPS Latitude", "format": "double" }, "longitude": { "type": "number", "description": "GPS Longitude", "format": "double" } }, "additionalProperties": false, "description": "A DTO containing GPS coordinates details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.LocalityDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Locality unique code identifier." }, "name": { "type": "string", "description": "Localized locality name.", "nullable": true }, "types": { "type": "array", "items": { "type": "string" }, "description": "Locality types.", "nullable": true }, "parent": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.LocalityDto" } }, "additionalProperties": false, "description": "A DTO containing locality details." }, "BizMachine.Ultimate.DataStructures.Common.Models.Ruian": { "type": "object", "properties": { "addressPointNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "buildingNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "streetNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "cityBoroughNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "cityDistrictNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "municipalityPartNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "municipalityNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "basicSettlementUnitNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "cadasterAreaNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "plotNumber": { "minimum": 1, "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.PurposeTypeReferenceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Purpose type code." }, "name": { "type": "string", "description": "Purposed type localized name.", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.CzSpecificDataDto": { "type": "object", "properties": { "municipalityPart": { "type": "string", "nullable": true }, "cityBorough": { "type": "string", "nullable": true }, "cityDistrict": { "type": "string", "nullable": true }, "orientationNumber": { "type": "string", "nullable": true }, "houseNumber": { "type": "integer", "format": "int32", "nullable": true }, "isEvidenceNumber": { "type": "boolean" }, "ruian": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.Common.Models.Ruian" }, "purposeTypes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.PurposeTypeReferenceDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.SkSpecificDataDto": { "type": "object", "properties": { "purposeTypes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.PurposeTypeReferenceDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.CountrySpecificDataDto": { "type": "object", "properties": { "cz": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.CzSpecificDataDto" }, "sk": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.SkSpecificDataDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto": { "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of the content.", "nullable": true }, "updatedAt": { "type": "string", "description": "DateTime when content was updated at.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Meta information about the content." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.AddressDataDto": { "required": [ "_meta", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Address unique identifier." }, "text": { "type": "string", "description": "Address text.", "nullable": true }, "streetName": { "type": "string", "description": "Street name.", "nullable": true }, "streetNumber": { "type": "string", "description": "Street number.", "nullable": true }, "city": { "type": "string", "description": "City name.", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code.", "nullable": true }, "coordinates": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.CoordinatesDto" }, "locality": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.LocalityDto" }, "countrySpecific": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.CountrySpecificDataDto" }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto" } }, "additionalProperties": false, "description": "A DTO containing information about address." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.IdentifierEntryDto": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "Original company identifier value." }, "name": { "type": "string", "description": "Name of the identifier", "nullable": true }, "formattedValue": { "type": "string", "description": "Formatted company identifier value.", "nullable": true }, "description": { "type": "string", "description": "Description of the identifier", "nullable": true } }, "additionalProperties": false, "description": "A DTO holding company identifier and its formatted value." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.CompanyLogoDto": { "type": "object", "properties": { "url": { "type": "string", "description": "A URL link to company logo", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about company logo." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.CourtDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Court name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about registration court." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.RegistrationDto": { "type": "object", "properties": { "court": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.CourtDto" }, "fileNumber": { "type": "string", "description": "Registration file number.", "nullable": true }, "recordUrl": { "type": "string", "description": "Record URL address.", "nullable": true }, "createdAt": { "type": "string", "description": "DateTime when registration was created at.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing company registration information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumDataDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumParentDataDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string", "nullable": true }, "parent": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumParentDataDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.BasicInfoDataDto": { "required": [ "_meta", "nationalIn" ], "type": "object", "properties": { "nationalIn": { "type": "string", "description": "Company's national identifier." }, "identifiers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.IdentifierEntryDto" }, "description": "Additional company identifiers.", "nullable": true }, "name": { "type": "string", "description": "Company name.", "nullable": true }, "vatIn": { "type": "string", "description": "Company VAT number.", "nullable": true }, "isVerifiedVatPayer": { "type": "boolean", "description": "Is company verified VAT payer?" }, "taxIn": { "type": "string", "description": "Company TAX number.", "nullable": true }, "establishedAt": { "type": "string", "description": "Date when company was established at.", "format": "date-time", "nullable": true }, "disestablishedAt": { "type": "string", "description": "Date when company was disestablished at.", "format": "date-time", "nullable": true }, "closedAt": { "type": "string", "description": "Date when company was closed at.", "format": "date-time", "nullable": true }, "logo": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.CompanyLogoDto" }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Company keywords.", "nullable": true }, "registration": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.RegistrationDto" }, "health": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumDataDto" }, "legalForm": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumParentDataDto" }, "institutionalSector": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumParentDataDto" }, "selfDescription": { "type": "string", "description": "Company self description.", "nullable": true }, "selfDeclaredCategories": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumParentDataDto" }, "description": "Company self-declared categories.", "nullable": true }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto" } }, "additionalProperties": false, "description": "A DTO containing basic information about the company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.AmountCurrencyDto": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.AmountCurrencyDtoBizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryRangeDto": { "required": [ "code" ], "type": "object", "properties": { "lowerBound": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.AmountCurrencyDto" }, "upperBound": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.AmountCurrencyDto" }, "code": { "type": "string", "description": "A code of the category.", "example": "rev_1500M-inf" }, "name": { "type": "string", "description": "A name of the category.", "nullable": true, "example": "1 500 000 000 Kč a vice" } }, "additionalProperties": false, "description": "A category DTO holding integer lower and upper bound." }, "BizMachine.Ultimate.DataStructures.Common.Models.Metrics.MetricTypes": { "enum": [ "CategoryValueCurrency", "Category", "ValueRatio", "ValueBool", "ValueCurrency", "Value", "ValueRange", "ValueRangeCurrency", "ValueRangeRatio", "ValueUnit" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineCategoryValueCurrencyDto": { "required": [ "category", "type", "validFrom" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.AmountCurrencyDto" }, "category": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.AmountCurrencyDtoBizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryRangeDto" }, "name": { "type": "string", "description": "Contains localized name of metric entry.", "nullable": true }, "type": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.Common.Models.Metrics.MetricTypes" }, "validFrom": { "type": "string", "description": "System.DateTimeOffset from which the timeline is valid.", "format": "date-time" }, "validTo": { "type": "string", "description": "System.DateTimeOffset until which the timeline is valid.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO holding a timeline including BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryBaseDto which is valid in time interval." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto": { "required": [ "type", "validFrom" ], "type": "object", "properties": { "name": { "type": "string", "description": "Contains localized name of metric entry.", "nullable": true }, "type": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.Common.Models.Metrics.MetricTypes" }, "validFrom": { "type": "string", "description": "System.DateTimeOffset from which the timeline is valid.", "format": "date-time" }, "validTo": { "type": "string", "description": "System.DateTimeOffset until which the timeline is valid.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO holding a timeline including from/to System.DateTimeOffset." }, "System.Int32BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryRangeDto": { "required": [ "code" ], "type": "object", "properties": { "lowerBound": { "type": "integer", "description": "Lower bound of the category.", "format": "int32" }, "upperBound": { "type": "integer", "description": "Upper bound of the category.", "format": "int32" }, "code": { "type": "string", "description": "A code of the category.", "example": "rev_1500M-inf" }, "name": { "type": "string", "description": "A name of the category.", "nullable": true, "example": "1 500 000 000 Kč a vice" } }, "additionalProperties": false, "description": "A category DTO holding integer lower and upper bound." }, "System.Int32BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryRangeDtoBizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineCategoryDto": { "required": [ "category", "type", "validFrom" ], "type": "object", "properties": { "category": { "$ref": "#/components/schemas/System.Int32BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryRangeDto" }, "name": { "type": "string", "description": "Contains localized name of metric entry.", "nullable": true }, "type": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.Common.Models.Metrics.MetricTypes" }, "validFrom": { "type": "string", "description": "System.DateTimeOffset from which the timeline is valid.", "format": "date-time" }, "validTo": { "type": "string", "description": "System.DateTimeOffset until which the timeline is valid.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO holding a timeline including BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryBaseDto which is valid in time interval." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.MetricsDataDto": { "required": [ "_meta" ], "type": "object", "properties": { "revenue": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineCategoryValueCurrencyDto" }, "assetsTotal": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "netProfitMargin": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "revenueGrowth": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "isExporter": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "isImporter": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "employees": { "$ref": "#/components/schemas/System.Int32BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.CategoryRangeDtoBizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineCategoryDto" }, "connectedCompaniesCount": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "registeredCapital": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "ebit": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "ebitda": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "ebitMargin": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "vehiclesOperatedTotal": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "vehiclesOwnedTotal": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "vehiclesRegistered12Months": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "personnelCost": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "openJobCountCurrentTotal": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "latestFinancialsAvailable": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "publicOwnershipShare": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "privateOwnershipShare": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "foreignOwnershipShare": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "eshopCount": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "locationCount": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "riskCount": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "businessCardsCount": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "ownerAge": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.TimelineEntryDto" }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto" } }, "additionalProperties": false, "description": "A DTO containing information about the company metrics." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Nace.NaceDetailDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Locality unique code identifier." }, "name": { "type": "string", "description": "Localized locality name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing basic information about NACE." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Nace.NaceDataDto": { "required": [ "_meta" ], "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Nace.NaceDetailDto" }, "other": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Nace.NaceDetailDto" }, "description": "All others NACE details.", "nullable": true }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto" } }, "additionalProperties": false, "description": "A DTO containing company NACE information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactDto": { "required": [ "createdAt", "uniqueId", "value" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Contact unique identifier." }, "value": { "type": "string", "description": "Contact value." }, "valueFormatted": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "DateTime when contact was created.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "DateTime when contact was updated.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about the contact." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactsDataDto": { "required": [ "_meta" ], "type": "object", "properties": { "phoneNumber": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactDto" }, "email": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactDto" }, "website": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactDto" }, "linkedIn": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactDto" }, "facebook": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactDto" }, "twitter": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactDto" }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto" } }, "additionalProperties": false, "description": "A DTO containing information about company contacts." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.DriverDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Driver code.", "nullable": true }, "name": { "type": "string", "description": "Localized driver name.", "nullable": true }, "weight": { "type": "integer", "description": "Driver's weight.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing driver details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Localized name of the indicator", "nullable": true }, "value": { "type": "integer", "description": "Indicator value.", "format": "int32" }, "validFrom": { "type": "string", "description": "DateTime when indicator is valid from.", "format": "date-time" }, "validTo": { "type": "string", "description": "DateTime when indicator is valid to.", "format": "date-time", "nullable": true }, "drivers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.DriverDto" }, "description": "A list of drivers that are influencing the indicator.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing detailed indicator information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorsDataDto": { "required": [ "_meta" ], "type": "object", "properties": { "activity": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorDto" }, "covid19": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorDto" }, "growth": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorDto" }, "reachability": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorDto" }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto" } }, "additionalProperties": false, "description": "A DTO containing company indicators information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Risks.ConnectedCompanyDto": { "type": "object", "properties": { "uniqueId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Risks.RiskDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "parent": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumParentDataDto" }, "severity": { "type": "integer", "format": "int32" }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time", "nullable": true }, "connectedCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Risks.ConnectedCompanyDto" }, "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Enums.EnumDataDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Risks.RiskDataDto": { "required": [ "_meta" ], "type": "object", "properties": { "current": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Risks.RiskDto" }, "nullable": true }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.MetaDataDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.AggregatedDataContentDto": { "required": [ "companyUniqueId" ], "type": "object", "properties": { "companyUniqueId": { "type": "string", "description": "Company unique identifier." }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.AddressDataDto" }, "basicInfo": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.BasicInfoDataDto" }, "metrics": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.MetricsDataDto" }, "nace": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Nace.NaceDataDto" }, "contacts": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactsDataDto" }, "indicators": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorsDataDto" }, "risks": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Risks.RiskDataDto" } }, "additionalProperties": false, "description": "A DTO that contains company aggregated data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ProspectorDataDto": { "type": "object", "properties": { "link": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.ExtendedMetaDataDto": { "type": "object", "properties": { "prospector": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ProspectorDataDto" }, "hash": { "type": "string", "description": "Hash of the content.", "nullable": true }, "updatedAt": { "type": "string", "description": "DateTime when content was updated at.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Extended DTO meta data with API information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.AggregatedDataEnvelopeDto": { "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.AggregatedDataContentDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.ExtendedMetaDataDto" } }, "additionalProperties": false, "description": "Envelope that contains aggregated data and meta information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.EmailDto": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.OtpDto": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.ApiKeyDto": { "type": "object", "properties": { "apiKey": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.ApiKeyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.ApiKeyDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto": { "required": [ "currentPage", "maxPageSize", "pageSize", "totalItems", "totalPages" ], "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "maxPageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BulkAggregatedDataDto": { "required": [ "companyUniqueId" ], "type": "object", "properties": { "companyUniqueId": { "type": "string", "description": "Company unique identifier." }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Address.AddressDataDto" }, "basicInfo": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BasicInfo.BasicInfoDataDto" }, "metrics": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Metrics.MetricsDataDto" }, "nace": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Nace.NaceDataDto" }, "contacts": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Contacts.ContactsDataDto" }, "indicators": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Indicators.IndicatorsDataDto" }, "risks": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.Risks.RiskDataDto" }, "_meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.ExtendedMetaDataDto" } }, "additionalProperties": false, "description": "A DTO structure used for bulk retrieving aggregated data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BulkAggregatedDataDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.AggregatedData.v4.BulkAggregatedDataDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Modules.Companies.DataStructures.Models.Contacts.v4.ContactType": { "enum": [ "Phone", "Fax", "Email", "Website", "Other", "SocialMedia" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string" }, "nationalIn": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.NameDto": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.RoleDto": { "required": [ "validFrom" ], "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "format": "date" }, "validTo": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.DepartmentDto": { "required": [ "validFrom" ], "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "format": "date" }, "validTo": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.PersonDto": { "required": [ "name", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string" }, "name": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.NameDto" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.RoleDto" }, "nullable": true }, "departments": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.DepartmentDto" }, "nullable": true } }, "additionalProperties": false, "description": "An object containing information about a person." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.SourceDto": { "required": [ "code", "lastCheckedAt", "url" ], "type": "object", "properties": { "url": { "type": "string" }, "lastCheckedAt": { "type": "string", "format": "date-time" }, "code": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.StatusDto": { "required": [ "isVerified", "lastVerifiedAt" ], "type": "object", "properties": { "isVerified": { "type": "boolean" }, "lastVerifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.ContactDto": { "required": [ "confidence", "createdAt", "type", "uniqueId", "value", "valueFormatted" ], "type": "object", "properties": { "uniqueId": { "type": "string" }, "type": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "isPrimary": { "type": "boolean" }, "confidence": { "type": "number", "format": "double" }, "isPersonal": { "type": "boolean" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.SourceDto" }, "nullable": true }, "status": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.StatusDto" }, "value": { "type": "string" }, "valueFormatted": { "type": "string", "description": "Formatted value for phone contacts" } }, "additionalProperties": false, "description": "A class representing a single contact of a company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardDto": { "required": [ "company", "contacts" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto" }, "person": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.PersonDto" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.ContactDto" } } }, "additionalProperties": false, "description": "A DTO representing contacts of a single company grouped by person data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDataSourceDto": { "type": "object", "properties": { "code": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "externalId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.SupportedVerificationSourceDto": { "type": "object", "properties": { "contactUniqueId": { "type": "string", "description": "Matching unique id for the source.", "nullable": true }, "sourceUrl": { "type": "string", "description": "Full URL of the source.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing data about supported verification source." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsMetaDto": { "required": [ "createdAt", "hash" ], "type": "object", "properties": { "dataSources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDataSourceDto" }, "description": "Sources of the provided data.", "nullable": true }, "createdAt": { "type": "string", "description": "System.DateTimeOffset, when data was created at.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "System.DateTimeOffset, when data was updated at.", "format": "date-time", "nullable": true }, "hash": { "type": "string", "description": "Hash of the content." }, "searchHighlights": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Search highlights when searching for a business card.\r\nHighlighted parts are wrapped in tag.", "nullable": true }, "supportedVerificationSources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.SupportedVerificationSourceDto" }, "description": "A list of supported verification sources.", "nullable": true } }, "additionalProperties": false, "description": "Business cards meta wrapper with additional information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsDataMetaDto": { "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsMetaDto" } }, "additionalProperties": false, "description": "A DTO containing data and meta information about business cards." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.BusinessCards.BusinessCardsDataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.CoordinatesDto": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Latitude coordinate. Value is between -90 and 90.", "format": "double", "example": 49.5774191265 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Longitude coordinate. Value is between -180 and 180.", "format": "double", "example": 17.2819177995 } }, "additionalProperties": false, "description": "A DTO with GPS coordinates of the address." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Localities.v3.LocalityReferenceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Locality identification code.", "example": "CZ0712" }, "name": { "type": "string", "description": "Localized name of the location.", "nullable": true }, "types": { "type": "array", "items": { "type": "string" }, "description": "Gets or sets the System.String holding the type of the Locality.", "nullable": true }, "parent": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Localities.v3.LocalityReferenceDto" } }, "additionalProperties": false, "description": "A DTO containing data about locality." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.RuianDto": { "type": "object", "properties": { "addressPointNumber": { "type": "integer", "description": "Number identifying a specific address in RUIAN.", "format": "int32", "nullable": true }, "buildingNumber": { "type": "integer", "description": "Number identifying a specific building in RUIAN.", "format": "int32", "nullable": true }, "streetNumber": { "type": "integer", "description": "Number identifying a specific street in RUIAN.", "format": "int32", "nullable": true }, "cityBoroughNumber": { "type": "integer", "description": "Number of the city borough in RUIAN. Example: Prague 1, Prague 10.", "format": "int32", "nullable": true, "example": 10 }, "cityDistrictNumber": { "type": "integer", "description": "Code of the city district and the city part of the territorially divided statutory city.", "format": "int32", "nullable": true }, "municipalityPartNumber": { "type": "integer", "description": "Number of the municipality part (specific part of a village or town) in RUIAN.", "format": "int32", "nullable": true }, "municipalityNumber": { "type": "integer", "description": "Number identifying a specific municipality in RUIAN.", "format": "int32", "nullable": true }, "basicSettlementUnitNumber": { "type": "integer", "description": "Number of the basic settlement unit (administrative division) in RUIAN.", "format": "int32", "nullable": true }, "cadasterAreaNumber": { "type": "integer", "description": "Number of the cadaster area in RUIAN.", "format": "int32", "nullable": true }, "plotNumber": { "type": "integer", "description": "Number of the specific plot of land in RUIAN.", "format": "int64", "nullable": true }, "url": { "type": "string", "description": "Url to additional data about the address.", "format": "uri", "nullable": true } }, "additionalProperties": false, "description": "A DTO with RUIAN information related to the address." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.PurposeTypeReferenceDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Code value", "nullable": true, "example": "retail" }, "name": { "type": "string", "description": "Localized name related to the code value", "nullable": true, "example": "Prodej" } }, "additionalProperties": false, "description": "Dto holding Code and its Name" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.CzSpecificDataDto": { "type": "object", "properties": { "cityPart": { "type": "string", "description": "Name of the city part.", "nullable": true }, "cityBorough": { "type": "string", "description": "Name of the city borough.", "nullable": true }, "cityDistrict": { "type": "string", "description": "Name of the city district.", "nullable": true }, "orientationNumber": { "type": "string", "description": "Address orientation number.", "nullable": true }, "houseNumber": { "type": "integer", "description": "Address house number.", "format": "int32" }, "isEvidenceNumber": { "type": "boolean", "description": "Is it evidence number?" }, "ruian": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.RuianDto" }, "purposeTypes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.PurposeTypeReferenceDto" }, "description": "Collection of purpose codes with code names", "nullable": true } }, "additionalProperties": false, "description": "A DTO with specific data related to the Czech Republic." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.SkSpecificDataDto": { "required": [ "purposeTypes" ], "type": "object", "properties": { "purposeTypes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.PurposeTypeReferenceDto" }, "description": "Collection of purpose codes with code names" } }, "additionalProperties": false, "description": "A DTO with specific data related to Slovakia." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.CountrySpecificDataDto": { "type": "object", "properties": { "cz": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.CzSpecificDataDto" }, "sk": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.SkSpecificDataDto" } }, "additionalProperties": false, "description": "A DTO with country-specific information related to the address." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.GetAddressDto": { "required": [ "locality", "text", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique Address identifier.", "example": "cz-address-123456" }, "text": { "type": "string", "description": "Full address text." }, "coordinates": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.CoordinatesDto" }, "streetName": { "type": "string", "description": "Street name part of the address.", "nullable": true }, "streetNumber": { "type": "string", "description": "Street number part of the address.", "nullable": true }, "city": { "type": "string", "description": "City part of the address.", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code part of the address.", "nullable": true }, "locality": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Localities.v3.LocalityReferenceDto" }, "countrySpecific": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.CountrySpecificDataDto" } }, "additionalProperties": false, "description": "Holds information about the address." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDto": { "required": [ "company", "contact", "person" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto" }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.GetAddressDto" }, "person": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.PersonDto" }, "contact": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.ContactDto" } }, "additionalProperties": false, "description": "A DTO representing contacts of a single company grouped by a person." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto": { "required": [ "createdAt", "hash" ], "type": "object", "properties": { "dataSources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDataSourceDto" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "prospector": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ProspectorDataDto" }, "hash": { "type": "string" } }, "additionalProperties": false, "description": "A DTO for meta data related to Data requests or return objects" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Contacts.SingleContactDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.CompanyTagDto": { "type": "object", "properties": { "companyBid": { "type": "string", "description": "National identifier of the company.", "nullable": true }, "tagUid": { "type": "string", "description": "Unique identifier of the tag.", "format": "uuid" }, "name": { "type": "string", "description": "Tag name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about company-tag relation." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyUniqueIdentifierDto": { "required": [ "uniqueId" ], "type": "object", "properties": { "uniqueId": { "maxLength": 50, "type": "string", "description": "A globally unique identifier for the Company.\r\n\r\n cz-company-12345678\r\n" } }, "additionalProperties": false, "description": "A DTO for Unique identifier of a Company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankIconDto": { "type": "object", "properties": { "url": { "type": "string", "description": "Url to the location of an icon/image file.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold the Url to an icon file for a bank logo." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 6, "type": "string", "description": "A code representing the bank.", "example": "CZ0100" }, "name": { "type": "string", "description": "The name of the bank.", "nullable": true }, "icon": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankIconDto" } }, "additionalProperties": false, "description": "A DTO to hold basic information about a Bank." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankDataSourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 6, "type": "string", "description": "A code of the bank source." }, "name": { "type": "string", "description": "The name of the bank source.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold information about the source of information about a bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankAccountDto": { "required": [ "bank", "iban", "validFrom" ], "type": "object", "properties": { "bank": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankDto" }, "iban": { "type": "string", "description": "The IBAN of the account." }, "accountNumber": { "type": "string", "description": "The local account number of the account.", "nullable": true }, "validFrom": { "type": "string", "description": "Date the account was created.", "format": "date-time" }, "validTo": { "type": "string", "description": "Date the account was closed if applicable.", "format": "date-time", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankDataSourceDto" }, "description": "A collection of data sources. i.e. where the information about the account came from.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold information about a Company's bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.TimelineEntryDto": { "required": [ "validFrom" ], "type": "object", "properties": { "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO holding a timeline including from/to System.DateTimeOffset." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.ExtendedBankDto": { "required": [ "code", "timeline" ], "type": "object", "properties": { "timeline": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.TimelineEntryDto" }, "description": "A collection of timelines representing a Company's relationship with a bank which can span multiple accounts.\r\nIf there is a break in the relationship (e.g. all accounts were closed and then an account re-opened in the\r\nfuture) there will be multiple timelines." }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankDataSourceDto" }, "description": "An System.Collections.Generic.ICollection`1 of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankDataSourceDto. Essentially a list of sources\r\nwhere the information about a company's bank account came from.", "nullable": true }, "code": { "maxLength": 6, "type": "string", "description": "A code representing the bank.", "example": "CZ0100" }, "name": { "type": "string", "description": "The name of the bank.", "nullable": true }, "icon": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankIconDto" } }, "additionalProperties": false, "description": "A DTO for extended information about a Bank in the context of a Company's bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDto": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyUniqueIdentifierDto" }, "bankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankAccountDto" }, "description": "A collection of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankAccountDto holding data about bank accounts held by the Company.", "nullable": true }, "banks": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.ExtendedBankDto" }, "description": "A collection of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.BankDto holding data about the banks where the company's accounts are held.", "nullable": true } }, "additionalProperties": false, "description": "A DTO for data related to a Company's bank account information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BankAccounts.GetCompanyBankAccountDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankIconDto": { "type": "object", "properties": { "url": { "type": "string", "description": "Url to the location of an icon/image file.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold the Url to an icon file for a bank logo." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.BankDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 6, "type": "string", "description": "A code representing the bank.", "example": "CZ0100" }, "name": { "type": "string", "description": "The name of the bank.", "nullable": true }, "icon": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankIconDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankSourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A code of the bank source." }, "name": { "type": "string", "description": "The name of the bank source.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold information about the source of information about a bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.BankAccountDto": { "required": [ "bank", "validFrom" ], "type": "object", "properties": { "bank": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.BankDto" }, "iban": { "type": "string", "description": "The IBAN of the account.", "nullable": true }, "accountNumber": { "type": "string", "description": "The local account number of the account.", "nullable": true }, "validFrom": { "type": "string", "description": "Date the account was created.", "format": "date-time" }, "validTo": { "type": "string", "description": "Date the account was closed if applicable.", "format": "date-time", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankSourceDto" }, "description": "A collection of data sources. i.e. where the information about the account came from.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold information about a Company's bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDto": { "required": [ "bankAccount", "company" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto" }, "bankAccount": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.BankAccountDto" } }, "additionalProperties": false, "description": "A DTO to hold information about a Company's bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankAccounts.GetBankAccountDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.ExtendedBankDto": { "required": [ "code", "validFrom" ], "type": "object", "properties": { "validFrom": { "type": "string", "description": "DateTime from which this information is valid.", "format": "date-time" }, "validTo": { "type": "string", "description": "DateTime upon which this information is valid.", "format": "date-time", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankSourceDto" }, "description": "A collection of data sources. i.e. where the information about the account came from.", "nullable": true }, "code": { "maxLength": 6, "type": "string", "description": "A code representing the bank.", "example": "CZ0100" }, "name": { "type": "string", "description": "The name of the bank.", "nullable": true }, "icon": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.BankIconDto" } }, "additionalProperties": false, "description": "A DTO to hold information about a bank where company has bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDto": { "required": [ "bank", "company" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto" }, "bank": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.ExtendedBankDto" } }, "additionalProperties": false, "description": "A DTO to hold information about a Company's bank account." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.BanksAndBankAccounts.Banks.GetBankDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.IdentifierEntryDto": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "Original company identifier value." }, "name": { "type": "string", "description": "Name of the identifier", "nullable": true }, "formattedValue": { "type": "string", "description": "Formatted company identifier value.", "nullable": true }, "description": { "type": "string", "description": "Description of the identifier", "nullable": true }, "isPrimary": { "type": "boolean", "description": "Is primary identifier flag" } }, "additionalProperties": false, "description": "A DTO holding company identifier and its formatted value." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.SelfDeclaredCategoryDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A SelfDeclaredCategory Code of the Company." }, "name": { "type": "string", "description": "Name corresponding with the code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold code value and the code name." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.SourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "type": "string", "description": "The code of the Source." }, "name": { "type": "string", "description": "The name of the Source.", "nullable": true } }, "additionalProperties": false, "description": "A DTO for information about the source of the data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BasicInfo.AlternativeNameDto": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "The alternative name text. Required field." }, "weight": { "maximum": 1, "minimum": 0, "type": "number", "description": "The weighting of the alternative name.", "format": "double", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.SourceDto" }, "description": "A collection of sources this name was found in.", "nullable": true } }, "additionalProperties": false, "description": "A DTO for a company alternative name." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.LogoDto": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "An Url address of the company logo." } }, "additionalProperties": false, "description": "A DTO to hold url of the Company logo." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.NameDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CreatorDto": { "type": "object", "properties": { "type": { "type": "string", "description": " Type of the Creator.\r\nPerson", "nullable": true }, "uniqueId": { "type": "string", "description": " UniqueId of the Creator.\r\ncz-person-123546", "nullable": true } }, "additionalProperties": false, "description": "A DTO with basic data about a Creator." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BeneficiaryRegistrationDto": { "type": "object", "properties": { "url": { "type": "string", "description": "A link to UBO registry", "nullable": true, "example": "https://esm.justice.cz/ias/issm/rejstrik-$sm?ico=05450641" } }, "additionalProperties": false, "description": "A DTO containing URL to UBO registry." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.RegistrationDto": { "required": [ "recordUrl" ], "type": "object", "properties": { "court": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.NameDto" }, "createdAt": { "type": "string", "description": "Date when registration was created.", "format": "date-time", "nullable": true }, "fileNumber": { "type": "string", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CreatorDto" }, "recordUrl": { "type": "string" }, "beneficiaryRegistration": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BeneficiaryRegistrationDto" } }, "additionalProperties": false, "description": "A DTO for information about the original registration of the Company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.DeregistrationDto": { "required": [ "createdAt" ], "type": "object", "properties": { "createdAt": { "type": "string", "description": "A System.DateTimeOffset the Deregistration was created.", "format": "date-time" }, "method": { "type": "string", "description": "The method of Deregistration.", "nullable": true } }, "additionalProperties": false, "description": "DTO for Deregistration data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.HealthDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A Health Code of the Company." }, "name": { "type": "string", "description": "Name corresponding with the code.", "nullable": true }, "isTerminated": { "type": "boolean", "description": "Gets or sets the System.Boolean flag to signal whether a Company has been terminated or not." } }, "additionalProperties": false, "description": "A DTO to hold code value and the code name." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.LegalFormDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A LegalForm Code of the Company." }, "name": { "type": "string", "description": "Name corresponding with the code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold code value and the code name." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.InstitutionalSectorDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A InstitutionalSector Code of the Company." }, "name": { "type": "string", "description": "Name corresponding with the code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold code value and the code name." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "A globally unique identifier for the Company.\r\n\r\n cz-company-12345678\r\n" }, "nationalIn": { "type": "string", "description": "The native National ID of the Company." }, "identifiers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.IdentifierEntryDto" }, "description": "Additional company identifiers.", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "A collection of keywords.", "nullable": true }, "selfDeclaredCategories": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.SelfDeclaredCategoryDto" }, "description": "A collection of company category codes.", "nullable": true }, "name": { "maxLength": 120, "type": "string", "description": "Name of the company up to Bizmachine.Prospector.Backend.Database.Models.StringLengthConstants.InternationalCompanyName\r\ncharacters in length.", "nullable": true }, "alternativeNames": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.BasicInfo.AlternativeNameDto" }, "description": "A collection of alternative names of the company.", "nullable": true }, "vatIn": { "type": "string", "description": "Country specific VAT number.", "nullable": true }, "taxIn": { "type": "string", "description": "Country specific TAX number.", "nullable": true }, "logo": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.LogoDto" }, "establishedAt": { "type": "string", "description": "A System.DateTimeOffset the company was established.", "format": "date-time", "nullable": true }, "disestablishedAt": { "type": "string", "description": "A System.DateTimeOffset the company was Disestablished.", "format": "date-time", "nullable": true }, "closedAt": { "type": "string", "description": "A System.DateTimeOffset \"the company closed the business.", "format": "date-time", "nullable": true }, "registration": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.RegistrationDto" }, "registeredCapital": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "deregistration": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.DeregistrationDto" }, "health": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.HealthDto" }, "legalForm": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.LegalFormDto" }, "institutionalSector": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.InstitutionalSectorDto" }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.GetAddressDto" }, "selfDescription": { "type": "string", "description": "A string with localised description of how the Company describes itself.", "nullable": true }, "isVerifiedVatPayer": { "type": "boolean", "description": "Specifies if the entity is verified as VAT payer." } }, "additionalProperties": false, "description": "A DTO for Basic Data about a Company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyBasicDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.CompanyUniqueIdDto": { "required": [ "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RelationshipTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RoleConnectionTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RoleDto": { "required": [ "activeFrom", "type" ], "type": "object", "properties": { "type": { "type": "string" }, "activeFrom": { "type": "string", "format": "date" }, "activeTo": { "type": "string", "format": "date", "nullable": true }, "connectionType": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RoleConnectionTypeDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RolesDto": { "type": "object", "properties": { "inCompany": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RoleDto" }, "nullable": true }, "inConnectedCompany": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RoleDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.ConnectionDto": { "required": [ "activeFrom", "roles", "type" ], "type": "object", "properties": { "type": { "type": "string" }, "roles": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RolesDto" }, "activeFrom": { "type": "string", "format": "date" }, "activeTo": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Metrics.v3.TimelineEntryDto": { "required": [ "type", "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of timeline metric/>.", "example": "ValueBool, ValueRatio, Category" }, "validFrom": { "type": "string", "description": "System.DateTimeOffset from which the timeline is valid.", "format": "date-time" }, "validTo": { "type": "string", "description": "System.DateTimeOffset until which the timeline is valid.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO holding a timeline including from/to System.DateTimeOffset." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDto": { "required": [ "activeFrom", "company", "relationshipType" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto" }, "relationshipType": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.RelationshipTypeDto" }, "activeFrom": { "type": "string", "format": "date" }, "activeTo": { "type": "string", "format": "date", "nullable": true }, "distance": { "maximum": 1, "minimum": 0, "type": "number", "format": "double", "nullable": true }, "connections": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.ConnectionDto" }, "nullable": true }, "metrics": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Metrics.v3.TimelineEntryDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDto": { "required": [ "company", "connectedCompanies" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.CompanyUniqueIdDto" }, "connectedCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDto" } } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.GetConnectedCompanyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.PersonDataDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "uniqueId": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.NameDto" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.RoleDto" }, "nullable": true }, "departments": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.DepartmentDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.PersonDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.ContactDto": { "required": [ "confidence", "createdAt", "guid", "value", "valueFormatted" ], "type": "object", "properties": { "guid": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "isPrimary": { "type": "boolean" }, "confidence": { "type": "number", "format": "double" }, "isPrivate": { "type": "boolean" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.SourceDto" }, "nullable": true }, "status": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.StatusDto" }, "person": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.PersonDto" }, "value": { "type": "string" }, "valueFormatted": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.TypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.SocialMediaEntryDto": { "required": [ "confidence", "createdAt", "guid", "type", "value", "valueFormatted" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.TypeDto" }, "guid": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "isPrimary": { "type": "boolean" }, "confidence": { "type": "number", "format": "double" }, "isPrivate": { "type": "boolean" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.SourceDto" }, "nullable": true }, "status": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.StatusDto" }, "person": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.PersonDto" }, "value": { "type": "string" }, "valueFormatted": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDto": { "type": "object", "properties": { "people": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.PersonDataDto" }, "nullable": true }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.ContactDto" }, "nullable": true }, "faxNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.ContactDto" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.ContactDto" }, "nullable": true }, "websites": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.ContactDto" }, "nullable": true }, "socialMedia": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.SocialMediaEntryDto" }, "nullable": true }, "other": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.ContactDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDto": { "required": [ "contacts", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string" }, "contacts": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Contacts.GetContactsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.UniqueIdDto": { "type": "object", "properties": { "uniqueId": { "maxLength": 50, "type": "string", "description": " A string of a max length of 50 characters.\r\ncz-company-12345678", "nullable": true } }, "additionalProperties": false, "description": "Provides a basic DTO for Objects with a UniqueId." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetDriverReference": { "required": [ "code", "weight" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the driver using the BMU type BizMachine.Ultimate.DataStructures.v1.Company.Models.Indicators.Types.DriverCode." }, "weight": { "type": "integer", "description": "Weight of the driver.", "format": "int32" }, "detail": { "type": "string", "description": "Non-localized value further qualifying the driver for the context of the company.\r\nSpecifies a number, time, technology, person, etc. (e.g., \"Pipedrive\").", "nullable": true }, "name": { "type": "string", "description": "Name of the driver.", "nullable": true } }, "additionalProperties": false, "description": "A DTO object for transferring information about a Driver." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.TimelineEntryDto": { "required": [ "drivers", "value" ], "type": "object", "properties": { "value": { "maximum": 100, "minimum": 0, "type": "integer", "description": "A integer value for the indicator between 0 and 100.", "format": "int32" }, "label": { "type": "string", "description": "Company-specific label providing additional context for the indicator.", "nullable": true }, "summary": { "type": "string", "description": "A localized summary.", "nullable": true }, "drivers": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetDriverReference" }, "description": "An System.Collections.Generic.ICollection`1 of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetDriverReference objects." }, "validFrom": { "type": "string", "description": "System.DateTimeOffset the BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.TimelineEntryDto is valid from.", "format": "date-time", "nullable": true }, "validTo": { "type": "string", "description": "System.DateTimeOffset the BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.TimelineEntryDto is valid until.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO to transfer timeline entries for Company N:BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorDto": { "required": [ "timeline" ], "type": "object", "properties": { "timeline": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.TimelineEntryDto" }, "description": "A timeline of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.TimelineEntryDto objects. It must not be \r\nand must contain at least one item." }, "name": { "type": "string", "description": "Contains localized name of indicator entry.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold a timeline collection of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.TimelineEntryDto objects." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDto": { "required": [ "company", "indicators" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.UniqueIdDto" }, "indicators": { "minLength": 1, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorDto" }, "description": " The collection of Indicator data as a System.Collections.Generic.IDictionary`2 with\r\nKey = System.String, Value = BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorDto. It must not be \r\nand must contain at least one item." } }, "additionalProperties": false, "description": "A DTO to hold a collection of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorDto data with respective string names." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.GetIndicatorsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Metrics.v3.MetricBaseDto": { "required": [ "timeline" ], "type": "object", "properties": { "timeline": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Metrics.v3.TimelineEntryDto" } }, "name": { "type": "string", "description": "Contains localized name of metric entry.", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDto": { "required": [ "company", "metrics" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.UniqueIdDto" }, "metrics": { "minLength": 1, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Metrics.v3.MetricBaseDto" } } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Metrics.GetCompanyMetricsDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Modules.Companies.DataStructures.Models.NaceCodeSourceEnum": { "enum": [ "Source", "Identified" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.NaceCodeDetailDto": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "maxLength": 6, "type": "string", "description": "The code of the NACE code up to Bizmachine.Prospector.Backend.Database.Models.StringLengthConstants.Code\r\ncharacters in length." }, "name": { "maxLength": 200, "type": "string", "description": "The name of the NACE code up to Bizmachine.Prospector.Backend.Database.Models.StringLengthConstants.LongName\r\ncharacters in length.", "nullable": true }, "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Companies.DataStructures.Models.NaceCodeSourceEnum" } }, "additionalProperties": false, "description": "A DTO with information about a NACE code of a Company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.NaceCodeEntityDto": { "required": [ "primary" ], "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.NaceCodeDetailDto" }, "other": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.NaceCodeDetailDto" }, "description": "A collection of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.NaceCodeDetailDto objects with data about the other NACE codes of a Company.", "nullable": true } }, "additionalProperties": false, "description": "A DTO for all available NACE codes of a Company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDto": { "required": [ "company", "nace" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyUniqueIdentifierDto" }, "nace": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.NaceCodeEntityDto" } }, "additionalProperties": false, "description": "Wrapper DTO for the Company's NACE codes." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Ultimate.DataStructures.v1.Company.Models.NaceCodes.Enums.NaceTypeEnum": { "enum": [ "Source", "Identified" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.BmuCompanyDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique identifier of the company." }, "nationalIn": { "type": "string", "description": "Company national identifier." }, "name": { "type": "string", "description": "Company's name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with company information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.NaceCodeBaseDto": { "required": [ "code", "name", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the NACE code." }, "name": { "type": "string", "description": "NACE code localized name." }, "isPrimary": { "type": "boolean", "description": "Is NACE code primary?" }, "type": { "type": "string", "description": "Type of NACE code.", "example": "Identified" } }, "additionalProperties": false, "description": "A DTO containing NACE code details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDto": { "required": [ "company", "nace" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.BmuCompanyDto" }, "nace": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.NaceCodeBaseDto" } }, "additionalProperties": false, "description": "A DTO containing NACE code details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.NaceCodes.GetNaceCodesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedEntitySourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A code of the owned entity source." }, "name": { "type": "string", "description": "Localized name for the source code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with owned entity source information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedEntityDto": { "required": [ "source", "type", "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the owned entity.", "example": "company" }, "share": { "maximum": 1, "minimum": 0, "type": "number", "description": "Floating point Percentage share of ownership between 0 and 1.0. if unknown.", "format": "double", "nullable": true }, "role": { "type": "string", "description": "A localised description of the Role the owner plays in the owned company.", "nullable": true }, "validFrom": { "type": "string", "description": "Date the ownership is valid from.", "format": "date-time" }, "validTo": { "type": "string", "description": "Date the ownership is valid to.", "format": "date-time", "nullable": true }, "source": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedEntitySourceDto" } }, "additionalProperties": false, "description": "DTO for generic owned company data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDto": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.UniqueIdDto" }, "ownedCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedEntityDto" }, "description": "List of owned companies.", "nullable": true } }, "additionalProperties": false, "description": "DTO for owned companies." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.OwnedCompanies.OwnedCompaniesDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyUniqueIdDto": { "required": [ "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string" } }, "additionalProperties": false, "description": "A type to hold the Company Unique Id as a string." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.OwnerEntitySourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A code of the owner entity source." }, "name": { "type": "string", "description": "Localized name for the source code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with owner entity source information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.Simple.SimpleRoleDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Role's type." } }, "additionalProperties": false, "description": "Simplified base DTO of the owner's role." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.SimpleTimelineEntryDto": { "required": [ "value" ], "type": "object", "properties": { "value": { "maximum": 100, "minimum": 0, "type": "integer", "description": "A integer value for the indicator between 0 and 100.", "format": "int32" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.Simple.SimpleConnectedCompanyDto": { "required": [ "roles", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Company unique identifier." }, "nationalIn": { "type": "string", "description": "Company's nationalIn.", "nullable": true }, "name": { "type": "string", "description": "Name of the company.", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.Simple.SimpleRoleDto" }, "description": "Collection of roles in the connected company." }, "indicators": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Indicators.SimpleTimelineEntryDto" }, "description": "Connected company's indicators.", "nullable": true }, "registration": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.RegistrationDto" } }, "additionalProperties": false, "description": "Simplified DTO of the connected company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.GetOwnerEntityDto": { "required": [ "source", "type", "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the owner entity.", "example": "company" }, "share": { "type": "number", "description": "Floating point Percentage share of ownership between 0 and 1.0. if unknown.", "format": "double", "nullable": true }, "validFrom": { "type": "string", "description": "Date the owner is valid from.", "format": "date" }, "validTo": { "type": "string", "description": "Date the owner is valid until. Can be null if the owner is still valid.", "format": "date", "nullable": true }, "role": { "type": "string", "description": "A localised description of the Role the owner plays in the company.", "nullable": true }, "source": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.OwnerEntitySourceDto" }, "connectedCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.ConnectedCompanies.Simple.SimpleConnectedCompanyDto" }, "description": "A collection of companies connected to this owner.", "nullable": true } }, "additionalProperties": false, "description": "Base DTO class to hold data on an Company owners." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDto": { "required": [ "company" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyUniqueIdDto" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.GetOwnerEntityDto" }, "description": "An System.Collections.Generic.ICollection`1 of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.GetOwnerEntityDto.", "nullable": true } }, "additionalProperties": false, "description": "A DTO for data about a the owners of a company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Owners.CompanyOwnersDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Ultimate.DataStructures.v1.Company.Models.Owners.Enums.OwnerEntityType": { "enum": [ "Company", "Person", "Unknown", "ForeignCompany" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.OwnerEntitySourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A code of the owner entity source." }, "name": { "type": "string", "description": "Localized name for the source code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with owner entity source information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerEntityDto": { "required": [ "source", "type", "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the owner entity.", "example": "company" }, "share": { "type": "number", "description": "Floating point Percentage share of ownership between 0 and 1.0. if unknown.", "format": "double", "nullable": true }, "validFrom": { "type": "string", "description": "Date the owner is valid from.", "format": "date" }, "validTo": { "type": "string", "description": "Date the owner is valid until. Can be null if the owner is still valid.", "format": "date", "nullable": true }, "role": { "type": "string", "description": "A localised description of the Role the owner plays in the company.", "nullable": true }, "source": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.OwnerEntitySourceDto" } }, "additionalProperties": false, "description": "Base DTO class to hold data on an Company owners." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDto": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.BmuCompanyDto" }, "owner": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerEntityDto" } }, "additionalProperties": false, "description": "A DTO to return single owner data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Owners.GetOwnerDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.ConnectedCompanyDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique identifier of the company." }, "nationalIn": { "type": "string", "description": "Company national identifier." }, "name": { "type": "string", "description": "Company's name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with connected company information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.RiskSourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Source unique identifier.", "example": "bizmachine" }, "name": { "type": "string", "description": "Source localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about risk source." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.RiskTimelineDto": { "required": [ "severity", "validFrom" ], "type": "object", "properties": { "severity": { "type": "integer", "description": "Severity of the risk.", "format": "int32" }, "validFrom": { "type": "string", "description": "A System.DateTimeOffset when the risk timeline becomes valid.", "format": "date-time" }, "validTo": { "type": "string", "description": "A System.DateTimeOffset when the timeline is valid to.", "format": "date-time", "nullable": true }, "connectedCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.ConnectedCompanyDto" }, "description": "Collection of connected companies tied to the risk timeline.", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.RiskSourceDto" }, "description": "Collection of timeline sources.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with risk timeline details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.RiskDto": { "required": [ "timeline" ], "type": "object", "properties": { "name": { "type": "string", "description": "Risk's localized name", "nullable": true }, "timeline": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.RiskTimelineDto" }, "description": "A collection of risk timelines." } }, "additionalProperties": false, "description": "A DTO containing risk details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDto": { "required": [ "company", "risks" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.UniqueIdDto" }, "risks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.RiskDto" }, "description": "A collection of risks." } }, "additionalProperties": false, "description": "A DTO wrapper with risk data related to the company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Risks.GetRisksDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.RiskSourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Source unique identifier.", "example": "bizmachine" }, "name": { "type": "string", "description": "Source localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about risk source." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.RiskDto": { "required": [ "code", "connectedCompanies", "severity", "sources", "validFrom" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the risk." }, "name": { "type": "string", "description": "Risk's localized name", "nullable": true }, "severity": { "type": "integer", "description": "Severity of the risk.", "format": "int32" }, "validFrom": { "type": "string", "description": "A System.DateTimeOffset when the risk timeline becomes valid.", "format": "date-time" }, "validTo": { "type": "string", "description": "A System.DateTimeOffset when the timeline is valid to.", "format": "date-time", "nullable": true }, "connectedCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.BmuCompanyDto" }, "description": "Collection of connected companies tied to the risk." }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.RiskSourceDto" }, "description": "Collection of sources." } }, "additionalProperties": false, "description": "A DTO containing risk details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDto": { "required": [ "company", "risk" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.BmuCompanyDto" }, "risk": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.RiskDto" } }, "additionalProperties": false, "description": "A DTO containing risk details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Risks.GetRiskDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.StatutorySourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A code of the source." }, "name": { "type": "string", "description": "The name of the source.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold information about the source of information about statutory." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.StatutoryBaseDto": { "required": [ "role", "source", "type", "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the Statutory Rep as a string.", "example": "person" }, "role": { "type": "string", "description": "A localised description of the Role of the Statutory Rep." }, "validFrom": { "type": "string", "description": "Date from when the Statutory Rep was associated with the parent company.", "format": "date" }, "validTo": { "type": "string", "description": "Date to when the Statutory Rep was associated with the parent company.", "format": "date", "nullable": true }, "source": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.StatutorySourceDto" } }, "additionalProperties": false, "description": "Describes a DTO to hold information about a Statutory Representative." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GovernanceStructureDto": { "required": [ "text", "validFrom" ], "type": "object", "properties": { "text": { "type": "string", "description": "Text of the governance structure." }, "validFrom": { "type": "string", "description": "Date when governance structure is valid from.", "format": "date" } }, "additionalProperties": false, "description": "Newest statutory governance structure details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDto": { "required": [ "company", "statutories" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyUniqueIdDto" }, "statutories": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.StatutoryBaseDto" }, "description": "An System.Collections.Generic.ICollection`1 of BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.StatutoryBaseDto instances." }, "governanceStructure": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GovernanceStructureDto" } }, "additionalProperties": false, "description": "A DTO for storage of Statutory representatives related to a company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.Statutories.GetCompanyStatutoryDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.WebsiteDto": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "Valid website url.", "format": "uri" } }, "additionalProperties": false, "description": "A DTO containing website URL." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.ContactsDto": { "type": "object", "properties": { "website": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.WebsiteDto" } }, "additionalProperties": false, "description": "A DTO containing suggest contacts details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.SuggestedCompanyDto": { "required": [ "name", "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique ID of a company." }, "nationalIn": { "type": "string", "description": "National IN of a company." }, "name": { "type": "string", "description": "Name of a company." }, "city": { "type": "string", "description": "City where the company is located.", "nullable": true }, "contacts": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.ContactsDto" }, "highlights": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Highlights of the matched fields.", "nullable": true } }, "additionalProperties": false, "description": "Contains data about suggested company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.SuggestedCompanyDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Suggest.SuggestedCompanyDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.TechnologySourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Source unique identifier.", "example": "bizmachine" }, "name": { "type": "string", "description": "Source localized name.", "nullable": true }, "url": { "type": "string", "description": "Source URL link.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about technology source." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.TechnologyDto": { "required": [ "code", "confidence", "lastSeenAt", "sources" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the technology." }, "name": { "type": "string", "description": "Technology's localized name", "nullable": true }, "confidence": { "type": "number", "description": "Confidence of the technology.", "format": "double" }, "lastSeenAt": { "type": "string", "description": "A System.DateTime when the technology was last seen at.", "format": "date-time" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.TechnologySourceDto" }, "description": "Collection of sources." } }, "additionalProperties": false, "description": "A DTO containing technology details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDto": { "required": [ "company", "technology" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.BmuCompanyDto" }, "technology": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.TechnologyDto" } }, "additionalProperties": false, "description": "A DTO containing technology details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Technologies.GetTechnologyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.RoleCode": { "enum": [ "Any", "Buyer", "Supplier" ], "type": "string", "description": "Enumeration of Roles a Company can have in a Contract" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContentDto": { "type": "object", "properties": { "text": { "type": "string", "description": "Text of the contract.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about contract content." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.StateDto": { "enum": [ "New", "Valid", "Draft", "Removed" ], "type": "string", "description": "Enumeration of states a contract can have." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.PersonDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the signatory." } }, "additionalProperties": false, "description": "A DTO containing information about person who signed the contract." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.SignatureDto": { "required": [ "createdAt" ], "type": "object", "properties": { "person": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.PersonDto" }, "createdAt": { "type": "string", "description": "Date when the contract was signed.", "format": "date-time" } }, "additionalProperties": false, "description": "A DTO containing information about who signed and when signed the contract." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.ValueDto": { "required": [ "amount", "currency", "vat" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Currency text.", "example": "CZK" }, "amount": { "type": "number", "description": "Amount of the contract.", "format": "double", "example": 376929 }, "vat": { "type": "integer", "description": "Value-added tax (VAT).", "format": "int32", "example": 21 } }, "additionalProperties": false, "description": "A DTO containing information about contract value." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.ValueWithTypeDto": { "required": [ "amount", "currency", "vat" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the value.", "nullable": true, "example": "vatIncluded" }, "currency": { "type": "string", "description": "Currency text.", "example": "CZK" }, "amount": { "type": "number", "description": "Amount of the contract.", "format": "double", "example": 376929 }, "vat": { "type": "integer", "description": "Value-added tax (VAT).", "format": "int32", "example": 21 } }, "additionalProperties": false, "description": "A DTO containing additional information about contract value." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.EntityBaseDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the entity." } }, "additionalProperties": false, "description": "Base DTO for contract entity." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.PartyBaseDto": { "required": [ "isPayer", "isPublisher", "isRecipient", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the party." }, "isPublisher": { "type": "boolean", "description": "Is the party publisher?" }, "isRecipient": { "type": "boolean", "description": "Is the party recipient?" }, "isPayer": { "type": "boolean", "description": "Is the party payer?" } }, "additionalProperties": false, "description": "Base DTO for contract party." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetTopicDto": { "required": [ "code", "confidence" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique code identifying topic." }, "name": { "type": "string", "description": "Localized name of the topic.", "nullable": true }, "confidence": { "type": "number", "description": "Confidence of how much the topic relates to the contract.", "format": "double" } }, "additionalProperties": false, "description": "A DTO containing information about contract topic." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.HashDto": { "required": [ "algorithm", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "Hash value.", "example": "378dbad7b9f4145cad5be6dacea466e58ea86a823e40f03d13d93c8c29106f4b" }, "algorithm": { "type": "string", "description": "Algorithm used for hashing.", "example": "sha2" } }, "additionalProperties": false, "description": "A DTO containing information about attachment hash." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetAttachmentDto": { "required": [ "title", "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL address of the attachment.", "format": "uri" }, "title": { "type": "string", "description": "Title of the attachment." }, "hash": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.HashDto" }, "text": { "type": "string", "description": "Text of the attachment.", "nullable": true }, "publishedAt": { "type": "string", "description": "Date then the attachment was published at.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about contract attachment." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContractDataDto": { "required": [ "parties", "publishedAt", "state", "title", "uniqueId", "url", "validFrom" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique identifier of the contract.", "example": "cz-contract-regsmluv-0000001301" }, "url": { "type": "string", "description": "An URL address of the contract.", "format": "uri" }, "version": { "type": "string", "description": "Version of the contract.", "nullable": true }, "title": { "type": "string", "description": "Localized contract title." }, "summary": { "type": "string", "description": "Localized contract summary.", "nullable": true }, "content": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContentDto" }, "state": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.StateDto" }, "publishedAt": { "type": "string", "description": "Date when the contract was published at.", "format": "date-time" }, "signature": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.SignatureDto" }, "originalLanguage": { "type": "string", "description": "Original language of the contract in ISO 3166 format.", "nullable": true, "example": "cs" }, "value": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.ValueDto" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.ValueWithTypeDto" }, "description": "Values of the contract with their types.", "nullable": true }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.EntityBaseDto" }, "description": "Entities that are referred in the Contract.", "nullable": true }, "validFrom": { "type": "string", "description": "Date the Contract is valid from.", "format": "date-time" }, "validTo": { "type": "string", "description": "Date the contract is valid to.", "format": "date-time", "nullable": true }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto" }, "description": "Information about contract buyers.", "nullable": true }, "suppliers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v3.CompanyDto" }, "description": "Information about contract suppliers.", "nullable": true }, "parties": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.PartyBaseDto" }, "description": "Collection of parties entering the contract agreement." }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Collection of keywords classifying the contract.", "nullable": true }, "topics": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetTopicDto" }, "description": "Topics of the contract with confidence of how much the topic relates to the contract.", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetAttachmentDto" }, "description": "A collection of document references attached to a contract.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about the contract." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContractDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContractDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContractDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Contracts.v3.GetContractDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.Models.PermissionDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Permission identifier.", "example": "custom.data.read" } }, "additionalProperties": false, "description": "A DTO containing required permission information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.Models.AttachedEntityBaseDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of entity.", "example": "Company" } }, "additionalProperties": false, "description": "A DTO containing information about type of attached entity of the custom data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.GetCustomDataEntryDto": { "required": [ "content", "dataKey", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Custom data unique identifier.", "example": "cz-customdata-123456789" }, "dataKey": { "type": "string", "description": "Data key categorizing the custom data." }, "permission": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.Models.PermissionDto" }, "attachedTo": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.Models.AttachedEntityBaseDto" }, "description": "Information about entity this custom data entry attached to.", "nullable": true }, "content": { "type": "string", "description": "Actual content of the custom data entry." } }, "additionalProperties": false, "description": "A DTO containing detailed information about custom data entry." }, "BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.GetCustomDataEntryDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.GetCustomDataEntryDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.GetCustomDataEntryDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.CustomData.v3.GetCustomDataEntryDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopCompanyDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Company unique identifier.", "example": "cz-company-05450641" }, "nationalIn": { "type": "string", "description": "Company national identifier.", "example": "05450641" }, "name": { "type": "string", "description": "Company name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing details about eshop company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.FeatureReferenceDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.AttributeReferenceDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopMetricsDto": { "type": "object", "properties": { "ratingCountTotal": { "type": "integer", "description": "A summary of ratings.", "format": "int32", "nullable": true }, "ratingValue": { "type": "number", "description": "Rating value of the source", "format": "double", "nullable": true }, "ratingCountIncrement": { "type": "number", "description": "Incremental value of the rating count.", "format": "double", "nullable": true }, "ratingCountChangePct": { "type": "number", "description": "Value of a change in the rating count.", "format": "double", "nullable": true }, "deliveryDurationDays": { "type": "integer", "description": "Delivery duration in days.", "format": "int32", "nullable": true }, "ratingValueDelivery": { "type": "number", "description": "Delivery rating.", "format": "double", "nullable": true }, "lastRatedAt": { "type": "string", "description": "The date of the last rating.", "format": "date-time", "nullable": true }, "productCount": { "type": "integer", "description": "A numerical value of products.", "format": "int32", "nullable": true }, "countryRank": { "type": "integer", "description": "Ranking number in the country.", "format": "int32", "nullable": true }, "searchTrafficEstimate": { "type": "integer", "description": "Estimate of search traffic.", "format": "int32", "nullable": true }, "searchTrafficEstimateChangePct": { "type": "number", "description": "Percentage of search traffic estimation.", "format": "double", "nullable": true }, "paidKeywords": { "type": "integer", "description": "Number of paid keywords.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A DTO holding information about eshop metrics." }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.ProductCategoryReferenceDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopSourceDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.AttributeReferenceDto" }, "nullable": true }, "metrics": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopMetricsDto" }, "productCategories": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.ProductCategoryReferenceDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.BrandReferenceDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Code of the brand.", "nullable": true }, "name": { "type": "string", "description": "Localized name of the brand.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about eshop brand." }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.PhoneNumberDto": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopContactsDto": { "type": "object", "properties": { "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.PhoneNumberDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.GetEShopDataDto": { "required": [ "company", "status", "uniqueId", "url" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Eshop unique identifier.", "example": "cz-eshop-540832" }, "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopCompanyDto" }, "name": { "type": "string", "description": "Name of the eshop.", "nullable": true }, "status": { "type": "string", "description": "Status in which eshop is.", "example": "Active, Inactive, Unknown" }, "url": { "type": "string", "description": "Eshop URL." }, "termsUrl": { "type": "string", "description": "Url of terms and conditions.", "nullable": true }, "establishedAt": { "type": "string", "description": "Date when eshop was established.", "format": "date", "nullable": true }, "description": { "type": "string", "description": "Description of the eshop.", "nullable": true }, "technologies": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.FeatureReferenceDto" }, "description": "A collection of eshop technologies.", "nullable": true }, "paymentOptions": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.FeatureReferenceDto" }, "description": "A collection of eshop payment options.", "nullable": true }, "deliveryOptions": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.FeatureReferenceDto" }, "description": "A collection of eshop delivery options.", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopSourceDto" }, "description": "A collection of eshop sources.", "nullable": true }, "brands": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.BrandReferenceDto" }, "description": "A Collection of brands.", "nullable": true }, "contacts": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.EShopContactsDto" }, "metrics": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Metrics.v3.MetricBaseDto" }, "description": "Eshop metrics.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing data about the eshop." }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.GetEShopDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.GetEShopDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.GetEShopDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.EShops.v3.GetEShopDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.Enum.FeedbackValueDto": { "enum": [ "Any", "Positive", "Negative" ], "type": "string", "description": "Feedback values enumeration for searching by a feedback." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.EventCategoryDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Event category code identifier." }, "name": { "type": "string", "description": "Category's localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with event category details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.EventEntityRoleDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Event role code identifier." }, "name": { "type": "string", "description": "Role's localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with event role details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.EventEntityDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Event entity type." }, "role": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.EventEntityRoleDto" } }, "additionalProperties": false, "description": "Base DTO with entity details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.Enum.PutFeedbackValueDto": { "enum": [ "Positive", "Negative" ], "type": "string", "description": "Feedback values enumeration for creating a feedback." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetSimpleFeedbackDto": { "required": [ "lastChanged", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.Enum.PutFeedbackValueDto" }, "lastChanged": { "type": "string", "description": "Date when the feedback was changed last.", "format": "date-time" } }, "additionalProperties": false, "description": "A DTO with details about user's event feedback." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetEventDataDto": { "required": [ "entities", "startedAt", "subject", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Event's unique identifier.", "example": "cz-event-31345678" }, "subject": { "type": "string", "description": "Event's localized subject." }, "summary": { "type": "string", "description": "Event's localized summary.", "nullable": true }, "text": { "type": "string", "description": "Event's localized text.", "nullable": true }, "url": { "type": "string", "description": "Event's URL address.", "nullable": true }, "publishedAt": { "type": "string", "description": "Date when the event was published.", "format": "date-time", "nullable": true }, "startedAt": { "type": "string", "description": "Date when the event was started.", "format": "date-time" }, "finishedAt": { "type": "string", "description": "Date when the event was finished.", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "description": "Date when the event expires.", "format": "date-time", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.EventCategoryDto" }, "description": "A collection of event's categories.", "nullable": true }, "severity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Event severity value.", "format": "int32", "nullable": true }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.EventEntityDto" }, "description": "A collection of event's entities." }, "feedback": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetSimpleFeedbackDto" } }, "additionalProperties": false, "description": "A DTO containing event's data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetEventDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetEventDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetEventDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Events.v3.GetEventDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Ultimate.DataStructures.v1.Models.FinancialReports.Enums.FinancialReportType": { "enum": [ "BalanceSheet", "BalanceSheetAssets", "BalanceSheetLiabilitiesEquity", "IncomeStatement", "CashFlow", "Unknown" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportCompanyDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Company unique identifier.", "example": "cz-company-05450641" }, "nationalIn": { "type": "string", "description": "Company national identifier.", "example": "05450641" }, "name": { "type": "string", "description": "Company name.", "nullable": true } }, "additionalProperties": false, "description": "Holds information about company in the financial report." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialStandardDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the financial item.", "example": "cas2016" }, "name": { "type": "string", "description": "Name of the financial standard.", "nullable": true } }, "additionalProperties": false, "description": "Enumeration reference DTO for financial standard." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportContentDto": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "Localized report text." }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Relevant report keywords.", "nullable": true } }, "additionalProperties": false, "description": "Holds information about report content." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportPeriodDto": { "required": [ "year" ], "type": "object", "properties": { "year": { "type": "integer", "description": "Year when the report was relevant.", "format": "int32" }, "startedAt": { "type": "string", "description": "Date when report was started at.", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "description": "Date when report was finished at.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Holds information about report period." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.AuditDto": { "required": [ "company" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportCompanyDto" }, "text": { "type": "string", "description": "Localized audit text.", "nullable": true } }, "additionalProperties": false, "description": "Holds information about financial report audit." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialItemDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the financial item.", "example": "bfid_001" }, "name": { "type": "string", "description": "Name of the financial item.", "nullable": true } }, "additionalProperties": false, "description": "Holds information about financial item." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportValuesDto": { "required": [ "confidence", "netto" ], "type": "object", "properties": { "netto": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "confidence": { "type": "number", "description": "Report value confidence.", "format": "double" }, "brutto": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "correction": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" } }, "additionalProperties": false, "description": "Holds information about financial report values." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportItemDto": { "required": [ "financialItem", "values" ], "type": "object", "properties": { "sourceName": { "type": "string", "description": "Name of the source.", "nullable": true }, "rowReference": { "type": "string", "description": "Item row reference.", "nullable": true }, "financialItem": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialItemDto" }, "values": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportValuesDto" } }, "additionalProperties": false, "description": "Holds information about financial report item." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.GetFinancialReportDto": { "required": [ "company", "items", "period", "standard", "type", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Report unique identifier.", "example": "cz-financial-22774637-2015-44585106" }, "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportCompanyDto" }, "standard": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialStandardDto" }, "type": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Models.FinancialReports.Enums.FinancialReportType" }, "title": { "type": "string", "description": "Report's localized title.", "nullable": true }, "url": { "type": "string", "description": "Report's URL.", "nullable": true }, "content": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportContentDto" }, "period": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportPeriodDto" }, "publishedAt": { "type": "string", "description": "Date when report was published at.", "format": "date-time", "nullable": true }, "audit": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.AuditDto" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.FinancialReportItemDto" }, "description": "Items contained in the report." } }, "additionalProperties": false, "description": "Holds information about company financial report." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.GetFinancialReportDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.GetFinancialReportDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.GetFinancialReportDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Financials.v3.GetFinancialReportDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.JobCompanyDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "nationalIn": { "type": "string" }, "uniqueId": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.CategoryDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "A category code of the job." }, "name": { "type": "string", "description": "Localized name corresponding to the category code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold code value and the code name." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.LocationDto": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "Location information in a text form.", "example": "\"Zkumavka s.r.o. - pracoviště Bouda" }, "locality": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Localities.v3.LocalityReferenceDto" } }, "additionalProperties": false, "description": "A DTO to hold location information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryAmountCurrencyDto": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryRangeDto": { "type": "object", "properties": { "lowerBound": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryAmountCurrencyDto" }, "upperBound": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryAmountCurrencyDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryPeriodType": { "enum": [ "Unknown", "Hourly", "Monthly" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryDto": { "required": [ "period", "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "Salary information in text format.", "example": "16000.00" }, "singleValue": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryAmountCurrencyDto" }, "rangeValue": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryRangeDto" }, "period": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryPeriodType" } }, "additionalProperties": false, "description": "A DTO to hold information about salary." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.IscoDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Isco code of the job." }, "name": { "type": "string", "description": "Localized name corresponding to the Isco code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO to hold code value and the code name." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.EmploymentType": { "enum": [ "Unknown", "Parttime", "Fulltime" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.BenefitDto": { "type": "object", "properties": { "code": { "type": "string", "description": "A benefit code of the job.", "nullable": true, "example": "meals" }, "name": { "type": "string", "description": "Localized name corresponding to the benefit code.", "nullable": true }, "value": { "type": "string", "description": "Additional information to the benefit.", "nullable": true, "example": "stravování" } }, "additionalProperties": false, "description": "A DTO that holds information about job benefit." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.RequirementDto": { "type": "object", "properties": { "code": { "type": "string", "description": "A requirement code of the job.", "nullable": true, "example": "education" }, "name": { "type": "string", "description": "Localized name corresponding to the requirement code.", "nullable": true }, "value": { "type": "string", "description": "Additional information to the requirement.", "nullable": true, "example": "elementary" } }, "additionalProperties": false, "description": "A DTO that holds information about job requirement." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryContactType": { "enum": [ "Unknown", "Phone", "Email" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.ContactDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryContactType" }, "value": { "type": "string", "description": "Contact value.", "nullable": true, "example": "tel.: 111 490 001, e-mail: firma123@email.com" } }, "additionalProperties": false, "description": "A DTO to hold information about contact." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.GetJobDataDto": { "required": [ "company", "title", "uniqueId", "url", "validFrom" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique identifier of the job.", "example": "cz-jobposting-123456" }, "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.JobCompanyDto" }, "title": { "type": "string", "description": "Title of the job." }, "description": { "type": "string", "description": "Description of the job.", "nullable": true }, "url": { "type": "string", "description": "Url of the job." }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Collection of keywords describing the job.", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.CategoryDto" }, "description": "Collection of categories related to the job.", "nullable": true }, "location": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.LocationDto" }, "salary": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.SalaryDto" }, "validFrom": { "type": "string", "description": "Date the job is valid from.", "format": "date-time" }, "validTo": { "type": "string", "description": "Date the job is valid to.", "format": "date-time", "nullable": true }, "isco": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.IscoDto" }, "employmentType": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.EmploymentType" }, "shifts": { "maximum": 4, "minimum": 1, "type": "integer", "description": "Number of shifts in the job.", "format": "int32", "nullable": true }, "positionsCount": { "type": "integer", "description": "Number of job positions.", "format": "int32" }, "benefits": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.BenefitDto" }, "description": "Collection of job benefits.", "nullable": true }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.RequirementDto" }, "description": "Collection of job requirements.", "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.ContactDto" }, "description": "Collection of job contacts.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing data about the job." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.GetJobDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.GetJobDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.GetJobDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Jobs.v3.GetJobDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationCategoryDto": { "required": [ "code", "confidence" ], "type": "object", "properties": { "code": { "type": "string", "description": "Location Category Code." }, "confidence": { "maximum": 1, "minimum": 0, "type": "number", "description": "It is number between 0 and 1.\r\nIt expresses certainty of the determining the Category Code.", "format": "double" }, "name": { "type": "string", "description": "Name related to Location Category Code.", "nullable": true } }, "additionalProperties": false, "description": "Holds Location Category Data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationCompanyDto": { "required": [ "nationalIn", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "A globally unique identifier for the Company.\r\n\r\n cz-company-12345678\r\n" }, "nationalIn": { "type": "string", "description": "Company's nationalIn.", "example": "12345678" }, "name": { "type": "string", "description": "Company's name.", "nullable": true } }, "additionalProperties": false, "description": "Holds information about company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactSourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Location contact source code." }, "name": { "type": "string", "description": "Localized source name.", "nullable": true }, "url": { "type": "string", "description": "Location contact url.", "format": "uri", "nullable": true }, "lastCheckedAt": { "type": "string", "description": "Date when the source was last checked.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Holds information about location contact sources." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactDto": { "required": [ "value", "valueFormatted" ], "type": "object", "properties": { "value": { "minLength": 1, "type": "string", "description": "Contact value representing e.g. email address, phone number or website.", "example": "00420466614056, info@nastarerybarne.cz" }, "valueFormatted": { "minLength": 1, "type": "string", "description": "Formatted contact value representing e.g. email address, phone number or website." }, "sources": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactSourceDto" }, "description": "Collection of contact sources.", "nullable": true } }, "additionalProperties": false, "description": "Holds information about contacts in the specific location." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactsDto": { "type": "object", "properties": { "emails": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactDto" }, "description": "Collection of emails related to the specific location.", "nullable": true }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactDto" }, "description": "Collection of phone numbers related to the specific location.", "nullable": true }, "websites": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactDto" }, "description": "Collection of websites related to the specific location.", "nullable": true } }, "additionalProperties": false, "description": "Holds information about contacts in the specific location." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationPictureSourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Picture code.", "example": "cz-restu" }, "name": { "type": "string", "description": "Name corresponding to the picture code.", "nullable": true } }, "additionalProperties": false, "description": "It holds information about picture source." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationPictureDto": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "Url address of the picture.", "format": "uri", "example": "https://www.restu.cz/ir/restaurant/727/7274a7dfec44ae61f78351726694590f.jpg" }, "lastCheckedAt": { "type": "string", "description": "Date when the source was last checked.", "format": "date-time", "nullable": true }, "source": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationPictureSourceDto" } }, "additionalProperties": false, "description": "It holds information about Location Picture." }, "BizMachine.Ultimate.DataStructures.Common.Models.Localization.LocalizableValue": { "required": [ "value" ], "type": "object", "properties": { "locales": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "value": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationSourceRatingDto": { "required": [ "count", "text" ], "type": "object", "properties": { "count": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "text": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.Common.Models.Localization.LocalizableValue" }, "value": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationSourceDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "externalId": { "minLength": 1, "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "rating": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationSourceRatingDto" }, "name": { "type": "string", "description": "Name related to Location Source Code.", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Location type code.", "example": "cz-restu" }, "name": { "type": "string", "description": "Localized name corresponding to the location type code.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with location type details." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.ProtectionMethodDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique protection method code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about protection method." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto": { "type": "object", "properties": { "unit": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.ConstructionTypeEntityDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique construction type code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about construction type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.GasConnectionDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique gas connection code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about gas connection." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.HeatingMethodDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique heating method code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about heating method." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.LiftEquipmentDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique lift equipment code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about lift equipment." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.MeansOfUseDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique means of use code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about means of use." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.SewerConnectionDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique sewer connection code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about sewer connection." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.BuildingTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique building type code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about building type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.WaterSupplyConnectionDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Unique water supply connection code identifier.", "example": "0001" }, "name": { "type": "string", "description": "Localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about water supply connection." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.BuildingRuianDto": { "type": "object", "properties": { "buildingNumber": { "type": "integer", "format": "int32", "nullable": true }, "cadasterAreaNumber": { "type": "integer", "format": "int32", "nullable": true }, "cityPartNumber": { "type": "integer", "format": "int32", "nullable": true }, "municipalityPartNumber": { "type": "integer", "format": "int32", "nullable": true }, "plotNumber": { "type": "integer", "format": "int64", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.CzSpecificBuildingDataDto": { "type": "object", "properties": { "cadasterArea": { "type": "string", "description": "Building's cadaster area.", "nullable": true }, "parcelAndCadasterArea": { "type": "string", "description": "Parcel and cadaster area.", "nullable": true }, "ruian": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.BuildingRuianDto" } }, "additionalProperties": false, "description": "A DTO containing data about Czechia's buildings." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.CountrySpecificBuildingDataDto": { "required": [ "cz" ], "type": "object", "properties": { "cz": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.CzSpecificBuildingDataDto" } }, "additionalProperties": false, "description": "A DTO containing country-specific building data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.PlotReferenceDto": { "required": [ "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique identifier of a plot." } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.GetBuildingDataDto": { "required": [ "countrySpecific", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique identifier of the building object." }, "coordinates": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.CoordinatesDto" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.GetAddressDto" }, "description": "A list of addresses belonging to the building.", "nullable": true }, "locality": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Localities.v3.LocalityReferenceDto" }, "protectionMethods": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.ProtectionMethodDto" }, "description": "A list of protection methods used in the building.", "nullable": true }, "buildingArea": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "constructionType": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.ConstructionTypeEntityDto" }, "gasConnection": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.GasConnectionDto" }, "heatingMethod": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.HeatingMethodDto" }, "liftEquipment": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.LiftEquipmentDto" }, "meansOfUse": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.MeansOfUseDto" }, "sewerConnection": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.SewerConnectionDto" }, "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.BuildingTypeDto" }, "waterSupplyConnection": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.WaterSupplyConnectionDto" }, "completedAt": { "type": "string", "description": "Date of completion of the building.", "format": "date", "nullable": true }, "enclosedBuildingSpace": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "flatsCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of flats in the building.", "format": "int32" }, "floorAreaSum": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "floorsCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of floors in the building.", "format": "int32" }, "validFrom": { "type": "string", "description": "Date from which this information is valid.", "format": "date", "nullable": true }, "validTo": { "type": "string", "description": "Date upon which this information is valid.", "format": "date", "nullable": true }, "countrySpecific": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.CountrySpecificBuildingDataDto" }, "plot": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.PlotReferenceDto" } }, "additionalProperties": false, "description": "A DTO containing information about the building." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.GetLocationDataDto": { "required": [ "address", "locationIn", "name", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Unique Location Id.", "example": "cz-location-BMPCZ00331552" }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Addresses.v3.GetAddressDto" }, "categories": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationCategoryDto" }, "description": "Location categories with BizMachine.Ultimate.DataStructures.Common.Types.SourceCode and Name.", "nullable": true }, "company": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationCompanyDto" }, "contacts": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationContactsDto" }, "establishedAt": { "type": "string", "description": "Date of the Location establishment.", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "Name of the Location." }, "locationIn": { "type": "string", "description": "Identification number of the Location." }, "pictures": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationPictureDto" }, "description": "Pictures of the Location stored in form of Url.", "nullable": true }, "sources": { "minLength": 1, "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationSourceDto" }, "description": "Sources from where the Location was acquired.", "nullable": true }, "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.LocationTypeDto" }, "building": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Buildings.v3.GetBuildingDataDto" } }, "additionalProperties": false, "description": "Holds information related to location." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.GetLocationDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.GetLocationDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.GetLocationDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Locations.v3.GetLocationDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareDetailsDto": { "type": "object", "properties": { "templateCode": { "type": "string", "description": "Template code to use for shared company.", "nullable": true }, "language": { "type": "string", "description": "Page language.", "nullable": true }, "expiresAt": { "type": "string", "description": "DateTime when link should expire.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO request details for sharing a company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareCompanyDto": { "type": "object", "properties": { "url": { "type": "string", "description": "Share link pointing to company.", "format": "uri", "nullable": true }, "expiresAt": { "type": "string", "description": "DateTime when the link expires.", "format": "date-time" } }, "additionalProperties": false, "description": "A DTO containing link details for sharing a company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareCompanyDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Companies.v4.Share.ShareCompanyDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.Params.SubsidyCompanyRole": { "enum": [ "Any", "Recipient", "Provider" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyCompanyWithNameDto": { "required": [ "nationalIn" ], "type": "object", "properties": { "nationalIn": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.NamedUrlDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SignatureDto": { "type": "object", "properties": { "person": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.NameDto" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.AllocationsValuesDto": { "type": "object", "properties": { "required": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "decided": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "consumed": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "released": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "drawn": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "refunded": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.AmountCurrencyDto" }, "euCofinancingRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.AllocationsDto": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "values": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.AllocationsValuesDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.TopicDto": { "type": "object", "properties": { "confidence": { "type": "number", "format": "double" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyDataDto": { "required": [ "uniqueId" ], "type": "object", "properties": { "uniqueId": { "type": "string" }, "title": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "recipient": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyCompanyWithNameDto" }, "providers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyCompanyWithNameDto" }, "nullable": true }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "programme": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.NamedUrlDto" }, "priority": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.NamedUrlDto" }, "url": { "type": "string", "nullable": true }, "signature": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SignatureDto" }, "budgetChapter": { "type": "string", "nullable": true }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.AllocationsDto" }, "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "nullable": true }, "topics": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.TopicDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Subsidies.v3.SubsidyDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.TagShareRoleDto": { "enum": [ "Viewer", "Contributor", "Manager", "Owner" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.ShareToDto": { "required": [ "role" ], "type": "object", "properties": { "role": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.TagShareRoleDto" }, "expiresAt": { "type": "string", "description": "Date and time when share expires.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about user to share tag with." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.TagShareUserDto": { "type": "object", "properties": { "uid": { "type": "string", "description": "User's unique identifier.", "format": "uuid" }, "email": { "type": "string", "description": "User's email address.", "nullable": true }, "name": { "type": "string", "description": "User's full name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about tag share user." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.GetTagSharesDto": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string", "description": "A role assigned to the tag share." }, "expiresAt": { "type": "string", "description": "Date and time when share expires.", "format": "date-time", "nullable": true }, "user": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.TagShareUserDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.GetTagSharesDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v3.Shares.GetTagSharesDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.AddTagDto": { "required": [ "label" ], "type": "object", "properties": { "label": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Name of the tag." }, "color": { "type": "string", "description": "Tag color as hex value. For example: 6095e2", "nullable": true }, "order": { "type": "integer", "description": "Priority order of the tag.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A DTO for adding a new Tag." }, "BizMachine.Prospector.Api.DataStructures.Dtos.LocalizationDtos.TagLocalizationDto": { "type": "object", "properties": { "languageCode": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagType": { "enum": [ "User", "Shared" ], "type": "string", "description": "Type of tag in relation to users." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagShareRoleDto": { "enum": [ "Viewer", "Contributor", "Manager", "Owner" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.ShareToDto": { "required": [ "role" ], "type": "object", "properties": { "role": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagShareRoleDto" }, "expiresAt": { "type": "string", "description": "Date and time when share expires.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about user to share tag with." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagDto": { "required": [ "createdAt", "type" ], "type": "object", "properties": { "uid": { "type": "string", "description": "Tag unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "Tag name.", "nullable": true }, "color": { "type": "string", "description": "Tag hex color value.", "nullable": true }, "order": { "type": "integer", "description": "Ordering number of the tag.", "format": "int32" }, "description": { "type": "string", "description": "Optional description of the tag.", "nullable": true }, "localizations": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.LocalizationDtos.TagLocalizationDto" }, "description": "Tag localizations.", "nullable": true }, "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.TagType" }, "share": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tags.v2.ShareToDto" }, "createdAt": { "type": "string", "description": "Date and time when the tag was originally created.", "format": "date-time" } }, "additionalProperties": false, "description": "A DTO containing information about Tag." }, "Microsoft.AspNetCore.JsonPatch.Operations.Operation": { "type": "object", "properties": { "value": { "type": "object", "additionalProperties": false, "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.Enums.RoleCode": { "enum": [ "Any", "MainBuyer", "Buyer", "Supplier" ], "type": "string" }, "BizMachine.Ultimate.DataStructures.v1.Models.Tenders.Enums.ParticipantType": { "enum": [ "Company", "Person", "Unknown" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.ParticipantBaseDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Models.Tenders.Enums.ParticipantType" } }, "additionalProperties": false, "description": "A DTO containing base information for tender participants." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.BiddingDto": { "type": "object", "properties": { "startedAt": { "type": "string", "description": "System.DateTimeOffset when the tender bidding started at.", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "description": "System.DateTimeOffset when the tender bidding finished at.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about tender bidding times." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.Enums.VatStatus": { "enum": [ "VatUnknown" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderMoneyDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.Enums.VatStatus" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about tender money." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderRangeValueDto": { "required": [ "lowerBound" ], "type": "object", "properties": { "lowerBound": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderMoneyDto" }, "upperBound": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderMoneyDto" } }, "additionalProperties": false, "description": "A DTO containing tender range values." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderValueDto": { "type": "object", "properties": { "singleValue": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderMoneyDto" }, "rangeValue": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderRangeValueDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.SupplierBaseDto": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Models.Tenders.Enums.ParticipantType" }, "value": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderMoneyDto" } }, "additionalProperties": false, "description": "A DTO containing base information for tender suppliers." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.BidderBaseDto": { "required": [ "offer", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Models.Tenders.Enums.ParticipantType" }, "offer": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderMoneyDto" } }, "additionalProperties": false, "description": "A DTO containing base information for tender bidders." }, "BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.CodeNameDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetCpvDto": { "required": [ "primary" ], "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.CodeNameDto" }, "others": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.CodeNameDto" }, "description": "Tender other CPVs details.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about CPVs." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTopicsDto": { "required": [ "code", "confidence" ], "type": "object", "properties": { "code": { "maxLength": 50, "type": "string", "description": "Topic unique code identifier." }, "confidence": { "type": "number", "description": "Topic confidence level.", "format": "double" }, "name": { "type": "string", "description": "Localized topic name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about tender topic." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetStateDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "type": "string", "description": "State unique code identifier." }, "name": { "type": "string", "description": "Localized state name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with tender state information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTenderDataDto": { "required": [ "filedAt", "text", "title", "uniqueId", "url" ], "type": "object", "properties": { "uniqueId": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Unique identifier of the tender." }, "mainBuyer": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.ParticipantBaseDto" }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.ParticipantBaseDto" }, "description": "A collection of all tender buyers.", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Tender keywords.", "nullable": true }, "url": { "type": "string", "description": "An URL address of the tender." }, "filedAt": { "type": "string", "description": "System.DateTimeOffset when was the tender filed at.", "format": "date-time" }, "publishedAt": { "type": "string", "description": "System.DateTimeOffset when was the tender published at.", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "description": "System.DateTimeOffset when was the tender last updated at.", "format": "date-time", "nullable": true }, "bidding": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.BiddingDto" }, "value": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.TenderValueDto" }, "suppliers": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.SupplierBaseDto" }, "description": "A collection of all tender suppliers.", "nullable": true }, "bidders": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.BidderBaseDto" }, "description": "A collection of all tender bidders.", "nullable": true }, "title": { "type": "string", "description": "Tender localized title." }, "summary": { "type": "string", "description": "Tender localized summary.", "nullable": true }, "text": { "type": "string", "description": "Tender localized text." }, "cpv": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetCpvDto" }, "topics": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTopicsDto" }, "description": "A collection of tender topics.", "nullable": true }, "state": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetStateDto" }, "locality": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Localities.v3.LocalityReferenceDto" }, "description": "A collection of localities for the tender.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about tender." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTenderDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTenderDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTenderDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Tenders.v3.GetTenderDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Params.VehicleNationalInSearchScope": { "enum": [ "Owners", "Operators", "Any" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.VehicleStatus": { "enum": [ "New", "Used", "Exported", "Removed" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.CategoryDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.IconDto": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.MakeDto": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "icon": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.IconDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.ModelDto": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.TypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.WeightDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.HeightDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's height." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.LengthDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's length." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.WidthDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's width." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.ChassisTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code specifying the exact chassis type." }, "name": { "type": "string", "description": "Localized name of chassis type.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's chassis type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact fuel type." }, "name": { "type": "string", "description": "Localized name of the fuel type.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's fuel type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelConsumptionCategoryDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact fuel consumption category." }, "name": { "type": "string", "description": "Localized name of the fuel consumption category.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's fuel consumption category." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelConsumptionDto": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelConsumptionCategoryDto" }, "unit": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's fuel consumption." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelTypeDto" }, "consumption": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelConsumptionDto" } }, "additionalProperties": false, "description": "A DTO with detailed information about vehicle's fuel." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.EngineDto": { "type": "object", "properties": { "displacement": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "fuelType": { "type": "string", "description": "Type of engine's fuel.", "nullable": true, "deprecated": true }, "power": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "fuel": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.FuelDto" }, "emissions": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's engine." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.TextDto": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.BodyDto": { "required": [ "color" ], "type": "object", "properties": { "color": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.TextDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleAddressDto": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "locality": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.CodeNameDto" } }, "additionalProperties": false }, "BizMachine.Ultimate.DataStructures.v1.Models.Vehicles.Enums.RegistrationTerminationMethod": { "enum": [ "Export", "Sale", "Removal" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetRegistrationBaseDto": { "required": [ "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleAddressDto" }, "validFrom": { "type": "string", "format": "date" }, "validTo": { "type": "string", "format": "date", "nullable": true }, "terminationMethod": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Models.Vehicles.Enums.RegistrationTerminationMethod" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetDomesticRegistrationDto": { "required": [ "uniqueId", "validFrom" ], "type": "object", "properties": { "nationalIn": { "type": "string", "nullable": true }, "uniqueId": { "type": "string" }, "type": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleAddressDto" }, "validFrom": { "type": "string", "format": "date" }, "validTo": { "type": "string", "format": "date", "nullable": true }, "terminationMethod": { "$ref": "#/components/schemas/BizMachine.Ultimate.DataStructures.v1.Models.Vehicles.Enums.RegistrationTerminationMethod" } }, "additionalProperties": false, "description": "A DTO for holding vehicle registration information about a domestic Czech company." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetRegistrationsDto": { "type": "object", "properties": { "international": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetRegistrationBaseDto" }, "nullable": true }, "domestic": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetDomesticRegistrationDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.OwnerOperatorDto": { "required": [ "nationalIn", "type", "uniqueId", "validFrom" ], "type": "object", "properties": { "type": { "type": "string" }, "uniqueId": { "type": "string" }, "nationalIn": { "maxLength": 20, "type": "string" }, "name": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "format": "date" }, "validTo": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.AttributeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 6, "minLength": 0, "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleDataDto": { "required": [ "status", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "maxLength": 50, "type": "string", "description": "Unique identification of the vehicle." }, "vin": { "maxLength": 30, "type": "string", "description": "Vin code of the vehicle.", "nullable": true }, "name": { "maxLength": 200, "type": "string", "description": "Name of the vehicle.", "nullable": true }, "certificateNumber": { "maxLength": 50, "type": "string", "description": "Certificate number of the vehicle.", "nullable": true }, "category": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.CategoryDto" }, "make": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.MakeDto" }, "model": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.ModelDto" }, "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.TypeDto" }, "status": { "type": "string", "description": "Specifies the status of the vehicle.", "example": "New,\r\nUsed" }, "weight": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.WeightDto" }, "height": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.HeightDto" }, "length": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.LengthDto" }, "width": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.WidthDto" }, "transmissionType": { "type": "string", "description": "Specifies the transmission type of the vehicle.", "nullable": true, "example": "Manual,\r\nAutomatic" }, "axleCount": { "type": "integer", "description": "Number of axles in the vehicle.", "format": "int32", "nullable": true }, "maxPassengers": { "type": "integer", "description": "Number of maximum passengers.", "format": "int32", "nullable": true }, "chassisType": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.ChassisTypeDto" }, "maxSpeed": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "engine": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.EngineDto" }, "body": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.BodyDto" }, "registrations": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetRegistrationsDto" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.OwnerOperatorDto" }, "description": "Data about vehicle owners.", "nullable": true }, "operators": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.OwnerOperatorDto" }, "description": "Data about vehicle operators.", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.Properties.AttributeDto" }, "description": "Specific attributes of the vehicle.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about vehicle." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDto" } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v3.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.DataMetaDto" }, "nullable": true } }, "additionalProperties": false }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Params.OwnershipOperationSearchScopeDto": { "enum": [ "EverOwnedOrOperated", "CurrentlyOwnsAndOperates", "CurrentlyOwnsOrOperates", "CurrentlyOwns", "CurrentlyOperates", "EverOperated" ], "type": "string" }, "BizMachine.Prospector.Modules.Vehicles.DataStructures.Enums.VehicleStatus": { "enum": [ "New", "Used", "Exported", "Removed" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.CategoryDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code specifying the exact category." }, "name": { "type": "string", "description": "Category's localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's category." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.IconDto": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL address of an icon.", "format": "uri" } }, "additionalProperties": false, "description": "A DTO with icon information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.MakeDto": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact make.", "nullable": true }, "name": { "type": "string", "description": "Make's localized name.", "nullable": true }, "text": { "type": "string", "description": "Full make text.", "nullable": true }, "icon": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.IconDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's make." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.ModelDto": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact model.", "nullable": true }, "name": { "type": "string", "description": "Model's localized name.", "nullable": true }, "text": { "type": "string", "description": "Full model text.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's model." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.RoadworthinessDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact roadworthiness." }, "name": { "type": "string", "description": "Localized name of the roadworthiness.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's roadworthiness." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TypeDto": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact type.", "nullable": true }, "name": { "type": "string", "description": "Type's localized name.", "nullable": true }, "text": { "type": "string", "description": "Full text of the type.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.VehicleCurrentStatusDto": { "required": [ "category", "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact current status." }, "category": { "type": "string", "description": "Status category.", "example": "unknown, normal, warning, issue, terminated" }, "name": { "type": "string", "description": "Localized name of the status.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's current status." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.EstimatedOperatingAreaDto": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying operating area.", "nullable": true }, "name": { "type": "string", "description": "operating area's localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about estimated operating area" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.WeightDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's weight." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.HeightDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's height." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.LengthDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's length." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.WidthDto": { "required": [ "total" ], "type": "object", "properties": { "total": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's width." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TransmissionTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact transmission code." }, "name": { "type": "string", "description": "Localized name of the transmission.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's transmission type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TransmissionDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TransmissionTypeDto" } }, "additionalProperties": false, "description": "Contains details about vehicle's transmission." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.ChassisTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code specifying the exact chassis type." }, "name": { "type": "string", "description": "Localized name of chassis type.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's chassis type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelTypeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact fuel type." }, "name": { "type": "string", "description": "Localized name of the fuel type.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's fuel type." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelConsumptionCategoryDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact fuel consumption category." }, "name": { "type": "string", "description": "Localized name of the fuel consumption category.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's fuel consumption category." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelConsumptionDto": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelConsumptionCategoryDto" }, "unit": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's fuel consumption." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelTypeDto" }, "consumption": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelConsumptionDto" } }, "additionalProperties": false, "description": "A DTO with detailed information about vehicle's fuel." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.EngineDto": { "type": "object", "properties": { "displacement": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "power": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "fuel": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.FuelDto" }, "emissions": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's engine." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TextDto": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "Generic text description." } }, "additionalProperties": false, "description": "A DTO with generic text information." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.BodyDto": { "required": [ "color" ], "type": "object", "properties": { "color": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TextDto" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's body." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.VehicleAddressDto": { "type": "object", "properties": { "text": { "type": "string", "description": "Full address text.", "nullable": true }, "locality": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.CodeNameDto" } }, "additionalProperties": false, "description": "A DTO with information about registration address." }, "BizMachine.Prospector.Modules.Vehicles.DataStructures.Enums.RegistrationTerminationMethod": { "enum": [ "Export", "Sale", "Removal" ], "type": "string" }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.RegistrationBaseDto": { "required": [ "type", "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "description": "Specifies the type of registration." }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.VehicleAddressDto" }, "validFrom": { "type": "string", "description": "Date when registration became valid.", "format": "date" }, "validTo": { "type": "string", "description": "Date when registration becomes invalid.", "format": "date", "nullable": true }, "terminationMethod": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Vehicles.DataStructures.Enums.RegistrationTerminationMethod" } }, "additionalProperties": false, "description": "A DTO with information about vehicle's registration." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.LogoDto": { "type": "object", "properties": { "url": { "type": "string", "description": "A URL link to company logo", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about company logo." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.DomesticRegistrationDto": { "required": [ "type", "uniqueId", "validFrom" ], "type": "object", "properties": { "uniqueId": { "type": "string", "description": "Company unique identifier." }, "nationalIn": { "type": "string", "description": "Company national identifier.", "nullable": true }, "logo": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.LogoDto" }, "type": { "type": "string", "description": "Specifies the type of registration." }, "address": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.VehicleAddressDto" }, "validFrom": { "type": "string", "description": "Date when registration became valid.", "format": "date" }, "validTo": { "type": "string", "description": "Date when registration becomes invalid.", "format": "date", "nullable": true }, "terminationMethod": { "$ref": "#/components/schemas/BizMachine.Prospector.Modules.Vehicles.DataStructures.Enums.RegistrationTerminationMethod" } }, "additionalProperties": false, "description": "A DTO that holds information about a company that registered a vehicle in their home country." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.RegistrationsDto": { "type": "object", "properties": { "international": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.RegistrationBaseDto" }, "description": "A collection of international vehicle registrations.", "nullable": true }, "domestic": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.DomesticRegistrationDto" }, "description": "A collection of domestic vehicle registrations.", "nullable": true } }, "additionalProperties": false, "description": "A DTO that holds data about vehicle registrations." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.InspectionResultDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact inspection result." }, "name": { "type": "string", "description": "Localized name of the inspection result.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's inspection result." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.InspectionIssueDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact inspection issue." }, "name": { "type": "string", "description": "Localized name of the inspection issue.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's inspection issue." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.InspectionDto": { "required": [ "code", "validFrom" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact inspection." }, "name": { "type": "string", "description": "Inspection's localized name.", "nullable": true }, "validFrom": { "type": "string", "description": "Date when inspection became valid.", "format": "date" }, "validTo": { "type": "string", "description": "Date when inspection became invalid.", "format": "date", "nullable": true }, "result": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.InspectionResultDto" }, "protocolId": { "type": "string", "description": "Inspection protocol ID.", "nullable": true }, "mileage": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.InspectionIssueDto" }, "description": "A collection of inspection issues.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's inspection." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.AttributeDto": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Code specifying the exact attribute." }, "name": { "type": "string", "description": "Attribute's localized name.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about attributes." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.OwnerOperatorDto": { "required": [ "nationalIn", "type", "uniqueId", "validFrom" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of registration." }, "uniqueId": { "maxLength": 50, "type": "string", "description": "Unique identifier of the operator/owner." }, "nationalIn": { "maxLength": 20, "type": "string", "description": "Company national identifier of the operator/owner." }, "name": { "type": "string", "description": "Name of the operator/owner.", "nullable": true }, "logo": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.LogoDto" }, "validFrom": { "type": "string", "description": "Date when inspection became valid.", "format": "date" }, "validTo": { "type": "string", "description": "Date when inspection became invalid.", "format": "date", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.AttributeDto" }, "description": "Specific attributes of the vehicle registration.", "nullable": true } }, "additionalProperties": false, "description": "A DTO with information about vehicle's operator / owner." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.GetVehicleDataDto": { "required": [ "currentStatus", "status", "uniqueId" ], "type": "object", "properties": { "uniqueId": { "maxLength": 50, "type": "string", "description": "Unique identification of the vehicle." }, "vin": { "maxLength": 30, "type": "string", "description": "Vin code of the vehicle.", "nullable": true }, "name": { "maxLength": 200, "type": "string", "description": "Name of the vehicle.", "nullable": true }, "certificateNumber": { "maxLength": 50, "type": "string", "description": "Certificate number of the vehicle.", "nullable": true }, "category": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.CategoryDto" }, "make": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.MakeDto" }, "model": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.ModelDto" }, "roadworthiness": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.RoadworthinessDto" }, "type": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TypeDto" }, "status": { "type": "string", "description": "Specifies the status of the vehicle.", "example": "New,\r\nUsed" }, "currentStatus": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.VehicleCurrentStatusDto" }, "estimatedOperatingArea": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.EstimatedOperatingAreaDto" }, "weight": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.WeightDto" }, "height": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.HeightDto" }, "length": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.LengthDto" }, "width": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.WidthDto" }, "transmissionType": { "type": "string", "description": "Specifies the transmission type of the vehicle.", "nullable": true, "example": "Manual,\r\nAutomatic", "deprecated": true }, "transmission": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.TransmissionDto" }, "axleCount": { "type": "integer", "description": "Number of axles in the vehicle.", "format": "int32", "nullable": true }, "maxPassengers": { "type": "integer", "description": "Number of maximum passengers.", "format": "int32", "nullable": true }, "chassisType": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.ChassisTypeDto" }, "maxSpeed": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.ValueUnitDto" }, "engine": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.EngineDto" }, "body": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.BodyDto" }, "registrations": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.RegistrationsDto" }, "metrics": { "minLength": 1, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Metrics.v3.MetricBaseDto" }, "description": "Data about vehicle metrics.", "nullable": true }, "inspections": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.InspectionDto" }, "description": "Collection of vehicle inspections data.", "nullable": true }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.OwnerOperatorDto" }, "description": "Data about vehicle owners.", "nullable": true }, "operators": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.OwnerOperatorDto" }, "description": "Data about vehicle operators.", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.AttributeDto" }, "description": "Specific attributes of the vehicle.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing information about vehicle." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.VehicleDateRangeDto": { "type": "object", "properties": { "from": { "type": "string", "description": "Date when data became valid.", "format": "date-time" }, "to": { "type": "string", "description": "Date when data became invalid.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing date range." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.VehiclesMetaDataDto": { "required": [ "createdAt", "hash" ], "type": "object", "properties": { "dataSources": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.BaseDtos.MetaDataSourceDto" }, "description": "Sources of the provided data.", "nullable": true }, "createdAt": { "type": "string", "description": "System.DateTimeOffset, when data was created at.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "System.DateTimeOffset, when data was updated at.", "format": "date-time", "nullable": true }, "hash": { "type": "string", "description": "Hash of the content." }, "companyOperator": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.VehicleDateRangeDto" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Properties.AttributeDto" }, "description": "All attributes related to vehicle. This field is mix of vehicle attributes and current operator attributes.", "nullable": true } }, "additionalProperties": false, "description": "A DTO containing vehicle-specific meta data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.VehiclesDataMetaDto": { "required": [ "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.GetVehicleDataDto" }, "meta": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.VehiclesMetaDataDto" } }, "additionalProperties": false, "description": "A DTO wrapper for vehicle-specific data." }, "BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.VehiclesDataMetaDtoSystem.Collections.Generic.ICollectionBizMachine.Prospector.Api.DataStructures.Dtos.GenericDtos.PagedDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Filtering.PagingResultDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.GetVehicleDataDtoBizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.VehiclesDataMetaDto" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "Authorization header which caries ApiKey information. Copy value generated using ApiKey endpoint.
\n Example: abcdefgh-1234-5678-90yz-ijklmnopqrs", "name": "X-Api-Key", "in": "header" } } } }