@firmenakte/api-client 2.1.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/client.d.ts +136 -136
- package/client.js +68 -68
- package/package.json +1 -1
package/client.d.ts
CHANGED
|
@@ -1313,10 +1313,10 @@ export interface ZipCodeResponse {
|
|
|
1313
1313
|
}
|
|
1314
1314
|
export declare namespace Api {
|
|
1315
1315
|
/**
|
|
1316
|
-
*
|
|
1316
|
+
* @description Downloads the signed GISA PDF extract for a license (GISA-Zahl). Language defaults to German (De).
|
|
1317
1317
|
* @tags Trades
|
|
1318
1318
|
* @name V1TradesDocumentsDetail
|
|
1319
|
-
* @summary
|
|
1319
|
+
* @summary GISA PDF extract
|
|
1320
1320
|
* @request GET:/api/v1/trades/documents/{gisaZahl}
|
|
1321
1321
|
* @secure
|
|
1322
1322
|
*/
|
|
@@ -1336,10 +1336,10 @@ export declare namespace Api {
|
|
|
1336
1336
|
type ResponseBody = Blob;
|
|
1337
1337
|
}
|
|
1338
1338
|
/**
|
|
1339
|
-
*
|
|
1339
|
+
* @description Returns the global catalog of GISA Trade Definitions with pagination.
|
|
1340
1340
|
* @tags Trades
|
|
1341
1341
|
* @name V1TradesList
|
|
1342
|
-
* @summary
|
|
1342
|
+
* @summary GISA trade catalog
|
|
1343
1343
|
* @request GET:/api/v1/trades
|
|
1344
1344
|
* @secure
|
|
1345
1345
|
*/
|
|
@@ -1369,10 +1369,10 @@ export declare namespace Api {
|
|
|
1369
1369
|
type ResponseBody = PagedResponseOfTradeCatalogItemResponse;
|
|
1370
1370
|
}
|
|
1371
1371
|
/**
|
|
1372
|
-
*
|
|
1372
|
+
* @description Returns all company licenses for a specific trade definition with pagination.
|
|
1373
1373
|
* @tags Trades
|
|
1374
1374
|
* @name V1TradesLicensesList
|
|
1375
|
-
* @summary
|
|
1375
|
+
* @summary Licenses by trade
|
|
1376
1376
|
* @request GET:/api/v1/trades/{tradeKey}/licenses
|
|
1377
1377
|
* @secure
|
|
1378
1378
|
*/
|
|
@@ -1402,10 +1402,10 @@ export declare namespace Api {
|
|
|
1402
1402
|
type ResponseBody = PagedResponseOfGisaLicense;
|
|
1403
1403
|
}
|
|
1404
1404
|
/**
|
|
1405
|
-
*
|
|
1405
|
+
* @description Returns all licenses for a specific company (FNR).
|
|
1406
1406
|
* @tags Trades
|
|
1407
1407
|
* @name V1TradesCompanyDetail
|
|
1408
|
-
* @summary
|
|
1408
|
+
* @summary Company GISA licenses
|
|
1409
1409
|
* @request GET:/api/v1/trades/company/{fnr}
|
|
1410
1410
|
* @secure
|
|
1411
1411
|
*/
|
|
@@ -1419,10 +1419,10 @@ export declare namespace Api {
|
|
|
1419
1419
|
type ResponseBody = GisaLicense[];
|
|
1420
1420
|
}
|
|
1421
1421
|
/**
|
|
1422
|
-
*
|
|
1422
|
+
* @description Returns a single GISA change by id.
|
|
1423
1423
|
* @tags Trades
|
|
1424
1424
|
* @name V1TradesChangesDetail
|
|
1425
|
-
* @summary
|
|
1425
|
+
* @summary GISA change by id
|
|
1426
1426
|
* @request GET:/api/v1/trades/changes/{id}
|
|
1427
1427
|
* @secure
|
|
1428
1428
|
*/
|
|
@@ -1437,10 +1437,10 @@ export declare namespace Api {
|
|
|
1437
1437
|
type ResponseBody = GisaChange;
|
|
1438
1438
|
}
|
|
1439
1439
|
/**
|
|
1440
|
-
* @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
1440
|
+
* @description Feed of GISA changes — one entry per change to a company's trade licences. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
1441
1441
|
* @tags Trades
|
|
1442
1442
|
* @name V1TradesChangesList
|
|
1443
|
-
* @summary
|
|
1443
|
+
* @summary GISA change feed
|
|
1444
1444
|
* @request GET:/api/v1/trades/changes
|
|
1445
1445
|
* @secure
|
|
1446
1446
|
*/
|
|
@@ -1479,10 +1479,10 @@ export declare namespace Api {
|
|
|
1479
1479
|
type ResponseBody = PagedResponseOfGisaChange;
|
|
1480
1480
|
}
|
|
1481
1481
|
/**
|
|
1482
|
-
*
|
|
1482
|
+
* @description Returns (id, name) pairs for all people with at least one business assignment. For client-side name index.
|
|
1483
1483
|
* @tags People
|
|
1484
1484
|
* @name V1PeopleNamesList
|
|
1485
|
-
* @summary
|
|
1485
|
+
* @summary Person name index
|
|
1486
1486
|
* @request GET:/api/v1/people/names
|
|
1487
1487
|
* @secure
|
|
1488
1488
|
*/
|
|
@@ -1494,10 +1494,10 @@ export declare namespace Api {
|
|
|
1494
1494
|
type ResponseBody = PersonNameItem[];
|
|
1495
1495
|
}
|
|
1496
1496
|
/**
|
|
1497
|
-
* @description name and search behave identically here — both split the term on spaces and keep people whose "firstName lastName" contains every token, case-insensitively — except that search wins when both are given. Ordered by last name, then first name unless orderBy says otherwise. Combine with fnr or businessName to get the officers of one company, or with functionCode for one role. fnr, functionCode, businessName, businessCity and businessRegisteredSince_gte all describe one and the same assignment: a person comes back only if a single company of theirs satisfies every one of them. So the youngest owners of this year's new Viennese companies are one page: ?businessCity=Wien&businessRegisteredSince_gte=2026-01-01&functionCode=IN&functionCode=KP&functionCode=GS&functionCode=PG&orderBy=birthDate&orderByDescending=true&pageSize=3
|
|
1497
|
+
* @description Lists people who hold a function in, or a GISA licence for, an Austrian company. name and search behave identically here — both split the term on spaces and keep people whose "firstName lastName" contains every token, case-insensitively — except that search wins when both are given. Ordered by last name, then first name unless orderBy says otherwise. Combine with fnr or businessName to get the officers of one company, or with functionCode for one role. fnr, functionCode, businessName, businessCity and businessRegisteredSince_gte all describe one and the same assignment: a person comes back only if a single company of theirs satisfies every one of them. So the youngest owners of this year's new Viennese companies are one page: ?businessCity=Wien&businessRegisteredSince_gte=2026-01-01&functionCode=IN&functionCode=KP&functionCode=GS&functionCode=PG&orderBy=birthDate&orderByDescending=true&pageSize=3
|
|
1498
1498
|
* @tags People
|
|
1499
1499
|
* @name V1PeopleList
|
|
1500
|
-
* @summary
|
|
1500
|
+
* @summary People search
|
|
1501
1501
|
* @request GET:/api/v1/people
|
|
1502
1502
|
* @secure
|
|
1503
1503
|
*/
|
|
@@ -1545,10 +1545,10 @@ export declare namespace Api {
|
|
|
1545
1545
|
type ResponseBody = PagedResponseOfPerson;
|
|
1546
1546
|
}
|
|
1547
1547
|
/**
|
|
1548
|
-
* @description personId is the synthetic id described in the glossary — "firstname-lastname-birthdate", lower case, inner spaces replaced by hyphens and "x" for a part the register does not give, e.g. "max-mustermann-1970-01-01". It is matched exactly. Take it from a list row or from an assignment on a company rather than composing it yourself.
|
|
1548
|
+
* @description Returns one person with every company function, GISA licence and Edikt attached to them. personId is the synthetic id described in the glossary — "firstname-lastname-birthdate", lower case, inner spaces replaced by hyphens and "x" for a part the register does not give, e.g. "max-mustermann-1970-01-01". It is matched exactly. Take it from a list row or from an assignment on a company rather than composing it yourself.
|
|
1549
1549
|
* @tags People
|
|
1550
1550
|
* @name V1PeopleDetail
|
|
1551
|
-
* @summary
|
|
1551
|
+
* @summary Person detail
|
|
1552
1552
|
* @request GET:/api/v1/people/{personId}
|
|
1553
1553
|
* @secure
|
|
1554
1554
|
*/
|
|
@@ -1562,10 +1562,10 @@ export declare namespace Api {
|
|
|
1562
1562
|
type ResponseBody = PersonDetailResponse;
|
|
1563
1563
|
}
|
|
1564
1564
|
/**
|
|
1565
|
-
*
|
|
1565
|
+
* @description Returns the OeNACE classification catalog with company counts. Results are ordered by company count descending — most used first.
|
|
1566
1566
|
* @tags Oenace
|
|
1567
1567
|
* @name V1OenaceList
|
|
1568
|
-
* @summary
|
|
1568
|
+
* @summary OeNACE classification catalog
|
|
1569
1569
|
* @request GET:/api/v1/oenace
|
|
1570
1570
|
* @secure
|
|
1571
1571
|
*/
|
|
@@ -1600,10 +1600,10 @@ export declare namespace Api {
|
|
|
1600
1600
|
type ResponseBody = PagedResponseOfOenaceCatalogItemResponse;
|
|
1601
1601
|
}
|
|
1602
1602
|
/**
|
|
1603
|
-
*
|
|
1603
|
+
* @description Returns all legal forms with pagination and optional search, sorted by business count descending.
|
|
1604
1604
|
* @tags LegalForms
|
|
1605
1605
|
* @name V1LegalformsList
|
|
1606
|
-
* @summary
|
|
1606
|
+
* @summary Legal form catalog
|
|
1607
1607
|
* @request GET:/api/v1/legalforms
|
|
1608
1608
|
* @secure
|
|
1609
1609
|
*/
|
|
@@ -1632,10 +1632,10 @@ export declare namespace Api {
|
|
|
1632
1632
|
type ResponseBody = PagedResponseOfLegalFormCatalogItemResponse;
|
|
1633
1633
|
}
|
|
1634
1634
|
/**
|
|
1635
|
-
* @description The network of people and companies around one starting point — who sits on which board with whom. nodes are people ("person") and companies ("business"), each carrying the id you would pass to /people/{personId} or /businesses/{fnr}; edges are source/target pairs of those ids whose relationshipType is "assignment", a person holding a function in a company. ("address", two companies registered at the same street address, is a second edge type the deployment can enable; it is off today, so expect only assignment edges.) The traversal depth is fixed at 2 hops and is not a parameter — a node with further connections outside that boundary carries hasMore=true, and isCentralNode marks the entity you started from. personId and fnr are mutually exclusive, not combinable: supplying both, or neither, is a 400, and an id that exists in neither register is a 404.
|
|
1635
|
+
* @description Returns the graph (nodes and edges) within 2 hops of the start entity. Exactly one of personId or fnr must be provided. The network of people and companies around one starting point — who sits on which board with whom. nodes are people ("person") and companies ("business"), each carrying the id you would pass to /people/{personId} or /businesses/{fnr}; edges are source/target pairs of those ids whose relationshipType is "assignment", a person holding a function in a company. ("address", two companies registered at the same street address, is a second edge type the deployment can enable; it is off today, so expect only assignment edges.) The traversal depth is fixed at 2 hops and is not a parameter — a node with further connections outside that boundary carries hasMore=true, and isCentralNode marks the entity you started from. personId and fnr are mutually exclusive, not combinable: supplying both, or neither, is a 400, and an id that exists in neither register is a 404.
|
|
1636
1636
|
* @tags Graph
|
|
1637
1637
|
* @name V1GraphList
|
|
1638
|
-
* @summary
|
|
1638
|
+
* @summary Relationship graph
|
|
1639
1639
|
* @request GET:/api/v1/graph
|
|
1640
1640
|
* @secure
|
|
1641
1641
|
*/
|
|
@@ -1652,10 +1652,10 @@ export declare namespace Api {
|
|
|
1652
1652
|
type ResponseBody = GraphResponse;
|
|
1653
1653
|
}
|
|
1654
1654
|
/**
|
|
1655
|
-
* @description Each row carries only id, fnr, changeType and the dates; fetch the payload with GET /globalchanges/{id}, or poll one register's typed feed instead (/businesses/changes, /documents/changes, /edikte/changes, /trades/changes). Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id.
|
|
1655
|
+
* @description The single feed of every change across all registers — Firmenbuch, GISA, Ediktsdatei and the BMF Scheinunternehmen list — as lightweight reference rows. Each row carries only id, fnr, changeType and the dates; fetch the payload with GET /globalchanges/{id}, or poll one register's typed feed instead (/businesses/changes, /documents/changes, /edikte/changes, /trades/changes). Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id.
|
|
1656
1656
|
* @tags GlobalChanges
|
|
1657
1657
|
* @name V1GlobalchangesList
|
|
1658
|
-
* @summary
|
|
1658
|
+
* @summary All-register change feed
|
|
1659
1659
|
* @request GET:/api/v1/globalchanges
|
|
1660
1660
|
* @secure
|
|
1661
1661
|
*/
|
|
@@ -1694,10 +1694,10 @@ export declare namespace Api {
|
|
|
1694
1694
|
type ResponseBody = PagedResponseOfGlobalChange;
|
|
1695
1695
|
}
|
|
1696
1696
|
/**
|
|
1697
|
-
* @description Built for watchlist polling: pass up to 1000 fnr values (repeat the parameter) and one cursor, and get back four arrays — businessChanges, documentChanges, ediktChanges, globalChanges — each ordered by ascending id and capped at maxResultsPerType. Not paged: raise maxResultsPerType or advance sinceId instead. sinceId is exclusive and since is inclusive, exactly as on the paged feeds, but one sinceId covers all four arrays: an array that comes back full at maxResultsPerType has more behind it and bounds the cursor, so advance sinceId only to the lowest of the full arrays' highest ids, and to the highest id of all four once none comes back full. Passing no fnr returns four empty arrays, not the whole feed.
|
|
1697
|
+
* @description Changes for a watchlist of companies, all four change types in one unpaged response. Built for watchlist polling: pass up to 1000 fnr values (repeat the parameter) and one cursor, and get back four arrays — businessChanges, documentChanges, ediktChanges, globalChanges — each ordered by ascending id and capped at maxResultsPerType. Not paged: raise maxResultsPerType or advance sinceId instead. sinceId is exclusive and since is inclusive, exactly as on the paged feeds, but one sinceId covers all four arrays: an array that comes back full at maxResultsPerType has more behind it and bounds the cursor, so advance sinceId only to the lowest of the full arrays' highest ids, and to the highest id of all four once none comes back full. Passing no fnr returns four empty arrays, not the whole feed.
|
|
1698
1698
|
* @tags GlobalChanges
|
|
1699
1699
|
* @name V1GlobalchangesAggregatedList
|
|
1700
|
-
* @summary
|
|
1700
|
+
* @summary Aggregated watchlist changes
|
|
1701
1701
|
* @request GET:/api/v1/globalchanges/aggregated
|
|
1702
1702
|
* @secure
|
|
1703
1703
|
*/
|
|
@@ -1723,10 +1723,10 @@ export declare namespace Api {
|
|
|
1723
1723
|
type ResponseBody = AggregatedChangesResponse;
|
|
1724
1724
|
}
|
|
1725
1725
|
/**
|
|
1726
|
-
* @description The envelope is a discriminator plus the payload: changeType says which register, and data is the matching object — a BusinessChange, DocumentChange, EdiktChange, GisaChange or ScheinunternehmenChange. Since data is a union, read changeType before it.
|
|
1726
|
+
* @description Returns one change with its typed payload, whichever register it came from. The envelope is a discriminator plus the payload: changeType says which register, and data is the matching object — a BusinessChange, DocumentChange, EdiktChange, GisaChange or ScheinunternehmenChange. Since data is a union, read changeType before it.
|
|
1727
1727
|
* @tags GlobalChanges
|
|
1728
1728
|
* @name V1GlobalchangesDetail
|
|
1729
|
-
* @summary
|
|
1729
|
+
* @summary Change by id
|
|
1730
1730
|
* @request GET:/api/v1/globalchanges/{id}
|
|
1731
1731
|
* @secure
|
|
1732
1732
|
*/
|
|
@@ -1741,10 +1741,10 @@ export declare namespace Api {
|
|
|
1741
1741
|
type ResponseBody = ChangeDetailResponse;
|
|
1742
1742
|
}
|
|
1743
1743
|
/**
|
|
1744
|
-
* @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "edikt" answers 404 here.
|
|
1744
|
+
* @description Returns one Ediktsdatei change by id. The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "edikt" answers 404 here.
|
|
1745
1745
|
* @tags Edikte
|
|
1746
1746
|
* @name V1EdikteChangesDetail
|
|
1747
|
-
* @summary
|
|
1747
|
+
* @summary Edikt change by id
|
|
1748
1748
|
* @request GET:/api/v1/edikte/changes/{id}
|
|
1749
1749
|
* @secure
|
|
1750
1750
|
*/
|
|
@@ -1759,10 +1759,10 @@ export declare namespace Api {
|
|
|
1759
1759
|
type ResponseBody = EdiktChange;
|
|
1760
1760
|
}
|
|
1761
1761
|
/**
|
|
1762
|
-
* @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the publication date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss an insolvency notice resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
1762
|
+
* @description Feed of Ediktsdatei changes — insolvency and other court notices published about a company or a person. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the publication date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss an insolvency notice resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
1763
1763
|
* @tags Edikte
|
|
1764
1764
|
* @name V1EdikteChangesList
|
|
1765
|
-
* @summary
|
|
1765
|
+
* @summary Ediktsdatei change feed
|
|
1766
1766
|
* @request GET:/api/v1/edikte/changes
|
|
1767
1767
|
* @secure
|
|
1768
1768
|
*/
|
|
@@ -1801,10 +1801,10 @@ export declare namespace Api {
|
|
|
1801
1801
|
type ResponseBody = PagedResponseOfEdiktChange;
|
|
1802
1802
|
}
|
|
1803
1803
|
/**
|
|
1804
|
-
*
|
|
1804
|
+
* @description Downloads a Firmenbuch document (PDF/XML) by its document key.
|
|
1805
1805
|
* @tags Documents
|
|
1806
1806
|
* @name V1DocumentsDownloadDetail
|
|
1807
|
-
* @summary
|
|
1807
|
+
* @summary Firmenbuch document download
|
|
1808
1808
|
* @request GET:/api/v1/documents/download/{documentKey}
|
|
1809
1809
|
* @secure
|
|
1810
1810
|
*/
|
|
@@ -1818,10 +1818,10 @@ export declare namespace Api {
|
|
|
1818
1818
|
type ResponseBody = void;
|
|
1819
1819
|
}
|
|
1820
1820
|
/**
|
|
1821
|
-
* @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "document" answers 404 here.
|
|
1821
|
+
* @description Returns one document change by id, with the document's metadata. The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "document" answers 404 here.
|
|
1822
1822
|
* @tags Documents
|
|
1823
1823
|
* @name V1DocumentsChangesDetail
|
|
1824
|
-
* @summary
|
|
1824
|
+
* @summary Document change by id
|
|
1825
1825
|
* @request GET:/api/v1/documents/changes/{id}
|
|
1826
1826
|
* @secure
|
|
1827
1827
|
*/
|
|
@@ -1836,10 +1836,10 @@ export declare namespace Api {
|
|
|
1836
1836
|
type ResponseBody = DocumentChange;
|
|
1837
1837
|
}
|
|
1838
1838
|
/**
|
|
1839
|
-
* @description Each entry names a documentKey; fetch the file itself with GET /documents/download/{documentKey}. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the document date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
1839
|
+
* @description Feed of newly filed Firmenbuch documents — this is how you learn that a company has published a new Jahresabschluss. Each entry names a documentKey; fetch the file itself with GET /documents/download/{documentKey}. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the document date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
1840
1840
|
* @tags Documents
|
|
1841
1841
|
* @name V1DocumentsChangesList
|
|
1842
|
-
* @summary
|
|
1842
|
+
* @summary Document change feed
|
|
1843
1843
|
* @request GET:/api/v1/documents/changes
|
|
1844
1844
|
* @secure
|
|
1845
1845
|
*/
|
|
@@ -1878,10 +1878,10 @@ export declare namespace Api {
|
|
|
1878
1878
|
type ResponseBody = PagedResponseOfDocumentChange;
|
|
1879
1879
|
}
|
|
1880
1880
|
/**
|
|
1881
|
-
*
|
|
1881
|
+
* @description Returns all courts with pagination and optional search, sorted by business count descending.
|
|
1882
1882
|
* @tags Courts
|
|
1883
1883
|
* @name V1CourtsList
|
|
1884
|
-
* @summary
|
|
1884
|
+
* @summary Court catalog
|
|
1885
1885
|
* @request GET:/api/v1/courts
|
|
1886
1886
|
* @secure
|
|
1887
1887
|
*/
|
|
@@ -1910,10 +1910,10 @@ export declare namespace Api {
|
|
|
1910
1910
|
type ResponseBody = PagedResponseOfCourtCatalogItemResponse;
|
|
1911
1911
|
}
|
|
1912
1912
|
/**
|
|
1913
|
-
*
|
|
1913
|
+
* @description Resolve company names to FNRs by exact name match (1:1). Used for CSV import.
|
|
1914
1914
|
* @tags Businesses
|
|
1915
1915
|
* @name V1BusinessesResolveNamesCreate
|
|
1916
|
-
* @summary
|
|
1916
|
+
* @summary Name to FNR resolution
|
|
1917
1917
|
* @request POST:/api/v1/businesses/resolve-names
|
|
1918
1918
|
* @secure
|
|
1919
1919
|
*/
|
|
@@ -1925,10 +1925,10 @@ export declare namespace Api {
|
|
|
1925
1925
|
type ResponseBody = ResolveBusinessNamesResponse;
|
|
1926
1926
|
}
|
|
1927
1927
|
/**
|
|
1928
|
-
* @description name and search are different tools. name is a case-insensitive substring match on the company name and nothing else. search splits the term on spaces and keeps only companies matching every token, where a token matches the name, the fnr, or — when the whole term is a number — a GISA licence key or GISA-Zahl; it additionally lifts companies whose name starts with the term to the top of the default (name) ordering. So name narrows a known name, search finds an unknown one. Inactive companies always sort after active ones, whatever orderBy says. Pass countOnly=true for totalRecords without the rows, and use /businesses/aggregate to group the same filter set instead of paging through it.
|
|
1928
|
+
* @description Lists companies matching the filters, one page of list rows per call. name and search are different tools. name is a case-insensitive substring match on the company name and nothing else. search splits the term on spaces and keeps only companies matching every token, where a token matches the name, the fnr, or — when the whole term is a number — a GISA licence key or GISA-Zahl; it additionally lifts companies whose name starts with the term to the top of the default (name) ordering. So name narrows a known name, search finds an unknown one. Inactive companies always sort after active ones, whatever orderBy says. Pass countOnly=true for totalRecords without the rows, and use /businesses/aggregate to group the same filter set instead of paging through it.
|
|
1929
1929
|
* @tags Businesses
|
|
1930
1930
|
* @name V1BusinessesList
|
|
1931
|
-
* @summary
|
|
1931
|
+
* @summary Company search
|
|
1932
1932
|
* @request GET:/api/v1/businesses
|
|
1933
1933
|
* @secure
|
|
1934
1934
|
*/
|
|
@@ -2491,10 +2491,10 @@ export declare namespace Api {
|
|
|
2491
2491
|
type ResponseBody = PagedResponseOfBusinessListResponse;
|
|
2492
2492
|
}
|
|
2493
2493
|
/**
|
|
2494
|
-
* No
|
|
2494
|
+
* @description Returns all business (fnr, name) pairs for client-side name index. No pagination.
|
|
2495
2495
|
* @tags Businesses
|
|
2496
2496
|
* @name V1BusinessesNamesList
|
|
2497
|
-
* @summary
|
|
2497
|
+
* @summary Company name index
|
|
2498
2498
|
* @request GET:/api/v1/businesses/names
|
|
2499
2499
|
* @secure
|
|
2500
2500
|
*/
|
|
@@ -2506,10 +2506,10 @@ export declare namespace Api {
|
|
|
2506
2506
|
type ResponseBody = BusinessNameItem[];
|
|
2507
2507
|
}
|
|
2508
2508
|
/**
|
|
2509
|
-
* @description Unfiltered — it is the size of the whole dataset, not of a search. For a count over filters, call GET /businesses with countOnly=true and read totalRecords.
|
|
2509
|
+
* @description Returns the number of companies in the dataset, as a bare integer. Unfiltered — it is the size of the whole dataset, not of a search. For a count over filters, call GET /businesses with countOnly=true and read totalRecords.
|
|
2510
2510
|
* @tags Businesses
|
|
2511
2511
|
* @name V1BusinessesCountList
|
|
2512
|
-
* @summary
|
|
2512
|
+
* @summary Company count
|
|
2513
2513
|
* @request GET:/api/v1/businesses/count
|
|
2514
2514
|
* @secure
|
|
2515
2515
|
*/
|
|
@@ -2521,10 +2521,10 @@ export declare namespace Api {
|
|
|
2521
2521
|
type ResponseBody = number;
|
|
2522
2522
|
}
|
|
2523
2523
|
/**
|
|
2524
|
-
*
|
|
2524
|
+
* @description Counts over the same filter set as GET /businesses, grouped by one dimension — the server-side GROUP BY that a caller would otherwise page the whole result set to compute. Every /businesses filter means exactly what it means there; page, pageSize, orderBy, orderByDescending and countOnly are ignored — top and minCount cap the bucket list instead. totalRecords equals /businesses?countOnly=true for the same filter; how the buckets relate to it is documented on BusinessAggregateResponse.
|
|
2525
2525
|
* @tags Businesses
|
|
2526
2526
|
* @name V1BusinessesAggregateList
|
|
2527
|
-
* @summary
|
|
2527
|
+
* @summary Grouped company counts
|
|
2528
2528
|
* @request GET:/api/v1/businesses/aggregate
|
|
2529
2529
|
* @secure
|
|
2530
2530
|
*/
|
|
@@ -3101,10 +3101,10 @@ export declare namespace Api {
|
|
|
3101
3101
|
type ResponseBody = BusinessAggregateResponse;
|
|
3102
3102
|
}
|
|
3103
3103
|
/**
|
|
3104
|
-
*
|
|
3104
|
+
* @description Active businesses similar to the given one (same OeNACE branch, same region preferred).
|
|
3105
3105
|
* @tags Businesses
|
|
3106
3106
|
* @name V1BusinessesSimilarList
|
|
3107
|
-
* @summary
|
|
3107
|
+
* @summary Similar companies
|
|
3108
3108
|
* @request GET:/api/v1/businesses/{fnr}/similar
|
|
3109
3109
|
* @secure
|
|
3110
3110
|
*/
|
|
@@ -3118,10 +3118,10 @@ export declare namespace Api {
|
|
|
3118
3118
|
type ResponseBody = BusinessListResponse[];
|
|
3119
3119
|
}
|
|
3120
3120
|
/**
|
|
3121
|
-
* @description fnr is matched exactly against the stored, normalised Firmenbuchnummer — lower case, no spaces, no leading zeros and no "FN" prefix, e.g. 34853f. Nothing is normalised on the way in, so "FN 34853 f" answers 404 rather than the company. 404 also means the company is not in the dataset yet.
|
|
3121
|
+
* @description Returns the whole Firmenakte of one company: master data, addresses, people, GISA licences, Edikte, documents and the parsed annual accounts. fnr is matched exactly against the stored, normalised Firmenbuchnummer — lower case, no spaces, no leading zeros and no "FN" prefix, e.g. 34853f. Nothing is normalised on the way in, so "FN 34853 f" answers 404 rather than the company. 404 also means the company is not in the dataset yet.
|
|
3122
3122
|
* @tags Businesses
|
|
3123
3123
|
* @name V1BusinessesDetail
|
|
3124
|
-
* @summary
|
|
3124
|
+
* @summary Company Firmenakte
|
|
3125
3125
|
* @request GET:/api/v1/businesses/{fnr}
|
|
3126
3126
|
* @secure
|
|
3127
3127
|
*/
|
|
@@ -3135,10 +3135,10 @@ export declare namespace Api {
|
|
|
3135
3135
|
type ResponseBody = BusinessDetailResponse;
|
|
3136
3136
|
}
|
|
3137
3137
|
/**
|
|
3138
|
-
* @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "business" answers 404 here.
|
|
3138
|
+
* @description Returns one Firmenbuch change by id. The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "business" answers 404 here.
|
|
3139
3139
|
* @tags Businesses
|
|
3140
3140
|
* @name V1BusinessesChangesDetail
|
|
3141
|
-
* @summary
|
|
3141
|
+
* @summary Firmenbuch change by id
|
|
3142
3142
|
* @request GET:/api/v1/businesses/changes/{id}
|
|
3143
3143
|
* @secure
|
|
3144
3144
|
*/
|
|
@@ -3153,10 +3153,10 @@ export declare namespace Api {
|
|
|
3153
3153
|
type ResponseBody = BusinessChange;
|
|
3154
3154
|
}
|
|
3155
3155
|
/**
|
|
3156
|
-
* @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate — so a back-dated entry is not missed — and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses. Use GET /globalchanges for the same feed across all four registers.
|
|
3156
|
+
* @description Feed of Firmenbuch changes — one entry per new legal record (Eintragung). Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate — so a back-dated entry is not missed — and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses. Use GET /globalchanges for the same feed across all four registers.
|
|
3157
3157
|
* @tags Businesses
|
|
3158
3158
|
* @name V1BusinessesChangesList
|
|
3159
|
-
* @summary
|
|
3159
|
+
* @summary Firmenbuch change feed
|
|
3160
3160
|
* @request GET:/api/v1/businesses/changes
|
|
3161
3161
|
* @secure
|
|
3162
3162
|
*/
|
|
@@ -3195,10 +3195,10 @@ export declare namespace Api {
|
|
|
3195
3195
|
type ResponseBody = PagedResponseOfBusinessChange;
|
|
3196
3196
|
}
|
|
3197
3197
|
/**
|
|
3198
|
-
*
|
|
3198
|
+
* @description Returns all assignment functions (code/text lookup) for display. Cached 24h.
|
|
3199
3199
|
* @tags AssignmentFunctions
|
|
3200
3200
|
* @name V1AssignmentfunctionsList
|
|
3201
|
-
* @summary
|
|
3201
|
+
* @summary Assignment function catalog
|
|
3202
3202
|
* @request GET:/api/v1/assignmentfunctions
|
|
3203
3203
|
* @secure
|
|
3204
3204
|
*/
|
|
@@ -3210,10 +3210,10 @@ export declare namespace Api {
|
|
|
3210
3210
|
type ResponseBody = AssignmentFunctionItemResponse[];
|
|
3211
3211
|
}
|
|
3212
3212
|
/**
|
|
3213
|
-
*
|
|
3213
|
+
* @description Returns unique City+ZipCode combinations from addresses with pagination and optional search.
|
|
3214
3214
|
* @tags Addresses
|
|
3215
3215
|
* @name V1AddressesLocationsList
|
|
3216
|
-
* @summary
|
|
3216
|
+
* @summary City and ZIP combinations
|
|
3217
3217
|
* @request GET:/api/v1/addresses/locations
|
|
3218
3218
|
* @secure
|
|
3219
3219
|
*/
|
|
@@ -3241,10 +3241,10 @@ export declare namespace Api {
|
|
|
3241
3241
|
type ResponseBody = PagedResponseOfAddressLocationResponse;
|
|
3242
3242
|
}
|
|
3243
3243
|
/**
|
|
3244
|
-
*
|
|
3244
|
+
* @description Returns unique cities from addresses with pagination and optional search.
|
|
3245
3245
|
* @tags Addresses
|
|
3246
3246
|
* @name V1AddressesCitiesList
|
|
3247
|
-
* @summary
|
|
3247
|
+
* @summary Cities
|
|
3248
3248
|
* @request GET:/api/v1/addresses/cities
|
|
3249
3249
|
* @secure
|
|
3250
3250
|
*/
|
|
@@ -3272,10 +3272,10 @@ export declare namespace Api {
|
|
|
3272
3272
|
type ResponseBody = PagedResponseOfCityResponse;
|
|
3273
3273
|
}
|
|
3274
3274
|
/**
|
|
3275
|
-
*
|
|
3275
|
+
* @description Returns unique zip codes from addresses with pagination and optional search.
|
|
3276
3276
|
* @tags Addresses
|
|
3277
3277
|
* @name V1AddressesZipcodesList
|
|
3278
|
-
* @summary
|
|
3278
|
+
* @summary ZIP codes
|
|
3279
3279
|
* @request GET:/api/v1/addresses/zipcodes
|
|
3280
3280
|
* @secure
|
|
3281
3281
|
*/
|
|
@@ -3370,11 +3370,11 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
3370
3370
|
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
3371
3371
|
api: {
|
|
3372
3372
|
/**
|
|
3373
|
-
*
|
|
3373
|
+
* @description Downloads the signed GISA PDF extract for a license (GISA-Zahl). Language defaults to German (De).
|
|
3374
3374
|
*
|
|
3375
3375
|
* @tags Trades
|
|
3376
3376
|
* @name V1TradesDocumentsDetail
|
|
3377
|
-
* @summary
|
|
3377
|
+
* @summary GISA PDF extract
|
|
3378
3378
|
* @request GET:/api/v1/trades/documents/{gisaZahl}
|
|
3379
3379
|
* @secure
|
|
3380
3380
|
*/
|
|
@@ -3385,11 +3385,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3385
3385
|
language?: "De" | "En";
|
|
3386
3386
|
}, params?: RequestParams) => Promise<HttpResponse<Blob, ProblemDetails | ApiError>>;
|
|
3387
3387
|
/**
|
|
3388
|
-
*
|
|
3388
|
+
* @description Returns the global catalog of GISA Trade Definitions with pagination.
|
|
3389
3389
|
*
|
|
3390
3390
|
* @tags Trades
|
|
3391
3391
|
* @name V1TradesList
|
|
3392
|
-
* @summary
|
|
3392
|
+
* @summary GISA trade catalog
|
|
3393
3393
|
* @request GET:/api/v1/trades
|
|
3394
3394
|
* @secure
|
|
3395
3395
|
*/
|
|
@@ -3413,11 +3413,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3413
3413
|
pageSize?: number;
|
|
3414
3414
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfTradeCatalogItemResponse, ProblemDetails | ApiError>>;
|
|
3415
3415
|
/**
|
|
3416
|
-
*
|
|
3416
|
+
* @description Returns all company licenses for a specific trade definition with pagination.
|
|
3417
3417
|
*
|
|
3418
3418
|
* @tags Trades
|
|
3419
3419
|
* @name V1TradesLicensesList
|
|
3420
|
-
* @summary
|
|
3420
|
+
* @summary Licenses by trade
|
|
3421
3421
|
* @request GET:/api/v1/trades/{tradeKey}/licenses
|
|
3422
3422
|
* @secure
|
|
3423
3423
|
*/
|
|
@@ -3438,31 +3438,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3438
3438
|
pageSize?: number;
|
|
3439
3439
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfGisaLicense, ProblemDetails | ApiError>>;
|
|
3440
3440
|
/**
|
|
3441
|
-
*
|
|
3441
|
+
* @description Returns all licenses for a specific company (FNR).
|
|
3442
3442
|
*
|
|
3443
3443
|
* @tags Trades
|
|
3444
3444
|
* @name V1TradesCompanyDetail
|
|
3445
|
-
* @summary
|
|
3445
|
+
* @summary Company GISA licenses
|
|
3446
3446
|
* @request GET:/api/v1/trades/company/{fnr}
|
|
3447
3447
|
* @secure
|
|
3448
3448
|
*/
|
|
3449
3449
|
v1TradesCompanyDetail: (fnr: string, params?: RequestParams) => Promise<HttpResponse<GisaLicense[], ProblemDetails | ApiError>>;
|
|
3450
3450
|
/**
|
|
3451
|
-
*
|
|
3451
|
+
* @description Returns a single GISA change by id.
|
|
3452
3452
|
*
|
|
3453
3453
|
* @tags Trades
|
|
3454
3454
|
* @name V1TradesChangesDetail
|
|
3455
|
-
* @summary
|
|
3455
|
+
* @summary GISA change by id
|
|
3456
3456
|
* @request GET:/api/v1/trades/changes/{id}
|
|
3457
3457
|
* @secure
|
|
3458
3458
|
*/
|
|
3459
3459
|
v1TradesChangesDetail: (id: number, params?: RequestParams) => Promise<HttpResponse<GisaChange, ProblemDetails | ApiError>>;
|
|
3460
3460
|
/**
|
|
3461
|
-
* @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
3461
|
+
* @description Feed of GISA changes — one entry per change to a company's trade licences. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
3462
3462
|
*
|
|
3463
3463
|
* @tags Trades
|
|
3464
3464
|
* @name V1TradesChangesList
|
|
3465
|
-
* @summary
|
|
3465
|
+
* @summary GISA change feed
|
|
3466
3466
|
* @request GET:/api/v1/trades/changes
|
|
3467
3467
|
* @secure
|
|
3468
3468
|
*/
|
|
@@ -3495,21 +3495,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3495
3495
|
pageSize?: number;
|
|
3496
3496
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfGisaChange, ProblemDetails | ApiError>>;
|
|
3497
3497
|
/**
|
|
3498
|
-
*
|
|
3498
|
+
* @description Returns (id, name) pairs for all people with at least one business assignment. For client-side name index.
|
|
3499
3499
|
*
|
|
3500
3500
|
* @tags People
|
|
3501
3501
|
* @name V1PeopleNamesList
|
|
3502
|
-
* @summary
|
|
3502
|
+
* @summary Person name index
|
|
3503
3503
|
* @request GET:/api/v1/people/names
|
|
3504
3504
|
* @secure
|
|
3505
3505
|
*/
|
|
3506
3506
|
v1PeopleNamesList: (params?: RequestParams) => Promise<HttpResponse<PersonNameItem[], ProblemDetails | ApiError>>;
|
|
3507
3507
|
/**
|
|
3508
|
-
* @description name and search behave identically here — both split the term on spaces and keep people whose "firstName lastName" contains every token, case-insensitively — except that search wins when both are given. Ordered by last name, then first name unless orderBy says otherwise. Combine with fnr or businessName to get the officers of one company, or with functionCode for one role. fnr, functionCode, businessName, businessCity and businessRegisteredSince_gte all describe one and the same assignment: a person comes back only if a single company of theirs satisfies every one of them. So the youngest owners of this year's new Viennese companies are one page: ?businessCity=Wien&businessRegisteredSince_gte=2026-01-01&functionCode=IN&functionCode=KP&functionCode=GS&functionCode=PG&orderBy=birthDate&orderByDescending=true&pageSize=3
|
|
3508
|
+
* @description Lists people who hold a function in, or a GISA licence for, an Austrian company. name and search behave identically here — both split the term on spaces and keep people whose "firstName lastName" contains every token, case-insensitively — except that search wins when both are given. Ordered by last name, then first name unless orderBy says otherwise. Combine with fnr or businessName to get the officers of one company, or with functionCode for one role. fnr, functionCode, businessName, businessCity and businessRegisteredSince_gte all describe one and the same assignment: a person comes back only if a single company of theirs satisfies every one of them. So the youngest owners of this year's new Viennese companies are one page: ?businessCity=Wien&businessRegisteredSince_gte=2026-01-01&functionCode=IN&functionCode=KP&functionCode=GS&functionCode=PG&orderBy=birthDate&orderByDescending=true&pageSize=3
|
|
3509
3509
|
*
|
|
3510
3510
|
* @tags People
|
|
3511
3511
|
* @name V1PeopleList
|
|
3512
|
-
* @summary
|
|
3512
|
+
* @summary People search
|
|
3513
3513
|
* @request GET:/api/v1/people
|
|
3514
3514
|
* @secure
|
|
3515
3515
|
*/
|
|
@@ -3551,21 +3551,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3551
3551
|
pageSize?: number;
|
|
3552
3552
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfPerson, ProblemDetails | ApiError>>;
|
|
3553
3553
|
/**
|
|
3554
|
-
* @description personId is the synthetic id described in the glossary — "firstname-lastname-birthdate", lower case, inner spaces replaced by hyphens and "x" for a part the register does not give, e.g. "max-mustermann-1970-01-01". It is matched exactly. Take it from a list row or from an assignment on a company rather than composing it yourself.
|
|
3554
|
+
* @description Returns one person with every company function, GISA licence and Edikt attached to them. personId is the synthetic id described in the glossary — "firstname-lastname-birthdate", lower case, inner spaces replaced by hyphens and "x" for a part the register does not give, e.g. "max-mustermann-1970-01-01". It is matched exactly. Take it from a list row or from an assignment on a company rather than composing it yourself.
|
|
3555
3555
|
*
|
|
3556
3556
|
* @tags People
|
|
3557
3557
|
* @name V1PeopleDetail
|
|
3558
|
-
* @summary
|
|
3558
|
+
* @summary Person detail
|
|
3559
3559
|
* @request GET:/api/v1/people/{personId}
|
|
3560
3560
|
* @secure
|
|
3561
3561
|
*/
|
|
3562
3562
|
v1PeopleDetail: (personId: string, params?: RequestParams) => Promise<HttpResponse<PersonDetailResponse, ProblemDetails | ApiError>>;
|
|
3563
3563
|
/**
|
|
3564
|
-
*
|
|
3564
|
+
* @description Returns the OeNACE classification catalog with company counts. Results are ordered by company count descending — most used first.
|
|
3565
3565
|
*
|
|
3566
3566
|
* @tags Oenace
|
|
3567
3567
|
* @name V1OenaceList
|
|
3568
|
-
* @summary
|
|
3568
|
+
* @summary OeNACE classification catalog
|
|
3569
3569
|
* @request GET:/api/v1/oenace
|
|
3570
3570
|
* @secure
|
|
3571
3571
|
*/
|
|
@@ -3594,11 +3594,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3594
3594
|
pageSize?: number;
|
|
3595
3595
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfOenaceCatalogItemResponse, ProblemDetails | ApiError>>;
|
|
3596
3596
|
/**
|
|
3597
|
-
*
|
|
3597
|
+
* @description Returns all legal forms with pagination and optional search, sorted by business count descending.
|
|
3598
3598
|
*
|
|
3599
3599
|
* @tags LegalForms
|
|
3600
3600
|
* @name V1LegalformsList
|
|
3601
|
-
* @summary
|
|
3601
|
+
* @summary Legal form catalog
|
|
3602
3602
|
* @request GET:/api/v1/legalforms
|
|
3603
3603
|
* @secure
|
|
3604
3604
|
*/
|
|
@@ -3621,11 +3621,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3621
3621
|
pageSize?: number;
|
|
3622
3622
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfLegalFormCatalogItemResponse, ProblemDetails | ApiError>>;
|
|
3623
3623
|
/**
|
|
3624
|
-
* @description The network of people and companies around one starting point — who sits on which board with whom. nodes are people ("person") and companies ("business"), each carrying the id you would pass to /people/{personId} or /businesses/{fnr}; edges are source/target pairs of those ids whose relationshipType is "assignment", a person holding a function in a company. ("address", two companies registered at the same street address, is a second edge type the deployment can enable; it is off today, so expect only assignment edges.) The traversal depth is fixed at 2 hops and is not a parameter — a node with further connections outside that boundary carries hasMore=true, and isCentralNode marks the entity you started from. personId and fnr are mutually exclusive, not combinable: supplying both, or neither, is a 400, and an id that exists in neither register is a 404.
|
|
3624
|
+
* @description Returns the graph (nodes and edges) within 2 hops of the start entity. Exactly one of personId or fnr must be provided. The network of people and companies around one starting point — who sits on which board with whom. nodes are people ("person") and companies ("business"), each carrying the id you would pass to /people/{personId} or /businesses/{fnr}; edges are source/target pairs of those ids whose relationshipType is "assignment", a person holding a function in a company. ("address", two companies registered at the same street address, is a second edge type the deployment can enable; it is off today, so expect only assignment edges.) The traversal depth is fixed at 2 hops and is not a parameter — a node with further connections outside that boundary carries hasMore=true, and isCentralNode marks the entity you started from. personId and fnr are mutually exclusive, not combinable: supplying both, or neither, is a 400, and an id that exists in neither register is a 404.
|
|
3625
3625
|
*
|
|
3626
3626
|
* @tags Graph
|
|
3627
3627
|
* @name V1GraphList
|
|
3628
|
-
* @summary
|
|
3628
|
+
* @summary Relationship graph
|
|
3629
3629
|
* @request GET:/api/v1/graph
|
|
3630
3630
|
* @secure
|
|
3631
3631
|
*/
|
|
@@ -3636,11 +3636,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3636
3636
|
fnr?: string;
|
|
3637
3637
|
}, params?: RequestParams) => Promise<HttpResponse<GraphResponse, ProblemDetails | ApiError>>;
|
|
3638
3638
|
/**
|
|
3639
|
-
* @description Each row carries only id, fnr, changeType and the dates; fetch the payload with GET /globalchanges/{id}, or poll one register's typed feed instead (/businesses/changes, /documents/changes, /edikte/changes, /trades/changes). Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id.
|
|
3639
|
+
* @description The single feed of every change across all registers — Firmenbuch, GISA, Ediktsdatei and the BMF Scheinunternehmen list — as lightweight reference rows. Each row carries only id, fnr, changeType and the dates; fetch the payload with GET /globalchanges/{id}, or poll one register's typed feed instead (/businesses/changes, /documents/changes, /edikte/changes, /trades/changes). Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id.
|
|
3640
3640
|
*
|
|
3641
3641
|
* @tags GlobalChanges
|
|
3642
3642
|
* @name V1GlobalchangesList
|
|
3643
|
-
* @summary
|
|
3643
|
+
* @summary All-register change feed
|
|
3644
3644
|
* @request GET:/api/v1/globalchanges
|
|
3645
3645
|
* @secure
|
|
3646
3646
|
*/
|
|
@@ -3673,11 +3673,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3673
3673
|
pageSize?: number;
|
|
3674
3674
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfGlobalChange, ProblemDetails | ApiError>>;
|
|
3675
3675
|
/**
|
|
3676
|
-
* @description Built for watchlist polling: pass up to 1000 fnr values (repeat the parameter) and one cursor, and get back four arrays — businessChanges, documentChanges, ediktChanges, globalChanges — each ordered by ascending id and capped at maxResultsPerType. Not paged: raise maxResultsPerType or advance sinceId instead. sinceId is exclusive and since is inclusive, exactly as on the paged feeds, but one sinceId covers all four arrays: an array that comes back full at maxResultsPerType has more behind it and bounds the cursor, so advance sinceId only to the lowest of the full arrays' highest ids, and to the highest id of all four once none comes back full. Passing no fnr returns four empty arrays, not the whole feed.
|
|
3676
|
+
* @description Changes for a watchlist of companies, all four change types in one unpaged response. Built for watchlist polling: pass up to 1000 fnr values (repeat the parameter) and one cursor, and get back four arrays — businessChanges, documentChanges, ediktChanges, globalChanges — each ordered by ascending id and capped at maxResultsPerType. Not paged: raise maxResultsPerType or advance sinceId instead. sinceId is exclusive and since is inclusive, exactly as on the paged feeds, but one sinceId covers all four arrays: an array that comes back full at maxResultsPerType has more behind it and bounds the cursor, so advance sinceId only to the lowest of the full arrays' highest ids, and to the highest id of all four once none comes back full. Passing no fnr returns four empty arrays, not the whole feed.
|
|
3677
3677
|
*
|
|
3678
3678
|
* @tags GlobalChanges
|
|
3679
3679
|
* @name V1GlobalchangesAggregatedList
|
|
3680
|
-
* @summary
|
|
3680
|
+
* @summary Aggregated watchlist changes
|
|
3681
3681
|
* @request GET:/api/v1/globalchanges/aggregated
|
|
3682
3682
|
* @secure
|
|
3683
3683
|
*/
|
|
@@ -3697,31 +3697,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3697
3697
|
maxResultsPerType?: number;
|
|
3698
3698
|
}, params?: RequestParams) => Promise<HttpResponse<AggregatedChangesResponse, ProblemDetails | ApiError>>;
|
|
3699
3699
|
/**
|
|
3700
|
-
* @description The envelope is a discriminator plus the payload: changeType says which register, and data is the matching object — a BusinessChange, DocumentChange, EdiktChange, GisaChange or ScheinunternehmenChange. Since data is a union, read changeType before it.
|
|
3700
|
+
* @description Returns one change with its typed payload, whichever register it came from. The envelope is a discriminator plus the payload: changeType says which register, and data is the matching object — a BusinessChange, DocumentChange, EdiktChange, GisaChange or ScheinunternehmenChange. Since data is a union, read changeType before it.
|
|
3701
3701
|
*
|
|
3702
3702
|
* @tags GlobalChanges
|
|
3703
3703
|
* @name V1GlobalchangesDetail
|
|
3704
|
-
* @summary
|
|
3704
|
+
* @summary Change by id
|
|
3705
3705
|
* @request GET:/api/v1/globalchanges/{id}
|
|
3706
3706
|
* @secure
|
|
3707
3707
|
*/
|
|
3708
3708
|
v1GlobalchangesDetail: (id: number, params?: RequestParams) => Promise<HttpResponse<ChangeDetailResponse, ProblemDetails | ApiError>>;
|
|
3709
3709
|
/**
|
|
3710
|
-
* @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "edikt" answers 404 here.
|
|
3710
|
+
* @description Returns one Ediktsdatei change by id. The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "edikt" answers 404 here.
|
|
3711
3711
|
*
|
|
3712
3712
|
* @tags Edikte
|
|
3713
3713
|
* @name V1EdikteChangesDetail
|
|
3714
|
-
* @summary
|
|
3714
|
+
* @summary Edikt change by id
|
|
3715
3715
|
* @request GET:/api/v1/edikte/changes/{id}
|
|
3716
3716
|
* @secure
|
|
3717
3717
|
*/
|
|
3718
3718
|
v1EdikteChangesDetail: (id: number, params?: RequestParams) => Promise<HttpResponse<EdiktChange, ProblemDetails | ApiError>>;
|
|
3719
3719
|
/**
|
|
3720
|
-
* @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the publication date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss an insolvency notice resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
3720
|
+
* @description Feed of Ediktsdatei changes — insolvency and other court notices published about a company or a person. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the publication date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss an insolvency notice resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
3721
3721
|
*
|
|
3722
3722
|
* @tags Edikte
|
|
3723
3723
|
* @name V1EdikteChangesList
|
|
3724
|
-
* @summary
|
|
3724
|
+
* @summary Ediktsdatei change feed
|
|
3725
3725
|
* @request GET:/api/v1/edikte/changes
|
|
3726
3726
|
* @secure
|
|
3727
3727
|
*/
|
|
@@ -3754,31 +3754,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3754
3754
|
pageSize?: number;
|
|
3755
3755
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfEdiktChange, ProblemDetails | ApiError>>;
|
|
3756
3756
|
/**
|
|
3757
|
-
*
|
|
3757
|
+
* @description Downloads a Firmenbuch document (PDF/XML) by its document key.
|
|
3758
3758
|
*
|
|
3759
3759
|
* @tags Documents
|
|
3760
3760
|
* @name V1DocumentsDownloadDetail
|
|
3761
|
-
* @summary
|
|
3761
|
+
* @summary Firmenbuch document download
|
|
3762
3762
|
* @request GET:/api/v1/documents/download/{documentKey}
|
|
3763
3763
|
* @secure
|
|
3764
3764
|
*/
|
|
3765
3765
|
v1DocumentsDownloadDetail: (documentKey: string, params?: RequestParams) => Promise<HttpResponse<void, string | ProblemDetails | ApiError>>;
|
|
3766
3766
|
/**
|
|
3767
|
-
* @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "document" answers 404 here.
|
|
3767
|
+
* @description Returns one document change by id, with the document's metadata. The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "document" answers 404 here.
|
|
3768
3768
|
*
|
|
3769
3769
|
* @tags Documents
|
|
3770
3770
|
* @name V1DocumentsChangesDetail
|
|
3771
|
-
* @summary
|
|
3771
|
+
* @summary Document change by id
|
|
3772
3772
|
* @request GET:/api/v1/documents/changes/{id}
|
|
3773
3773
|
* @secure
|
|
3774
3774
|
*/
|
|
3775
3775
|
v1DocumentsChangesDetail: (id: number, params?: RequestParams) => Promise<HttpResponse<DocumentChange, ProblemDetails | ApiError>>;
|
|
3776
3776
|
/**
|
|
3777
|
-
* @description Each entry names a documentKey; fetch the file itself with GET /documents/download/{documentKey}. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the document date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
3777
|
+
* @description Feed of newly filed Firmenbuch documents — this is how you learn that a company has published a new Jahresabschluss. Each entry names a documentKey; fetch the file itself with GET /documents/download/{documentKey}. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the document date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
|
|
3778
3778
|
*
|
|
3779
3779
|
* @tags Documents
|
|
3780
3780
|
* @name V1DocumentsChangesList
|
|
3781
|
-
* @summary
|
|
3781
|
+
* @summary Document change feed
|
|
3782
3782
|
* @request GET:/api/v1/documents/changes
|
|
3783
3783
|
* @secure
|
|
3784
3784
|
*/
|
|
@@ -3811,11 +3811,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3811
3811
|
pageSize?: number;
|
|
3812
3812
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfDocumentChange, ProblemDetails | ApiError>>;
|
|
3813
3813
|
/**
|
|
3814
|
-
*
|
|
3814
|
+
* @description Returns all courts with pagination and optional search, sorted by business count descending.
|
|
3815
3815
|
*
|
|
3816
3816
|
* @tags Courts
|
|
3817
3817
|
* @name V1CourtsList
|
|
3818
|
-
* @summary
|
|
3818
|
+
* @summary Court catalog
|
|
3819
3819
|
* @request GET:/api/v1/courts
|
|
3820
3820
|
* @secure
|
|
3821
3821
|
*/
|
|
@@ -3838,21 +3838,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3838
3838
|
pageSize?: number;
|
|
3839
3839
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfCourtCatalogItemResponse, ProblemDetails | ApiError>>;
|
|
3840
3840
|
/**
|
|
3841
|
-
*
|
|
3841
|
+
* @description Resolve company names to FNRs by exact name match (1:1). Used for CSV import.
|
|
3842
3842
|
*
|
|
3843
3843
|
* @tags Businesses
|
|
3844
3844
|
* @name V1BusinessesResolveNamesCreate
|
|
3845
|
-
* @summary
|
|
3845
|
+
* @summary Name to FNR resolution
|
|
3846
3846
|
* @request POST:/api/v1/businesses/resolve-names
|
|
3847
3847
|
* @secure
|
|
3848
3848
|
*/
|
|
3849
3849
|
v1BusinessesResolveNamesCreate: (data: ResolveBusinessNamesRequest, params?: RequestParams) => Promise<HttpResponse<ResolveBusinessNamesResponse, ProblemDetails | ApiError>>;
|
|
3850
3850
|
/**
|
|
3851
|
-
* @description name and search are different tools. name is a case-insensitive substring match on the company name and nothing else. search splits the term on spaces and keeps only companies matching every token, where a token matches the name, the fnr, or — when the whole term is a number — a GISA licence key or GISA-Zahl; it additionally lifts companies whose name starts with the term to the top of the default (name) ordering. So name narrows a known name, search finds an unknown one. Inactive companies always sort after active ones, whatever orderBy says. Pass countOnly=true for totalRecords without the rows, and use /businesses/aggregate to group the same filter set instead of paging through it.
|
|
3851
|
+
* @description Lists companies matching the filters, one page of list rows per call. name and search are different tools. name is a case-insensitive substring match on the company name and nothing else. search splits the term on spaces and keeps only companies matching every token, where a token matches the name, the fnr, or — when the whole term is a number — a GISA licence key or GISA-Zahl; it additionally lifts companies whose name starts with the term to the top of the default (name) ordering. So name narrows a known name, search finds an unknown one. Inactive companies always sort after active ones, whatever orderBy says. Pass countOnly=true for totalRecords without the rows, and use /businesses/aggregate to group the same filter set instead of paging through it.
|
|
3852
3852
|
*
|
|
3853
3853
|
* @tags Businesses
|
|
3854
3854
|
* @name V1BusinessesList
|
|
3855
|
-
* @summary
|
|
3855
|
+
* @summary Company search
|
|
3856
3856
|
* @request GET:/api/v1/businesses
|
|
3857
3857
|
* @secure
|
|
3858
3858
|
*/
|
|
@@ -4409,31 +4409,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4409
4409
|
"guv.ZinsenUndAehnlicheAufwendungen_lte"?: number | null;
|
|
4410
4410
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfBusinessListResponse, ProblemDetails | ApiError>>;
|
|
4411
4411
|
/**
|
|
4412
|
-
* No
|
|
4412
|
+
* @description Returns all business (fnr, name) pairs for client-side name index. No pagination.
|
|
4413
4413
|
*
|
|
4414
4414
|
* @tags Businesses
|
|
4415
4415
|
* @name V1BusinessesNamesList
|
|
4416
|
-
* @summary
|
|
4416
|
+
* @summary Company name index
|
|
4417
4417
|
* @request GET:/api/v1/businesses/names
|
|
4418
4418
|
* @secure
|
|
4419
4419
|
*/
|
|
4420
4420
|
v1BusinessesNamesList: (params?: RequestParams) => Promise<HttpResponse<BusinessNameItem[], ProblemDetails | ApiError>>;
|
|
4421
4421
|
/**
|
|
4422
|
-
* @description Unfiltered — it is the size of the whole dataset, not of a search. For a count over filters, call GET /businesses with countOnly=true and read totalRecords.
|
|
4422
|
+
* @description Returns the number of companies in the dataset, as a bare integer. Unfiltered — it is the size of the whole dataset, not of a search. For a count over filters, call GET /businesses with countOnly=true and read totalRecords.
|
|
4423
4423
|
*
|
|
4424
4424
|
* @tags Businesses
|
|
4425
4425
|
* @name V1BusinessesCountList
|
|
4426
|
-
* @summary
|
|
4426
|
+
* @summary Company count
|
|
4427
4427
|
* @request GET:/api/v1/businesses/count
|
|
4428
4428
|
* @secure
|
|
4429
4429
|
*/
|
|
4430
4430
|
v1BusinessesCountList: (params?: RequestParams) => Promise<HttpResponse<number, ProblemDetails | ApiError>>;
|
|
4431
4431
|
/**
|
|
4432
|
-
*
|
|
4432
|
+
* @description Counts over the same filter set as GET /businesses, grouped by one dimension — the server-side GROUP BY that a caller would otherwise page the whole result set to compute. Every /businesses filter means exactly what it means there; page, pageSize, orderBy, orderByDescending and countOnly are ignored — top and minCount cap the bucket list instead. totalRecords equals /businesses?countOnly=true for the same filter; how the buckets relate to it is documented on BusinessAggregateResponse.
|
|
4433
4433
|
*
|
|
4434
4434
|
* @tags Businesses
|
|
4435
4435
|
* @name V1BusinessesAggregateList
|
|
4436
|
-
* @summary
|
|
4436
|
+
* @summary Grouped company counts
|
|
4437
4437
|
* @request GET:/api/v1/businesses/aggregate
|
|
4438
4438
|
* @secure
|
|
4439
4439
|
*/
|
|
@@ -5004,41 +5004,41 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5004
5004
|
"guv.ZinsenUndAehnlicheAufwendungen_lte"?: number | null;
|
|
5005
5005
|
}, params?: RequestParams) => Promise<HttpResponse<BusinessAggregateResponse, ProblemDetails | ApiError>>;
|
|
5006
5006
|
/**
|
|
5007
|
-
*
|
|
5007
|
+
* @description Active businesses similar to the given one (same OeNACE branch, same region preferred).
|
|
5008
5008
|
*
|
|
5009
5009
|
* @tags Businesses
|
|
5010
5010
|
* @name V1BusinessesSimilarList
|
|
5011
|
-
* @summary
|
|
5011
|
+
* @summary Similar companies
|
|
5012
5012
|
* @request GET:/api/v1/businesses/{fnr}/similar
|
|
5013
5013
|
* @secure
|
|
5014
5014
|
*/
|
|
5015
5015
|
v1BusinessesSimilarList: (fnr: string, params?: RequestParams) => Promise<HttpResponse<BusinessListResponse[], ProblemDetails | ApiError>>;
|
|
5016
5016
|
/**
|
|
5017
|
-
* @description fnr is matched exactly against the stored, normalised Firmenbuchnummer — lower case, no spaces, no leading zeros and no "FN" prefix, e.g. 34853f. Nothing is normalised on the way in, so "FN 34853 f" answers 404 rather than the company. 404 also means the company is not in the dataset yet.
|
|
5017
|
+
* @description Returns the whole Firmenakte of one company: master data, addresses, people, GISA licences, Edikte, documents and the parsed annual accounts. fnr is matched exactly against the stored, normalised Firmenbuchnummer — lower case, no spaces, no leading zeros and no "FN" prefix, e.g. 34853f. Nothing is normalised on the way in, so "FN 34853 f" answers 404 rather than the company. 404 also means the company is not in the dataset yet.
|
|
5018
5018
|
*
|
|
5019
5019
|
* @tags Businesses
|
|
5020
5020
|
* @name V1BusinessesDetail
|
|
5021
|
-
* @summary
|
|
5021
|
+
* @summary Company Firmenakte
|
|
5022
5022
|
* @request GET:/api/v1/businesses/{fnr}
|
|
5023
5023
|
* @secure
|
|
5024
5024
|
*/
|
|
5025
5025
|
v1BusinessesDetail: (fnr: string, params?: RequestParams) => Promise<HttpResponse<BusinessDetailResponse, ProblemDetails | ApiError>>;
|
|
5026
5026
|
/**
|
|
5027
|
-
* @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "business" answers 404 here.
|
|
5027
|
+
* @description Returns one Firmenbuch change by id. The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "business" answers 404 here.
|
|
5028
5028
|
*
|
|
5029
5029
|
* @tags Businesses
|
|
5030
5030
|
* @name V1BusinessesChangesDetail
|
|
5031
|
-
* @summary
|
|
5031
|
+
* @summary Firmenbuch change by id
|
|
5032
5032
|
* @request GET:/api/v1/businesses/changes/{id}
|
|
5033
5033
|
* @secure
|
|
5034
5034
|
*/
|
|
5035
5035
|
v1BusinessesChangesDetail: (id: number, params?: RequestParams) => Promise<HttpResponse<BusinessChange, ProblemDetails | ApiError>>;
|
|
5036
5036
|
/**
|
|
5037
|
-
* @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate — so a back-dated entry is not missed — and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses. Use GET /globalchanges for the same feed across all four registers.
|
|
5037
|
+
* @description Feed of Firmenbuch changes — one entry per new legal record (Eintragung). Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate — so a back-dated entry is not missed — and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses. Use GET /globalchanges for the same feed across all four registers.
|
|
5038
5038
|
*
|
|
5039
5039
|
* @tags Businesses
|
|
5040
5040
|
* @name V1BusinessesChangesList
|
|
5041
|
-
* @summary
|
|
5041
|
+
* @summary Firmenbuch change feed
|
|
5042
5042
|
* @request GET:/api/v1/businesses/changes
|
|
5043
5043
|
* @secure
|
|
5044
5044
|
*/
|
|
@@ -5071,21 +5071,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5071
5071
|
pageSize?: number;
|
|
5072
5072
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfBusinessChange, ProblemDetails | ApiError>>;
|
|
5073
5073
|
/**
|
|
5074
|
-
*
|
|
5074
|
+
* @description Returns all assignment functions (code/text lookup) for display. Cached 24h.
|
|
5075
5075
|
*
|
|
5076
5076
|
* @tags AssignmentFunctions
|
|
5077
5077
|
* @name V1AssignmentfunctionsList
|
|
5078
|
-
* @summary
|
|
5078
|
+
* @summary Assignment function catalog
|
|
5079
5079
|
* @request GET:/api/v1/assignmentfunctions
|
|
5080
5080
|
* @secure
|
|
5081
5081
|
*/
|
|
5082
5082
|
v1AssignmentfunctionsList: (params?: RequestParams) => Promise<HttpResponse<AssignmentFunctionItemResponse[], ProblemDetails | ApiError>>;
|
|
5083
5083
|
/**
|
|
5084
|
-
*
|
|
5084
|
+
* @description Returns unique City+ZipCode combinations from addresses with pagination and optional search.
|
|
5085
5085
|
*
|
|
5086
5086
|
* @tags Addresses
|
|
5087
5087
|
* @name V1AddressesLocationsList
|
|
5088
|
-
* @summary
|
|
5088
|
+
* @summary City and ZIP combinations
|
|
5089
5089
|
* @request GET:/api/v1/addresses/locations
|
|
5090
5090
|
* @secure
|
|
5091
5091
|
*/
|
|
@@ -5107,11 +5107,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5107
5107
|
pageSize?: number;
|
|
5108
5108
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfAddressLocationResponse, ProblemDetails | ApiError>>;
|
|
5109
5109
|
/**
|
|
5110
|
-
*
|
|
5110
|
+
* @description Returns unique cities from addresses with pagination and optional search.
|
|
5111
5111
|
*
|
|
5112
5112
|
* @tags Addresses
|
|
5113
5113
|
* @name V1AddressesCitiesList
|
|
5114
|
-
* @summary
|
|
5114
|
+
* @summary Cities
|
|
5115
5115
|
* @request GET:/api/v1/addresses/cities
|
|
5116
5116
|
* @secure
|
|
5117
5117
|
*/
|
|
@@ -5133,11 +5133,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5133
5133
|
pageSize?: number;
|
|
5134
5134
|
}, params?: RequestParams) => Promise<HttpResponse<PagedResponseOfCityResponse, ProblemDetails | ApiError>>;
|
|
5135
5135
|
/**
|
|
5136
|
-
*
|
|
5136
|
+
* @description Returns unique zip codes from addresses with pagination and optional search.
|
|
5137
5137
|
*
|
|
5138
5138
|
* @tags Addresses
|
|
5139
5139
|
* @name V1AddressesZipcodesList
|
|
5140
|
-
* @summary
|
|
5140
|
+
* @summary ZIP codes
|
|
5141
5141
|
* @request GET:/api/v1/addresses/zipcodes
|
|
5142
5142
|
* @secure
|
|
5143
5143
|
*/
|