{"openapi":"3.0.1","info":{"title":"Company report API 5.01","description":"Group structure package (Q343)","version":"1.0.0"},"servers":[{"url":"https:\/\/demo.asiakastieto.fi\/"},{"url":"https:\/\/www.asiakastieto.fi\/"}],"paths":{"\/services\/company5\/REST":{"get":{"summary":"Retrieve company information with Finnish business id","parameters":[{"name":"businessid","in":"query","required":true,"schema":{"type":"string"},"example":"01110279","description":"business id of the target without dash"},{"name":"version","in":"query","required":true,"schema":{"type":"string"},"example":5.01,"description":"current company API version 5.01"},{"name":"packet","in":"query","description":"specifies requested report. Value Q343 returns the Group structure package","required":true,"schema":{"type":"string"},"example":"Q343"},{"name":"userid","in":"query","required":true,"description":"Your user id provided by Suomen Asiakastieto","schema":{"type":"string","minLength":6,"maxLength":12},"example":"myuserid"},{"name":"passwd","in":"query","required":true,"description":"Your password provided by Suomen Asiakastieto","schema":{"type":"string"},"example":"mypassword"},{"name":"enduser","in":"query","required":true,"description":"Chosen by you (1-12 chrs) for logging purposes. Can be some identiefer identifying requesting personell or system.","schema":{"type":"string"},"example":"testuser"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","enum":["FI","SV","EN"]},"example":"EN"},{"name":"reqmsg","in":"query","required":true,"schema":{"type":"string"},"example":"COMPANY","description":"value COMPANY specifies company information is requested"},{"name":"purpose","in":"query","required":false,"schema":{"type":"string"},"example":1,"description":"Purpose of the call. Please see purpose codes from documentation."},{"name":"target","in":"query","required":false,"schema":{"type":"string","enum":["VAP1","PAP1"]},"example":"VAP1","description":"specifies target environment. Use VAP1 for company demo and PAP1 for production"},{"name":"format","in":"query","required":true,"schema":{"type":"string","enum":["json","xml"]},"example":"json","description":"preferred response format. This swagger describes the json structure"},{"name":"timestamp","in":"query","required":true,"schema":{"type":"string"},"example":"2024052107063028+0000000","description":"timestamp of the call. By default queries cannot be older than 15 minutes."},{"name":"checksum","in":"query","required":true,"schema":{"type":"string","minLength":128,"maxLength":128},"example":"TESTCHECKSUMSUMFORSWAGGERTHATISNOTVALID917CFC8D23F75864C1852B65D263957C88D620C53DDBB4C10F6EB0630FBD1F8AA863FA103A2DB88146DED4967","description":"Checksum that uses shared secret. Please see documentation on authentication."}],"responses":{"200":{"description":"Successful response. All responses fall under 200 also those with errors. In error situation and responseHeader\/responseStatus = 1 and errorMsg\/errorCode is present.","content":{"application\/json":{"schema":{"type":"object","properties":{"companyResponse":{"type":"object","properties":{"responseHeader":{"type":"object","properties":{"languageCode":{"type":"string","example":"EN"},"timeStamp":{"type":"object","properties":{"date":{"type":"string","example":"2024-05-21"},"time":{"type":"string","example":"10:06:30"}}},"responseStatus":{"type":"string","example":"0"},"currencyCode":{"type":"string","example":"EUR","description":"always EUR"}}},"identificationData":{"type":"object","properties":{"businessId":{"type":"string","example":"01110279"},"name":{"type":"string","example":"Suomen Asiakastieto Oy"},"domicileCode":{"type":"string","example":"091"},"domicile":{"type":"string","example":"Helsinki"},"companyLanguageCode":{"type":"string","example":"FI"},"postalAddress":{"type":"object","properties":{"street":{"type":"string","example":"Hermannin Rantatie 6"},"zip":{"type":"string","example":"00580"},"town":{"type":"string","example":"Helsinki"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Verkkosaarenkatu 5"},"zip":{"type":"string","example":"00580"},"town":{"type":"string","example":"Helsinki"}}},"contactInformation":{"type":"object","properties":{"phone":{"type":"string","example":"+358 10 2707000"},"www":{"type":"string","example":"www.asiakastieto.fi"},"eMail":{"type":"string","example":"asiakaspalvelu@asiakastieto.fi"}}},"companyForm":{"type":"string","example":"OY"},"companyFormText":{"type":"string","example":"Limited company"},"lineOfBusiness":{"type":"object","properties":{"lineOfBusinessCode":{"type":"string","example":"82910"},"lineOfBusinessText":{"type":"string","example":"Activities of collection agencies and credit bureaus"}}},"naceCode":{"type":"string","example":"8291"},"naceText":{"type":"string","example":"Activities of collection agencies and credit bureaus"}}},"companyBasics":{"type":"object","properties":{"statusAndType":{"type":"object","properties":{"registrationDate":{"type":"string","example":"1961-11-10"},"tradeRegisterChangeDate":{"type":"string","example":"2022-05-07"},"companyStatus":{"type":"object","properties":{"statusCode":{"type":"string"},"statusText":{"type":"string"},"date":{"type":"string","example":"2024-07-29"}},"description":"current codes L = Dissolved, J = Public summons to creditors, S = Placed in liquidation"},"companyStatus2":{"type":"object","properties":{"statusCode":{"type":"string","example":"A"},"statusText":{"type":"string","example":"Active"},"date":{"type":"string","example":"2024-07-29"}},"description":"Deduction on the current status. Current codes A = Active U= Unconfirmed P = Passive"},"startingDate":{"type":"string","example":"1963-06-01"},"lineOfBusiness":{"type":"object","properties":{"lineOfBusinessCode":{"type":"string","example":"82910"},"lineOfBusinessText":{"type":"string","example":"Activities of collection agencies and credit bureaus"}}},"sectorCode":{"type":"string","example":"11102"},"sectorText":{"type":"string","example":"Non-financial corporations, excl. housing corporations, national private"},"companyForm":{"type":"string","example":"OY"},"companyFormText":{"type":"string","example":"Limited company"},"ownerType":{"type":"string","example":"1"},"ownerTypeText":{"type":"string","example":"Private Finnish"},"numberOfPlacesOfBusiness":{"type":"string","example":"1"},"shareCapitalData":{"type":"object","properties":{"shareCapital":{"type":"string","example":"1880333"},"shareCapitalPaid":{"type":"string","example":"1880333"},"numberOfShares":{"type":"string","example":"74533"}}},"accountingPeriodData":{"type":"object","properties":{"accountingPeriodStartDay":{"type":"string","example":"--01-01","description":"day in gMonthDay format"},"accountingPeriodEndDay":{"type":"string","example":"--12-31","description":"day in gMonthDay format"},"exceptionAccountingPeriod":{"type":"object","properties":{"startDate":{"type":"string","example":"2021-12-31"},"endDate":{"type":"string","example":"2021-12-31"}}},"endedAccountingPeriod":{"type":"object","properties":{"endDate":{"type":"string","example":"2021-12-31"},"length":{"type":"string","example":"12"},"turnover":{"type":"string","example":"65527000"}}},"personnel":{"type":"object","properties":{"numberOfEmployees":{"type":"integer","example":169}}}}},"personnelCategoryRow":{"type":"object","properties":{"year":{"type":"string","example":"2023"},"personnelCategoryCode":{"type":"string","example":"6"},"latestPersonnelCategoryMin":{"type":"string","example":"100"},"latestPersonnelCategoryMax":{"type":"string","example":"249"},"prevYear":{"type":"string","example":"2022"},"prevPersonnelCategoryCode":{"type":"string","example":"6"},"personnelCategoryMinPrev":{"type":"string","example":"100"},"personnelCategoryMaxPrev":{"type":"string","example":"249"}}},"turnoverRow":{"type":"array","items":{"type":"object","properties":{"year":{"type":"string","example":"2023"},"latestTurnoverMin":{"type":"string","example":"20000"},"latestTurnoverMax":{"type":"string","example":"20000"},"turnoverPrevioustYear":{"type":"string","example":"2022"},"turnoverMinPrev":{"type":"string","example":"20000"},"turnoverMaxPrev":{"type":"string","example":"20000"}}}},"leiCode":{"type":"string","example":"501111FI1G123456789","description":"lei code for entity if active"},"threatOfEliminationData":{"type":"object","properties":{"code":{"type":"string","example":"PRHPO3"},"text":{"type":"string","example":"Threat of elimination set by Finnish Patent and Registration Office: notification of beneficial owners must be filed by"},"date":{"type":"string","example":""}}},"nuts":{"type":"object","properties":{"code":{"type":"string","example":"FI1C4"},"text":{"type":"string","example":"Kymeenlaakso"},"date":{"type":"string","example":""}}},"obligationToCarryOutAnAudit":{"type":"object","properties":{"code":{"type":"string","example":"1"},"text":{"type":"string","example":"On the basis of the information in the financial statements, the company is obligated to appoint an auditor. The audit has been carried out."}}}}}}},"companyInGroup":{"type":"array","items":{"type":"object","properties":{"groupStatus":{"type":"string","example":"1"},"numberOfCompanyGroupLines":{"type":"string","example":"1"},"companyInGroupRow":{"type":"array","items":{"type":"object","properties":{"groupRow":{"type":"array","items":{"type":"object","properties":{"level":{"type":"string","example":"1"},"groupCompanyBusinessId":{"type":"string","example":"21940077"},"groupCompanyName":{"type":"string","example":"Enento Group Oyj"},"parentCompanyBusinessId":{"type":"string","example":"21940077"},"parentCompanyName":{"type":"string","example":"Enento Group Oyj"},"ultimateParentCompanyBusinessId":{"type":"string","example":"21940077"},"ultimateParentCompanyName":{"type":"string","example":"Enento Group Oyj"},"groupOwnershipShare":{"type":"string","example":"38.3"},"paymentDefault":{"type":"boolean","example":false},"informationOfThePenaltyPayments":{"type":"boolean","example":false}}}}}}}}}},"errorMessage":{"type":"object","properties":{"errorCode":{"type":"string","example":"VH5"},"errorText":{"type":"string","example":"Invalid Business ID\/VAT number"}}}}}}}}}}}}}}}