{"openapi":"3.1.0","info":{"title":"Additional Tools API","description":"Die additional Toolbox API bietet zus\u00e4tzliche Services.","version":"1.0.0"},"servers":[{"url":"https:\/\/api.wirtschaftscompass.at\/tools","description":"Generated server url"}],"security":[{"compass-api-token":[]}],"tags":[{"name":"V1","description":"Additional Tools Version 1"}],"paths":{"\/v1\/{wico-id}\/agh":{"get":{"tags":["V1"],"summary":"AGH-Abfrage \/ HFU-Liste","description":"Pr\u00fcfung der Haftungsfreistellung f\u00fcr Unternehmen, die Bauauftr\u00e4ge nach \u00a7 19 Abs 1a UStG an Subunternehmer vergeben.","operationId":"performAghRequest","parameters":[{"name":"wico-id","in":"path","description":"[wicoId] des Objekts","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"503":{"description":"Service Unavailable","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceException"]},"404":{"description":"Not Found","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceNotFoundException"]},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AghResultType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/AghResultType"}}}}}}},"\/v1\/vat-number\/{vat-number}\/validation":{"get":{"tags":["V1"],"summary":"Validierung einer UID-Nummer","description":"Mit Hilfe dieser Validierung kann eine UID-Nummer gegen\u00fcber der VIES-Service der Europ\u00e4isches Kommission auf Richtigkeit \u00fcberpr\u00fcft werden.","operationId":"performVatValidation","parameters":[{"name":"vat-number","in":"path","description":"[vat-number] des Objekts (z.B.: ATU36779802)","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"503":{"description":"Service Unavailable","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceException"]},"404":{"description":"Not Found","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceNotFoundException"]},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ValidationResultType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/ValidationResultType"}}}}}}},"\/health":{"get":{"tags":["X"],"summary":"","description":"","operationId":"getPing","responses":{"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"503":{"description":"Service Unavailable","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceException"]},"404":{"description":"Not Found","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceNotFoundException"]},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ResponseString"}}}}}}}},"components":{"schemas":{"Failure":{"properties":{"message":{"type":"string"},"stacktrace":{"type":"string"}},"required":["message","stacktrace"],"xml":{"name":"failure","namespace":"urn:compass:wico:api:1.0"}},"AghDataType":{"type":"object","properties":{"name":{"type":"string","description":""},"dgnr":{"type":"string","description":""},"address":{"type":"string","description":""}},"required":["address","dgnr","name"]},"AghResultDataType":{"type":"object","properties":{"aghData":{"$ref":"#\/components\/schemas\/AghDataType","description":"","xml":{"name":"agh-data"}},"referenceDate":{"type":"string","description":"","xml":{"name":"reference-date"}},"registered":{"type":"boolean","description":""}},"required":["referenceDate"]},"AghResultType":{"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta","description":""},"data":{"$ref":"#\/components\/schemas\/AghResultDataType","description":""}},"required":["data","meta"],"xml":{"name":"aghResultType","namespace":"urn:compass:wico:api:1.0"}},"Api":{"type":"object","properties":{"domain":{"type":"string","description":""},"version":{"type":"string","description":""}},"required":["domain","version"],"xml":{"name":"api","namespace":"urn:compass:wico:api:1.0"}},"Meta":{"type":"object","properties":{"api":{"$ref":"#\/components\/schemas\/Api","description":""},"user":{"$ref":"#\/components\/schemas\/User","description":""},"cost":{"type":"string","description":""},"lastUpdate":{"type":"string","description":""},"generationDate":{"type":"string","description":""}},"required":["api","cost","generationDate","lastUpdate","user"],"xml":{"name":"meta","namespace":"urn:compass:wico:api:1.0"}},"User":{"type":"object","properties":{"organisation":{"type":"string","description":""},"username":{"type":"string","description":""},"clientInfo":{"type":"string","description":""}},"required":["clientInfo","organisation","username"],"xml":{"name":"user","namespace":"urn:compass:wico:api:1.0"}},"AddressType":{"type":"object","properties":{"addressType":{"type":"string","description":"","xml":{"name":"address-type"}},"countryCode":{"$ref":"#\/components\/schemas\/CountryCodeType","description":"","xml":{"name":"country-code"}},"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","description":"","xml":{"name":"geo-location"}},"poBox":{"type":"string","description":"","xml":{"name":"po-box"}}}},"CountryCodeType":{"type":"object","properties":{"value":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["ISO_3166_1_ALPHA_3"],"xml":{"attribute":true}}}},"GeoLocationType":{"type":"object","properties":{"lat":{"type":"number","format":"double","description":""},"lon":{"type":"number","format":"double","description":""}}},"ValidationResultDataType":{"type":"object","properties":{"countryCode":{"$ref":"#\/components\/schemas\/CountryCodeType","description":"","xml":{"name":"country-code"}},"vatNumber":{"type":"string","description":"","xml":{"name":"vat-number"}},"timestamp":{"type":"string","description":""},"valid":{"type":"boolean","description":""},"name":{"type":"string","description":""},"address":{"$ref":"#\/components\/schemas\/AddressType","description":""}},"required":["countryCode","timestamp","vatNumber"]},"ValidationResultType":{"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta","description":""},"data":{"$ref":"#\/components\/schemas\/ValidationResultDataType","description":""}},"required":["data","meta"],"xml":{"name":"validationResultType","namespace":"urn:compass:wico:api:1.0"}},"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","scheme":"bearer","bearerFormat":"JWT"}}}}