{ "openapi": "3.0.1", "info": { "title": "UnternehmensScreener API", "version": "v1", "description": "# Getting started\r\n\r\n- **API key:** If you don't have an API key, head over to [firmenakte.at/api](https://firmenakte.at/api).\r\n- **Install:** `npm i @firmenakte/api-client`\r\n- **MCP:** For AI agents (e.g. Cursor), use the MCP server at **mcp.firmenakte.at/mcp** so the agent calls the API directly (not for reading docs).\r\n" }, "servers": [ { "url": "https://api.firmenakte.at" } ], "paths": { "/api/v1/trades/documents/{gisaZahl}": { "get": { "tags": [ "Trades" ], "parameters": [ { "name": "gisaZahl", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "historical", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "language", "in": "query", "schema": { "enum": [ "De", "En" ], "default": "De" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": {} } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1TradesDocumentsDetail(0, { historical: false, language: 'De' });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/trades/documents/0?historical=false&language=De' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/trades": { "get": { "tags": [ "Trades" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "minCompanyCount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfTradeCatalogItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfTradeCatalogItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfTradeCatalogItemResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1TradesList({ search: 'string', minCompanyCount: 0, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/trades?search=string&minCompanyCount=0&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/trades/{tradeKey}/licenses": { "get": { "tags": [ "Trades" ], "parameters": [ { "name": "tradeKey", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGisaLicense" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGisaLicense" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGisaLicense" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1TradesLicensesList(0, { page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/trades/0/licenses?page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/trades/company/{fnr}": { "get": { "tags": [ "Trades" ], "parameters": [ { "name": "fnr", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GisaLicense" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GisaLicense" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GisaLicense" } } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1TradesCompanyDetail('string');" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/trades/company/string' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/trades/changes/{id}": { "get": { "tags": [ "Trades" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GisaChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GisaChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GisaChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1TradesChangesDetail(0);" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/trades/changes/0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/trades/changes": { "get": { "tags": [ "Trades" ], "parameters": [ { "name": "fnr", "in": "query", "schema": { "type": "string" } }, { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sinceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGisaChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGisaChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGisaChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1TradesChangesList({ fnr: 'string', since: '2026-05-12T08:26:54.537Z', sinceId: 0, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/trades/changes?fnr=string&since=2026-05-12T08%3A26%3A54.538Z&sinceId=0&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/people/names": { "get": { "tags": [ "People" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonNameItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonNameItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonNameItem" } } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1PeopleNamesList();" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/people/names' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/people": { "get": { "tags": [ "People" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "schema": { "type": "string" } }, { "name": "functionCode", "in": "query", "schema": { "type": "string" } }, { "name": "businessName", "in": "query", "schema": { "type": "string" } }, { "name": "fnr", "in": "query", "schema": { "type": "string" } }, { "name": "hasEdikt", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfPerson" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1PeopleList({ name: 'string', search: 'string', firstName: 'string', lastName: 'string', functionCode: 'string', businessName: 'string', fnr: 'string', hasEdikt: true, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/people?name=string&search=string&firstName=string&lastName=string&functionCode=string&businessName=string&fnr=string&hasEdikt=true&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/people/{personId}": { "get": { "tags": [ "People" ], "parameters": [ { "name": "personId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PersonDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PersonDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PersonDetailResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1PeopleDetail('string');" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/people/string' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/oenace": { "get": { "tags": [ "Oenace" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "ebene", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "minCompanyCount", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfOenaceCatalogItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfOenaceCatalogItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfOenaceCatalogItemResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1OenaceList({ search: 'string', ebene: 0, minCompanyCount: 0, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/oenace?search=string&ebene=0&minCompanyCount=0&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/legalforms": { "get": { "tags": [ "LegalForms" ], "parameters": [ { "name": "search", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfLegalFormCatalogItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfLegalFormCatalogItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfLegalFormCatalogItemResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1LegalformsList({ search: 'string', page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/legalforms?search=string&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/graph": { "get": { "tags": [ "Graph" ], "parameters": [ { "name": "personId", "in": "query", "schema": { "type": "string" } }, { "name": "fnr", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GraphResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GraphResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GraphResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1GraphList({ personId: 'string', fnr: 'string' });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/graph?personId=string&fnr=string' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/globalchanges": { "get": { "tags": [ "GlobalChanges" ], "parameters": [ { "name": "fnr", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sinceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGlobalChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGlobalChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfGlobalChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1GlobalchangesList({ fnr: 'string', since: '2026-05-12T08:26:54.538Z', sinceId: 0, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/globalchanges?fnr=string&since=2026-05-12T08%3A26%3A54.538Z&sinceId=0&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/globalchanges/aggregated": { "get": { "tags": [ "GlobalChanges" ], "parameters": [ { "name": "fnr", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sinceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxResultsPerType", "in": "query", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AggregatedChangesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AggregatedChangesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AggregatedChangesResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1GlobalchangesAggregatedList({ fnr: [], since: '2026-05-12T08:26:54.538Z', sinceId: 0, maxResultsPerType: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/globalchanges/aggregated?fnr=&since=2026-05-12T08%3A26%3A54.538Z&sinceId=0&maxResultsPerType=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/globalchanges/{id}": { "get": { "tags": [ "GlobalChanges" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeDetailResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1GlobalchangesDetail(0);" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/globalchanges/0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/edikte/changes/{id}": { "get": { "tags": [ "Edikte" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EdiktChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EdiktChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EdiktChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1EdikteChangesDetail(0);" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/edikte/changes/0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/edikte/changes": { "get": { "tags": [ "Edikte" ], "parameters": [ { "name": "fnr", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sinceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfEdiktChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfEdiktChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfEdiktChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1EdikteChangesList({ fnr: 'string', since: '2026-05-12T08:26:54.538Z', sinceId: 0, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/edikte/changes?fnr=string&since=2026-05-12T08%3A26%3A54.538Z&sinceId=0&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/documents/download/{documentKey}": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "documentKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": {}, "application/xml": {}, "application/octet-stream": {} } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1DocumentsDownloadDetail('string');" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/documents/download/string' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/documents/changes/{id}": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1DocumentsChangesDetail(0);" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/documents/changes/0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/documents/changes": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "fnr", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sinceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfDocumentChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfDocumentChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfDocumentChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1DocumentsChangesList({ fnr: 'string', since: '2026-05-12T08:26:54.538Z', sinceId: 0, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/documents/changes?fnr=string&since=2026-05-12T08%3A26%3A54.538Z&sinceId=0&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/courts": { "get": { "tags": [ "Courts" ], "parameters": [ { "name": "search", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfCourtCatalogItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfCourtCatalogItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfCourtCatalogItemResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1CourtsList({ search: 'string', page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/courts?search=string&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses/resolve-names": { "post": { "tags": [ "Businesses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveBusinessNamesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveBusinessNamesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveBusinessNamesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResolveBusinessNamesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolveBusinessNamesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveBusinessNamesResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesResolveNamesCreate();" }, { "lang": "cURL", "label": "cURL", "source": "curl -X POST 'https://api.firmenakte.at/api/v1/businesses/resolve-names' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses": { "get": { "tags": [ "Businesses" ], "parameters": [ { "name": "fnr", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "name", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "search", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "city", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "courtCode", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "legalFormCode", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "zipCode", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "hasEdikt", "in": "query", "schema": { "type": "boolean" } }, { "name": "active", "in": "query", "schema": { "type": "boolean" } }, { "name": "isScheinunternehmen", "in": "query", "schema": { "type": "boolean" } }, { "name": "gisaLicenseKey", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "oenaceCode", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "schema": { "enum": [ "bilanz.AktivierteEigenleistungen", "bilanz.AnlageVermoegen", "bilanz.Bilanzgewinn", "bilanz.BilanzSumme", "bilanz.Eigenkapital", "bilanz.EingefordertesStammkapital", "bilanz.Finanzanlagen", "bilanz.Forderungen", "bilanz.ForderungenLieferungen", "bilanz.Gewinnruecklagen", "bilanz.ImmaterielleVermoegensgegenstaende", "bilanz.Kapitalruecklagen", "bilanz.KurzfristigeForderungen", "bilanz.KurzfristigeVerbindlichkeiten", "bilanz.LangfristigeForderungen", "bilanz.LangfristigeVerbindlichkeiten", "bilanz.LiquidesVermoegen", "bilanz.PassiveRechnungsabgrenzungen", "bilanz.Rechnungsabgrenzungen", "bilanz.Rueckstellungen", "bilanz.Sachanlagen", "bilanz.Umlaufvermoegen", "bilanz.Verbindlichkeiten", "bilanz.VerbindlichkeitenLieferungen", "bilanz.Vorraete", "bilanz.Vortrag", "bilanz.Wertpapiere", "detailViews", "employees", "guv.Abschreibungen", "guv.AufloesungGewinnruecklagen", "guv.AufwendungenAusFinanzanlagen", "guv.Bestandsveraenderung", "guv.BetriebsErfolg", "guv.ErgebnisVorSteuern", "guv.ErtraegeAusBeteiligungen", "guv.ErtraegeAusWertpapieren", "guv.Finanzerfolg", "guv.Jahresueberschuss", "guv.Personalaufwand", "guv.SonstigeBetrieblicheAufwendungen", "guv.SonstigeBetrieblicheErtraege", "guv.SonstigeZinsenUndAehnlicheErtraege", "guv.SozialeAufwendungen", "guv.Steueraufwand", "guv.Umsatzerloese", "guv.WarenUndMaterialeinkauf", "guv.ZinsenUndAehnlicheAufwendungen", "name" ], "type": "string", "description": "Sort by this key figure or by name. Same options as key figure filter keys.", "nullable": true } }, { "name": "orderByDescending", "in": "query", "description": "If true, sort descending; otherwise ascending.", "schema": { "type": "boolean" } }, { "name": "countOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "maximum": 100000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "bilanz.AktivierteEigenleistungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: AktivierteEigenleistungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.AktivierteEigenleistungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: AktivierteEigenleistungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.AnlageVermoegen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: AnlageVermoegen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.AnlageVermoegen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: AnlageVermoegen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Bilanzgewinn_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Bilanzgewinn", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Bilanzgewinn_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Bilanzgewinn", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.BilanzSumme_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: BilanzSumme", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.BilanzSumme_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: BilanzSumme", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Eigenkapital_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Eigenkapital", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Eigenkapital_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Eigenkapital", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.EingefordertesStammkapital_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: EingefordertesStammkapital", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.EingefordertesStammkapital_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: EingefordertesStammkapital", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Finanzanlagen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Finanzanlagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Finanzanlagen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Finanzanlagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Forderungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Forderungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Forderungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Forderungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.ForderungenLieferungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: ForderungenLieferungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.ForderungenLieferungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: ForderungenLieferungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Gewinnruecklagen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Gewinnruecklagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Gewinnruecklagen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Gewinnruecklagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.ImmaterielleVermoegensgegenstaende_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: ImmaterielleVermoegensgegenstaende", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.ImmaterielleVermoegensgegenstaende_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: ImmaterielleVermoegensgegenstaende", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Kapitalruecklagen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Kapitalruecklagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Kapitalruecklagen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Kapitalruecklagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.KurzfristigeForderungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: KurzfristigeForderungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.KurzfristigeForderungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: KurzfristigeForderungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.KurzfristigeVerbindlichkeiten_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: KurzfristigeVerbindlichkeiten", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.KurzfristigeVerbindlichkeiten_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: KurzfristigeVerbindlichkeiten", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.LangfristigeForderungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: LangfristigeForderungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.LangfristigeForderungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: LangfristigeForderungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.LangfristigeVerbindlichkeiten_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: LangfristigeVerbindlichkeiten", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.LangfristigeVerbindlichkeiten_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: LangfristigeVerbindlichkeiten", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.LiquidesVermoegen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: LiquidesVermoegen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.LiquidesVermoegen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: LiquidesVermoegen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.PassiveRechnungsabgrenzungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: PassiveRechnungsabgrenzungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.PassiveRechnungsabgrenzungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: PassiveRechnungsabgrenzungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Rechnungsabgrenzungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Rechnungsabgrenzungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Rechnungsabgrenzungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Rechnungsabgrenzungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Rueckstellungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Rueckstellungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Rueckstellungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Rueckstellungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Sachanlagen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Sachanlagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Sachanlagen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Sachanlagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Umlaufvermoegen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Umlaufvermoegen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Umlaufvermoegen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Umlaufvermoegen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Verbindlichkeiten_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Verbindlichkeiten", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Verbindlichkeiten_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Verbindlichkeiten", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.VerbindlichkeitenLieferungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: VerbindlichkeitenLieferungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.VerbindlichkeitenLieferungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: VerbindlichkeitenLieferungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Vorraete_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Vorraete", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Vorraete_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Vorraete", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Vortrag_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Vortrag", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Vortrag_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Vortrag", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Wertpapiere_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by balance sheet item: Wertpapiere", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "bilanz.Wertpapiere_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by balance sheet item: Wertpapiere", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "employees_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by number of employees", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "employees_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by number of employees", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Abschreibungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: Abschreibungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Abschreibungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: Abschreibungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.AufloesungGewinnruecklagen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: AufloesungGewinnruecklagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.AufloesungGewinnruecklagen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: AufloesungGewinnruecklagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.AufwendungenAusFinanzanlagen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: AufwendungenAusFinanzanlagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.AufwendungenAusFinanzanlagen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: AufwendungenAusFinanzanlagen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Bestandsveraenderung_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: Bestandsveraenderung", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Bestandsveraenderung_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: Bestandsveraenderung", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.BetriebsErfolg_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: BetriebsErfolg", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.BetriebsErfolg_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: BetriebsErfolg", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ErgebnisVorSteuern_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: ErgebnisVorSteuern", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ErgebnisVorSteuern_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: ErgebnisVorSteuern", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ErtraegeAusBeteiligungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: ErtraegeAusBeteiligungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ErtraegeAusBeteiligungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: ErtraegeAusBeteiligungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ErtraegeAusWertpapieren_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: ErtraegeAusWertpapieren", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ErtraegeAusWertpapieren_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: ErtraegeAusWertpapieren", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Finanzerfolg_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: Finanzerfolg", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Finanzerfolg_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: Finanzerfolg", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Jahresueberschuss_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: Jahresueberschuss", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Jahresueberschuss_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: Jahresueberschuss", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Personalaufwand_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: Personalaufwand", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Personalaufwand_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: Personalaufwand", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SonstigeBetrieblicheAufwendungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: SonstigeBetrieblicheAufwendungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SonstigeBetrieblicheAufwendungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: SonstigeBetrieblicheAufwendungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SonstigeBetrieblicheErtraege_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: SonstigeBetrieblicheErtraege", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SonstigeBetrieblicheErtraege_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: SonstigeBetrieblicheErtraege", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SonstigeZinsenUndAehnlicheErtraege_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: SonstigeZinsenUndAehnlicheErtraege", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SonstigeZinsenUndAehnlicheErtraege_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: SonstigeZinsenUndAehnlicheErtraege", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SozialeAufwendungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: SozialeAufwendungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.SozialeAufwendungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: SozialeAufwendungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Steueraufwand_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: Steueraufwand", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Steueraufwand_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: Steueraufwand", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Umsatzerloese_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: Umsatzerloese", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.Umsatzerloese_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: Umsatzerloese", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.WarenUndMaterialeinkauf_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: WarenUndMaterialeinkauf", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.WarenUndMaterialeinkauf_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: WarenUndMaterialeinkauf", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ZinsenUndAehnlicheAufwendungen_gte", "in": "query", "description": "Lower bound (inclusive) for Filter by profit and loss item: ZinsenUndAehnlicheAufwendungen", "schema": { "type": "number", "format": "decimal", "nullable": true } }, { "name": "guv.ZinsenUndAehnlicheAufwendungen_lte", "in": "query", "description": "Upper bound (inclusive) for Filter by profit and loss item: ZinsenUndAehnlicheAufwendungen", "schema": { "type": "number", "format": "decimal", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfBusinessListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfBusinessListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfBusinessListResponse" } } } } }, "x-keyFigureFilterKeys": [ "bilanz.AktivierteEigenleistungen", "bilanz.AnlageVermoegen", "bilanz.Bilanzgewinn", "bilanz.BilanzSumme", "bilanz.Eigenkapital", "bilanz.EingefordertesStammkapital", "bilanz.Finanzanlagen", "bilanz.Forderungen", "bilanz.ForderungenLieferungen", "bilanz.Gewinnruecklagen", "bilanz.ImmaterielleVermoegensgegenstaende", "bilanz.Kapitalruecklagen", "bilanz.KurzfristigeForderungen", "bilanz.KurzfristigeVerbindlichkeiten", "bilanz.LangfristigeForderungen", "bilanz.LangfristigeVerbindlichkeiten", "bilanz.LiquidesVermoegen", "bilanz.PassiveRechnungsabgrenzungen", "bilanz.Rechnungsabgrenzungen", "bilanz.Rueckstellungen", "bilanz.Sachanlagen", "bilanz.Umlaufvermoegen", "bilanz.Verbindlichkeiten", "bilanz.VerbindlichkeitenLieferungen", "bilanz.Vorraete", "bilanz.Vortrag", "bilanz.Wertpapiere", "employees", "guv.Abschreibungen", "guv.AufloesungGewinnruecklagen", "guv.AufwendungenAusFinanzanlagen", "guv.Bestandsveraenderung", "guv.BetriebsErfolg", "guv.ErgebnisVorSteuern", "guv.ErtraegeAusBeteiligungen", "guv.ErtraegeAusWertpapieren", "guv.Finanzerfolg", "guv.Jahresueberschuss", "guv.Personalaufwand", "guv.SonstigeBetrieblicheAufwendungen", "guv.SonstigeBetrieblicheErtraege", "guv.SonstigeZinsenUndAehnlicheErtraege", "guv.SozialeAufwendungen", "guv.Steueraufwand", "guv.Umsatzerloese", "guv.WarenUndMaterialeinkauf", "guv.ZinsenUndAehnlicheAufwendungen" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesList({ fnr: [], name: 'string', search: 'string', city: [], courtCode: [], legalFormCode: [], zipCode: [], hasEdikt: true, active: true, isScheinunternehmen: true, gisaLicenseKey: [], oenaceCode: [], orderBy: 'bilanz.AktivierteEigenleistungen', orderByDescending: true, countOnly: true, page: 0, pageSize: 0, bilanz.AktivierteEigenleistungen_gte: 0, bilanz.AktivierteEigenleistungen_lte: 0, bilanz.AnlageVermoegen_gte: 0, bilanz.AnlageVermoegen_lte: 0, bilanz.Bilanzgewinn_gte: 0, bilanz.Bilanzgewinn_lte: 0, bilanz.BilanzSumme_gte: 0, bilanz.BilanzSumme_lte: 0, bilanz.Eigenkapital_gte: 0, bilanz.Eigenkapital_lte: 0, bilanz.EingefordertesStammkapital_gte: 0, bilanz.EingefordertesStammkapital_lte: 0, bilanz.Finanzanlagen_gte: 0, bilanz.Finanzanlagen_lte: 0, bilanz.Forderungen_gte: 0, bilanz.Forderungen_lte: 0, bilanz.ForderungenLieferungen_gte: 0, bilanz.ForderungenLieferungen_lte: 0, bilanz.Gewinnruecklagen_gte: 0, bilanz.Gewinnruecklagen_lte: 0, bilanz.ImmaterielleVermoegensgegenstaende_gte: 0, bilanz.ImmaterielleVermoegensgegenstaende_lte: 0, bilanz.Kapitalruecklagen_gte: 0, bilanz.Kapitalruecklagen_lte: 0, bilanz.KurzfristigeForderungen_gte: 0, bilanz.KurzfristigeForderungen_lte: 0, bilanz.KurzfristigeVerbindlichkeiten_gte: 0, bilanz.KurzfristigeVerbindlichkeiten_lte: 0, bilanz.LangfristigeForderungen_gte: 0, bilanz.LangfristigeForderungen_lte: 0, bilanz.LangfristigeVerbindlichkeiten_gte: 0, bilanz.LangfristigeVerbindlichkeiten_lte: 0, bilanz.LiquidesVermoegen_gte: 0, bilanz.LiquidesVermoegen_lte: 0, bilanz.PassiveRechnungsabgrenzungen_gte: 0, bilanz.PassiveRechnungsabgrenzungen_lte: 0, bilanz.Rechnungsabgrenzungen_gte: 0, bilanz.Rechnungsabgrenzungen_lte: 0, bilanz.Rueckstellungen_gte: 0, bilanz.Rueckstellungen_lte: 0, bilanz.Sachanlagen_gte: 0, bilanz.Sachanlagen_lte: 0, bilanz.Umlaufvermoegen_gte: 0, bilanz.Umlaufvermoegen_lte: 0, bilanz.Verbindlichkeiten_gte: 0, bilanz.Verbindlichkeiten_lte: 0, bilanz.VerbindlichkeitenLieferungen_gte: 0, bilanz.VerbindlichkeitenLieferungen_lte: 0, bilanz.Vorraete_gte: 0, bilanz.Vorraete_lte: 0, bilanz.Vortrag_gte: 0, bilanz.Vortrag_lte: 0, bilanz.Wertpapiere_gte: 0, bilanz.Wertpapiere_lte: 0, employees_gte: 0, employees_lte: 0, guv.Abschreibungen_gte: 0, guv.Abschreibungen_lte: 0, guv.AufloesungGewinnruecklagen_gte: 0, guv.AufloesungGewinnruecklagen_lte: 0, guv.AufwendungenAusFinanzanlagen_gte: 0, guv.AufwendungenAusFinanzanlagen_lte: 0, guv.Bestandsveraenderung_gte: 0, guv.Bestandsveraenderung_lte: 0, guv.BetriebsErfolg_gte: 0, guv.BetriebsErfolg_lte: 0, guv.ErgebnisVorSteuern_gte: 0, guv.ErgebnisVorSteuern_lte: 0, guv.ErtraegeAusBeteiligungen_gte: 0, guv.ErtraegeAusBeteiligungen_lte: 0, guv.ErtraegeAusWertpapieren_gte: 0, guv.ErtraegeAusWertpapieren_lte: 0, guv.Finanzerfolg_gte: 0, guv.Finanzerfolg_lte: 0, guv.Jahresueberschuss_gte: 0, guv.Jahresueberschuss_lte: 0, guv.Personalaufwand_gte: 0, guv.Personalaufwand_lte: 0, guv.SonstigeBetrieblicheAufwendungen_gte: 0, guv.SonstigeBetrieblicheAufwendungen_lte: 0, guv.SonstigeBetrieblicheErtraege_gte: 0, guv.SonstigeBetrieblicheErtraege_lte: 0, guv.SonstigeZinsenUndAehnlicheErtraege_gte: 0, guv.SonstigeZinsenUndAehnlicheErtraege_lte: 0, guv.SozialeAufwendungen_gte: 0, guv.SozialeAufwendungen_lte: 0, guv.Steueraufwand_gte: 0, guv.Steueraufwand_lte: 0, guv.Umsatzerloese_gte: 0, guv.Umsatzerloese_lte: 0, guv.WarenUndMaterialeinkauf_gte: 0, guv.WarenUndMaterialeinkauf_lte: 0, guv.ZinsenUndAehnlicheAufwendungen_gte: 0, guv.ZinsenUndAehnlicheAufwendungen_lte: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/businesses?fnr=&name=string&search=string&city=&courtCode=&legalFormCode=&zipCode=&hasEdikt=true&active=true&isScheinunternehmen=true&gisaLicenseKey=&oenaceCode=&orderBy=bilanz.AktivierteEigenleistungen&orderByDescending=true&countOnly=true&page=0&pageSize=0&bilanz.AktivierteEigenleistungen_gte=0&bilanz.AktivierteEigenleistungen_lte=0&bilanz.AnlageVermoegen_gte=0&bilanz.AnlageVermoegen_lte=0&bilanz.Bilanzgewinn_gte=0&bilanz.Bilanzgewinn_lte=0&bilanz.BilanzSumme_gte=0&bilanz.BilanzSumme_lte=0&bilanz.Eigenkapital_gte=0&bilanz.Eigenkapital_lte=0&bilanz.EingefordertesStammkapital_gte=0&bilanz.EingefordertesStammkapital_lte=0&bilanz.Finanzanlagen_gte=0&bilanz.Finanzanlagen_lte=0&bilanz.Forderungen_gte=0&bilanz.Forderungen_lte=0&bilanz.ForderungenLieferungen_gte=0&bilanz.ForderungenLieferungen_lte=0&bilanz.Gewinnruecklagen_gte=0&bilanz.Gewinnruecklagen_lte=0&bilanz.ImmaterielleVermoegensgegenstaende_gte=0&bilanz.ImmaterielleVermoegensgegenstaende_lte=0&bilanz.Kapitalruecklagen_gte=0&bilanz.Kapitalruecklagen_lte=0&bilanz.KurzfristigeForderungen_gte=0&bilanz.KurzfristigeForderungen_lte=0&bilanz.KurzfristigeVerbindlichkeiten_gte=0&bilanz.KurzfristigeVerbindlichkeiten_lte=0&bilanz.LangfristigeForderungen_gte=0&bilanz.LangfristigeForderungen_lte=0&bilanz.LangfristigeVerbindlichkeiten_gte=0&bilanz.LangfristigeVerbindlichkeiten_lte=0&bilanz.LiquidesVermoegen_gte=0&bilanz.LiquidesVermoegen_lte=0&bilanz.PassiveRechnungsabgrenzungen_gte=0&bilanz.PassiveRechnungsabgrenzungen_lte=0&bilanz.Rechnungsabgrenzungen_gte=0&bilanz.Rechnungsabgrenzungen_lte=0&bilanz.Rueckstellungen_gte=0&bilanz.Rueckstellungen_lte=0&bilanz.Sachanlagen_gte=0&bilanz.Sachanlagen_lte=0&bilanz.Umlaufvermoegen_gte=0&bilanz.Umlaufvermoegen_lte=0&bilanz.Verbindlichkeiten_gte=0&bilanz.Verbindlichkeiten_lte=0&bilanz.VerbindlichkeitenLieferungen_gte=0&bilanz.VerbindlichkeitenLieferungen_lte=0&bilanz.Vorraete_gte=0&bilanz.Vorraete_lte=0&bilanz.Vortrag_gte=0&bilanz.Vortrag_lte=0&bilanz.Wertpapiere_gte=0&bilanz.Wertpapiere_lte=0&employees_gte=0&employees_lte=0&guv.Abschreibungen_gte=0&guv.Abschreibungen_lte=0&guv.AufloesungGewinnruecklagen_gte=0&guv.AufloesungGewinnruecklagen_lte=0&guv.AufwendungenAusFinanzanlagen_gte=0&guv.AufwendungenAusFinanzanlagen_lte=0&guv.Bestandsveraenderung_gte=0&guv.Bestandsveraenderung_lte=0&guv.BetriebsErfolg_gte=0&guv.BetriebsErfolg_lte=0&guv.ErgebnisVorSteuern_gte=0&guv.ErgebnisVorSteuern_lte=0&guv.ErtraegeAusBeteiligungen_gte=0&guv.ErtraegeAusBeteiligungen_lte=0&guv.ErtraegeAusWertpapieren_gte=0&guv.ErtraegeAusWertpapieren_lte=0&guv.Finanzerfolg_gte=0&guv.Finanzerfolg_lte=0&guv.Jahresueberschuss_gte=0&guv.Jahresueberschuss_lte=0&guv.Personalaufwand_gte=0&guv.Personalaufwand_lte=0&guv.SonstigeBetrieblicheAufwendungen_gte=0&guv.SonstigeBetrieblicheAufwendungen_lte=0&guv.SonstigeBetrieblicheErtraege_gte=0&guv.SonstigeBetrieblicheErtraege_lte=0&guv.SonstigeZinsenUndAehnlicheErtraege_gte=0&guv.SonstigeZinsenUndAehnlicheErtraege_lte=0&guv.SozialeAufwendungen_gte=0&guv.SozialeAufwendungen_lte=0&guv.Steueraufwand_gte=0&guv.Steueraufwand_lte=0&guv.Umsatzerloese_gte=0&guv.Umsatzerloese_lte=0&guv.WarenUndMaterialeinkauf_gte=0&guv.WarenUndMaterialeinkauf_lte=0&guv.ZinsenUndAehnlicheAufwendungen_gte=0&guv.ZinsenUndAehnlicheAufwendungen_lte=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses/names": { "get": { "tags": [ "Businesses" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessNameItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessNameItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessNameItem" } } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesNamesList();" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/businesses/names' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses/count": { "get": { "tags": [ "Businesses" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, "application/json": { "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, "text/json": { "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesCountList();" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/businesses/count' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses/{fnr}": { "get": { "tags": [ "Businesses" ], "parameters": [ { "name": "fnr", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BusinessDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesDetail('string');" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/businesses/string' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses/{fnr}/sync": { "post": { "tags": [ "Businesses" ], "parameters": [ { "name": "fnr", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesSyncCreate('string');" }, { "lang": "cURL", "label": "cURL", "source": "curl -X POST 'https://api.firmenakte.at/api/v1/businesses/string/sync' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses/changes/{id}": { "get": { "tags": [ "Businesses" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BusinessChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BusinessChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BusinessChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesChangesDetail(0);" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/businesses/changes/0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/businesses/changes": { "get": { "tags": [ "Businesses" ], "parameters": [ { "name": "fnr", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sinceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfBusinessChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfBusinessChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfBusinessChange" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1BusinessesChangesList({ fnr: 'string', since: '2026-05-12T08:26:54.538Z', sinceId: 0, page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/businesses/changes?fnr=string&since=2026-05-12T08%3A26%3A54.538Z&sinceId=0&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/assignmentfunctions": { "get": { "tags": [ "AssignmentFunctions" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentFunctionItemResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentFunctionItemResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentFunctionItemResponse" } } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1AssignmentfunctionsList();" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/assignmentfunctions' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/addresses/locations": { "get": { "tags": [ "Addresses" ], "parameters": [ { "name": "search", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfAddressLocationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfAddressLocationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfAddressLocationResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1AddressesLocationsList({ search: 'string', page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/addresses/locations?search=string&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/addresses/cities": { "get": { "tags": [ "Addresses" ], "parameters": [ { "name": "search", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfCityResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfCityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfCityResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1AddressesCitiesList({ search: 'string', page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/addresses/cities?search=string&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } }, "/api/v1/addresses/zipcodes": { "get": { "tags": [ "Addresses" ], "parameters": [ { "name": "search", "in": "query", "schema": { "maxLength": 200, "type": "string" } }, { "name": "page", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResponseOfZipCodeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfZipCodeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResponseOfZipCodeResponse" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript", "source": "import { createApiClient } from '@firmenakte/api-client';\n\nconst api = createApiClient({\n apiKey: 'YOUR_API_KEY',\n});\n\nconst result = await api.v1AddressesZipcodesList({ search: 'string', page: 0, pageSize: 0 });" }, { "lang": "cURL", "label": "cURL", "source": "curl -X GET 'https://api.firmenakte.at/api/v1/addresses/zipcodes?search=string&page=0&pageSize=0' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" } ] } } }, "components": { "schemas": { "Address": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fnr": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "street": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true } } }, "AddressLocationResponse": { "type": "object", "properties": { "city": { "type": "string" }, "zipCode": { "type": "string" }, "businessCount": { "type": "integer", "format": "int32" } } }, "AggregatedChangesResponse": { "type": "object", "properties": { "businessChanges": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessChange" } }, "documentChanges": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentChange" } }, "ediktChanges": { "type": "array", "items": { "$ref": "#/components/schemas/EdiktChange" } }, "globalChanges": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalChange" } } } }, "AssignmentFunctionItemResponse": { "type": "object", "properties": { "code": { "type": "string" }, "text": { "type": "string" } } }, "Bilanz": { "type": "object", "properties": { "documentKey": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "bilanzSumme": { "type": "number", "format": "double", "nullable": true }, "anlageVermoegen": { "type": "number", "format": "double", "nullable": true }, "immaterielleVermoegensgegenstaende": { "type": "number", "format": "double", "nullable": true }, "aktivierteEigenleistungen": { "type": "number", "format": "double", "nullable": true }, "sachanlagen": { "type": "number", "format": "double", "nullable": true }, "finanzanlagen": { "type": "number", "format": "double", "nullable": true }, "umlaufvermoegen": { "type": "number", "format": "double", "nullable": true }, "vorraete": { "type": "number", "format": "double", "nullable": true }, "forderungen": { "type": "number", "format": "double", "nullable": true }, "forderungenLieferungen": { "type": "number", "format": "double", "nullable": true }, "wertpapiere": { "type": "number", "format": "double", "nullable": true }, "liquidesVermoegen": { "type": "number", "format": "double", "nullable": true }, "rechnungsabgrenzungen": { "type": "number", "format": "double", "nullable": true }, "eigenkapital": { "type": "number", "format": "double", "nullable": true }, "eingefordertesStammkapital": { "type": "number", "format": "double", "nullable": true }, "kapitalruecklagen": { "type": "number", "format": "double", "nullable": true }, "gewinnruecklagen": { "type": "number", "format": "double", "nullable": true }, "bilanzgewinn": { "type": "number", "format": "double", "nullable": true }, "vortrag": { "type": "number", "format": "double", "nullable": true }, "rueckstellungen": { "type": "number", "format": "double", "nullable": true }, "verbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "langfristigeVerbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "kurzfristigeVerbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "verbindlichkeitenLieferungen": { "type": "number", "format": "double", "nullable": true }, "langfristigeForderungen": { "type": "number", "format": "double", "nullable": true }, "kurzfristigeForderungen": { "type": "number", "format": "double", "nullable": true }, "passiveRechnungsabgrenzungen": { "type": "number", "format": "double", "nullable": true } }, "nullable": true }, "BilanzDto": { "type": "object", "properties": { "bilanzSumme": { "type": "number", "format": "double", "nullable": true }, "anlageVermoegen": { "type": "number", "format": "double", "nullable": true }, "immaterielleVermoegensgegenstaende": { "type": "number", "format": "double", "nullable": true }, "aktivierteEigenleistungen": { "type": "number", "format": "double", "nullable": true }, "sachanlagen": { "type": "number", "format": "double", "nullable": true }, "finanzanlagen": { "type": "number", "format": "double", "nullable": true }, "umlaufvermoegen": { "type": "number", "format": "double", "nullable": true }, "vorraete": { "type": "number", "format": "double", "nullable": true }, "forderungen": { "type": "number", "format": "double", "nullable": true }, "forderungenLieferungen": { "type": "number", "format": "double", "nullable": true }, "wertpapiere": { "type": "number", "format": "double", "nullable": true }, "liquidesVermoegen": { "type": "number", "format": "double", "nullable": true }, "rechnungsabgrenzungen": { "type": "number", "format": "double", "nullable": true }, "eigenkapital": { "type": "number", "format": "double", "nullable": true }, "eingefordertesStammkapital": { "type": "number", "format": "double", "nullable": true }, "kapitalruecklagen": { "type": "number", "format": "double", "nullable": true }, "gewinnruecklagen": { "type": "number", "format": "double", "nullable": true }, "bilanzgewinn": { "type": "number", "format": "double", "nullable": true }, "vortrag": { "type": "number", "format": "double", "nullable": true }, "rueckstellungen": { "type": "number", "format": "double", "nullable": true }, "verbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "langfristigeVerbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "kurzfristigeVerbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "verbindlichkeitenLieferungen": { "type": "number", "format": "double", "nullable": true }, "langfristigeForderungen": { "type": "number", "format": "double", "nullable": true }, "kurzfristigeForderungen": { "type": "number", "format": "double", "nullable": true }, "passiveRechnungsabgrenzungen": { "type": "number", "format": "double", "nullable": true } }, "nullable": true }, "BusinessAssignment": { "type": "object", "properties": { "fnr": { "type": "string" }, "vnr": { "type": "string" }, "pnr": { "type": "string" }, "personId": { "type": "string" }, "functionCode": { "type": "string" }, "functionText": { "type": "string", "nullable": true }, "capitalAmount": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "BusinessAssignmentDetailResponse": { "type": "object", "properties": { "fnr": { "type": "string" }, "vnr": { "type": "string" }, "pnr": { "type": "string" }, "personId": { "type": "string" }, "functionCode": { "type": "string", "nullable": true }, "capitalAmount": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "person": { "$ref": "#/components/schemas/PersonResponse" } } }, "BusinessChange": { "required": [ "vnr" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fnr": { "type": "string", "nullable": true }, "vnr": { "type": "string" }, "changedDate": { "type": "string", "format": "date-time", "nullable": true }, "globalChange": { "$ref": "#/components/schemas/GlobalChange" }, "legalRecord": { "$ref": "#/components/schemas/LegalRecord" }, "changeType": { "$ref": "#/components/schemas/ChangeType" } } }, "BusinessDetailResponse": { "type": "object", "properties": { "fnr": { "type": "string" }, "euid": { "type": "string", "nullable": true }, "name": { "type": "string" }, "purpose": { "type": "string", "nullable": true }, "legalForm": { "$ref": "#/components/schemas/LegalForm" }, "court": { "$ref": "#/components/schemas/Court" }, "lastCrawledAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "isScheinunternehmen": { "type": "boolean" }, "scheinunternehmenKundmachungen": { "type": "array", "items": { "$ref": "#/components/schemas/ScheinunternehmenKundmachungDto" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "edikte": { "type": "array", "items": { "$ref": "#/components/schemas/Edikt" } }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessAssignmentDetailResponse" } }, "gisaLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/GisaLicense" } }, "legalRecords": { "type": "array", "items": { "$ref": "#/components/schemas/LegalRecordDetailDto" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentMetadata2" } }, "parsedJahresabschluesse": { "type": "array", "items": { "$ref": "#/components/schemas/ParsedJahresabschlussDto" } }, "latestKeyFigures": { "$ref": "#/components/schemas/BusinessLatestKeyFiguresDto" }, "oenaces": { "type": "array", "items": { "$ref": "#/components/schemas/OenaceDto" } } } }, "BusinessLatestKeyFiguresDto": { "type": "object", "properties": { "fnr": { "type": "string" }, "documentKey": { "type": "string", "nullable": true }, "documentDate": { "type": "string", "format": "date-time", "nullable": true }, "employees": { "type": "number", "format": "double", "nullable": true }, "bilanzSumme": { "type": "number", "format": "double", "nullable": true }, "anlageVermoegen": { "type": "number", "format": "double", "nullable": true }, "immaterielleVermoegensgegenstaende": { "type": "number", "format": "double", "nullable": true }, "aktivierteEigenleistungen": { "type": "number", "format": "double", "nullable": true }, "sachanlagen": { "type": "number", "format": "double", "nullable": true }, "finanzanlagen": { "type": "number", "format": "double", "nullable": true }, "umlaufvermoegen": { "type": "number", "format": "double", "nullable": true }, "vorraete": { "type": "number", "format": "double", "nullable": true }, "forderungen": { "type": "number", "format": "double", "nullable": true }, "forderungenLieferungen": { "type": "number", "format": "double", "nullable": true }, "wertpapiere": { "type": "number", "format": "double", "nullable": true }, "liquidesVermoegen": { "type": "number", "format": "double", "nullable": true }, "rechnungsabgrenzungen": { "type": "number", "format": "double", "nullable": true }, "eigenkapital": { "type": "number", "format": "double", "nullable": true }, "eingefordertesStammkapital": { "type": "number", "format": "double", "nullable": true }, "kapitalruecklagen": { "type": "number", "format": "double", "nullable": true }, "gewinnruecklagen": { "type": "number", "format": "double", "nullable": true }, "bilanzgewinn": { "type": "number", "format": "double", "nullable": true }, "vortrag": { "type": "number", "format": "double", "nullable": true }, "rueckstellungen": { "type": "number", "format": "double", "nullable": true }, "verbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "langfristigeVerbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "kurzfristigeVerbindlichkeiten": { "type": "number", "format": "double", "nullable": true }, "verbindlichkeitenLieferungen": { "type": "number", "format": "double", "nullable": true }, "langfristigeForderungen": { "type": "number", "format": "double", "nullable": true }, "kurzfristigeForderungen": { "type": "number", "format": "double", "nullable": true }, "passiveRechnungsabgrenzungen": { "type": "number", "format": "double", "nullable": true }, "betriebsErfolg": { "type": "number", "format": "double", "nullable": true }, "umsatzerloese": { "type": "number", "format": "double", "nullable": true }, "warenUndMaterialeinkauf": { "type": "number", "format": "double", "nullable": true }, "jahresueberschuss": { "type": "number", "format": "double", "nullable": true }, "bestandsveraenderung": { "type": "number", "format": "double", "nullable": true }, "personalaufwand": { "type": "number", "format": "double", "nullable": true }, "steueraufwand": { "type": "number", "format": "double", "nullable": true }, "ergebnisVorSteuern": { "type": "number", "format": "double", "nullable": true }, "zinsenUndAehnlicheAufwendungen": { "type": "number", "format": "double", "nullable": true }, "abschreibungen": { "type": "number", "format": "double", "nullable": true }, "sonstigeBetrieblicheErtraege": { "type": "number", "format": "double", "nullable": true }, "sozialeAufwendungen": { "type": "number", "format": "double", "nullable": true }, "sonstigeBetrieblicheAufwendungen": { "type": "number", "format": "double", "nullable": true }, "ertraegeAusBeteiligungen": { "type": "number", "format": "double", "nullable": true }, "ertraegeAusWertpapieren": { "type": "number", "format": "double", "nullable": true }, "sonstigeZinsenUndAehnlicheErtraege": { "type": "number", "format": "double", "nullable": true }, "aufwendungenAusFinanzanlagen": { "type": "number", "format": "double", "nullable": true }, "finanzerfolg": { "type": "number", "format": "double", "nullable": true }, "aufloesungGewinnruecklagen": { "type": "number", "format": "double", "nullable": true } }, "nullable": true }, "BusinessListResponse": { "type": "object", "properties": { "fnr": { "type": "string" }, "name": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "legalForm": { "$ref": "#/components/schemas/LegalForm" }, "isActive": { "type": "boolean" }, "isScheinunternehmen": { "type": "boolean" }, "hasEdikt": { "type": "boolean" }, "oenaceNumericCode": { "type": "string", "nullable": true } } }, "BusinessNameItem": { "type": "object", "properties": { "fnr": { "type": "string" }, "name": { "type": "string" } } }, "BusinessSummaryDto": { "type": "object", "properties": { "fnr": { "type": "string" }, "name": { "type": "string" }, "city": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "nullable": true }, "ChangeDetailResponse": { "type": "object", "properties": { "changeType": { "type": "string" }, "data": {} } }, "ChangeType": { "enum": [ "business", "edikt", "document", "gisa", "scheinunternehmen", "unknown" ] }, "CityResponse": { "type": "object", "properties": { "city": { "type": "string" }, "businessCount": { "type": "integer", "format": "int32" } } }, "Court": { "required": [ "text" ], "type": "object", "properties": { "code": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "text": { "type": "string" } }, "nullable": true }, "CourtCatalogItemResponse": { "type": "object", "properties": { "code": { "type": "string" }, "text": { "type": "string" }, "businessCount": { "type": "integer", "format": "int32" } } }, "DocumentChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fnr": { "type": "string", "nullable": true }, "documentKey": { "type": "string" }, "changedDate": { "type": "string", "format": "date-time", "nullable": true }, "globalChange": { "$ref": "#/components/schemas/GlobalChange" }, "document": { "$ref": "#/components/schemas/DocumentMetadata" }, "changeType": { "$ref": "#/components/schemas/ChangeType" } } }, "DocumentMetadata": { "type": "object", "properties": { "documentKey": { "type": "string" }, "fnr": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "documentTypeCode": { "type": "string", "nullable": true }, "documentDate": { "type": "string", "format": "date-time", "nullable": true }, "fileExtension": { "type": "string", "nullable": true }, "parsedJahresabschluss": { "$ref": "#/components/schemas/ParsedJahresabschluss" } }, "nullable": true }, "DocumentMetadata2": { "type": "object", "properties": { "documentKey": { "type": "string" }, "fnr": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "documentTypeCode": { "type": "string", "nullable": true }, "documentDate": { "type": "string", "format": "date-time", "nullable": true }, "fileExtension": { "type": "string", "nullable": true }, "parsedJahresabschluss": { "$ref": "#/components/schemas/ParsedJahresabschluss" } } }, "Edikt": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "ediktArt": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "hinweis": { "type": "string", "nullable": true }, "ergaenzung": { "type": "string", "nullable": true }, "bekanntmachungsDatum": { "type": "string", "format": "date" }, "loeschDatum": { "type": "string", "format": "date" }, "aenderungsZeitstempel": { "type": "string", "format": "date-time" }, "caseNumber": { "type": "string" }, "caseDepartment": { "type": "string", "nullable": true }, "caseYear": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "string", "nullable": true }, "fnr": { "type": "string", "nullable": true }, "courtCode": { "type": "string", "nullable": true } } }, "Edikt2": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "ediktArt": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "hinweis": { "type": "string", "nullable": true }, "ergaenzung": { "type": "string", "nullable": true }, "bekanntmachungsDatum": { "type": "string", "format": "date" }, "loeschDatum": { "type": "string", "format": "date" }, "aenderungsZeitstempel": { "type": "string", "format": "date-time" }, "caseNumber": { "type": "string" }, "caseDepartment": { "type": "string", "nullable": true }, "caseYear": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "string", "nullable": true }, "fnr": { "type": "string", "nullable": true }, "courtCode": { "type": "string", "nullable": true } }, "nullable": true }, "EdiktChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fnr": { "type": "string", "nullable": true }, "ediktArt": { "type": "integer", "format": "int32" }, "ediktId": { "type": "integer", "format": "int64" }, "changedDate": { "type": "string", "format": "date-time", "nullable": true }, "globalChange": { "$ref": "#/components/schemas/GlobalChange" }, "edikt": { "$ref": "#/components/schemas/Edikt2" }, "changeType": { "$ref": "#/components/schemas/ChangeType" } } }, "GisaChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fnr": { "type": "string", "nullable": true }, "gisaZahl": { "type": "integer", "format": "int64" }, "stateHash": { "type": "string" }, "changedDate": { "type": "string", "format": "date-time", "nullable": true }, "globalChange": { "$ref": "#/components/schemas/GlobalChange" }, "gisaLicense": { "$ref": "#/components/schemas/GisaLicense" }, "changeType": { "$ref": "#/components/schemas/ChangeType" } } }, "GisaLicense": { "required": [ "description" ], "type": "object", "properties": { "gisaZahl": { "type": "integer", "format": "int64" }, "fnr": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "licenseKey": { "type": "integer", "format": "int32" }, "trade": { "$ref": "#/components/schemas/GisaTrade" }, "description": { "type": "string" }, "isActive": { "type": "boolean", "nullable": true }, "addressId": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "string", "nullable": true } } }, "GisaLicenseItemDto": { "type": "object", "properties": { "gisaZahl": { "type": "integer", "format": "int64" }, "fnr": { "type": "string" }, "licenseKey": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "isActive": { "type": "boolean", "nullable": true }, "trade": { "$ref": "#/components/schemas/GisaTradeSummaryDto" } } }, "GisaTrade": { "required": [ "description" ], "type": "object", "properties": { "licenseKey": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "isHistorical": { "type": "boolean" } }, "nullable": true }, "GisaTradeSummaryDto": { "type": "object", "properties": { "licenseKey": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "nullable": true }, "GlobalChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "changeType": { "$ref": "#/components/schemas/ChangeType" }, "fnr": { "type": "string", "nullable": true }, "changedDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "GraphEdgeDto": { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "isActive": { "type": "boolean" }, "relationshipType": { "type": "string" } } }, "GraphNodeDto": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "isCentralNode": { "type": "boolean" }, "hasMore": { "type": "boolean" } } }, "GraphResponse": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/GraphNodeDto" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/GraphEdgeDto" } } } }, "Guv": { "type": "object", "properties": { "documentKey": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "betriebsErfolg": { "type": "number", "format": "double", "nullable": true }, "umsatzerloese": { "type": "number", "format": "double", "nullable": true }, "warenUndMaterialeinkauf": { "type": "number", "format": "double", "nullable": true }, "jahresueberschuss": { "type": "number", "format": "double", "nullable": true }, "bestandsveraenderung": { "type": "number", "format": "double", "nullable": true }, "personalaufwand": { "type": "number", "format": "double", "nullable": true }, "steueraufwand": { "type": "number", "format": "double", "nullable": true }, "ergebnisVorSteuern": { "type": "number", "format": "double", "nullable": true }, "zinsenUndAehnlicheAufwendungen": { "type": "number", "format": "double", "nullable": true }, "abschreibungen": { "type": "number", "format": "double", "nullable": true }, "sonstigeBetrieblicheErtraege": { "type": "number", "format": "double", "nullable": true }, "sozialeAufwendungen": { "type": "number", "format": "double", "nullable": true }, "sonstigeBetrieblicheAufwendungen": { "type": "number", "format": "double", "nullable": true }, "ertraegeAusBeteiligungen": { "type": "number", "format": "double", "nullable": true }, "ertraegeAusWertpapieren": { "type": "number", "format": "double", "nullable": true }, "sonstigeZinsenUndAehnlicheErtraege": { "type": "number", "format": "double", "nullable": true }, "aufwendungenAusFinanzanlagen": { "type": "number", "format": "double", "nullable": true }, "finanzerfolg": { "type": "number", "format": "double", "nullable": true }, "aufloesungGewinnruecklagen": { "type": "number", "format": "double", "nullable": true } }, "nullable": true }, "GuvDto": { "type": "object", "properties": { "betriebsErfolg": { "type": "number", "format": "double", "nullable": true }, "umsatzerloese": { "type": "number", "format": "double", "nullable": true }, "warenUndMaterialeinkauf": { "type": "number", "format": "double", "nullable": true }, "jahresueberschuss": { "type": "number", "format": "double", "nullable": true }, "bestandsveraenderung": { "type": "number", "format": "double", "nullable": true }, "personalaufwand": { "type": "number", "format": "double", "nullable": true }, "steueraufwand": { "type": "number", "format": "double", "nullable": true }, "ergebnisVorSteuern": { "type": "number", "format": "double", "nullable": true }, "zinsenUndAehnlicheAufwendungen": { "type": "number", "format": "double", "nullable": true }, "abschreibungen": { "type": "number", "format": "double", "nullable": true }, "sonstigeBetrieblicheErtraege": { "type": "number", "format": "double", "nullable": true }, "sozialeAufwendungen": { "type": "number", "format": "double", "nullable": true }, "sonstigeBetrieblicheAufwendungen": { "type": "number", "format": "double", "nullable": true }, "ertraegeAusBeteiligungen": { "type": "number", "format": "double", "nullable": true }, "ertraegeAusWertpapieren": { "type": "number", "format": "double", "nullable": true }, "sonstigeZinsenUndAehnlicheErtraege": { "type": "number", "format": "double", "nullable": true }, "aufwendungenAusFinanzanlagen": { "type": "number", "format": "double", "nullable": true }, "finanzerfolg": { "type": "number", "format": "double", "nullable": true }, "aufloesungGewinnruecklagen": { "type": "number", "format": "double", "nullable": true } }, "nullable": true }, "LegalForm": { "required": [ "text" ], "type": "object", "properties": { "code": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "text": { "type": "string" } }, "nullable": true }, "LegalFormCatalogItemResponse": { "type": "object", "properties": { "code": { "type": "string" }, "text": { "type": "string" }, "businessCount": { "type": "integer", "format": "int32" } } }, "LegalRecord": { "type": "object", "properties": { "fnr": { "type": "string" }, "vnr": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "executionDate": { "type": "string", "format": "date-time" }, "caseNumber": { "type": "string", "nullable": true }, "applicationText": { "type": "string", "nullable": true }, "changeType": { "type": "string", "nullable": true } } }, "LegalRecordChangeDto": { "type": "object", "properties": { "type": { "type": "string" }, "value": {} } }, "LegalRecordDetailDto": { "type": "object", "properties": { "fnr": { "type": "string" }, "vnr": { "type": "string" }, "executionDate": { "type": "string", "format": "date-time" }, "caseNumber": { "type": "string", "nullable": true }, "applicationText": { "type": "string", "nullable": true }, "changeType": { "type": "string", "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/LegalRecordChangeDto" } } } }, "OenaceCatalogItemResponse": { "type": "object", "properties": { "edvCode": { "type": "string" }, "code": { "type": "string" }, "titel": { "type": "string" }, "kurztitel": { "type": "string" }, "ebene": { "type": "integer", "format": "int32" }, "numericCode": { "type": "string", "nullable": true }, "companyCount": { "type": "integer", "format": "int32" } } }, "OenaceDto": { "type": "object", "properties": { "kurztitel": { "type": "string", "nullable": true }, "titel": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "numericCode": { "type": "string", "nullable": true } } }, "PagedResponseOfAddressLocationResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AddressLocationResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfBusinessChange": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessChange" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfBusinessListResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessListResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfCityResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CityResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfCourtCatalogItemResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CourtCatalogItemResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfDocumentChange": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentChange" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfEdiktChange": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EdiktChange" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfGisaChange": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GisaChange" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfGisaLicense": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GisaLicense" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfGlobalChange": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalChange" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfLegalFormCatalogItemResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LegalFormCatalogItemResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfOenaceCatalogItemResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OenaceCatalogItemResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfPerson": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfTradeCatalogItemResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TradeCatalogItemResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseOfZipCodeResponse": { "required": [ "data", "pageNumber", "pageSize", "totalRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ZipCodeResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "ParsedJahresabschluss": { "type": "object", "properties": { "documentKey": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "employees": { "type": "number", "format": "double", "nullable": true }, "bilanz": { "$ref": "#/components/schemas/Bilanz" }, "guv": { "$ref": "#/components/schemas/Guv" } }, "nullable": true }, "ParsedJahresabschlussDto": { "type": "object", "properties": { "documentKey": { "type": "string" }, "documentDate": { "type": "string", "format": "date-time", "nullable": true }, "employees": { "type": "number", "format": "double", "nullable": true }, "bilanz": { "$ref": "#/components/schemas/BilanzDto" }, "guv": { "$ref": "#/components/schemas/GuvDto" } } }, "Person": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "firstName": { "maxLength": 200, "type": "string", "nullable": true }, "lastName": { "maxLength": 200, "type": "string", "nullable": true }, "birthDate": { "type": "string", "nullable": true }, "titlePrefix": { "type": "string", "nullable": true }, "titleSuffix": { "type": "string", "nullable": true }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessAssignment" } }, "gisaLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/GisaLicense" } }, "edikte": { "type": "array", "items": { "$ref": "#/components/schemas/Edikt" } }, "scheinunternehmenKundmachungen": { "type": "array", "items": { "$ref": "#/components/schemas/ScheinunternehmenKundmachung" } } } }, "PersonAssignmentItemDto": { "type": "object", "properties": { "fnr": { "type": "string" }, "vnr": { "type": "string" }, "pnr": { "type": "string" }, "personId": { "type": "string" }, "functionCode": { "type": "string" }, "capitalAmount": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "business": { "$ref": "#/components/schemas/BusinessSummaryDto" }, "businessEdikte": { "type": "array", "items": { "$ref": "#/components/schemas/Edikt" } } } }, "PersonDetailResponse": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "nullable": true }, "titlePrefix": { "type": "string", "nullable": true }, "titleSuffix": { "type": "string", "nullable": true }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/PersonAssignmentItemDto" } }, "gisaLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/GisaLicenseItemDto" } }, "edikte": { "type": "array", "items": {} } } }, "PersonNameItem": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "PersonResponse": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "nullable": true }, "titlePrefix": { "type": "string", "nullable": true }, "titleSuffix": { "type": "string", "nullable": true } }, "nullable": true }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "ResolveBusinessNamesRequest": { "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, "ResolveBusinessNamesResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResolveBusinessNamesResultItem" } } } }, "ResolveBusinessNamesResultItem": { "type": "object", "properties": { "name": { "type": "string" }, "fnr": { "type": "string", "nullable": true } } }, "ScheinunternehmenKundmachung": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "guid": { "type": "string" }, "uid": { "type": "string", "nullable": true }, "fnr": { "type": "string", "nullable": true }, "personId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "publicationDate": { "type": "string", "format": "date-time", "nullable": true }, "addressText": { "type": "string", "nullable": true }, "rechtskraftBescheid": { "type": "string", "nullable": true }, "zeitpunktAlsScheinunternehmen": { "type": "string", "format": "date-time", "nullable": true } } }, "ScheinunternehmenKundmachungDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "guid": { "type": "string" }, "uid": { "type": "string", "nullable": true }, "fnr": { "type": "string", "nullable": true }, "personId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "publicationDate": { "type": "string", "format": "date-time", "nullable": true }, "addressText": { "type": "string", "nullable": true }, "rechtskraftBescheid": { "type": "string", "nullable": true }, "zeitpunktAlsScheinunternehmen": { "type": "string", "format": "date-time", "nullable": true } } }, "TradeCatalogItemResponse": { "type": "object", "properties": { "licenseKey": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "companyCount": { "type": "integer", "format": "int32" } } }, "ZipCodeResponse": { "type": "object", "properties": { "zipCode": { "type": "string" }, "businessCount": { "type": "integer", "format": "int32" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "Enter your API Key", "name": "x-api-key", "in": "header" } } }, "security": [ { "ApiKey": [] } ], "tags": [ { "name": "Trades" }, { "name": "People" }, { "name": "Oenace" }, { "name": "LegalForms" }, { "name": "Graph" }, { "name": "GlobalChanges" }, { "name": "Edikte" }, { "name": "Documents" }, { "name": "Courts" }, { "name": "Businesses" }, { "name": "AssignmentFunctions" }, { "name": "Addresses" } ] }