{"openapi":"3.0.1","info":{"title":"Changelist API","description":"Die Changelist API bietet die M\u00f6glichkeit \u00c4nderungslisten abzurufen.","version":"1.0.0"},"servers":[{"url":"https:\/\/api.wirtschaftscompass.at\/changelist","description":"Generated server url"}],"security":[{"compass-api-token":[]}],"tags":[{"name":"V1","description":"Changelist Version 1"}],"paths":{"\/v1\/changes\/at-wiereg":{"get":{"tags":["V1"],"summary":"\u00c4nderungen im WiEReG","description":"Abruf der \u00c4nderungslisten aus dem Register der wirtschaftlichen Eigent\u00fcmer.
Liefert alle ver\u00e4nderten Objekte im WiEReG zur\u00fcck. Es werden zus\u00e4tzlich aufbereite Texte f\u00fcr jede \u00c4nderungsmeldung ausgegeben, die inhaltlich mit dem BMF akkordiert sind.","operationId":"wieregAT","parameters":[{"name":"from","in":"query","description":"Von-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Bis-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Seite, die abgefragt werden soll (0..N)","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Anzahl an Ergebnissen pro Seite","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.PerformanceTrackerException"]},"403":{"description":"Forbidden","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.infrastructure.common.security.exception.CompassAuthorizationException"]},"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"401":{"description":"Unauthorized","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["org.springframework.security.core.AuthenticationException"]},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WieregChangeSetsType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/WieregChangeSetsType"}}}}}}},"\/v1\/changes\/at-fb":{"get":{"tags":["V1"],"summary":"\u00c4nderungen im Firmenbuch","description":"Abruf der \u00c4nderungslisten aus dem amtlichen \u00f6sterreichischen Firmenbuch.","operationId":"fbAT","parameters":[{"name":"from","in":"query","description":"Von-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Bis-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"exclude-annual-accounts-filing-only","in":"query","description":"Bilanzeinreichung [true] oder [false]: Bezieht sich die Ver\u00e4nderung ausschlie\u00dflich auf die Einreichung eines Jahresabschlusses, kann die Ausgabe der betroffenen Unternehmen mit dieser Option unterdr\u00fcckt werden.","required":false,"schema":{"type":"boolean"}},{"name":"change-type","in":"query","description":"Art der Ver\u00e4nderung:
- REGISTERED: neu eingetragene Unternehmen
- UPDATED: Ver\u00e4nderungen an bereits bestehenden Unternehmen
- DELETED: L\u00f6schungen von Unternehmen","required":false,"schema":{"type":"string","enum":["REGISTERED","UPDATED","DELETED"]}},{"name":"page","in":"query","description":"Seite, die abgefragt werden soll (0..N)","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Anzahl an Ergebnissen pro Seite","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.PerformanceTrackerException"]},"403":{"description":"Forbidden","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.infrastructure.common.security.exception.CompassAuthorizationException"]},"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"401":{"description":"Unauthorized","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["org.springframework.security.core.AuthenticationException"]},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BusinessRegisterChangeSetsType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/BusinessRegisterChangeSetsType"}}}}}}},"\/v1\/changes\/at-edicts-insolvency-cases":{"get":{"tags":["V1"],"summary":"\u00c4nderungen Insolvenzen","description":"Abruf der \u00c4nderungslisten von Insolvenzen lt. Ediktsdatei des BMJ.","operationId":"edictsAT","parameters":[{"name":"from","in":"query","description":"Von-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Bis-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Seite, die abgefragt werden soll (0..N)","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Anzahl an Ergebnissen pro Seite","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.PerformanceTrackerException"]},"403":{"description":"Forbidden","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.infrastructure.common.security.exception.CompassAuthorizationException"]},"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"401":{"description":"Unauthorized","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["org.springframework.security.core.AuthenticationException"]},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InsolvencyCaseChangeSetsType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/InsolvencyCaseChangeSetsType"}}}}}}},"\/v1\/changes\/at-edicts-apparent-insolvencies":{"get":{"tags":["V1"],"summary":"\u00c4nderungen Offenkundige Zahlungsunf\u00e4higkeit","description":"Abruf der \u00c4nderungslisten f\u00fcr offenkundige Zahlungsunf\u00e4higkeiten lt. Ediktsdatei des BMJ.","operationId":"okuzaunAT","parameters":[{"name":"from","in":"query","description":"Von-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Bis-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Seite, die abgefragt werden soll (0..N)","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Anzahl an Ergebnissen pro Seite","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.PerformanceTrackerException"]},"403":{"description":"Forbidden","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.infrastructure.common.security.exception.CompassAuthorizationException"]},"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"401":{"description":"Unauthorized","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["org.springframework.security.core.AuthenticationException"]},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApparentInsolvencyCaseChangeSetsType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/ApparentInsolvencyCaseChangeSetsType"}}}}}}},"\/v1\/changes\/at-dummy-company":{"get":{"tags":["V1"],"summary":"\u00c4nderungen Scheinunternehmen","description":"Abruf der \u00c4nderungslisten von Scheinunternehmen gem. Sozialbetrugsbek\u00e4mpfungsgesetz \u00a78 des BMF.","operationId":"dummyCompanyAT","parameters":[{"name":"from","in":"query","description":"Von-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Bis-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Seite, die abgefragt werden soll (0..N)","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Anzahl an Ergebnissen pro Seite","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.PerformanceTrackerException"]},"403":{"description":"Forbidden","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.infrastructure.common.security.exception.CompassAuthorizationException"]},"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"401":{"description":"Unauthorized","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["org.springframework.security.core.AuthenticationException"]},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DummyCompanyChangeSetsType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/DummyCompanyChangeSetsType"}}}}}}},"\/health":{"get":{"tags":["X"],"summary":"","description":"","operationId":"getPing","responses":{"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.PerformanceTrackerException"]},"403":{"description":"Forbidden","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.infrastructure.common.security.exception.CompassAuthorizationException"]},"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"401":{"description":"Unauthorized","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["org.springframework.security.core.AuthenticationException"]},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ResponseString"}}}}}}}},"components":{"schemas":{"Failure":{"required":["message","stacktrace"],"type":"object","properties":{"message":{"type":"string","description":""},"stacktrace":{"type":"string","description":""}},"xml":{"name":"failure","namespace":"urn:compass:wico:api:1.0"}},"Pageable":{"type":"object","properties":{"page":{"minimum":0,"type":"integer","description":"","format":"int32"},"size":{"minimum":1,"type":"integer","description":"","format":"int32"},"sort":{"type":"array","description":"","items":{"type":"string"}}}},"AddressType":{"type":"object","properties":{"addressType":{"type":"string","description":"","xml":{"name":"address-type"}},"countryCode":{"$ref":"#\/components\/schemas\/CountryCodeType"},"state":{"type":"string","description":""},"district":{"type":"string","description":""},"postalCode":{"type":"string","description":"","xml":{"name":"postal-code"}},"place":{"type":"string","description":""},"streetAddress":{"type":"string","description":"","xml":{"name":"street-address"}},"houseNumber":{"type":"string","description":"","xml":{"name":"house-number"}},"apartmentNumber":{"type":"string","description":"","xml":{"name":"apartment-number"}},"careOf":{"type":"string","description":"","xml":{"name":"care-of"}},"geoLocation":{"$ref":"#\/components\/schemas\/GeoLocationType"},"poBox":{"type":"string","description":"","xml":{"name":"po-box"}}}},"Api":{"required":["domain","version"],"type":"object","properties":{"domain":{"type":"string","description":""},"version":{"type":"string","description":""}},"xml":{"name":"api","namespace":"urn:compass:wico:api:1.0"}},"CountryCodeType":{"type":"object","properties":{"value":{"type":"string","description":""},"type":{"type":"string","description":"","xml":{"attribute":true},"enum":["ISO_3166_1_ALPHA_3"]}}},"GeoLocationType":{"type":"object","properties":{"lat":{"type":"number","description":"","format":"double"},"lon":{"type":"number","description":"","format":"double"}}},"Meta":{"required":["api","cost","generationDate","lastUpdate","user"],"type":"object","properties":{"api":{"$ref":"#\/components\/schemas\/Api"},"user":{"$ref":"#\/components\/schemas\/User"},"cost":{"type":"string","description":""},"lastUpdate":{"type":"string","description":""},"generationDate":{"type":"string","description":""}},"xml":{"name":"meta","namespace":"urn:compass:wico:api:1.0"}},"NaturalPersonNameType":{"required":["givenName","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"","xml":{"name":"given-name"}},"givenNameAlias":{"type":"string","description":"","xml":{"name":"given-name-alias"}},"surname":{"type":"string","description":""},"surnameAlias":{"type":"string","description":"","xml":{"name":"surname-alias"}},"title":{"type":"string","description":""},"postNominalTitle":{"type":"string","description":"","xml":{"name":"post-nominal-title"}}}},"PaginationInformationType":{"type":"object","properties":{"totalChangesets":{"type":"integer","description":"","format":"int64"},"page":{"type":"integer","description":"","format":"int64"},"pageSize":{"type":"integer","description":"","format":"int64"}}},"ReferenceType":{"type":"object","properties":{"name":{"type":"string","description":""},"registerNumber":{"$ref":"#\/components\/schemas\/RegisterNumberType"},"structuredName":{"$ref":"#\/components\/schemas\/NaturalPersonNameType"},"sex":{"type":"string","description":"","enum":["M","F","O"]},"dateOfBirth":{"type":"string","description":"","xml":{"name":"date-of-birth"}},"yearOfBirth":{"type":"integer","description":"","format":"int32","xml":{"name":"year-of-birth"}},"pepStatus":{"type":"boolean","description":"","xml":{"name":"pep-status"}},"pepConnectionStatus":{"type":"boolean","description":"","xml":{"name":"pep-connection-status"}},"deceasedStatus":{"type":"boolean","description":"","xml":{"name":"deceased-status"}},"address":{"$ref":"#\/components\/schemas\/AddressType"},"wicoId":{"type":"string","description":"","xml":{"name":"wico-id","attribute":true}},"formerWicoIds":{"type":"array","description":"","items":{"type":"string"}},"objectType":{"type":"string","description":"","xml":{"name":"object-type","attribute":true},"enum":["REGISTERED_COMPANY","ASSOCIATION","TRADE_PERSON","NATURAL_PERSON","NON_INCORPORATED_PARTNERSHIP","TERRITORIAL_ENTITY","OTHER_NON_NATURAL_PERSON"]}}},"RegisterNumberType":{"type":"object","properties":{"value":{"type":"string","description":""},"register":{"type":"string","description":"","xml":{"attribute":true},"enum":["AT_FB","AT_ZVR","AT_TRADE","AT_ERV_PARTICIPANTS","AT_NOTARIES_CHAMBER","AT_CLINICAL_PSYCHOLOGISTS_LIST","AT_HEALTH_PSYCHOLOGISTS_LIST","AT_MUSIC_THERAPISTS_LIST","AT_PSYCHOTHERAPISTS_LIST","AT_TRAINING_TRAINING_THERAPISTS_LIST","AT_HEALTH_PROFESSIONALS_REGISTER","DE_HR"]},"authority":{"type":"string","description":"","xml":{"attribute":true}}}},"User":{"required":["clientInfo","organisation","username"],"type":"object","properties":{"organisation":{"type":"string","description":""},"username":{"type":"string","description":""},"clientInfo":{"type":"string","description":""}},"xml":{"name":"user","namespace":"urn:compass:wico:api:1.0"}},"WieregChangeSetsType":{"required":["meta","paginationInformation","wieregChanges"],"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta"},"wieregChanges":{"$ref":"#\/components\/schemas\/WieregChangesType"},"paginationInformation":{"$ref":"#\/components\/schemas\/PaginationInformationType"}}},"WieregChangeType":{"required":["date","description","entityReference","type"],"type":"object","properties":{"date":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["REGISTERED","UPDATED","DELETED"]},"entityReference":{"$ref":"#\/components\/schemas\/ReferenceType"},"description":{"type":"string","description":""}}},"WieregChangesType":{"type":"object","properties":{"wieregChange":{"type":"array","description":"","xml":{"name":"wiereg-change"},"items":{"$ref":"#\/components\/schemas\/WieregChangeType"}}}},"BusinessRegisterChangeSetsType":{"required":["businessRegisterChanges","meta","paginationInformation"],"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta"},"businessRegisterChanges":{"$ref":"#\/components\/schemas\/BusinessRegisterChangesType"},"paginationInformation":{"$ref":"#\/components\/schemas\/PaginationInformationType"}}},"BusinessRegisterChangeType":{"required":["date","entityReference","type"],"type":"object","properties":{"date":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["REGISTERED","UPDATED","DELETED"]},"entityReference":{"$ref":"#\/components\/schemas\/ReferenceType"},"annualAccountsOnly":{"type":"boolean","description":"","xml":{"name":"annual-accounts-only"}}}},"BusinessRegisterChangesType":{"type":"object","properties":{"businessRegisterChange":{"type":"array","description":"","xml":{"name":"business-register-change"},"items":{"$ref":"#\/components\/schemas\/BusinessRegisterChangeType"}}}},"DebtorType":{"required":["entityReference"],"type":"object","properties":{"entityReference":{"$ref":"#\/components\/schemas\/ReferenceType"}}},"InsolvencyCaseChangeSetsType":{"required":["insolvencyCaseChanges","meta","paginationInformation"],"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta"},"insolvencyCaseChanges":{"$ref":"#\/components\/schemas\/InsolvencyCaseChangesType"},"paginationInformation":{"$ref":"#\/components\/schemas\/PaginationInformationType"}}},"InsolvencyCaseChangeType":{"required":["date","insolvencyCaseReference","type"],"type":"object","properties":{"date":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["REGISTERED","UPDATED","DELETED"]},"insolvencyCaseReference":{"$ref":"#\/components\/schemas\/InsolvencyCaseReference"}}},"InsolvencyCaseChangesType":{"type":"object","properties":{"insolvencyCaseChange":{"type":"array","description":"","xml":{"name":"insolvency-case-change"},"items":{"$ref":"#\/components\/schemas\/InsolvencyCaseChangeType"}}}},"InsolvencyCaseReference":{"required":["court","courtNumber","debtor","fileNumber","type"],"type":"object","properties":{"courtNumber":{"type":"string","description":"","xml":{"name":"court-number"}},"court":{"type":"string","description":""},"fileNumber":{"type":"string","description":"","xml":{"name":"file-number"}},"type":{"type":"string","description":""},"debtor":{"$ref":"#\/components\/schemas\/DebtorType"}}},"ApparentInsolvencyCaseChangeSetsType":{"required":["apparentInsolvencyCaseChanges","meta","paginationInformation"],"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta"},"apparentInsolvencyCaseChanges":{"$ref":"#\/components\/schemas\/ApparentInsolvencyCaseChangesType"},"paginationInformation":{"$ref":"#\/components\/schemas\/PaginationInformationType"}}},"ApparentInsolvencyCaseChangeType":{"required":["apparentInsolvencyCaseReference","date","type"],"type":"object","properties":{"date":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["REGISTERED","UPDATED","DELETED"]},"apparentInsolvencyCaseReference":{"$ref":"#\/components\/schemas\/ApparentInsolvencyCaseReference"}}},"ApparentInsolvencyCaseChangesType":{"type":"object","properties":{"apparentInsolvencyCaseChange":{"type":"array","description":"","xml":{"name":"apparent-insolvency-case-change"},"items":{"$ref":"#\/components\/schemas\/ApparentInsolvencyCaseChangeType"}}}},"ApparentInsolvencyCaseReference":{"required":["court","courtNumber","debtor","fileNumber"],"type":"object","properties":{"courtNumber":{"type":"string","description":"","xml":{"name":"court-number"}},"court":{"type":"string","description":""},"fileNumber":{"type":"string","description":"","xml":{"name":"file-number"}},"debtor":{"$ref":"#\/components\/schemas\/DebtorType"}}},"DummyCompanyChangeSetsType":{"required":["dummyCompanyChanges","meta","paginationInformation"],"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta"},"dummyCompanyChanges":{"$ref":"#\/components\/schemas\/DummyCompanyChangesType"},"paginationInformation":{"$ref":"#\/components\/schemas\/PaginationInformationType"}}},"DummyCompanyChangeType":{"required":["date","entityReference","publicationDate","type"],"type":"object","properties":{"date":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["REGISTERED","UPDATED","DELETED"]},"publicationDate":{"type":"string","description":"","xml":{"name":"publication-date"}},"entityReference":{"$ref":"#\/components\/schemas\/ReferenceType"}}},"DummyCompanyChangesType":{"type":"object","properties":{"dummyCompanyChange":{"type":"array","description":"","items":{"$ref":"#\/components\/schemas\/DummyCompanyChangeType"}}}},"ResponseString":{"type":"object","properties":{"status":{"type":"string","description":"","enum":["OK","ERROR"]},"message":{"type":"string","description":""},"data":{"type":"string","description":""}}}},"securitySchemes":{"compass-api-token":{"type":"apiKey","name":"Authorization","in":"header"}}}}