@firmenakte/api-client 2.11.8 → 2.22.0

package/client.js

@@ -11,7 +11,14 @@
  * ---------------------------------------------------------------
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Api = exports.HttpClient = exports.ContentType = exports.BusinessExportFormat = exports.ChangeType = exports.InsolvencyCourtEventType = exports.InsolvencyEvidenceStatus = void 0;
+exports.Api = exports.HttpClient = exports.ContentType = exports.BusinessExportFormat = exports.ChangeType = exports.InsolvencyCourtEventType = exports.InsolvencyEvidenceStatus = exports.PassivpostenNach = void 0;
+/** The standard Passiva position a WeitererPassivposten follows in the filing. */
+var PassivpostenNach;
+(function (PassivpostenNach) {
+    PassivpostenNach["Eigenkapital"] = "eigenkapital";
+    PassivpostenNach["Rueckstellungen"] = "rueckstellungen";
+    PassivpostenNach["Verbindlichkeiten"] = "verbindlichkeiten";
+})(PassivpostenNach || (exports.PassivpostenNach = PassivpostenNach = {}));
 /** Conservative Firmenbuch evidence state: open, closed, absent, uncertain or conflicting. Conflicting means a known court closure and an active administrator role coexist. Absent means no classified court event and no active role, not certified solvency. */
 var InsolvencyEvidenceStatus;
 (function (InsolvencyEvidenceStatus) {
@@ -207,7 +214,7 @@ class HttpClient {
 }
 exports.HttpClient = HttpClient;
 /**
- * @title UnternehmensScreener API
+ * @title Firmenakte API
  * @version v1
  * @baseUrl https://api.firmenakte.at
  */
@@ -530,173 +537,6 @@ class Api extends HttpClient {
                 format: "json",
                 ...params,
             }),
-            /**
-             * @description The autocomplete read: /businesses and /people for one term, ranked together, so a search field costs one request per keystroke rather than two and does not have to merge two orders itself. Each row carries either business or person, whichever type names. Ordered by where the term sits in the name, then by the shorter name, then companies before people. pageSize is per side, so the answer holds up to twice as many rows. An empty search answers an empty list; use /businesses to page through the whole dataset. Kostet 1 Credit.
-             *
-             * @tags Search
-             * @name V1SearchList
-             * @summary Companies and people in one ranked list
-             * @request GET:/api/v1/search
-             * @secure
-             */
-            v1SearchList: (query, params = {}) => this.request({
-                path: `/api/v1/search`,
-                method: "GET",
-                query: query,
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @description Returns (id, name) pairs for all people with at least one business assignment. For client-side name index. Kostet 1 Credit.
-             *
-             * @tags People
-             * @name V1PeopleNamesList
-             * @summary Person name index
-             * @request GET:/api/v1/people/names
-             * @secure
-             */
-            v1PeopleNamesList: (params = {}) => this.request({
-                path: `/api/v1/people/names`,
-                method: "GET",
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @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 A row's assignments are a sample, not the person's whole collection: at most 25, and only the ones matching the fnr, functionCode, businessName, businessCity and businessRegisteredSince_gte you sent, so ?fnr=34853f gives you that company's row and nothing else. Ask GET /people/{personId} for all of them. Kostet 1 Credit.
-             *
-             * @tags People
-             * @name V1PeopleList
-             * @summary People search
-             * @request GET:/api/v1/people
-             * @secure
-             */
-            v1PeopleList: (query, params = {}) => this.request({
-                path: `/api/v1/people`,
-                method: "GET",
-                query: query,
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @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. An id beginning with "--" carries neither first nor last name, and that is not a person but the bucket every nameless assignment in the register lands in. It answers 404 like any id nobody holds, and it is left out of GET /people for the same reason. Kostet 1 Credit.
-             *
-             * @tags People
-             * @name V1PeopleDetail
-             * @summary Person detail
-             * @request GET:/api/v1/people/{personId}
-             * @secure
-             */
-            v1PeopleDetail: (personId, params = {}) => this.request({
-                path: `/api/v1/people/${personId}`,
-                method: "GET",
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @description Returns the OeNACE classification catalog with company counts. Results are ordered by company count descending — most used first. Kostet 1 Credit.
-             *
-             * @tags Oenace
-             * @name V1OenaceList
-             * @summary OeNACE classification catalog
-             * @request GET:/api/v1/oenace
-             * @secure
-             */
-            v1OenaceList: (query, params = {}) => this.request({
-                path: `/api/v1/oenace`,
-                method: "GET",
-                query: query,
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @description Returns all legal forms with pagination and optional search, sorted by business count descending. Kostet 1 Credit.
-             *
-             * @tags LegalForms
-             * @name V1LegalformsList
-             * @summary Legal form catalog
-             * @request GET:/api/v1/legalforms
-             * @secure
-             */
-            v1LegalformsList: (query, params = {}) => this.request({
-                path: `/api/v1/legalforms`,
-                method: "GET",
-                query: query,
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @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. Two further edge types the deployment can enable: "address", two companies registered at the same street address, and "ownership", a company holding shares in another — source is the shareholder, target the company it holds, and capitalAmount, currency and sharePercent carry the stake where the register gives one. Ownership edges are drawn only for companies crawled since the shareholder mapping went live, so a company not yet re-crawled reports none rather than implying it has none. 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. Kostet 3 Credits.
-             *
-             * @tags Graph
-             * @name V1GraphList
-             * @summary Relationship graph
-             * @request GET:/api/v1/graph
-             * @secure
-             */
-            v1GraphList: (query, params = {}) => this.request({
-                path: `/api/v1/graph`,
-                method: "GET",
-                query: query,
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @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. totalRecords stops there too — it is counted only as far as page 1000 reaches, so it caps at 1000 × pageSize and means "at least this many" once it is that; stop on a short page, not on a count. 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. Kostet 1 Credit.
-             *
-             * @tags GlobalChanges
-             * @name V1GlobalchangesList
-             * @summary All-register change feed
-             * @request GET:/api/v1/globalchanges
-             * @secure
-             */
-            v1GlobalchangesList: (query, params = {}) => this.request({
-                path: `/api/v1/globalchanges`,
-                method: "GET",
-                query: query,
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @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. Kostet 3 Credits.
-             *
-             * @tags GlobalChanges
-             * @name V1GlobalchangesAggregatedList
-             * @summary Aggregated watchlist changes
-             * @request GET:/api/v1/globalchanges/aggregated
-             * @secure
-             */
-            v1GlobalchangesAggregatedList: (query, params = {}) => this.request({
-                path: `/api/v1/globalchanges/aggregated`,
-                method: "GET",
-                query: query,
-                secure: true,
-                format: "json",
-                ...params,
-            }),
-            /**
-             * @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, FoerderungChange or ScheinunternehmenChange. Since data is a union, read changeType before it. Kostet 1 Credit.
-             *
-             * @tags GlobalChanges
-             * @name V1GlobalchangesDetail
-             * @summary Change by id
-             * @request GET:/api/v1/globalchanges/{id}
-             * @secure
-             */
-            v1GlobalchangesDetail: (id, params = {}) => this.request({
-                path: `/api/v1/globalchanges/${id}`,
-                method: "GET",
-                secure: true,
-                format: "json",
-                ...params,
-            }),
             /**
              * @description Kostet 1 Credit.
              *
@@ -764,47 +604,32 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * @description Downloads a Firmenbuch document (PDF/XML) by its document key. Kostet 3 Credits.
-             *
-             * @tags Documents
-             * @name V1DocumentsDownloadDetail
-             * @summary Firmenbuch document download
-             * @request GET:/api/v1/documents/download/{documentKey}
-             * @secure
-             */
-            v1DocumentsDownloadDetail: (documentKey, params = {}) => this.request({
-                path: `/api/v1/documents/download/${documentKey}`,
-                method: "GET",
-                secure: true,
-                ...params,
-            }),
-            /**
-             * @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. Kostet 1 Credit.
+             * @description Returns (id, name) pairs for all people with at least one business assignment. For client-side name index. id is the person's Firmenakte-ID, e.g. "P-7K3M-QX91". Kostet 1 Credit.
              *
-             * @tags Documents
-             * @name V1DocumentsChangesDetail
-             * @summary Document change by id
-             * @request GET:/api/v1/documents/changes/{id}
+             * @tags People
+             * @name V1PeopleNamesList
+             * @summary Person name index
+             * @request GET:/api/v1/people/names
              * @secure
              */
-            v1DocumentsChangesDetail: (id, params = {}) => this.request({
-                path: `/api/v1/documents/changes/${id}`,
+            v1PeopleNamesList: (params = {}) => this.request({
+                path: `/api/v1/people/names`,
                 method: "GET",
                 secure: true,
                 format: "json",
                 ...params,
             }),
             /**
-             * @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. totalRecords stops there too — it is counted only as far as page 1000 reaches, so it caps at 1000 × pageSize and means "at least this many" once it is that; stop on a short page, not on a count. 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. Kostet 1 Credit.
+             * @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. Combine with fnr or businessName to get the officers of one company, or with functionCode for one role. Each row's id is the person's Firmenakte-ID, the id GET /people/{personId} takes. 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 owners of this year's new Viennese companies are one query: ?businessCity=Wien&businessRegisteredSince_gte=2026-01-01&functionCode=IN&functionCode=KP&functionCode=GS&functionCode=PG A row's assignments are a sample, not the person's whole collection: at most 25, and only the ones matching the fnr, functionCode, businessName, businessCity and businessRegisteredSince_gte you sent, so ?fnr=34853f gives you that company's row and nothing else. Ask GET /people/{personId} for all of them. Kostet 1 Credit.
              *
-             * @tags Documents
-             * @name V1DocumentsChangesList
-             * @summary Document change feed
-             * @request GET:/api/v1/documents/changes
+             * @tags People
+             * @name V1PeopleList
+             * @summary People search
+             * @request GET:/api/v1/people
              * @secure
              */
-            v1DocumentsChangesList: (query, params = {}) => this.request({
-                path: `/api/v1/documents/changes`,
+            v1PeopleList: (query, params = {}) => this.request({
+                path: `/api/v1/people`,
                 method: "GET",
                 query: query,
                 secure: true,
@@ -812,18 +637,17 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * @description Returns all courts with pagination and optional search, sorted by business count descending. Kostet 1 Credit.
+             * @description Returns one person with every company function, GISA licence and Edikt attached to them. personId is the person's Firmenakte-ID as the glossary describes it, e.g. "P-7K3M-QX91", the id every list row, assignment and graph node carries. Take it from there rather than composing it yourself. Only that spelling answers. Any other spelling of the same Firmenakte-ID ("p7k3mqx91"), and the "vorname-nachname-…" id people carried before, answer one 308 whose relative Location is the canonical form. A Firmenakte-ID with a wrong check character, and an id nobody holds, answer 404; so does the bucket every nameless assignment in the register lands in, which is not a person. Kostet 1 Credit.
              *
-             * @tags Courts
-             * @name V1CourtsList
-             * @summary Court catalog
-             * @request GET:/api/v1/courts
+             * @tags People
+             * @name V1PeopleDetail
+             * @summary Person detail
+             * @request GET:/api/v1/people/{personId}
              * @secure
              */
-            v1CourtsList: (query, params = {}) => this.request({
-                path: `/api/v1/courts`,
+            v1PeopleDetail: (personId, params = {}) => this.request({
+                path: `/api/v1/people/${personId}`,
                 method: "GET",
-                query: query,
                 secure: true,
                 format: "json",
                 ...params,
@@ -847,7 +671,7 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * @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. inInsolvency is a Firmenbuch evidence filter, not an Ediktsdatei or Insolvenzdatei one. True matches a classified open court record or an active administrator role (MW, IW, AW, VW). False includes closed evidence without an active role, missing evidence and unclassified or uncertain evidence without another opening or role. Omit the parameter to leave this state unfiltered. A false value means no current positive evidence in this dataset, not verified legal assurance that no proceeding exists. The proceedings are published in the Insolvenzdatei, which this API does not read. Examples: ?inInsolvency=true; ?inInsolvency=false&name=Graf; ?inInsolvency=true&countOnly=true. The same values combine with every other filter. Pass countOnly=true for totalRecords without the rows, and use /businesses/aggregate to group the same filter set instead of paging through it. Kostet 1 Credit.
+             * @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. inInsolvency is a Firmenbuch evidence filter, not an Ediktsdatei or Insolvenzdatei one. True matches a classified open court record or an active administrator role (MW, IW, AW, VW). False includes closed evidence without an active role, missing evidence and unclassified or uncertain evidence without another opening or role. Omit the parameter to leave this state unfiltered. A false value means no current positive evidence in this dataset, not verified legal assurance that no proceeding exists. The proceedings are published in the Insolvenzdatei, which this API does not read. Examples: ?inInsolvency=true; ?inInsolvency=false&name=Graf; ?inInsolvency=true&countOnly=true. The same values combine with every other filter. Pass countOnly=true for totalRecords without the rows, and use /businesses/aggregate to group the same filter set instead of paging through it. Place filters: the Firmenbuch records no Bundesland and no Gemeinde, only the Sitzgericht, so both state and gemeinde are derived from the PLZ of the Geschäftsanschrift: the PLZ names a Gemeinde, and state is that Gemeinde's Land, so the Innviertel PLZ 5120–5399 are in Oberösterreich. gemeinde takes the slug of a Gemeinde, and because it reads the PLZ it answers every spelling of a place at once — "Klagenfurt am Wörthersee", "Klagenfurt" and "Klagenfurt-Viktring" are one Gemeinde, where city= would be three separate filters over free text. GET /addresses/gemeinden is the catalogue of the slugs, their aliases, their Bundesland and their PLZ; a company with a foreign or unusable PLZ is in no Gemeinde and no gemeinde= filter finds it. Kostet 1 Credit.
              *
              * @tags Businesses
              * @name V1BusinessesList
@@ -979,7 +803,7 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * @description Every parsed Jahresabschluss of one company, one entry per calendar year, newest first. The Firmenakte itself (GET /businesses/{fnr}) carries only the last five years. 404 only where the company itself is unknown, exactly as on GET /businesses/{fnr}. Kostet 1 Credit.
+             * @description Every parsed Jahresabschluss of one company, one entry per fiscal closing date, newest first. The Firmenakte itself (GET /businesses/{fnr}) carries only the last five periods. 404 only where the company itself is unknown, exactly as on GET /businesses/{fnr}. Kostet 1 Credit.
              *
              * @tags Businesses
              * @name V1BusinessesJahresabschluesseList
@@ -1043,22 +867,6 @@ class Api extends HttpClient {
                 format: "json",
                 ...params,
             }),
-            /**
-             * @description Returns all assignment functions (code/text lookup) for display. Cached 24h. Kostet 1 Credit.
-             *
-             * @tags AssignmentFunctions
-             * @name V1AssignmentfunctionsList
-             * @summary Assignment function catalog
-             * @request GET:/api/v1/assignmentfunctions
-             * @secure
-             */
-            v1AssignmentfunctionsList: (params = {}) => this.request({
-                path: `/api/v1/assignmentfunctions`,
-                method: "GET",
-                secure: true,
-                format: "json",
-                ...params,
-            }),
             /**
              * @description Returns unique City+ZipCode combinations from addresses with pagination and optional search. Kostet 1 Credit.
              *
@@ -1127,6 +935,221 @@ class Api extends HttpClient {
                 format: "json",
                 ...params,
             }),
+            /**
+             * @description The Gemeinde catalogue: one row per Austrian Gemeinde the register can address, with its official name, its URL slug, its Bundesland and that Land's slug, the PLZ that resolve to it, the alias slugs that name it and, for Wien, its Bezirke. This is the one source for a place's identity. The city column of an address is Firmenbuch free text and carries "Klagenfurt am Wörthersee", "Klagenfurt", "Klagenfurt-Viktring" and "Klagenfurt-Wölfnitz" side by side, so it cannot be a key; a Gemeinde is derived from the PLZ of the Geschäftsanschrift instead, and GET /businesses?gemeinde=<slug> answers every one of those spellings at once. Fold the zipCode buckets of GET /businesses/aggregate through zipCodes to count companies per Gemeinde. Unpaged and without a filter on purpose: 1.893 rows that change only with a new Gebietsstand, so one cacheable answer is cheaper for every caller than paging a list they all want whole. Companies with a foreign or unusable PLZ resolve to no Gemeinde and appear under none. Kostet 1 Credit.
+             *
+             * @tags Addresses
+             * @name V1AddressesGemeindenList
+             * @summary Gemeinden
+             * @request GET:/api/v1/addresses/gemeinden
+             * @secure
+             */
+            v1AddressesGemeindenList: (params = {}) => this.request({
+                path: `/api/v1/addresses/gemeinden`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description Downloads a Firmenbuch document (PDF/XML) by its document key. Kostet 3 Credits.
+             *
+             * @tags Documents
+             * @name V1DocumentsDownloadDetail
+             * @summary Firmenbuch document download
+             * @request GET:/api/v1/documents/download/{documentKey}
+             * @secure
+             */
+            v1DocumentsDownloadDetail: (documentKey, params = {}) => this.request({
+                path: `/api/v1/documents/download/${documentKey}`,
+                method: "GET",
+                secure: true,
+                ...params,
+            }),
+            /**
+             * @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. Kostet 1 Credit.
+             *
+             * @tags Documents
+             * @name V1DocumentsChangesDetail
+             * @summary Document change by id
+             * @request GET:/api/v1/documents/changes/{id}
+             * @secure
+             */
+            v1DocumentsChangesDetail: (id, params = {}) => this.request({
+                path: `/api/v1/documents/changes/${id}`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @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. totalRecords stops there too — it is counted only as far as page 1000 reaches, so it caps at 1000 × pageSize and means "at least this many" once it is that; stop on a short page, not on a count. 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. Kostet 1 Credit.
+             *
+             * @tags Documents
+             * @name V1DocumentsChangesList
+             * @summary Document change feed
+             * @request GET:/api/v1/documents/changes
+             * @secure
+             */
+            v1DocumentsChangesList: (query, params = {}) => this.request({
+                path: `/api/v1/documents/changes`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description The autocomplete read: /businesses and /people for one term, ranked together, so a search field costs one request per keystroke rather than two and does not have to merge two orders itself. Each row carries either business or person, whichever type names. Ordered by where the term sits in the name, then by the shorter name, then companies before people. pageSize is per side, so the answer holds up to twice as many rows. An empty search answers an empty list; use /businesses to page through the whole dataset. Kostet 1 Credit.
+             *
+             * @tags Search
+             * @name V1SearchList
+             * @summary Companies and people in one ranked list
+             * @request GET:/api/v1/search
+             * @secure
+             */
+            v1SearchList: (query, params = {}) => this.request({
+                path: `/api/v1/search`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @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} — a person's is the Firmenakte-ID, e.g. "P-7K3M-QX91"; edges are source/target pairs of those ids whose relationshipType is "assignment", a person holding a function in a company. Two further edge types the deployment can enable: "address", two companies registered at the same street address, and "ownership", a company holding shares in another — source is the shareholder, target the company it holds, and capitalAmount, currency and sharePercent carry the stake where the register gives one. Ownership edges are drawn only for companies crawled since the shareholder mapping went live, so a company not yet re-crawled reports none rather than implying it has none. 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. personId answers on the canonical Firmenakte-ID; another spelling of it and a person's old "vorname-nachname-…" id answer one 308 whose relative Location carries the canonical form. Kostet 3 Credits.
+             *
+             * @tags Graph
+             * @name V1GraphList
+             * @summary Relationship graph
+             * @request GET:/api/v1/graph
+             * @secure
+             */
+            v1GraphList: (query, params = {}) => this.request({
+                path: `/api/v1/graph`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @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. totalRecords stops there too — it is counted only as far as page 1000 reaches, so it caps at 1000 × pageSize and means "at least this many" once it is that; stop on a short page, not on a count. 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. Kostet 1 Credit.
+             *
+             * @tags GlobalChanges
+             * @name V1GlobalchangesList
+             * @summary All-register change feed
+             * @request GET:/api/v1/globalchanges
+             * @secure
+             */
+            v1GlobalchangesList: (query, params = {}) => this.request({
+                path: `/api/v1/globalchanges`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @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. Kostet 3 Credits.
+             *
+             * @tags GlobalChanges
+             * @name V1GlobalchangesAggregatedList
+             * @summary Aggregated watchlist changes
+             * @request GET:/api/v1/globalchanges/aggregated
+             * @secure
+             */
+            v1GlobalchangesAggregatedList: (query, params = {}) => this.request({
+                path: `/api/v1/globalchanges/aggregated`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @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, FoerderungChange or ScheinunternehmenChange. Since data is a union, read changeType before it. Kostet 1 Credit.
+             *
+             * @tags GlobalChanges
+             * @name V1GlobalchangesDetail
+             * @summary Change by id
+             * @request GET:/api/v1/globalchanges/{id}
+             * @secure
+             */
+            v1GlobalchangesDetail: (id, params = {}) => this.request({
+                path: `/api/v1/globalchanges/${id}`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description Returns the OeNACE classification catalog with company counts. Results are ordered by company count descending — most used first. Kostet 1 Credit.
+             *
+             * @tags Oenace
+             * @name V1OenaceList
+             * @summary OeNACE classification catalog
+             * @request GET:/api/v1/oenace
+             * @secure
+             */
+            v1OenaceList: (query, params = {}) => this.request({
+                path: `/api/v1/oenace`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description Returns all legal forms with pagination and optional search, sorted by business count descending. Kostet 1 Credit.
+             *
+             * @tags LegalForms
+             * @name V1LegalformsList
+             * @summary Legal form catalog
+             * @request GET:/api/v1/legalforms
+             * @secure
+             */
+            v1LegalformsList: (query, params = {}) => this.request({
+                path: `/api/v1/legalforms`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description Returns all courts with pagination and optional search, sorted by business count descending. Kostet 1 Credit.
+             *
+             * @tags Courts
+             * @name V1CourtsList
+             * @summary Court catalog
+             * @request GET:/api/v1/courts
+             * @secure
+             */
+            v1CourtsList: (query, params = {}) => this.request({
+                path: `/api/v1/courts`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description Returns all assignment functions (code/text lookup) for display. Cached 24h. Kostet 1 Credit.
+             *
+             * @tags AssignmentFunctions
+             * @name V1AssignmentfunctionsList
+             * @summary Assignment function catalog
+             * @request GET:/api/v1/assignmentfunctions
+             * @secure
+             */
+            v1AssignmentfunctionsList: (params = {}) => this.request({
+                path: `/api/v1/assignmentfunctions`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
         };
     }
 }