{"openapi":"3.1.1","info":{"title":"Salaxy Open API v03","description":"Main Salaxy API provides methods for paying salaries and other employment related tasks in the Finnish market.","contact":{"name":"Salaxy customer service","url":"https://developers.salaxy.com","email":"contact@salaxy.com"},"version":"v03","x-salaxy-model-namespace":"SALAXY.MODEL","x-salaxy-enum-namespace":"SALAXY.ENUM"},"servers":[{"url":"https://secure.salaxy.com/"}],"paths":{"/v03/api/calculator/new":{"get":{"tags":["Calculator"],"summary":"Factory method that creates a new Calculation object","operationId":"Calculator_CreateNew","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/recalculate":{"post":{"tags":["Calculator"],"summary":"Takes in a calculation and recalculates it.","operationId":"Calculator_Recalculate","requestBody":{"description":"The salary calculation that should be recalculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation object recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/recalculate-worktime":{"post":{"tags":["Calculator"],"summary":"Recalculates the Worktime into the rest of the calculation:\r\nMainly adds (recreates) rows for absences and holidays to the calculation.","operationId":"Calculator_RecalculateWorktime","requestBody":{"description":"The salary calculation that should be recalculated and the holidays and absences that should be added to it.\r\nShould contain the worktime property that is used as bases of the calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation object recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/recalculate-worktime/{type}":{"post":{"tags":["Calculator"],"summary":"Returns the planned absence, holiday salary or holiday compensations rows based on holiday/absence calendar and settings or given periods.","operationId":"Calculator_GetPlannedRows","parameters":[{"name":"type","in":"path","description":"Type of the planned rows.","required":true,"schema":{"pattern":"^(absencePeriod|holidaySalary|holidayCompensation|all)$","type":"string","default":"all"}}],"requestBody":{"description":"Calculation and periods.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannedRowsRequest"}}},"required":true},"responses":{"200":{"description":"Planned absence, holiday pay or holiday compensation rows.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDefinedRow"}}}}}}}},"/v03/api/calculator/worktime":{"post":{"tags":["Calculator"],"summary":"Gets the worktime data for Period recalculation from raw calc, holidays andabsences data.\r\nThese determine how holiday salaries etc. and absence deductions will be added as rows to calculations.\r\nThe idea is that user can still modify these before the actual calculation is done as often manual adjustments need to be made.\r\nAlso, providers that do not use HolidayYears and Absences can skip this step and use recalculate-worktime directly.\r\nNOTE: This is the anonymous method that can be called without storage.\r\nThere is a corresponding method in Calculations-service that fetches the holidayYear and Absences automatically.","operationId":"Calculator_GetWorktimeData","requestBody":{"description":"The salary calculation that should be recalculated and the holidays and absences that should be added to it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeriodRecalculationData"}}},"required":true},"responses":{"200":{"description":"The parameters for adding the actual rows and recalculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalcWorktime"}}}}}}},"/v03/api/calculator/salary":{"post":{"tags":["Calculator"],"summary":"Sets the salary for the calculation and returns it with full recalculated data.","operationId":"Calculator_Salary","parameters":[{"name":"kind","in":"query","description":"Type of the salary being calculated","schema":{"$ref":"#/components/schemas/SalaryKind"}},{"name":"amount","in":"query","description":"Amount of e.g. hours, months for the salary. Default is 1.","schema":{"type":"number","format":"double","default":1}},{"name":"price","in":"query","description":"Price of one unit - e.g. hour, month.","schema":{"type":"number","format":"double"}},{"name":"unit","in":"query","description":"E.g. hour, month. Typically this parameter can be left empty/null and the unit is set according to type.","schema":{"type":"string"}},{"name":"message","in":"query","description":"Optional message for the salary row that is shown in reports. If null, will be set according to type.","schema":{"type":"string"}},{"name":"isHouseholdDeductible","in":"query","description":"If set to true, will calculate the household deduction. Applies only to natural persons - as oppsed to companies.","schema":{"type":"boolean","default":false}},{"name":"taxDeductionCategories","in":"query","description":"If tax IsHouseholdDeductible is set to true, please also select the category (categories). \r\nNote that \"OwnPropety\" is a default, it does not need to be set: Only set RelativesProperty if necessary.","schema":{"$ref":"#/components/schemas/TaxDeductionWorkCategories"}}],"requestBody":{"description":"Optional calculation that should be modified. If left null, a new one will be created.\r\nNOTE: this can be set to null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"A calculation with given salary parameters. Either recalculated or a newly calculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/workerset":{"post":{"tags":["Calculator"],"summary":"Sets the a worker with the specified ID to the given calculation and returns the calculation with full data.","operationId":"Calculator_WorkerSet","parameters":[{"name":"profileId","in":"query","description":"Text identifying the person that should be set as the Worker. Value is one of the following:\r\n1) Guid: Identifier of the real existing Person object\r\n2) \"me\": Sets the current authenticated user as the worker\r\n3) \"new\": Creates a new Person object that is editable by the employer and sets that as the Worker\r\n4) \"example-[17/pensioner/default]\": Sets the Person as one of the predefined example Persons","schema":{"type":"string"}}],"requestBody":{"description":"The salary calculation that should be modified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation with the modifications recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/taxdeduction":{"post":{"tags":["Calculator"],"summary":"Sets the household deduction true or false and returns the calculation with full data.","operationId":"Calculator_TaxDeduction","parameters":[{"name":"setHouseHoldDeduction","in":"query","description":"If true, the household deduction (kotitalousvähennys) is calculated as part of the salary calculation.","schema":{"type":"boolean"}}],"requestBody":{"description":"The salary calculation that should be modified. \r\nNOTE: If you set this to null, a sample salary calculation for  100 euro is created. \r\nUse empty object '{}' for","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation with the modifications recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/work":{"post":{"tags":["Calculator"],"summary":"Stores information about the work type start- and end date as well as Framework and returns the calculation with full data.","operationId":"Calculator_Work","parameters":[{"name":"type","in":"query","description":"Type of the work framework","schema":{"$ref":"#/components/schemas/FrameworkAgreement"}},{"name":"subType","in":"query","description":"Subtype when one framework has several options","schema":{"$ref":"#/components/schemas/TesSubtype"}},{"name":"isTesIncludedInSalary","in":"query","description":"Marker that the payments defined by framework agreement are included in the salary (will not be added by the calculation).","schema":{"type":"boolean"}},{"name":"unionPayment","in":"query","description":"Type of the union payment","schema":{"$ref":"#/components/schemas/UnionPaymentType"}},{"name":"unionPaymentPercent","in":"query","description":"Percent of the union payment","schema":{"type":"number","format":"double"}},{"name":"numberOfDays","in":"query","description":"Number of days may affect calculation of different payments calculated based on a Framework agreement","schema":{"type":"integer","format":"int32"}},{"name":"dailyTravelExpenses","in":"query","description":"Travel expences per day","schema":{"type":"number","format":"double"}},{"name":"dailyTravelExpensesKm","in":"query","description":"The amount of kilometers travelled by day - used to define the amount of travel expenses in aomse framework agreements.","schema":{"type":"number","format":"double"}},{"name":"dailyExpenses","in":"query","description":"Daily expenses amount","schema":{"type":"number","format":"double"}},{"name":"isYksityisenHoidonTuki","in":"query","description":"If true will calculate the Finnish child care subsidy","schema":{"type":"boolean"}},{"name":"yksityisenHoidonTukiAmount","in":"query","description":"Amount of Finnish child care subsidy","schema":{"type":"number","format":"double"}},{"name":"isEntrepreneurPensionContract","in":"query","description":"If true, the Worker has his own entrepreneur contract.","schema":{"type":"boolean"}},{"name":"isEntrepreneurPensionContractForFarmer","in":"query","description":"If true, the Worker has his own Pension farmer contract.","schema":{"type":"boolean"}},{"name":"isEntrepreneurPensionContractForAthlete","in":"query","description":"If true, the Worker has his own Pension farmer contract.","schema":{"type":"boolean"}},{"name":"startDate","in":"query","description":"Work start date","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"Work end date","schema":{"type":"string","format":"date-time"}},{"name":"description","in":"query","description":"Detail description of the work (e.g. when framework is Other).","schema":{"type":"string"}}],"requestBody":{"description":"Parameters related to the framework agreement (TES) and other work type related calculations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation with the modifications recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/setunionpayment":{"post":{"tags":["Calculator"],"summary":"Changes the union payment for the calculation and returns it with full data recalculated.","operationId":"Calculator_SetUnionPayment","parameters":[{"name":"paymentType","in":"query","description":"Type of the union payment - some known types also se the the percent (e.g. Raksa).","schema":{"$ref":"#/components/schemas/UnionPaymentType"}},{"name":"unionPaymentPercent","in":"query","description":"Percent for the union payment- default is zero.","schema":{"type":"number","format":"double","default":0}}],"requestBody":{"description":"The salary calculation that should be modified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation with the modifications recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/addrow":{"post":{"tags":["Calculator"],"summary":"Adds a calculation row: An expenses, benefits or other such row and returns the recalculated calculation with full data.","operationId":"Calculator_AddRow","parameters":[{"name":"rowType","in":"query","description":"Type of the calculation row that should be added","schema":{"$ref":"#/components/schemas/CalculationRowType"}},{"name":"message","in":"query","description":"Message text for end user - used in salary calculation","schema":{"type":"string"}},{"name":"price","in":"query","description":"Price for the row (e.g. €/h, €/km, €/month. Default is 0.","schema":{"type":"number","format":"double","default":0}},{"name":"count","in":"query","description":"Count of the items - default is 1.","schema":{"type":"number","format":"double","default":1}},{"name":"sourceId","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"The salary calculation that should be modified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation with the modifications recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/deleterow":{"post":{"tags":["Calculator"],"summary":"Deletes a calculation row: Expenses, benefits etc. item and returns the recalculated calculation with full data.","operationId":"Calculator_DeleteRow","parameters":[{"name":"rowIndex","in":"query","description":"Zero based row index of the row that should be deleted.","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The salary calculation that should be modified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The calculation with the modifications recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculator/yearlyNumbers/{forDate}":{"get":{"tags":["Calculator"],"summary":"Gets salary calculation parameters that are changing yearly.\r\nThe method is designed for the end-of-year and as such it only supports 2 years:\r\nthe current / previous year (from Jan to Nov) OR current / next year (in approx. December).","operationId":"Calculator_GetYearlyChangingNumbers","parameters":[{"name":"forDate","in":"path","description":"Date for which the numbers are fetched","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearlyChangingNumbers"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/calculator/yearlyHolidays/{forDate}":{"get":{"tags":["Calculator"],"summary":"Returns holidays for the given year.","operationId":"Calculator_GetYearlyHolidays","parameters":[{"name":"forDate","in":"path","description":"Year for which the holidays are fetched","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Holidays for the given year.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YearlyHolidays"}}}}}}},"/v03/api/test/token":{"get":{"tags":["Test"],"operationId":"Test_TokenTest","parameters":[{"name":"token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/test/hello":{"get":{"tags":["Test"],"summary":"Basic hello world message","operationId":"Test_Hello","responses":{"200":{"description":"The same message text as what is passed in as message parameter.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/test/hello/{message}":{"get":{"tags":["Test"],"summary":"Basic hello world message","operationId":"Test_HelloByMessage","parameters":[{"name":"message","in":"path","description":"This text is mirrored in response.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The same message text as what is passed in as message parameter.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/test/user-name":{"get":{"tags":["Test"],"summary":"Gets the user name of the current user. Requires authorization.","operationId":"Test_GetUserName","responses":{"200":{"description":"The user name of the current user."}}}},"/v03/api/test/user-name-allow-anon":{"get":{"tags":["Test"],"summary":"Gets the user name of the current user. DOES NOT require authorization.","operationId":"Test_GetUserNameAllowAnon","responses":{"200":{"description":"The user name of the current user or \"Anonymous\" if not authenticated."}}}},"/v03/api/test/authorization":{"get":{"tags":["Test"],"summary":"Basic welcome message with authorization.","operationId":"Test_Authorization","responses":{"200":{"description":"Welcome [Current user displayu name]","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/test/delay":{"get":{"tags":["Test"],"summary":"Test a long lasting request.\r\nReturns the incoming parameter.\r\nAvailable in test environment only.","operationId":"Test_Delay","parameters":[{"name":"seconds","in":"query","description":"Delay in seconds.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The seconds parameter.","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}}}}},"/v03/api/test/values":{"post":{"tags":["Test"],"summary":"Test JSON serialization.","operationId":"Test_Values","requestBody":{"description":"Object of test values that is mirrored in serialization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestValues"}}},"required":true},"responses":{"200":{"description":"Returns the test object with given values or defaults.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestValues"}}}}}}},"/v03/api/test/accounts":{"post":{"tags":["Test"],"summary":"Creates a test account and returns test account details.\r\nAvailable in test environment only.","operationId":"Test_CrudSaveAccount","requestBody":{"description":"Onboarding object that defines the test user.\r\nFor Person, fill in names and PersonalId.\r\nFor company, fill in Company id, type and name as well as the above infor for company contact person.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}},"required":true},"responses":{"200":{"description":"A test user that is easy to destroy (will be destroyed periodically from the database).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAccountInfo"}}}}}}},"/v03/api/test/accounts/{id}":{"delete":{"tags":["Test"],"summary":"Deletes a test account.\r\nAvailable in test environment only.","operationId":"Test_CrudDeleteAccount","parameters":[{"name":"id","in":"path","description":"Identifier of the account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/test/exceptions/{type}":{"get":{"tags":["Test"],"summary":"Throws an exception. Used in testing error handling and alert user interfaces.","operationId":"Test_UserFriendlyException","parameters":[{"name":"type","in":"path","description":"Type of error to throw","required":true,"schema":{"$ref":"#/components/schemas/ApiTestErrorType"}}],"responses":{"200":{"description":"Always throws an exception."}}}},"/v03/api/test/federation":{"post":{"tags":["Test"],"summary":"Gets a test message for federation","operationId":"Test_GetFederationSample","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederationSampleViewModel"}}},"required":true},"responses":{"200":{"description":"Federation message for the current user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederationSampleViewModel"}}}}}}},"/v03/api/test/metrics/{name}":{"get":{"tags":["Test"],"summary":"Reports a metrics value for the AppInsight.","operationId":"Test_Metrics","parameters":[{"name":"name","in":"path","description":"Name of the metrics.","required":true,"schema":{"type":"string"}},{"name":"value","in":"query","description":"Value of the metrics.","schema":{"type":"number","format":"double"}}],"responses":{"200":{"description":"Text containg metrics name and value."}}}},"/v03/api/test/invoices/tax":{"post":{"tags":["Test"],"summary":"Test environment only: rebuilds the current account's Tax invoice for a month from the month's paid salaries and\r\nreleases it to the payment channel at once, also for the current month. This lets a partner or a customer test the\r\nTax payment without waiting for the monthly run. A read or paid Tax invoice blocks the rebuild: cancel it first.\r\nCompany accounts only, as in the AdminWeb rebuild.","operationId":"Test_CreateTaxInvoice","parameters":[{"name":"month","in":"query","description":"Any date in the month. Default: the current month.","schema":{"type":"string","format":"date-time"}},{"name":"channel","in":"query","description":"Channel for a new invoice. Default: the channel of the month's existing Tax invoice.","schema":{"$ref":"#/components/schemas/PaymentChannel"}}],"responses":{"200":{"description":"The created or updated Tax invoices; empty when a read or paid Tax invoice blocks the rebuild.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/test/odata":{"get":{"tags":["Test"],"summary":"Tests the OData parsing as an nonymous method","operationId":"Test_OData","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Text containg metrics name and value."}}}},"/v03/api/test/serialization":{"get":{"tags":["Test"],"summary":"Test JSON serialization using GET.","operationId":"Test_SerializationGet","parameters":[{"name":"intValue","in":"query","description":"Test integer.","schema":{"type":"integer","format":"int32"}},{"name":"doubleValue","in":"query","description":"Test double.","schema":{"type":"number","format":"double"}},{"name":"decimalValue","in":"query","description":"Test decimal.","schema":{"type":"number","format":"double"}},{"name":"stringValue","in":"query","description":"Test string.","schema":{"type":"string"}},{"name":"dateTimeValue","in":"query","description":"Test DateTime.","schema":{"type":"string","format":"date-time"}},{"name":"dateValue","in":"query","description":"Test Date.","schema":{"type":"string","format":"date-time"}},{"name":"boolValue","in":"query","description":"Test bool.","schema":{"type":"boolean"}},{"name":"objectValue","in":"query","description":"Test object.","schema":{"type":"object","additionalProperties":false}},{"name":"arrayValue","in":"query","description":"Test array","schema":{"type":"array","items":{"type":"string"}}},{"name":"enumValue","in":"query","description":"Test enum","schema":{"$ref":"#/components/schemas/TestEnum"}},{"name":"dictValue","in":"query","description":"Free values dictionary.","schema":{"type":"object","additionalProperties":false,"description":"Data dictionary that contains unstructured data for e.g. usecases."}}],"responses":{"200":{"description":"Returns the test object with given values or defaults.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestValues"}}}}}},"post":{"tags":["Test"],"summary":"Test JSON serialization using POST.","operationId":"Test_SerializationPost","requestBody":{"description":"Object of test values that is mirrored in serialization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestValues"}}},"required":true},"responses":{"200":{"description":"Returns the test object with given values or defaults.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestValues"}}}}}}},"/v03/api/test/text/{lang}/{key}":{"get":{"tags":["Test"],"summary":"Gets a text from the translations dictionary.","operationId":"Test_GetText","parameters":[{"name":"lang","in":"path","description":"Language for which the text is fetched.","required":true,"schema":{"$ref":"#/components/schemas/Language"}},{"name":"key","in":"path","description":"Translation key.\r\nE.g. \"SALAXY.EMAIL.MailAfterPaymentHandledEmployer.subject\" returns \"Maksoit palkan työntekijällesi\" in with \"fi\".","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The translated text from the dictionary.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/test/testList":{"get":{"tags":["Test"],"summary":"Returns a list of test IDs as a comma-separated string.","operationId":"Test_TestList","parameters":[{"name":"testIds","in":"query","description":"Array of test IDs.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"HTTP response containing the comma-separated list of test IDs.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/test/testNullableBoolean":{"post":{"tags":["Test"],"operationId":"Test_TestNullableBoolean","parameters":[{"name":"myValue","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/accounts/company":{"get":{"tags":["Account"],"summary":"Gets the current company account if the current account is a company","operationId":"Account_CrudGetCompany","responses":{"200":{"description":"The current company account or null if user is not logged in or if user is acting as a Person","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAccount"}}}}}},"post":{"tags":["Account"],"summary":"Saves the company account.","operationId":"Account_CrudSaveCompany","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAccount"}}},"required":true},"responses":{"200":{"description":"The saved company account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAccount"}}}}}}},"/v03/api/accounts/person":{"get":{"tags":["Account"],"summary":"Gets the current Person account: Either the current account or the Primary contact person account if the current account is a company.","operationId":"Account_CrudGetPerson","responses":{"200":{"description":"The current Person account if or null if the current account is a company, the PrimaryContact Person account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonAccount"}}}}}},"post":{"tags":["Account"],"summary":"Saves the person account.","operationId":"Account_CrudSavePerson","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonAccount"}}},"required":true},"responses":{"200":{"description":"The saved person account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonAccount"}}}}}}},"/v03/api/accounts/avatar":{"post":{"tags":["Account"],"summary":"Saves the avatar file for the account, does not save the account and avatar.","operationId":"Account_SaveAvatarFile","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"avatar":{"$ref":"#/components/schemas/IFormFile"}}}}},"required":true},"responses":{"200":{"description":"Avatar","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Avatar"}}}}}}},"/v03/api/accounts/switchRole":{"post":{"tags":["Account"],"summary":"Switches the role of the current user between\r\nWorker and Household","operationId":"Account_SwitchRole","parameters":[{"name":"role","in":"query","description":"The user role","schema":{"$ref":"#/components/schemas/WebSiteUserRole"}}],"responses":{"200":{"description":"New role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSiteUserRole"}}}}}}},"/v03/api/accounts/certificate":{"post":{"tags":["Account"],"summary":"Issues a new X.509 certificate for the account in PFX (PKCS12) format for Microsoft / Windows systems.","operationId":"Account_CrudSaveCertificate","requestBody":{"description":"A certificate object containing title and password for the new certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}},"required":true},"responses":{"200":{"description":"The PFX certificate file containing public and private keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}}}}},"get":{"tags":["Account"],"summary":"Lists existing X.509 certificates for the account.","operationId":"Account_CrudListCertificates","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Certificate"}}}}}}}},"/v03/api/accounts/certificate/pem":{"post":{"tags":["Account"],"summary":"Issues a new certificate for the account and provides the certificate in PEM format.\r\nFor this method, also the Certificate Signing Request (CSR) may be passed in the certificate Text field.","operationId":"Account_IssuePemCertificate","requestBody":{"description":"A certificate object containing title for the new certificate.\r\nYou may also pass the Certificate Signing Request (CSR) in the Password field. In this case the private key is not returned by the method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}},"required":true},"responses":{"200":{"description":"PEM files in zip: crt (public key / certificate), key (private key) and (both in one pem file).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedCertificate"}}}}}}},"/v03/api/accounts/certificate/{id}":{"delete":{"tags":["Account"],"summary":"Revokes existing X.509 certificate from the account.","operationId":"Account_CrudDeleteCertificate","parameters":[{"name":"id","in":"path","description":"Certificate (thumbprint) to revoke.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns string: \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/authorizingAccount":{"get":{"tags":["Account"],"summary":"Lists all accounts on behalf of which this account has been authorized to act.","operationId":"Account_CrudListAuthorizingAccounts","responses":{"200":{"description":"Accounts that this account can act on behalf of.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountBase"}}}}}}}},"/v03/api/accounts/authorizingAccount/{id}":{"delete":{"tags":["Account"],"summary":"Deletes the account. Restricted to the test system only.","operationId":"Account_CrudDeleteAuthorizingAccount","parameters":[{"name":"id","in":"path","description":"Id of the account which should be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/authorizedAccount":{"get":{"tags":["Account"],"summary":"Lists all accounts to which this account has given authorizations.","operationId":"Account_CrudListAuthorizedAccounts","responses":{"200":{"description":"Accounts that can act on behalf of this account.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuthorizedAvatar"}}}}}}},"post":{"tags":["Account"],"summary":"Allow an account to act on behalf of this account.","operationId":"Account_CrudSaveAuthorizedAccount","requestBody":{"description":"Account who is authorized to act on behalf of this account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizedAvatar"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizedAvatar"}}}}}}},"/v03/api/accounts/authorizedAccount/{id}":{"delete":{"tags":["Account"],"summary":"Disallow an account to act on behalf of this account.","operationId":"Account_CrudDeleteAuthorizedAccount","parameters":[{"name":"id","in":"path","description":"Account who is no more authorized to act on behalf of this account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/credential":{"get":{"tags":["Account"],"summary":"Lists all credentials which can access to this account.","operationId":"Account_CrudListCredentials","responses":{"200":{"description":"Credentials that can access to this account.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionUserCredential"}}}}}}},"post":{"tags":["Account"],"summary":"Updates the credential.","operationId":"Account_CrudSaveCredential","requestBody":{"description":"Credential to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionUserCredential"}}},"required":true},"responses":{"200":{"description":"Updated credential.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionUserCredential"}}}}}}},"/v03/api/accounts/credential/{id}":{"delete":{"tags":["Account"],"summary":"Remove the credential linked to the account.","operationId":"Account_CrudDeleteCredential","parameters":[{"name":"id","in":"path","description":"Credential (id) to remove.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/credential/{id}/avatar":{"post":{"tags":["Account"],"summary":"Changes the avatar file for the credential, does not save the credential. It requires a separate save.","operationId":"Account_SaveCredentialFileById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"avatar":{"$ref":"#/components/schemas/IFormFile"}}}}},"required":true},"responses":{"200":{"description":"Credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionUserCredential"}}}}}}},"/v03/api/accounts/credential/avatar":{"post":{"tags":["Account"],"summary":"Changes the avatar file for the credential, does not save the credential. It requires a separate save.","operationId":"Account_SaveCredentialFile","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"avatar":{"$ref":"#/components/schemas/IFormFile"}}}}},"required":true},"responses":{"200":{"description":"Credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionUserCredential"}}}}}}},"/v03/api/accounts/workflows":{"get":{"tags":["Account"],"summary":"Returns workflow data for the given API object.","operationId":"Account_CrudGetWorkflow","responses":{"200":{"description":"Workflow data for the given API object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowData"}}}}}},"post":{"tags":["Account"],"summary":"Adds or updates workflow event for the given API object.","operationId":"Account_CrudSaveWorkflow","requestBody":{"description":"Event to add or update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowEvent"}}},"required":true},"responses":{"200":{"description":"Workflow data for the given API object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowData"}}}}}}},"/v03/api/accounts/workflows/events/{eventId}":{"get":{"tags":["Account"],"summary":"Returns workflow event for the given API object and event id.","operationId":"Account_CrudGetWorkflowEvent","parameters":[{"name":"eventId","in":"path","description":"Unique id for the event.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow data for the given API object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowEvent"}}}}}}},"/v03/api/accounts/workflows/{eventIdOrType}":{"delete":{"tags":["Account"],"summary":"Deletes the workflow event from the given API object.","operationId":"Account_CrudDeleteWorkflow","parameters":[{"name":"eventIdOrType","in":"path","description":"Id or type of the event to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\".","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/calculation/all":{"delete":{"tags":["AccountReset"],"summary":"Remove all calculations, payrolls and payments from the account.","operationId":"AccountReset_CrudDeleteCalculations","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/invoice":{"delete":{"tags":["AccountReset"],"summary":"Remove invoices with business objects","operationId":"AccountReset_CrudDeleteInvoicesById","parameters":[{"name":"ids","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/worker/all":{"delete":{"tags":["AccountReset"],"summary":"Remove all workers from the account, including calculations, employment contracts and tax cards.","operationId":"AccountReset_CrudDeleteWorkers","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/holidays/all":{"delete":{"tags":["AccountReset"],"summary":"Remove all holiday years as well absences from all workers.\r\nDoes not touch the default values of holidays in Worker Employment relation.","operationId":"AccountReset_CrudDeleteHolidaysAndAbsences","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/authorizingAccount/all":{"delete":{"tags":["AccountReset"],"summary":"Delete all empty accounts (company or worker) created by this account.","operationId":"AccountReset_CrudDeleteAuthorizingAccounts","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/data/all":{"delete":{"tags":["AccountReset"],"summary":"Remove all calculations, workers etc. user objects except products and signature from the account.","operationId":"AccountReset_CrudDeleteData","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/product/pensionAndInsurance":{"delete":{"tags":["AccountReset"],"summary":"Remove pension and insurance from the account.","operationId":"AccountReset_CrudDeletePensionAndInsurance","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/product/all":{"delete":{"tags":["AccountReset"],"summary":"Remove all products from the account.","operationId":"AccountReset_CrudDeleteProducts","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/signature":{"delete":{"tags":["AccountReset"],"summary":"Remove the signature from the account.","operationId":"AccountReset_CrudDeleteSignature","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/current":{"delete":{"tags":["AccountReset"],"summary":"Delete the account completely including credentials and Auth0 user.","operationId":"AccountReset_CrudDeleteCurrent","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounts/sso-demo/create-certificate":{"post":{"tags":["AccountReset"],"summary":"For the purposes of Single Sign-On Demo, creates a certificate.","operationId":"AccountReset_SsoCreateCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssertionDemoCertificateRequest"}}},"required":true},"responses":{"200":{"description":"\"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssertionDemoCertificateResponse"}}}}}}},"/v03/api/accounts/kyc":{"delete":{"tags":["AccountReset"],"summary":"Removes the kyc.","operationId":"AccountReset_DeleteCurrentAccountKyc","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"tags":["AccountReset"],"summary":"Removes the kyc.","operationId":"AccountReset_AddCurrentAccountKyc","responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBase"}}}}}}},"/v03/api/partner-services/varma/pension/new":{"get":{"tags":["InsuranceServices"],"summary":"Factory method that creates a new Varma pension order.","operationId":"InsuranceServices_CrudVarmaPensionOrderGetNew","responses":{"200":{"description":"A new Varma pension order with default values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VarmaPensionOrder"}}}}}}},"/v03/api/partner-services/varma/pension/validate":{"post":{"tags":["InsuranceServices"],"summary":"Validates the Varma pension order.","operationId":"InsuranceServices_ValidateVarmaPensionOrder","requestBody":{"description":"The Varma pension order to validate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VarmaPensionOrder"}}},"required":true},"responses":{"200":{"description":"The Varma pension order with validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VarmaPensionOrder"}}}}}}},"/v03/api/partner-services/varma/pension/order":{"post":{"tags":["InsuranceServices"],"summary":"Sends the Varma pension order.","operationId":"InsuranceServices_SendVarmaPensionOrder","requestBody":{"description":"The Varma pension order to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VarmaPensionOrder"}}},"required":true},"responses":{"200":{"description":"The sent Varma pension order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VarmaPensionOrder"}}}}}}},"/v03/api/partner-services/local-tapiola/insurance/new":{"get":{"tags":["InsuranceServices"],"summary":"Factory method that creates a new Local Tapiola insurance order.","operationId":"InsuranceServices_CrudLocalTapiolaInsuranceOrderCreateNew","responses":{"200":{"description":"A new order with default values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalTapiolaInsuranceOrder"}}}}}}},"/v03/api/partner-services/local-tapiola/insurance/validate":{"post":{"tags":["InsuranceServices"],"summary":"Validates the Local Tapiola insurance order.","operationId":"InsuranceServices_CrudLocalTapiolaInsuranceOrderValidate","requestBody":{"description":"The Local Tapiola insurance to validate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalTapiolaInsuranceOrder"}}},"required":true},"responses":{"200":{"description":"The Local Tapiola insurance order with validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalTapiolaInsuranceOrder"}}}}}}},"/v03/api/partner-services/local-tapiola/insurance/order":{"post":{"tags":["InsuranceServices"],"summary":"Sends the Local Tapiola insurance order.","operationId":"InsuranceServices_CrudLocalTapiolaInsuranceOrderSave","requestBody":{"description":"The Local Tapiola insurance order to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalTapiolaInsuranceOrder"}}},"required":true},"responses":{"200":{"description":"The sent Local Tapiola insurance order .","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalTapiolaInsuranceOrder"}}}}}}},"/v03/api/onboarding/{id}":{"get":{"tags":["OnboardingApi"],"summary":"Gets a single Onboarding object based on identier","operationId":"OnboardingApi_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}}}}},"delete":{"tags":["OnboardingApi"],"summary":"Deletes an Onboarding object from the storage. The for onboarding of any type.","operationId":"OnboardingApi_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/onboarding/account/{accountId}":{"get":{"tags":["OnboardingApi"],"summary":"Gets an existing onboarding object for given authorizing account.","operationId":"OnboardingApi_CrudGetForAccount","parameters":[{"name":"accountId","in":"path","description":"Account id of the authorizing account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}}}}}},"/v03/api/onboarding/new":{"get":{"tags":["OnboardingApi"],"summary":"Factory method that creates a new Onboarding object","operationId":"OnboardingApi_CrudGetNew","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}}}}}},"/v03/api/onboarding":{"post":{"tags":["OnboardingApi"],"summary":"Creates or updates an Onboarding object.","operationId":"OnboardingApi_CrudSave","requestBody":{"description":"The Onboarding object that is updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}}}}}},"/v03/api/onboarding/commit":{"post":{"tags":["OnboardingApi"],"summary":"Commits the onboarding object and creates/changes the account.","operationId":"OnboardingApi_Commit","requestBody":{"description":"The Onboarding object that is committed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}},"required":true},"responses":{"200":{"description":"Created/changed account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}}}}}},"/v03/api/onboarding/contract":{"post":{"tags":["OnboardingApi"],"summary":"Accept the contact between SPL and the customer.","operationId":"OnboardingApi_AcceptContract","requestBody":{"description":"Contract for acceptance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationContract"}}},"required":true},"responses":{"200":{"description":"Contract details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationContract"}}}}}},"get":{"tags":["OnboardingApi"],"summary":"Returns the contract that the current account accepts on the signing page\r\n(workerContract for a worker; partnerContract or employerAuthorization for a company), whether it already has a valid contract,\r\nand whether the parent account's missing or expired IR certificate stops the acceptance.","operationId":"OnboardingApi_GetContractToAccept","responses":{"200":{"description":"Contract type to accept, whether the account has a valid contract, and the certificate gate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractToAccept"}}}}}}},"/v03/api/partner/company":{"post":{"tags":["Partner"],"summary":"TRUSTED PARTNERS: Gets the public company account information if account has already been created \r\nfor the company official Id (Y-tunnus in Finnish).\r\nIf the account does not exist, an account stub is created based on the official Id.\r\nIn production, this method is available to trusted partners only.\r\nNOTE: This method cannot be called with Partner's own Company ID (as of 07/2019) to assure access to partners own account. \r\nThis would be a security risk in some partner scenarios and the action does not make sense: Just use the partner account directly.","operationId":"Partner_AssureCompanyAccount","parameters":[{"name":"checkAuthorizationOnly","in":"query","description":"Does not create a new company, but checks the authorization for the given company.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssureCompanyAccountRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCompanyAccountInfo"}}}}}}},"/v03/api/partner/assureworker":{"post":{"tags":["Partner"],"summary":"TRUSTED PARTNERS: Assures that there is a Worker account to which Salaxy can pay salaries.\r\nIf the account does not exist, an account stub is created based on the official Id.\r\nIn production, this method is available to trusted partners only.","operationId":"Partner_AssureWorkerAccount","parameters":[{"name":"officialId","in":"query","description":"Social security number for the person: Henkilötunnus, HETU in Finnish","schema":{"type":"string"}},{"name":"firstName","in":"query","description":"First name of the person","schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Last name of the person","schema":{"type":"string"}},{"name":"email","in":"query","description":"Contact e-mail","schema":{"type":"string"}},{"name":"telephone","in":"query","description":"Telephone number for the contact person","schema":{"type":"string"}},{"name":"bankAccountIban","in":"query","description":"Optional bank account IBAN number.","schema":{"type":"string"}},{"name":"bankAccountBic","in":"query","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Optinal start date of the employment relation.","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"Optinal end date of the employment relation.","schema":{"type":"string","format":"date-time"}},{"name":"language","in":"query","description":"Language preference.","schema":{"default":"default","$ref":"#/components/schemas/Language"}}],"responses":{"200":{"description":"New or existing Worker account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerAccount"}}}}}}},"/v03/api/partner/assureworker/{id}":{"post":{"tags":["Partner"],"summary":"TRUSTED PARTNERS: Assures that there is a Worker account to which Salaxy can pay salaries.\r\nIf the account does not exist, an account stub is created based on the existing employer created worker.\r\nIn production, this method is available to trusted partners only.","operationId":"Partner_AssureWorkerAccountById","parameters":[{"name":"id","in":"path","description":"ID of the employer created worker.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"New or existing Worker account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerAccount"}}}}}}},"/v03/api/partner/clear/{partnerId}":{"post":{"tags":["Partner"],"summary":"Clears partner data.","operationId":"Partner_ClearPartnerData","parameters":[{"name":"partnerId","in":"path","description":"Partner id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/v03/api/reports/type/{type}":{"get":{"tags":["Reports"],"summary":"Gets all the generated reports of specific type for this user.","operationId":"Reports_CrudList","parameters":[{"name":"type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}}],"responses":{"200":{"description":"The metadata for reports of specified type","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Report"}}}}}}}},"/v03/api/reports/type/{type}/{id}":{"get":{"tags":["Reports"],"summary":"Gets a single report by type and id for this user.","operationId":"Reports_CrudGet","parameters":[{"name":"type","in":"path","description":"Report type.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"id","in":"path","description":"Report id.","required":true,"schema":{"type":"string"}},{"name":"wait","in":"query","description":"Optional flag to indicate, whether to wait for the report to be generated.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The metadata for the report.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Report"}}}}}}}},"/v03/api/reports/assure/{type}":{"get":{"tags":["Reports"],"summary":"Assures that the report (pdf) exists for given calculations (ids).","operationId":"Reports_Assure","parameters":[{"name":"type","in":"path","description":"Calculation report type.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"ids","in":"query","description":"Ids for calculations.","schema":{"type":"array","items":{"type":"string"}}},{"name":"language","in":"query","description":"Language for the report.","schema":{"$ref":"#/components/schemas/Language"}}],"responses":{"200":{"description":"The id of the report.","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"tags":["Reports"],"summary":"Assures that the report (pdf) exists for given calculations.","operationId":"Reports_AssurePost","parameters":[{"name":"type","in":"path","description":"Calculation report type.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"language","in":"query","description":"Language for the report.","schema":{"$ref":"#/components/schemas/Language"}}],"requestBody":{"description":"Calculations.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportingCalculation"}}}},"required":true},"responses":{"200":{"description":"The id of the report.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/reports/assure-pdf/{type}":{"get":{"tags":["Reports"],"summary":"Assures that the report (pdf) exists for given calculations (ids).","operationId":"Reports_AssurePdf","parameters":[{"name":"type","in":"path","description":"Calculation report type.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"ids","in":"query","description":"Ids for calculations.","schema":{"type":"array","items":{"type":"string"}}},{"name":"language","in":"query","description":"Language for the report.","schema":{"$ref":"#/components/schemas/Language"}},{"name":"disposition","in":"query","description":"Optional content disposition parameter (inline or attachment), if the response should be returned as file.","schema":{"type":"string"}}],"responses":{"200":{"description":"The id of the report.","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}}},"post":{"tags":["Reports"],"summary":"Assures that the report (pdf) exists for given calculations.","operationId":"Reports_AssurePdfPost","parameters":[{"name":"type","in":"path","description":"Calculation report type.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"language","in":"query","description":"Language for the report.","schema":{"$ref":"#/components/schemas/Language"}},{"name":"disposition","in":"query","description":"Optional content disposition parameter (inline or attachment), if the response should be returned as file.","schema":{"type":"string"}},{"name":"watermark","in":"query","description":"Optional watermark text for the report. Value \"default\" will show the default language versioned watermark.","schema":{"type":"string"}}],"requestBody":{"description":"Calculations.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportingCalculation"}}}},"required":true},"responses":{"200":{"description":"The id of the report.","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}}}},"/v03/api/reports/pdf/{type}":{"post":{"tags":["Reports"],"summary":"Gets PDF reporst for the specified calculations.","operationId":"Reports_CreatePdf","parameters":[{"name":"type","in":"path","description":"The report type.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"language","in":"query","description":"The language for the report.","schema":{"$ref":"#/components/schemas/Language"}},{"name":"disposition","in":"query","description":"Optional content disposition parameter (inline or attachment), if the response should be returned as file.","schema":{"type":"string"}},{"name":"watermark","in":"query","description":"Optional watermark text for the report. Value \"default\" will show the default language versioned watermark.","schema":{"type":"string"}}],"requestBody":{"description":"The calculations for which the report will be generated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingCalculationCollection"}}},"required":true},"responses":{"200":{"description":"The generated PDF report."}}}},"/v03/api/reports/accounting/{refDate}":{"get":{"tags":["Reports"],"summary":"Gets the monthly / yearly accounting data.","operationId":"Reports_GetAccountingDataForPeriod","parameters":[{"name":"refDate","in":"path","description":"Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"target","in":"query","description":"Accounting target: contains default ruleset for creating accounting entries.","schema":{"type":"string"}},{"name":"periodType","in":"query","description":"Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month.","schema":{"default":"month","$ref":"#/components/schemas/PeriodType"}},{"name":"endDate","in":"query","description":"End date for the period. Required only for the custom period.","schema":{"type":"string","format":"date-time"}},{"name":"periodDateKind","in":"query","description":"Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date.","schema":{"$ref":"#/components/schemas/PeriodDateKind"}},{"name":"minStatus","in":"query","description":"Minimum status level for the calculations: draft-paymentStarted-paymentSucceeded. The default level is paymentSucceeded.","schema":{"$ref":"#/components/schemas/CalculationStatus"}},{"name":"createdFrom","in":"query","description":"Minimum creation date for the calculation included in the report.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Raw data for accounting purposes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingData"}}}}}}},"/v03/api/reports/accounting/{id}":{"get":{"tags":["Reports"],"summary":"Gets the accounting data from the saved report id.","operationId":"Reports_GetAccountingDataById","parameters":[{"name":"id","in":"path","description":"Saved accounting data file id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"target","in":"query","description":"Accounting target: contains default ruleset for creating accounting entries.","schema":{"type":"string"}}],"responses":{"200":{"description":"Account report based on the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingData"}}}}}}},"/v03/api/reports/accounting":{"get":{"tags":["Reports"],"summary":"Gets the accounting data based on given set of calculations.","operationId":"Reports_GetAccountingData","parameters":[{"name":"calculationIds","in":"query","description":"Calculations that are the bases for the report.","schema":{"type":"array","items":{"type":"string"}}},{"name":"target","in":"query","description":"Accounting target: contains default ruleset for creating accounting entries.","schema":{"type":"string"}}],"responses":{"200":{"description":"Account report based on the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingData"}}}}}},"post":{"tags":["Reports"],"summary":"Gets the accounting data based on given set of calculations.\r\nThis method can be accessed anonymously for testing / development purposes.\r\nIn this case, last valid calculation employer is set as employer avatar, but other employer information is not filled in.","operationId":"Reports_GetAccountingDataPost","parameters":[{"name":"target","in":"query","description":"Accounting target: contains default ruleset for creating accounting entries.","schema":{"type":"string"}}],"requestBody":{"description":"Calculations that are the bases for the report.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportingCalculation"}}}},"required":true},"responses":{"200":{"description":"Account report based on the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingData"}}}}}}},"/v03/api/reports/accounting/{refDate}/holiday-pay-debt":{"get":{"tags":["Reports"],"summary":"Gets the accounting data for the holiday pay debt.","operationId":"Reports_GetAccountingDataForHolidayPayDebt","parameters":[{"name":"refDate","in":"path","description":"Last month to include in the report. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"target","in":"query","description":"Accounting target: contains default ruleset for creating accounting entries.","schema":{"type":"string"}},{"name":"employmentIds","in":"query","description":"Employment relations for which to get the holiday debt. If not given, all employment relations are incluced.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fromHolidayYear","in":"query","description":"Return debt only starting from the given year.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The accounting data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingData"}}}}}}},"/v03/api/reports/accounting/{refDate}/close":{"post":{"tags":["Reports"],"summary":"Closes the accounting period (month).","operationId":"Reports_CloseAccountingPeriod","parameters":[{"name":"refDate","in":"path","description":"Date for the period. The first date of the month.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"option","in":"query","description":"Option for closing the period. Currently only default -option supporte.","schema":{"default":"default","$ref":"#/components/schemas/AccountingPeriodClosingOption"}}],"responses":{"200":{"description":"The id of the accounting report for the period.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/reports/validate/payCertificate/{id}":{"get":{"tags":["Reports"],"summary":"Validates the request for pay certificate.","operationId":"Reports_ValidatePayCertificate","parameters":[{"name":"id","in":"path","description":"Worker ID.","required":true,"schema":{"type":"string"}},{"name":"calculationIds","in":"query","description":"IDs of the calculations selected for the period.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"ApiValidation object with possible issue descriptions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiValidation"}}}}}}},"/v03/api/reports/validate/pay-certificate/{id}":{"get":{"tags":["Reports"],"summary":"Validates the request for pay certificate.","operationId":"Reports_ValidatePayCertificatePayCertificate","parameters":[{"name":"id","in":"path","description":"Worker ID.","required":true,"schema":{"type":"string"}},{"name":"calculationIds","in":"query","description":"IDs of the calculations selected for the period.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"ApiValidation object with possible issue descriptions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiValidation"}}}}}}},"/v03/api/reports/calculation/{refDate}":{"get":{"tags":["Reports"],"summary":"Returns the raw data for the calculation based reports.","operationId":"Reports_GetCalculationReportDataForPeriod","parameters":[{"name":"refDate","in":"path","description":"Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodType","in":"query","description":"Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month.","schema":{"default":"month","$ref":"#/components/schemas/PeriodType"}},{"name":"endDate","in":"query","description":"End date for the period. Required only for the custom period.","schema":{"type":"string","format":"date-time"}},{"name":"periodDateKind","in":"query","description":"Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date.","schema":{"$ref":"#/components/schemas/PeriodDateKind"}},{"name":"workers","in":"query","description":"List of workers (by official id) to include in the report.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Raw data for cumulative reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculationReportData"}}}}}}},"/v03/api/reports/calculation":{"get":{"tags":["Reports"],"summary":"Returns the raw data for cumulative reports calculated from given set of calculations.","operationId":"Reports_GetCalculationReportData","parameters":[{"name":"calculationIds","in":"query","description":"Calculations that are the bases for the report.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Raw data for cumulative reports calculated fron the given set of the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculationReportData"}}}}}}},"/v03/api/reports/table/{type}":{"post":{"tags":["Reports"],"summary":"Returns tabular report data (rows + column metadata) for AG Grid.","operationId":"Reports_GetTableReportData","parameters":[{"name":"type","in":"path","description":"Report type.","required":true,"schema":{"$ref":"#/components/schemas/TableReportType"}}],"requestBody":{"description":"Query parameters. Applicable parameters depend on the report type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportQuery"}}},"required":true},"responses":{"200":{"description":"Report rows and column metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportData"}}}}}}},"/v03/api/reports/accountingRow/{refDate}":{"get":{"tags":["Reports"],"summary":"Returns the raw data for the accounting row reports.","operationId":"Reports_GetAccountingRowReportDataForPeriod","parameters":[{"name":"refDate","in":"path","description":"Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodType","in":"query","description":"Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month.","schema":{"default":"month","$ref":"#/components/schemas/PeriodType"}},{"name":"endDate","in":"query","description":"End date for the period. Required only for the custom period.","schema":{"type":"string","format":"date-time"}},{"name":"periodDateKind","in":"query","description":"Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date.","schema":{"$ref":"#/components/schemas/PeriodDateKind"}},{"name":"workers","in":"query","description":"List of workers (by official id) to include in the report.","schema":{"type":"array","items":{"type":"string"}}},{"name":"createdFrom","in":"query","description":"Minimum creation date for the calculation included in the report.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Raw data for row reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingRowReportData"}}}}}}},"/v03/api/reports/accounting-row/{refDate}":{"get":{"tags":["Reports"],"summary":"Returns the raw data for the accounting row reports.","operationId":"Reports_GetAccountingRowReportDataForPeriodAccountingRow","parameters":[{"name":"refDate","in":"path","description":"Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodType","in":"query","description":"Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month.","schema":{"default":"month","$ref":"#/components/schemas/PeriodType"}},{"name":"endDate","in":"query","description":"End date for the period. Required only for the custom period.","schema":{"type":"string","format":"date-time"}},{"name":"periodDateKind","in":"query","description":"Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date.","schema":{"$ref":"#/components/schemas/PeriodDateKind"}},{"name":"workers","in":"query","description":"List of workers (by official id) to include in the report.","schema":{"type":"array","items":{"type":"string"}}},{"name":"createdFrom","in":"query","description":"Minimum creation date for the calculation included in the report.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Raw data for row reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingRowReportData"}}}}}}},"/v03/api/reports/accountingRow":{"get":{"tags":["Reports"],"summary":"Returns the raw data for row reports calculated from given set of calculations.","operationId":"Reports_GetAccountingRowReportData","parameters":[{"name":"calculationIds","in":"query","description":"Calculations that are the bases for the report.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Raw data for row reports calculated fron the given set of the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingRowReportData"}}}}}}},"/v03/api/reports/accounting-row":{"get":{"tags":["Reports"],"summary":"Returns the raw data for row reports calculated from given set of calculations.","operationId":"Reports_GetAccountingRowReportDataAccountingRow","parameters":[{"name":"calculationIds","in":"query","description":"Calculations that are the bases for the report.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Raw data for row reports calculated fron the given set of the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingRowReportData"}}}}}}},"/v03/api/reports/holiday-pay-debt/{refDate}":{"get":{"tags":["Reports"],"summary":"Returns the holiday pay debt data report based on given employments.","operationId":"Reports_GetAccountingHolidayPayDebtReportData","parameters":[{"name":"refDate","in":"path","description":"Last month to include in the report. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"employmentIds","in":"query","description":"Employment relations for which to get the holiday debt. If not given, all employment relations are incluced.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The holiday pay debt data report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingHolidayPayDebtReportData"}}}}}}},"/v03/api/reports/summary/{refDate}":{"get":{"tags":["Reports"],"summary":"Returns the raw data for the summary reports.","operationId":"Reports_GetSummaryReportDataForPeriod","parameters":[{"name":"refDate","in":"path","description":"Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodType","in":"query","description":"Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month.","schema":{"default":"month","$ref":"#/components/schemas/PeriodType"}},{"name":"endDate","in":"query","description":"End date for the period. Required only for the custom period.","schema":{"type":"string","format":"date-time"}},{"name":"periodDateKind","in":"query","description":"Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is PaidAt date.","schema":{"$ref":"#/components/schemas/PeriodDateKind"}},{"name":"workers","in":"query","description":"List of workers (by official id) to include in the report.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Raw data for summary reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummaryReportData"}}}}}}},"/v03/api/reports/summary":{"get":{"tags":["Reports"],"summary":"Returns the raw data for the summary reports.","operationId":"Reports_GetSummaryReportData","parameters":[{"name":"calculationIds","in":"query","description":"Calculations that are the bases for the report.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Raw data for summary reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummaryReportData"}}}}}}},"/v03/api/reports/summary/{refDate}/{workerId}/{employerId}":{"get":{"tags":["Reports"],"summary":"Returns the raw data for the worker summary reports.","operationId":"Reports_GetWorkerSummaryReportDataForPeriod","parameters":[{"name":"refDate","in":"path","description":"Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"workerId","in":"path","description":"Worker id or keyword \"self\" to get the WorkerCopies for the current account instead. Please note that ID can be social security number or workers technical id.","required":true,"schema":{"type":"string"}},{"name":"employerId","in":"path","description":"Employer id. If null, first employer report will be returned.","required":true,"schema":{"type":"string"}},{"name":"periodType","in":"query","description":"Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month.","schema":{"default":"month","$ref":"#/components/schemas/PeriodType"}},{"name":"endDate","in":"query","description":"End date for the period. Required only for the custom period.","schema":{"type":"string","format":"date-time"}},{"name":"periodDateKind","in":"query","description":"Date kind for the period: either PaidAt date (paid by employer) or Salary date (paid to worker). The default is Salary date.","schema":{"$ref":"#/components/schemas/PeriodDateKind"}}],"responses":{"200":{"description":"Raw data for summary reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerSummaryReportData"}}}}}}},"/v03/api/reports/cumulative-calculation/{id}":{"get":{"tags":["Reports"],"summary":"Returns the calculation with cumulative data.\r\nPlease note that the cumulative data is calculated from several calculations preceding the the calculation.","operationId":"Reports_GetCumulativeCalculation","parameters":[{"name":"id","in":"path","description":"The calculation for which the cumulative report is created for.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Calculation with cumulative data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CumulativeCalculation"}}}}}}},"/v03/api/reports/pay-stats/{employmentId}":{"get":{"tags":["Reports"],"summary":"Returns the calculated pay statistics for the given employment relation.","operationId":"Reports_GetPayStatsCalculationReportDataObsolete","parameters":[{"name":"employmentId","in":"path","description":"The employment relation for which to calculate the statistics values.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The pay stats calculation report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayStatsCalculationReportData"}}}}}}},"/v03/api/reports/pay-stats-calc/{employmentId}":{"get":{"tags":["Reports"],"summary":"Returns the calculated pay statistics for the given employment relation.","operationId":"Reports_GetPayStatsCalculationReportData","parameters":[{"name":"employmentId","in":"path","description":"The employment relation for which to calculate the statistics values.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The pay stats calculation report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayStatsCalculationReportData"}}}}}}},"/v03/api/reports/data/accounting/{tableType}/{refDate}":{"get":{"tags":["Reports"],"summary":"Gets the monthly / yearly accounting data.","operationId":"Reports_GetAccountingReportTable_ObsoleteByRefDate","parameters":[{"name":"refDate","in":"path","description":"Reference date for the period. Please note that even if the date is not the first day of the given period, the entire period is returned.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"tableType","in":"path","description":"Accounting report table type.","required":true,"schema":{"$ref":"#/components/schemas/AccountingReportTableType"}},{"name":"periodType","in":"query","description":"Month, quarter, year or a custom period. The custom period requires endDate. Default value is the month.","schema":{"default":"month","$ref":"#/components/schemas/PeriodType"}},{"name":"endDate","in":"query","description":"End date for the period. Required only for the custom period.","schema":{"type":"string","format":"date-time"}},{"name":"minStatus","in":"query","description":"Minimum status level for the calculations: draft-paymentStarted-paymentSucceeded. The default level is paymentSucceeded.","schema":{"$ref":"#/components/schemas/CalculationStatus"}},{"name":"createdFrom","in":"query","description":"Minimum creation date for the calculation included in the report.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Raw data for accounting purposes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingReportTable"}}}}}}},"/v03/api/reports/data/accounting/{tableType}":{"get":{"tags":["Reports"],"summary":"Gets the accounting report based on given set of calculations.","operationId":"Reports_GetAccountingReportTable_Obsolete","parameters":[{"name":"calculationIds","in":"query","description":"Calculations that are the bases for the report.","schema":{"type":"array","items":{"type":"string"}}},{"name":"tableType","in":"path","description":"Accounting report table type.","required":true,"schema":{"$ref":"#/components/schemas/AccountingReportTableType"}}],"responses":{"200":{"description":"Account report based on the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingReportTable"}}}}}},"post":{"tags":["Reports"],"summary":"Gets the accounting report based on given set of calculations.\r\nThis method can be accessed anonymously for testing / development purposes.\r\nIn this case, last valid calculation employer is set as employer avatar, but other employer information is not filled in.","operationId":"Reports_GetAccountingReportTable_ObsoletePost","parameters":[{"name":"tableType","in":"path","description":"Accounting report table type.","required":true,"schema":{"$ref":"#/components/schemas/AccountingReportTableType"}}],"requestBody":{"description":"Calculations that are the bases for the report.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportingCalculation"}}}},"required":true},"responses":{"200":{"description":"Account report based on the calculations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingReportTable"}}}}}}},"/v03/api/session/isAuthorized":{"get":{"tags":["Session"],"summary":"Checks whether the current browser session is authorized:\r\nThis means that there is both UserCredential and valid CurrentAccount","operationId":"Session_IsAuthorized","responses":{"200":{"description":"True if the user has a valid session.","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/v03/api/session/current":{"get":{"tags":["Session"],"summary":"Gets the current session information - even if the user is not yet authorized.\r\nCheck for IsAuthorized or HasCredential to see if the user can perform operations.","operationId":"Session_GetSession","responses":{"200":{"description":"The Authorization object that provides information about the current session. Null, if there is no session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSession"}}}}}}},"/v03/api/absences":{"get":{"tags":["Absences"],"summary":"Performs an OData query to the search index.","operationId":"Absences_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfApiListItem"}}}}}},"post":{"tags":["Absences"],"summary":"Updates or creates a new object","operationId":"Absences_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerAbsences"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerAbsences"}}}}}}},"/v03/api/absences/{id}":{"get":{"tags":["Absences"],"summary":"Gets a single object based on identier","operationId":"Absences_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerAbsences"}}}}}},"delete":{"tags":["Absences"],"summary":"Deletes a Absences object from the storage","operationId":"Absences_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/absences/new":{"get":{"tags":["Absences"],"summary":"Factory method that creates a new object","operationId":"Absences_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerAbsences"}}}}}}},"/v03/api/absences/latest":{"get":{"tags":["Absences"],"summary":"Gets latest Absences objects.","operationId":"Absences_GetLatest","responses":{"200":{"description":"Array of found objects or an empty array if objects not found.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerAbsences"}}}}}}}},"/v03/api/absences/employment/{employmentId}":{"get":{"tags":["Absences"],"summary":"Gets the Absences object for a specific Employment relation.","operationId":"Absences_EmploymentListByEmploymentId","parameters":[{"name":"employmentId","in":"path","description":"The employment relation for which to list the Absences.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of Absences objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerAbsences"}}}}}}},"/v03/api/absences/employment/set":{"get":{"tags":["Absences"],"summary":"Returns Absences objects for given Employment relations.","operationId":"Absences_EmploymentList","parameters":[{"name":"employmentIds","in":"query","description":"Set of employmentIds for which to get the Absences objects.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Array of found objects or an empty array if objects not found.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerAbsences"}}}}}}}},"/v03/api/files":{"get":{"tags":["File"],"summary":"Returns list of files for the current owner.","operationId":"File_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfFileListItem"}}}}}}},"/v03/api/files/{id}":{"get":{"tags":["File"],"summary":"Gets a single object based on identier","operationId":"File_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Blob file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlobFile"}}}}}}},"/v03/api/files/{id}/content":{"get":{"tags":["File"],"summary":"Gets the content for a single file.","operationId":"File_GetContent","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file content as bytes","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}}}},"/v03/api/files/type/{type}":{"get":{"tags":["File"],"summary":"Gets all the Files of specific type for this user.","operationId":"File_CrudList","parameters":[{"name":"type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/BlobFileType"}}],"responses":{"200":{"description":"The metadata for all files of specified type","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlobFile"}}}}}}}},"/v03/api/files/{id}/stream":{"get":{"tags":["File"],"summary":"Gets the file stream / blob for a single file","operationId":"File_GetStream","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file stream","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}}}},"/v03/api/files/{id}/preview":{"get":{"tags":["File"],"summary":"Gets the preview image (currently always PNG) for the file, if available.","operationId":"File_GetPreview","parameters":[{"name":"id","in":"path","description":"Identifier of the file that potentially has preview","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file stream of the preview PNG.","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}}}}},"/v03/api/holidays":{"get":{"tags":["HolidayYears"],"summary":"Performs an OData query to the search index.","operationId":"HolidayYears_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfHolidayYearListItem"}}}}}},"post":{"tags":["HolidayYears"],"summary":"Updates or creates a new object","operationId":"HolidayYears_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidayYear"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidayYear"}}}}}}},"/v03/api/holidays/{id}":{"get":{"tags":["HolidayYears"],"summary":"Gets a single object based on identier","operationId":"HolidayYears_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidayYear"}}}}}},"delete":{"tags":["HolidayYears"],"summary":"Deletes an object from the storage","operationId":"HolidayYears_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/holidays/new":{"get":{"tags":["HolidayYears"],"summary":"Factory method that creates a new object","operationId":"HolidayYears_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidayYear"}}}}}}},"/v03/api/holidays/year/{year}":{"get":{"tags":["HolidayYears"],"summary":"Gets all the Holiday Year objects of specified year.","operationId":"HolidayYears_AllForYear","parameters":[{"name":"year","in":"path","description":"The holiday year to filter","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The full holiday year objects.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidayYear"}}}}}}}},"/v03/api/holidays/year/all":{"get":{"tags":["HolidayYears"],"summary":"Gets all the Holiday Year objects.","operationId":"HolidayYears_All","responses":{"200":{"description":"The full holiday year objects.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidayYear"}}}}}}}},"/v03/api/holidays/employment/{employmentId}":{"post":{"tags":["HolidayYears"],"summary":"Initializes the missing holiday years for an employment relation.","operationId":"HolidayYears_InitHolidaysForEmploymentId","parameters":[{"name":"employmentId","in":"path","description":"Identifier of the Employment relation that stores the holiday specification.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The holiday specification tht should be used for inititalization.\r\nThe spec is also stored to the Employment relation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaySpecificationForYear"}}},"required":true},"responses":{"200":{"description":"Holiday years for this employment relation - as initialized.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidayYear"}}}}}}},"get":{"tags":["HolidayYears"],"summary":"Gets the Holiday Year objects for a specific Employment relation.","operationId":"HolidayYears_EmploymentListByEmploymentId","parameters":[{"name":"employmentId","in":"path","description":"The employment relation for which to list the Holiday Years.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of Holiday Year objects.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidayYear"}}}}}}}},"/v03/api/holidays/employment/{employmentId}/default-spec":{"get":{"tags":["HolidayYears"],"summary":"Gets a default holiday specification based on employment relation information.\r\nThis is presented to the user before calling InitHolidaysForEmploymentId().","operationId":"HolidayYears_GetDefaultSpecForEmploymentId","parameters":[{"name":"employmentId","in":"path","description":"The employment relation ID from which the defaults are fetched.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Holiday specification that can be used for inititalization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaySpecificationForYear"}}}}}}},"/v03/api/holidays/employment/{employmentId}/available-holiday-accruals":{"get":{"tags":["HolidayYears"],"summary":"Returns current remaining accrued holiday days and bonuses.","operationId":"HolidayYears_GetAvailableHolidayAccruals","parameters":[{"name":"employmentId","in":"path","description":"The employment relation ID from which the accruals are fetched.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The current remaining accrued holiday days and bonuses.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false}}}}}}}},"/v03/api/holidays/employment/set":{"get":{"tags":["HolidayYears"],"summary":"Returns Holiday Year objects for given Employment relations.","operationId":"HolidayYears_EmploymentList","parameters":[{"name":"employmentIds","in":"query","description":"Set of employmentIds for which to get the Holiday Year objects.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Array of found objects or an empty array if objects not found.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidayYear"}}}}}}}},"/v03/api/holidays/year/{year}/{employmentId}/holiday-pay-calc":{"get":{"tags":["HolidayYears"],"summary":"Returns the holiday pay calculation report for the given employment relation and holiday year.","operationId":"HolidayYears_GetHolidayPayCalcReportData","parameters":[{"name":"year","in":"path","description":"The holiday year for the calculation.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"employmentId","in":"path","description":"The employment relation for which to list the Holiday Years.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The holiday pay calculation report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidayPayCalculationReportData"}}}}}}},"/v03/api/holidays/year/{year}/{employmentId}/holiday-pay/recalculate":{"post":{"tags":["HolidayYears"],"summary":"Recalculates holiday pay for the given employment relation and holiday year.","operationId":"HolidayYears_RecalculateEmploymentHolidayPay","parameters":[{"name":"year","in":"path","description":"Holiday year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"employmentId","in":"path","description":"Employment relation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The recalculated holiday year","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidayYear"}}}}}}},"/v03/api/holidays/year/{year}/holiday-pay/recalculate":{"post":{"tags":["HolidayYears"],"summary":"Recalculates holiday pay for all employment relations for the given holiday year.","operationId":"HolidayYears_RecalculateHolidayPay","parameters":[{"name":"year","in":"path","description":"Holiday year","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Boolean indicating that the job for calculations has started.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidayYear"}}}}}}}},"/v03/api/invoices":{"get":{"tags":["Invoice"],"summary":"Returns list of invoices for the current owner.","operationId":"Invoice_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfInvoiceListItem"}}}}}}},"/v03/api/invoices/{id}":{"get":{"tags":["Invoice"],"summary":"Gets a single invoice. based on identier.","operationId":"Invoice_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Invoice without pdf content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}}},"delete":{"tags":["Invoice"],"summary":"Deletes an object from the storage","operationId":"Invoice_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/invoices/{id}/content":{"get":{"tags":["Invoice"],"summary":"Downloads the pdf file for the invoice.","operationId":"Invoice_ContentGetById","parameters":[{"name":"id","in":"path","description":"The id of the invoice.","required":true,"schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/invoices/content":{"post":{"tags":["Invoice"],"summary":"Downloads the pdf file for the invoice.","operationId":"Invoice_Content","parameters":[{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The invoice for the pdf.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/v03/api/invoices/sepa":{"get":{"tags":["Invoice"],"summary":"Downloads the sepa file for the posted ids.","operationId":"Invoice_Sepa","parameters":[{"name":"ids","in":"query","description":"Ids of the invoices for the sepa payment.","schema":{"type":"array","items":{"type":"string"}}},{"name":"payerIbanNumber","in":"query","description":"Payer iban number.","schema":{"type":"string"}},{"name":"payerBic","in":"query","description":"Payer BIC.","schema":{"type":"string"}},{"name":"bankPartyId","in":"query","description":"Payer bank party id. Depends on the bank.","schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}},{"name":"version","in":"query","description":"ISO 20022 version, pain.001.001.02 (default) or pain.001.001.03","schema":{"type":"string","default":"pain.001.001.02"}}],"responses":{"200":{"description":"OK"}}},"post":{"tags":["Invoice"],"summary":"Downloads the sepa file for the posted invoices.","operationId":"Invoice_SepaPost","parameters":[{"name":"payerIbanNumber","in":"query","description":"Payer iban number.","schema":{"type":"string"}},{"name":"payerBic","in":"query","description":"Payer BIC.","schema":{"type":"string"}},{"name":"bankPartyId","in":"query","description":"Payer bank party id. Depends on the bank.","schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}},{"name":"version","in":"query","description":"ISO 20022 version, pain.001.001.02 (default) or pain.001.001.03","schema":{"type":"string","default":"pain.001.001.02"}}],"requestBody":{"description":"Invoices for the sepa payment.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/v03/api/invoices/{id}/finvoice":{"get":{"tags":["Invoice"],"summary":"Downloads the finvoice file for the invoice.","operationId":"Invoice_FinvoiceGetById","parameters":[{"name":"id","in":"path","description":"The id of the invoice.","required":true,"schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/invoices/finvoice":{"post":{"tags":["Invoice"],"summary":"Downloads the finvoice file for the invoice.","operationId":"Invoice_Finvoice","parameters":[{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachment.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The invoice for the finvoice.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/v03/api/invoices/create/{channel}":{"post":{"tags":["Invoice"],"summary":"Saves the calculation in its current state and creates invoices to pay a salary calculation.\r\nNote that if the calculation is already read-only, it will NOT be saved =&gt; Will be fetched from storage.","operationId":"Invoice_CreateInvoices","parameters":[{"name":"channel","in":"path","description":"Payment channel to use.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"excludePeriodicInvoices","in":"query","description":"If true, creates and returns calculation specific invoices immediately and creates periodic invoices in the background. The default option is false, all invoices are created immediately.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Calculation for which the invoices are created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Invoices which have been created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/invoices/create/{channel}/tax":{"post":{"tags":["Invoice"],"summary":"Creates/updates a tax invoice for the period.\r\nIf there is already a read-only tax invoice in the period, throws an error.","operationId":"Invoice_CreateTaxInvoice","parameters":[{"name":"channel","in":"path","description":"Payment channel to use.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"month","in":"query","description":"Month for the tax invoice.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Created/updated invoice.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}}}},"/v03/api/invoices/create/{channel}/union":{"post":{"tags":["Invoice"],"summary":"Creates/updates a union invoice for the period.\r\nIf there is already a read-only union invoice in the period, throws an error.","operationId":"Invoice_CreateUnionInvoice","parameters":[{"name":"channel","in":"path","description":"Payment channel to use.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"month","in":"query","description":"Month for the union invoice.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Created/updated invoice.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/invoices/create-by-id/{channel}":{"post":{"tags":["Invoice"],"summary":"Creates invoices to pay a salary calculation(s) that have already been stored in the database.","operationId":"Invoice_CreateInvoicesCreateById","parameters":[{"name":"channel","in":"path","description":"Payment channel to use.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"excludePeriodicInvoices","in":"query","description":"If true, creates and returns calculation specific invoices immediately and creates periodic invoices in the background. The default option is false, all invoices are created immediately.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"One or several identifiers of the Calculation for which the invoices are created.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Invoices which have been created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/invoices/create-for-payroll/{channel}/{payrollId}":{"post":{"tags":["Invoice"],"summary":"Creates invoices to pay a Payroll object that has already been stored in the database.","operationId":"Invoice_CreateInvoicesForPayroll","parameters":[{"name":"channel","in":"path","description":"Payment channel to use.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"payrollId","in":"path","description":"Identifier for the Payroll object.","required":true,"schema":{"type":"string"}},{"name":"excludePeriodicInvoices","in":"query","description":"If true, creates and returns calculation specific invoices immediately and creates periodic invoices in the background. The default option is false, all invoices are created immediately.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Invoices which have been created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/invoices/preview-and-created/{channel}":{"post":{"tags":["Invoice"],"summary":"Previews invoices to pay a salary calculation(s) and fetches the ones that have already been created.\r\nUsed for payment dialog preview: Does not yet save the invoices and does not do any other storage saves.","operationId":"Invoice_PreviewInvoices","parameters":[{"name":"channel","in":"path","description":"Channel to which the invoices are generated.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"excludePeriodicInvoices","in":"query","description":"If true, does not return periodic invoices. Only calculation specific invoices are returned.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The calculations for which the invoices are created as preview (not saved to storage).\r\nSpecified as ID's or unsaved Calculations or Payroll detail items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculationCollection"}}},"required":true},"responses":{"200":{"description":"Invoices (list item + metadata) which have been created for preview or that were previously created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePreview"}}}}}}}},"/v03/api/invoices/{id}/status/{status}":{"post":{"tags":["Invoice"],"summary":"Requests an update for the status of an invoice.","operationId":"Invoice_RequestStatusUpdatePost","parameters":[{"name":"id","in":"path","description":"Id of the invoice to update.","required":true,"schema":{"type":"string"}},{"name":"status","in":"path","description":"The requested status for the invoice.","required":true,"schema":{"$ref":"#/components/schemas/InvoiceStatus"}}],"responses":{"200":{"description":"The Invoice after the request. Please note that the actual payment channel may not process the request synchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}}},"get":{"tags":["Invoice"],"summary":"Requests an update for the status of an invoice.","operationId":"Invoice_RequestStatusUpdate","parameters":[{"name":"id","in":"path","description":"Id of the invoice to update.","required":true,"schema":{"type":"string"}},{"name":"status","in":"path","description":"The requested status for the invoice.","required":true,"schema":{"$ref":"#/components/schemas/InvoiceStatus"}}],"responses":{"200":{"description":"The Invoice after the request. Please note that the actual payment channel may not process the request synchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}}}},"/v03/api/invoices/{id}/einvoice":{"post":{"tags":["Invoice"],"summary":"Sends the invoice as einvoice.","operationId":"Invoice_SendAsEInvoice","parameters":[{"name":"id","in":"path","description":"Invoice id for which the einvoice should be generated and sent.","required":true,"schema":{"type":"string"}},{"name":"receiver","in":"query","description":"Receiver address (eivoice)","schema":{"type":"string"}},{"name":"intermediator","in":"query","description":"Intermediator address (einvoice)","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the delivery.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}}},"/v03/api/invoices/psd/accounts":{"get":{"tags":["Invoice"],"summary":"List current PSD accounts for the given bank.","operationId":"Invoice_GetPsdAccounts","parameters":[{"name":"bank","in":"query","description":"Selected bank.","schema":{"$ref":"#/components/schemas/Bank"}}],"responses":{"200":{"description":"List of accounts.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}}}}},"/v03/api/invoices/create/{channel}/{id}":{"post":{"tags":["Invoice"],"operationId":"Invoice_CreateInvoicesById","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/invoices/preview-for-payroll/{channel}/{payrollId}":{"post":{"tags":["Invoice"],"operationId":"Invoice_PreviewInvoicesForPayroll","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"payrollId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/invoices/preview/{channel}":{"post":{"tags":["Invoice"],"operationId":"Invoice_PreviewInvoicesOld","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/invoices/preview-by-id/{channel}":{"post":{"tags":["Invoice"],"operationId":"Invoice_PreviewInvoicesPreviewById","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/messages":{"get":{"tags":["MessageThread"],"summary":"Performs an OData query to the search index.","operationId":"MessageThread_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfMessageListItem"}}}}}},"post":{"tags":["MessageThread"],"summary":"Updates or creates a new object","operationId":"MessageThread_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}}},"/v03/api/messages/{id}":{"get":{"tags":["MessageThread"],"summary":"Gets a single object based on identier","operationId":"MessageThread_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}},"delete":{"tags":["MessageThread"],"summary":"Deletes an object from the storage","operationId":"MessageThread_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/messages/new":{"get":{"tags":["MessageThread"],"summary":"Factory method that creates a new object","operationId":"MessageThread_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}}},"/v03/api/messages/{id}/messages":{"post":{"tags":["MessageThread"],"summary":"Adds or modifies a message to the thread.","operationId":"MessageThread_AddMessage","parameters":[{"name":"id","in":"path","description":"Identifier of the thread","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The message to add or modify.\r\nIf date is not between thread CreatedAt and Now, it is set to Now.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}},"required":true},"responses":{"200":{"description":"The entire thread with the new text added and saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}}},"/v03/api/messages/{id}/files":{"post":{"tags":["MessageThread"],"summary":"Saves an attachment file as a message to the thread.","operationId":"MessageThread_AddBlobFileMessages","parameters":[{"name":"id","in":"path","description":"Message thread identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The entire thread","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}}},"/v03/api/messages/{id}/messages/blobFileMessage":{"post":{"tags":["MessageThread"],"summary":"Saves an attachment file as a message to the thread.","operationId":"MessageThread_AddBlobFileMessagesBlobFileMessage","parameters":[{"name":"id","in":"path","description":"Message thread identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The entire thread","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}}},"/v03/api/messages/{id}/read-by/{readBy}":{"post":{"tags":["MessageThread"],"summary":"Marks all messages as read by a given party","operationId":"MessageThread_MarkAsRead","parameters":[{"name":"id","in":"path","description":"Identifier of the thread","required":true,"schema":{"type":"string"}},{"name":"readBy","in":"path","description":"The party for which the messages are marked as read.","required":true,"schema":{"$ref":"#/components/schemas/MessageFrom"}}],"responses":{"200":{"description":"The entire thread with the messages marked as read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}}},"/v03/api/messages/{id}/notifications":{"post":{"tags":["MessageThread"],"summary":"Sends an email notification to the owner of the message.","operationId":"MessageThread_SendNotification","parameters":[{"name":"id","in":"path","description":"Message thread identifier.","required":true,"schema":{"type":"string"}},{"name":"subject","in":"query","description":"Subject for the notification.","schema":{"type":"string"}}],"requestBody":{"description":"Plain text content of the notification.","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Message thread where the notification has been added as a new message (as updated to the storage).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageThread"}}}}}}},"/v03/api/payment-channel/{channel}":{"get":{"tags":["PaymentChannel"],"summary":"Returns list of invoices for the payment channel using OData query and search.","operationId":"PaymentChannel_ODataSearch","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfInvoiceListItem"}}}}}},"post":{"tags":["PaymentChannel"],"summary":"Updates a single invoice in the payment channel.\r\nPlease note this is valid only in the test environment, and only very restricted set of changes are allowed.","operationId":"PaymentChannel_CrudSave","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}}],"requestBody":{"description":"Invoice to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"required":true},"responses":{"200":{"description":"Invoice without pdf content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}}}},"/v03/api/payment-channel/{channel}/{id}":{"get":{"tags":["PaymentChannel"],"summary":"Gets a single invoice in the payment channel.","operationId":"PaymentChannel_CrudGet","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Invoice without pdf content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}}},"delete":{"tags":["PaymentChannel"],"summary":"Deletes an object from the storage","operationId":"PaymentChannel_CrudDelete","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/payment-channel/{channel}/{id}/content":{"get":{"tags":["PaymentChannel"],"summary":"Downloads the pdf file for the single invoice.","operationId":"PaymentChannel_ContentById","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"The id of the invoice.","required":true,"schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition) in browser.\r\nIf false, the content is returned as an attachment (download, default).","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/payment-channel/{channel}/content":{"get":{"tags":["PaymentChannel"],"summary":"Downloads the pdf file for the invoices.","operationId":"PaymentChannel_Content","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"ids","in":"query","description":"The ids of the invoices.","schema":{"type":"array","items":{"type":"string"}}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition) in browser.\r\nIf false, the content is returned as an attachment (download, default).","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK"}}},"post":{"tags":["PaymentChannel"],"summary":"Downloads the pdf file for the invoice.","operationId":"PaymentChannel_ContentPost","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The invoice for the pdf.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/v03/api/payment-channel/{channel}/{id}/{type}":{"get":{"tags":["PaymentChannel"],"summary":"Downloads the calculation report pdf file for the single invoice.\r\nPlease note that this is applicable only for net invoices.","operationId":"PaymentChannel_ReportPdf","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"The id of the invoice.","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Calculation report type. Currently only salarySlip, employerReport, paymentReport and accountingReport are supported.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition) in browser.\r\nIf false, the content is returned as an attachment (download, default).","schema":{"type":"boolean","default":false}},{"name":"isSensitive","in":"query","description":"If true, the pdf hides any personal ids of the worker.","schema":{"type":"boolean","default":false}},{"name":"target","in":"query","description":"Accounting target: contains ruleset for creating accounting entries. Can be null. Only for accounting reports.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/payment-channel/{channel}/{type}":{"get":{"tags":["PaymentChannel"],"summary":"Downloads the calculation report pdf file for the invoice.\r\nPlease note that this is applicable only for net invoices.","operationId":"PaymentChannel_ReportPdfs","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"ids","in":"query","description":"The id of the invoice.","schema":{"type":"array","items":{"type":"string"}}},{"name":"type","in":"path","description":"Calculation report type. Currently only salarySlip, employerReport, paymentReport and accountingReport are supported.","required":true,"schema":{"$ref":"#/components/schemas/ReportType"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition) in browser.\r\nIf false, the content is returned as an attachment (download, default).","schema":{"type":"boolean","default":false}},{"name":"isSensitive","in":"query","description":"If true, the pdf hides any personal ids of the worker.","schema":{"type":"boolean","default":false}},{"name":"target","in":"query","description":"Accounting target: contains ruleset for creating accounting entries. Can be null. Only for accounting reports.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/payment-channel/{channel}/{id}/accounting":{"get":{"tags":["PaymentChannel"],"summary":"Gets the accounting data based on calculation in a single net salary invoice.\r\nPlease note that this is applicable only for net invoices.\r\nPlease note that the accounting does not contain holiday accruals.","operationId":"PaymentChannel_GetAccountingDataById","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"The id of the invoice.","required":true,"schema":{"type":"string"}},{"name":"target","in":"query","description":"Accounting target: contains ruleset for creating accounting entries.","schema":{"type":"string"}}],"responses":{"200":{"description":"Account report based on the calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingData"}}}}}}},"/v03/api/payment-channel/{channel}/accounting":{"get":{"tags":["PaymentChannel"],"summary":"Gets the accounting data based on calculations in net salary invoices.\r\nPlease note that this is applicable only for net invoices.\r\nPlease note that the accounting does not contain holiday accruals.","operationId":"PaymentChannel_GetAccountingData","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"ids","in":"query","description":"The ids of the invoices.","schema":{"type":"array","items":{"type":"string"}}},{"name":"target","in":"query","description":"Accounting target: contains ruleset for creating accounting entries.","schema":{"type":"string"}}],"responses":{"200":{"description":"Account report based on the calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingData"}}}}}}},"/v03/api/payment-channel/{channel}/{id}/sepa":{"get":{"tags":["PaymentChannel"],"summary":"Downloads the sepa file for the single invoice.","operationId":"PaymentChannel_SepaById","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"Id of the invoice for the sepa payment.","required":true,"schema":{"type":"string"}},{"name":"payerIbanNumber","in":"query","description":"Payer iban number.","schema":{"type":"string"}},{"name":"payerBic","in":"query","description":"Payer BIC.","schema":{"type":"string"}},{"name":"bankPartyId","in":"query","description":"Payer bank party id. Depends on the bank.","schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}},{"name":"version","in":"query","description":"ISO 20022 version, pain.001.001.02 (default) or pain.001.001.03","schema":{"type":"string","default":"pain.001.001.02"}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/payment-channel/{channel}/sepa":{"get":{"tags":["PaymentChannel"],"summary":"Downloads the sepa file for the given invoices.","operationId":"PaymentChannel_Sepa","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"ids","in":"query","description":"Ids of the invoices for the sepa payment.","schema":{"type":"array","items":{"type":"string"}}},{"name":"payerIbanNumber","in":"query","description":"Payer iban number.","schema":{"type":"string"}},{"name":"payerBic","in":"query","description":"Payer BIC.","schema":{"type":"string"}},{"name":"bankPartyId","in":"query","description":"Payer bank party id. Depends on the bank.","schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}},{"name":"version","in":"query","description":"ISO 20022 version, pain.001.001.02 (default) or pain.001.001.03","schema":{"type":"string","default":"pain.001.001.02"}}],"responses":{"200":{"description":"OK"}}},"post":{"tags":["PaymentChannel"],"summary":"Downloads the sepa file for the posted invoices.","operationId":"PaymentChannel_SepaPost","parameters":[{"name":"channel","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"payerIbanNumber","in":"query","description":"Payer iban number.","schema":{"type":"string"}},{"name":"payerBic","in":"query","description":"Payer BIC.","schema":{"type":"string"}},{"name":"bankPartyId","in":"query","description":"Payer bank party id. Depends on the bank.","schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachmnent.","schema":{"type":"boolean","default":false}},{"name":"version","in":"query","description":"ISO 20022 version, pain.001.001.02 (default) or pain.001.001.03","schema":{"type":"string","default":"pain.001.001.02"}}],"requestBody":{"description":"Invoices for the sepa payment.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/v03/api/payment-channel/{channel}/{id}/calculation":{"get":{"tags":["PaymentChannel"],"summary":"Gets the calculation in a single net salary invoice.\r\nPlease note that this is applicable only for net invoices.","operationId":"PaymentChannel_GetCalculation","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"The id of the invoice.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Calculation for the invoice.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/payment-channel/{channel}/calculation":{"get":{"tags":["PaymentChannel"],"summary":"Gets the calculations in net salary invoices.\r\nPlease note that this is applicable only for net invoices.","operationId":"PaymentChannel_GetCalculations","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"ids","in":"query","description":"The ids of the invoices.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Calculations for the invoices.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"}}}}}}}},"/v03/api/payment-channel/{channel}/status/{status}":{"get":{"tags":["PaymentChannel"],"summary":"Returns invoices to be paid by the partners customer companies.\r\nThe status filter can be set for the query.\r\nOptionally the period range (start and end date) can be given for the query.\r\nIf the period is not specified, it is last 14 days.","operationId":"PaymentChannel_GetInvoicesByStatus","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"status","in":"path","description":"Status filter for the query.","required":true,"schema":{"$ref":"#/components/schemas/InvoiceStatus"}},{"name":"dateKind","in":"query","description":"Date specifier for the period: invoicing date, due date or logical date (like salary date).","schema":{"default":"invoiceDate","$ref":"#/components/schemas/InvoiceDateKind"}},{"name":"start","in":"query","description":"Optional start date for the period to query the invoices. If not set, defaults to last 14 days.","schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","description":"Optional end date for the period to query the invoices. If not set, today is used.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"List of invoices.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/payment-channel/{channel}/update-status":{"post":{"tags":["PaymentChannel"],"summary":"Accepts and processes an invoice status notification message.\r\nThe 3rd party system can notify the invoice to be unread, read, paid or canceled.\r\nThe external id can be set in the notification for the invoice for later messaging.\r\nIf the notification message contains an external id and not a regular id,\r\nthe system tries to find the correct invoice using the earlier given external id for the invoice.","operationId":"PaymentChannel_UpdateStatus","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}}],"requestBody":{"description":"An array of status notification messages.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceStatusNotification"}}}},"required":true},"responses":{"200":{"description":"Invoices which have been updated by the notifications.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}},"/v03/api/payment-channel/{channel}/payment-messages":{"post":{"tags":["PaymentChannel"],"summary":"Creates a payment message (maksuaineisto) from unread invoices of one payer, or resends a message with\r\nparentMessageId. The server renders the file and allocates the display number; the message stays new until the\r\ndeliverer marks it sent (PATCH status sent). Returns 201 with a Location header. Send an Idempotency-Key header to\r\nmake a retry safe: the same key and body within 24 hours returns the original message; the same key with another\r\nbody is refused. A create whose invoices span partitions, under a rejecting partition policy, is refused with 400\r\nand validation.partitions.","operationId":"PaymentChannel_CreatePaymentMessage","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"Idempotency-Key","in":"header","schema":{"type":"string"}}],"requestBody":{"description":"Optional Idempotency-Key: 1-100 characters A-Z, a-z, 0-9 and . _ : -","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessageCreateRequest"}}},"required":true},"responses":{"201":{"description":"The payment message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessage"}}}}}},"get":{"tags":["PaymentChannel"],"summary":"Lists the payment messages of the channel from the search index, newest first unless ordered: summary rows without\r\nbatches, one page at a time. The index follows the table about a second later; get, patch and the file read the table.","operationId":"PaymentChannel_ListPaymentMessages","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"status","in":"query","description":"Optional status filter. The status set is open.","schema":{"type":"string"}},{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"One page of messages and the link to the next page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfPaymentMessageListItem"}}}}}}},"/v03/api/payment-channel/{channel}/payment-messages/{id}":{"get":{"tags":["PaymentChannel"],"summary":"Gets a payment message with its batches and transaction ids.","operationId":"PaymentChannel_GetPaymentMessage","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"Id of the payment message.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The payment message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessage"}}}}}},"patch":{"tags":["PaymentChannel"],"summary":"Changes the status of a payment message: { \"status\": \"sent\" } marks it sent after the deliverer fetched the file\r\n(its unread invoices become read), { \"status\": \"cancellationRequested\" } asks to cancel (the invoices are not\r\ntouched), { \"status\": \"executed\" } marks it paid where the channel allows it (the invoices become paid).","operationId":"PaymentChannel_PatchPaymentMessage","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"Id of the payment message.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The new status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessagePatch"}}},"required":true},"responses":{"200":{"description":"The payment message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessage"}}}}}}},"/v03/api/payment-channel/{channel}/payment-messages/{id}/sepa":{"get":{"tags":["PaymentChannel"],"summary":"Downloads the stored file of a payment message, under its stored file name. An idempotent read: the same file every time.","operationId":"PaymentChannel_PaymentMessageSepa","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"id","in":"path","description":"Id of the payment message.","required":true,"schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content as inline (disposition). If false, the content is returned as an attachment.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK"}}}},"/v03/api/payment-messages/settings/{channel}":{"get":{"tags":["PaymentMessage"],"summary":"The company's effective payment-message settings of a channel: the allowed actions, split, format and file name.","operationId":"PaymentMessage_GetSettings","parameters":[{"name":"channel","in":"path","description":"Payment channel key.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}}],"responses":{"200":{"description":"The channel's effective payment-message settings for the company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessageChannelInfo"}}}}}}},"/v03/api/payment-messages":{"post":{"tags":["PaymentMessage"],"summary":"Creates payment messages from the company's unread invoices of one channel, one per split group of the channel's\r\nsplitBy, or resends a message with parentMessageId (a child over its unpaid payments). The messages stay new until\r\ndownloaded (PATCH status sent).","operationId":"PaymentMessage_CrudSave","requestBody":{"description":"channel and invoiceIds, or parentMessageId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessageCompanyCreateRequest"}}},"required":true},"responses":{"200":{"description":"The created payment messages.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessageCompanyCreateResult"}}}}}},"get":{"tags":["PaymentMessage"],"summary":"The company's payment messages from the search index, newest first unless ordered: summary rows without batches, one\r\npage at a time. The index follows the table about a second later; get, patch and the file read the table.","operationId":"PaymentMessage_ODataSearch","parameters":[{"name":"channel","in":"query","description":"Optional channel filter.","schema":{"$ref":"#/components/schemas/PaymentChannel"}},{"name":"status","in":"query","description":"Optional status filter. The status set is open.","schema":{"type":"string"}},{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"One page of messages and the link to the next page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfPaymentMessageListItem"}}}}}}},"/v03/api/payment-messages/{id}":{"get":{"tags":["PaymentMessage"],"summary":"A payment message with its batches and transaction ids.","operationId":"PaymentMessage_CrudGet","parameters":[{"name":"id","in":"path","description":"Id of the payment message.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The payment message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessage"}}}}}},"patch":{"tags":["PaymentMessage"],"summary":"Changes the status: { \"status\": \"sent\" } after the company downloaded the file (only where the channel allows\r\ndownload; its invoices become read), { \"status\": \"cancellationRequested\" }, or { \"status\": \"executed\" } to mark\r\nit paid where the channel allows it (the invoices become paid). Writing the current status changes nothing.","operationId":"PaymentMessage_Patch","parameters":[{"name":"id","in":"path","description":"Id of the payment message.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The new status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessagePatch"}}},"required":true},"responses":{"200":{"description":"The payment message after the change.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMessage"}}}}}}},"/v03/api/payment-messages/{id}/sepa":{"get":{"tags":["PaymentMessage"],"summary":"Downloads the stored file under its stored file name. A read: it does not mark the message sent.","operationId":"PaymentMessage_Sepa","parameters":[{"name":"id","in":"path","description":"Id of the payment message.","required":true,"schema":{"type":"string"}},{"name":"inline","in":"query","description":"If true, returns the content inline; else as an attachment.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The payment message file as text/xml."}}}},"/v03/api/payroll":{"get":{"tags":["Payroll"],"summary":"Performs an OData query to the search index.","operationId":"Payroll_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfPayrollListItem"}}}}}},"post":{"tags":["Payroll"],"summary":"Updates or creates a new Payroll object","operationId":"Payroll_CrudSave","requestBody":{"description":"The Payroll message object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}},"required":true},"responses":{"200":{"description":"The payroll as saved into the database, but also Calculations added to the Result object and Validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/odata":{"get":{"tags":["Payroll"],"summary":"Performs an OData query to the search index.","operationId":"Payroll_ODataSearchLegacy","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfPayrollListItem"}}}}}}},"/v03/api/payroll/{id}":{"get":{"tags":["Payroll"],"summary":"Gets a single Payroll object based on identier","operationId":"Payroll_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}},"delete":{"tags":["Payroll"],"summary":"Deletes a Payroll object from the storage","operationId":"Payroll_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/payroll/new":{"get":{"tags":["Payroll"],"summary":"Factory method that creates a new Payroll object","operationId":"Payroll_CrudGetNew","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/validate":{"post":{"tags":["Payroll"],"summary":"Validates a Payroll object without storing it to the database.","operationId":"Payroll_Validate","requestBody":{"description":"The Payroll  object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}},"required":true},"responses":{"200":{"description":"The Payroll object with Calculations added to the Result object and Validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/add-employment":{"post":{"tags":["Payroll"],"summary":"Adds new calculations to the payroll and saves the payroll object.\r\nThe calculations are added based on employment relation ID's.","operationId":"Payroll_AddEmployments","parameters":[{"name":"ids","in":"query","description":"A comma separated list of employment relation id's for which the a new calculation is added to the Payroll list.\r\nAlso supports personal ID's when personal ID has an active employment relation as of SalaryDate\r\n(currently supports only Employers of up to 500 employment relations).","schema":{"type":"string"}}],"requestBody":{"description":"The Payroll  object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}},"required":true},"responses":{"200":{"description":"The Saved Payroll object with Calculations added to the Result object and Validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/{id}/calcs":{"post":{"tags":["Payroll"],"summary":"Saves changes to a Calculation that is part of a Payroll and returns the Paryoll validation data.","operationId":"Payroll_CalculationSave","parameters":[{"name":"id","in":"path","description":"Payroll ID where calculation belongs to.\r\nNote, that the current implementation does not assure that the calculation is within a Payroll\r\nnor set the salary date and the payment channel for the Payroll.\r\nThis may later be added without that being a breaking change.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The calculation object that is updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/payroll/add-calc":{"post":{"tags":["Payroll"],"summary":"Adds existing calculations to the payroll and saves the payroll object.\r\nIf calculation is read-only, a copy is made. If it is draft, the calculation is moved.","operationId":"Payroll_AddCalculations","parameters":[{"name":"ids","in":"query","description":"A comma separated list of calculation id's that are copied / moved to the Payroll list.","schema":{"type":"string"}}],"requestBody":{"description":"The Payroll  object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}},"required":true},"responses":{"200":{"description":"The Saved Payroll object with Calculations added to the Result object and Validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/delete-calc":{"post":{"tags":["Payroll"],"summary":"Remove calculations from the payroll and saves the payroll object.\r\nThe calculations are completely deleted.\r\nThis can only be done if the calculations and the payroll have not been paid yet.","operationId":"Payroll_DeleteCalculations","parameters":[{"name":"ids","in":"query","description":"A comma separated list of calculation id's that are deleted.","schema":{"type":"string"}}],"requestBody":{"description":"The Payroll  object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}},"required":true},"responses":{"200":{"description":"The Saved Payroll object with Calculations removed from the Result object and Validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/unlink-calc":{"post":{"tags":["Payroll"],"summary":"Remove calculations from the payroll and saves the payroll object.\r\nThe calculations are unlinked and they become individual calculations in the draft list (and can then be processed individually).\r\nThis can only be done if the calculations and the payroll have not been paid yet.","operationId":"Payroll_UnlinkCalculations","parameters":[{"name":"ids","in":"query","description":"A comma separated list of calculation id's that are unlinked from the Payroll list.","schema":{"type":"string"}}],"requestBody":{"description":"The Payroll  object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}},"required":true},"responses":{"200":{"description":"The Saved Payroll object with Calculations removed from the Result object and Validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/cancel/{id}":{"get":{"tags":["Payroll"],"summary":"Cancels the invoice or payment processing for the given payroll.\r\nPlease note that this is possible only if the payment channel supports the cancel action.","operationId":"Payroll_Cancel","parameters":[{"name":"id","in":"path","description":"Identifier of the Payroll to be cancelled.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The cancelled payroll.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollDetails"}}}}}}},"/v03/api/payroll/{id}/absences":{"get":{"tags":["Payroll"],"summary":"Gets absences for a single payroll report.","operationId":"Payroll_GetAbsences","parameters":[{"name":"id","in":"path","description":"Payroll ID for which to fetch the absences.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerAbsencePeriod"}}}}}}}},"/v03/api/test-data/taxcard-api":{"post":{"tags":["TestData"],"summary":"Sets the data for taxcards API for a personal Id.","operationId":"TestData_SetTaxcardApi","responses":{"200":{"description":"The data as it would be returnded now from the API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxcardInput"}}}}}}},"/v03/api/test-data/taxcard-api/{personalId}":{"get":{"tags":["TestData"],"summary":"Gets taxcard information for a personal Id.","operationId":"TestData_GetTaxcardApi","parameters":[{"name":"personalId","in":"path","description":"Personal ID for which the data is fetched.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Taxcard input or null if none is stored in the test data file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxcardInput"}}}}}}},"/v03/api/accounting-target":{"get":{"tags":["AccountingTarget"],"summary":"Performs an OData query to the search index.","operationId":"AccountingTarget_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfAccountingTargetListItem"}}}}}},"post":{"tags":["AccountingTarget"],"summary":"Updates or creates a new object","operationId":"AccountingTarget_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingTarget"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingTarget"}}}}}}},"/v03/api/accounting-target/{id}":{"get":{"tags":["AccountingTarget"],"summary":"Gets a single object based on identier","operationId":"AccountingTarget_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.\r\nThe indentifier may in format id@owner if the accounting target is a public read-only item owned by another owner.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingTarget"}}}}}},"delete":{"tags":["AccountingTarget"],"summary":"Deletes an object from the storage","operationId":"AccountingTarget_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/accounting-target/new":{"get":{"tags":["AccountingTarget"],"summary":"Factory method that creates a new object","operationId":"AccountingTarget_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingTarget"}}}}}}},"/v03/api/beneficial-owners":{"get":{"tags":["BeneficialOwners"],"summary":"Gets a single object.","operationId":"BeneficialOwners_CrudGet","responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeneficialOwners"}}}}}},"post":{"tags":["BeneficialOwners"],"summary":"Updates or creates a new object","operationId":"BeneficialOwners_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeneficialOwners"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeneficialOwners"}}}}}}},"/v03/api/calculations":{"get":{"tags":["Calculations"],"summary":"Returns list of all calculations for the current employer. Both editable and readonly calculations are returned.","operationId":"Calculations_ODataSearchAll","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Calculation list items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfCalculationListItem"}}}}}},"post":{"tags":["Calculations"],"summary":"Creates or updates a calculation.","operationId":"Calculations_CrudSave","requestBody":{"description":"The calculation object that is updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/set":{"get":{"tags":["Calculations"],"summary":"Returns Calculation objects for given identifiers.","operationId":"Calculations_CrudGetMulti","parameters":[{"name":"ids","in":"query","description":"Unique identifiers for the objects.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Array of found objects or an empty array if objects not found.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"}}}}}}}},"/v03/api/calculations/employment/{employmentId}":{"get":{"tags":["Calculations"],"summary":"Gets the Calculation objects for a specific Employment relation.","operationId":"Calculations_EmploymentListByEmploymentId","parameters":[{"name":"employmentId","in":"path","description":"The employment relation for which to list the Calculations.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of Calculation objects.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"}}}}}}}},"/v03/api/calculations/employment/set":{"get":{"tags":["Calculations"],"summary":"Returns Calculation objects for given Employment relations.","operationId":"Calculations_EmploymentList","parameters":[{"name":"employmentIds","in":"query","description":"Set of employmentIds for which to get the Calculation objects.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Array of found objects or an empty array if objects not found.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"}}}}}}}},"/v03/api/calculations/{id}":{"get":{"tags":["Calculations"],"summary":"Gets a single Calculation object based on identier","operationId":"Calculations_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}},"delete":{"tags":["Calculations"],"summary":"Deletes a Calculation object from the storage","operationId":"Calculations_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/calculations/new":{"get":{"tags":["Calculations"],"summary":"Factory method that creates a new Calculation object","operationId":"Calculations_CrudGetNew","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/copy/{id}":{"get":{"tags":["Calculations"],"summary":"Gets a copy of a paid or template calculation and creates a new draft based on that calculation.\r\nNote that this method just returns a copy of the calculation, it does not save it yet to the DB.","operationId":"Calculations_Copy","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Work start date for the new salary calculation","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"Work end date for the new salary calculation","schema":{"type":"string","format":"date-time"}},{"name":"numberOfDays","in":"query","description":"&gt;Number of days for the new calculation.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A copy of the calculation in state draft and instance specific properties nulled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/cancel/{id}":{"get":{"tags":["Calculations"],"summary":"Cancels the invoice or payment processing for the given calculation.\r\nPlease note that this is possible only if the payment channel supports the cancel action.","operationId":"Calculations_Cancel","parameters":[{"name":"id","in":"path","description":"Identifier of the Calculation to be cancelled.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The cancelled calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/repair/{id}":{"get":{"tags":["Calculations"],"summary":"Gets a copy of a paid calculation for repair.","operationId":"Calculations_Repair","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A copy of the calculation in status repair.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/repair":{"post":{"tags":["Calculations"],"summary":"Updates the repair calculation.","operationId":"Calculations_UpdateRepair","requestBody":{"description":"The repair calculation that is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingCalculation"}}},"required":true},"responses":{"200":{"description":"The updated repair calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/repair/commit":{"post":{"tags":["Calculations"],"summary":"Replaces the original calculation with the given calculation.\r\nThe original id field of the calculation is used to identify the original calculation.","operationId":"Calculations_CommitRepair","requestBody":{"description":"The calculation which replaces the original calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingCalculation"}}},"required":true},"responses":{"200":{"description":"The new version of the original calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/{id}/document-flow":{"get":{"tags":["Calculations"],"summary":"Returns document flow for the given calculation.","operationId":"Calculations_GetDocumentFlow","parameters":[{"name":"id","in":"path","description":"Id of the calculation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns document flow for the given calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentFlowItem"}}}}}}},"/v03/api/calculations/sharing/{calculationId}":{"post":{"tags":["Calculations"],"summary":"Create or remove a sharing to a given calculation.","operationId":"Calculations_Sharing","parameters":[{"name":"calculationId","in":"path","description":"Identifier of the calculation.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Sharing method. For typical sharing scenarios, use 'url'.","schema":{"default":"undefined","$ref":"#/components/schemas/SharingUriType"}},{"name":"employerId","in":"query","description":"Id of the employer to share the calculation with.","schema":{"type":"string"}},{"name":"to","in":"query","description":"Employer email address.","schema":{"type":"string"}},{"name":"cc","in":"query","description":"Adress for the copy of the email.","schema":{"type":"string"}},{"name":"message","in":"query","description":"Message to the employer.","schema":{"type":"string"}}],"responses":{"200":{"description":"The Sharing information for the calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculationSharing"}}}}}}},"/v03/api/calculations/sharing/{calculationId}/notification":{"post":{"tags":["Calculations"],"summary":"Notify the employer from the shared calculation.","operationId":"Calculations_NotifySharing","parameters":[{"name":"calculationId","in":"path","description":"Identifier of the calculation.","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Employer email address.","schema":{"type":"string"}},{"name":"cc","in":"query","description":"Adress for the copy of the email.","schema":{"type":"string"}},{"name":"message","in":"query","description":"Message to the employer.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns true, if the email sending was successfull.","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/v03/api/calculations/update-from-employment":{"post":{"tags":["Calculations"],"summary":"Updates a calculation from employment relation by deleting all the rows and re-setting the employment.\r\nIf the calculation has an ID, it is saved, if not it is just recalculated.","operationId":"Calculations_UpdateFromEmployment","parameters":[{"name":"save","in":"query","description":"If true, saves the calculation.\r\nIf false just recalculates.\r\nIf omitted, saves if the calculation has an id, otherwise just recalculates.\r\nThe null value may be removed when all clients are updated (defaults to false).","schema":{"type":"boolean"}},{"name":"updateRows","in":"query","description":"If true, updates also the default salary rows from employment data to calculation.\r\nFalse updates only other employment data.\r\nNull currently defaults to True for backward compatibility, but it may be removed (or default to false) in future versions (when all clients are updated).","schema":{"type":"boolean","default":true}}],"requestBody":{"description":"Calculation to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The updated and save calculation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/calculations/update-to-employment":{"post":{"tags":["Calculations"],"summary":"Updates (saves) the employment related information from Calculation to Employment relation.\r\nCurrently only updates rows, OccupationCode and WorkDescription.","operationId":"Calculations_UpdateToEmployment","requestBody":{"description":"Source calculation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Text \"ok\".","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/calculations/worktime":{"post":{"tags":["Calculations"],"summary":"Gets the worktime data for Period recalculation from raw calc fetching holidays and absences data from storage.\r\nThese determine how holiday salaries etc. and absence deductions will be added as rows to calculations.\r\nThe idea is that user can still modify these before the actual calculation is done as often manual adjustments need to be made.\r\nAlso, providers that do not use HolidayYears and Absences can skip this step and use recalculate-worktime directly.","operationId":"Calculations_GetWorktimeData","requestBody":{"description":"The salary calculation that should be recalculated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"The parameters for adding the actual rows and recalculation. This should","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalcWorktime"}}}}}}},"/v03/api/calculations/epr/{id}":{"get":{"tags":["Calculations"],"summary":"Gets the EarningsPayment object for a specific calculation.","operationId":"Calculations_GetEpr","parameters":[{"name":"id","in":"path","description":"The calculation for which to list the EarningsPayments.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of EarningsPayments objects.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}}},"/v03/api/calculations/epr":{"post":{"tags":["Calculations"],"summary":"Converts a calculation to EarningsPayment object.","operationId":"Calculations_ConvertToEpr","requestBody":{"description":"The calculation to convert to EarningsPayment report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingCalculation"}}},"required":true},"responses":{"200":{"description":"EarningsPayment object","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}}},"/v03/api/calculations/ir":{"post":{"tags":["Calculations"],"summary":"Saves the IR related data (rows and salary date) to a calculation.","operationId":"Calculations_SaveCalculationForIr","requestBody":{"description":"The calculation with ir related data to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Calculation object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/datasets":{"get":{"tags":["Dataset"],"summary":"Performs an OData query to the search index.","operationId":"Dataset_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfDatasetListItem"}}}}}},"post":{"tags":["Dataset"],"summary":"Updates or creates a new object","operationId":"Dataset_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}}}},"/v03/api/datasets/{id}":{"get":{"tags":["Dataset"],"summary":"Gets a single object based on identier","operationId":"Dataset_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}}},"delete":{"tags":["Dataset"],"summary":"Deletes an object from the storage","operationId":"Dataset_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/datasets/new":{"get":{"tags":["Dataset"],"summary":"Factory method that creates a new object","operationId":"Dataset_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}}}},"/v03/api/employments":{"get":{"tags":["Employment"],"summary":"Performs an OData query to the employment relations in search index.","operationId":"Employment_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"activeDate","in":"query","description":"Provides a helper for filtering only active employment relations. You can provide an ISO date (yyyy-mm-dd) to\r\nlist only employments that are active on a specific date. Set to \"today\" for today's date.\r\nDefault \"all\" lists all employments: active and passive.","schema":{"type":"string","default":"all"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfEmploymentListItem"}}}}}},"post":{"tags":["Employment"],"summary":"Adds or Updates an employment relation this Employer has created (Owned by this employer).\r\nWorkers cannot update employment relations.","operationId":"Employment_CrudSave","requestBody":{"description":"Employment relation that should be added or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}},"required":true},"responses":{"200":{"description":"The updated employment relation as stored in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}}}}},"/v03/api/employments/{id}":{"get":{"tags":["Employment"],"summary":"Gets a single object based on identier","operationId":"Employment_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}}}},"delete":{"tags":["Employment"],"summary":"Deletes a worker account that this Employer has created (Owned by this employer).\r\nThe methods looks for the WorkerAccount, deletes it and also deletes all the employment relations, taxcards, holidays and absences.\r\nThis method will fail if there are any calculations (paid or draft in WorkerAccount) or if the person is the contact person for the current company.","operationId":"Employment_CrudDelete","parameters":[{"name":"id","in":"path","description":"Identifier of the worker account that will be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/employments/{id}/pay-stats/recalculate":{"post":{"tags":["Employment"],"summary":"Recalculates pay statistics for the given employment relation.","operationId":"Employment_RecalculateEmploymentPayStats","parameters":[{"name":"id","in":"path","description":"Employment relation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The employment with calculated pay statistics.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employment"}}}}}}},"/v03/api/employments/pay-stats/recalculate":{"post":{"tags":["Employment"],"summary":"Recalculates pay statistics for all employment relations of the current employer.","operationId":"Employment_RecalculatePayStats","responses":{"200":{"description":"Boolean indicating that the job for calculations has started.","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/v03/api/employments/active":{"get":{"tags":["Employment"],"summary":"Gets all the active employment relations (the full payload).","operationId":"Employment_CrudGetActive","parameters":[{"name":"date","in":"query","description":"Date for which the employment relation should be active. Defaults to today.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"All active employment relations for the specified date.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Employment"}}}}}}}},"/v03/api/employments/employing":{"get":{"tags":["Employment"],"summary":"Performs an OData query to the employment relations for the current user (Worker).\r\nWorker can list and search all employers which have employed the worker.","operationId":"Employment_ODataSearchForEmployingRelations","responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfEmploymentListItem"}}}}}}},"/v03/api/employments/employing/{id}":{"get":{"tags":["Employment"],"summary":"Returns employer public employment profile for the employed Worker.","operationId":"Employment_GetEmployingRelation","parameters":[{"name":"id","in":"path","description":"Id@owner for the employment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployingRelation"}}}}}}},"/v03/api/household-years":{"get":{"tags":["HouseholdYear"],"summary":"Performs an OData query to the search index.","operationId":"HouseholdYear_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfHouseholdYearListItem"}}}}}},"post":{"tags":["HouseholdYear"],"summary":"Updates or creates a new object","operationId":"HouseholdYear_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdYear"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdYear"}}}}}}},"/v03/api/household-years/{id}":{"get":{"tags":["HouseholdYear"],"summary":"Gets a single object based on identier","operationId":"HouseholdYear_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdYear"}}}}}},"delete":{"tags":["HouseholdYear"],"summary":"Deletes an object from the storage","operationId":"HouseholdYear_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/household-years/new":{"get":{"tags":["HouseholdYear"],"summary":"Factory method that creates a new object","operationId":"HouseholdYear_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdYear"}}}}}}},"/v03/api/household-years/{id}/processingStatus/{processingStatus}":{"post":{"tags":["HouseholdYear"],"summary":"Requests an update for the processing status of the household year deduction..","operationId":"HouseholdYear_RequestProcessingStatusUpdatePost","parameters":[{"name":"id","in":"path","description":"Id of the year to update.","required":true,"schema":{"type":"string"}},{"name":"processingStatus","in":"path","description":"The requested processing status for the deduction.","required":true,"schema":{"$ref":"#/components/schemas/HouseholdYearProcessingStatus"}}],"responses":{"200":{"description":"The household yearldy deduction data after the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdYear"}}}}}},"get":{"tags":["HouseholdYear"],"summary":"Requests an update for the processing status of the household year deduction..","operationId":"HouseholdYear_RequestProcessingStatusUpdate","parameters":[{"name":"id","in":"path","description":"Id of the year to update.","required":true,"schema":{"type":"string"}},{"name":"processingStatus","in":"path","description":"The requested processing status for the deduction.","required":true,"schema":{"$ref":"#/components/schemas/HouseholdYearProcessingStatus"}}],"responses":{"200":{"description":"The household yearldy deduction data after the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdYear"}}}}}}},"/v03/api/household-years/{id}/pdfs":{"post":{"tags":["HouseholdYear"],"summary":"Returns pdf files for the given household year","operationId":"HouseholdYear_GetPdfsPost","parameters":[{"name":"id","in":"path","description":"Id of the year.","required":true,"schema":{"type":"string"}},{"name":"signature","in":"query","description":"Signing statement.","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of dictionary items containing blob and fileName properties.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false}}}}}}},"get":{"tags":["HouseholdYear"],"summary":"Returns pdf files for the given household year","operationId":"HouseholdYear_GetPdfs","parameters":[{"name":"id","in":"path","description":"Id of the year.","required":true,"schema":{"type":"string"}},{"name":"signature","in":"query","description":"Signing statement.","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of dictionary items containing blob and fileName properties.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false}}}}}}}},"/v03/api/household-years/calculations":{"get":{"tags":["HouseholdYear"],"summary":"Gets all paid calculations for the given year.","operationId":"HouseholdYear_GetCalculationsForYear","parameters":[{"name":"year","in":"query","description":"Year or null. If null, the current year is used.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Array containing all the calculations for the year.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"}}}}}}},"post":{"tags":["HouseholdYear"],"summary":"Updates the household data in the calculation.","operationId":"HouseholdYear_UpdateCalculation","requestBody":{"description":"Calculation to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Array containing all the calculations for the year.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/import/companies":{"post":{"tags":["Import"],"summary":"Creates or assures the posted customer companies in the system.\r\nChecks required authorizations for the calling account.\r\nPlease note that this method is only for TRUSTED partners.","operationId":"Import_ImportCompanies","requestBody":{"description":"Companies for import.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyImport"}}}},"required":true},"responses":{"200":{"description":"The result of the import containing detailed information about the created company.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyImport"}}}}}}}},"/v03/api/import/workers":{"post":{"tags":["Import"],"summary":"Creates or assures the posted worker employment relations in the system.","operationId":"Import_ImportWorkers","requestBody":{"description":"Workers for import.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerImport"}}}},"required":true},"responses":{"200":{"description":"Created or assured worker ids.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerImport"}}}}}}}},"/v03/api/import/calculations":{"post":{"tags":["Import"],"summary":"Adds posted calculations to a new or existing payroll object.\r\nThe existing payroll object is search by company official id, salary date and source id","operationId":"Import_ImportCalculations","parameters":[{"name":"isMerge","in":"query","description":"If true, the included calculations should be merged into the existing calculations.","schema":{"type":"boolean"}},{"name":"rowMergeOption","in":"query","description":"Merging option for the rows.","schema":{"$ref":"#/components/schemas/RowMergeOption"}},{"name":"sourceId","in":"query","description":"Source id for the merged rows.\r\nPlease note that if the RowMergeOption is RemoveImportedRows and the source ID is set, only the rows with the given source ID will be removed,\r\notherwise if the source ID is not set, all rows with any source ID will be removed.","schema":{"type":"string"}},{"name":"applyEmploymentDefaultRows","in":"query","description":"If true, any calculation should be added with \r\nthe default rows from the employment.","schema":{"type":"boolean"}},{"name":"applyWorktime","in":"query","description":"If true, resolves, recalculates and updates holidays and absences to the given calculations.","schema":{"type":"boolean"}}],"requestBody":{"description":"Additional options for save.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculationImport"}}}},"required":true},"responses":{"200":{"description":"Created or assured calculation ids.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculationImport"}}}}}}}},"/v03/api/import/invoicing/{channel}":{"post":{"tags":["Import"],"summary":"Creates invoices for given payroll objects.","operationId":"Import_CreateInvoicesForPayrolls","parameters":[{"name":"channel","in":"path","description":"Payment channel to use.","required":true,"schema":{"$ref":"#/components/schemas/PaymentChannel"}}],"requestBody":{"description":"Identifiers (format id@owner) for the payrolls.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoicingRequest"}}}},"required":true},"responses":{"200":{"description":"Invoices which have been created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoicingRequest"}}}}}}}},"/v03/api/import/einvoicing":{"post":{"tags":["Import"],"summary":"Sends the invoices as einvoices.","operationId":"Import_SendAsEInvoices","requestBody":{"description":"Identifiers (format id@owner) for the invoices for which the einvoices should be generated and sent.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EInvoicingRequest"}}}},"required":true},"responses":{"200":{"description":"Result of the deliveries.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EInvoicingRequest"}}}}}}}},"/v03/api/import/invoice-settings-check/{type}":{"post":{"tags":["Import"],"summary":"Checks the invoice settings for the company.","operationId":"Import_CheckInvoiceSettings","parameters":[{"name":"type","in":"path","description":"Check target: \"sepa\" for sepa-payments, or \"eInvoice\" for eInvoice -payments.","required":true,"schema":{"pattern":"^(sepa|eInvoice)$","type":"string","default":"sepa"}}],"requestBody":{"description":"Accounts to check.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceSettingsCheck"}}}},"required":true},"responses":{"200":{"description":"Check result containing InvoiceSettings object.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceSettingsCheck"}}}}}}}},"/v03/api/import/workers-check":{"post":{"tags":["Import"],"summary":"Checks the existence of given workers.\r\nThe id for worker can be worker ID, social security number of employment ID.","operationId":"Import_CheckWorkers","requestBody":{"description":"Workers to check.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerCheck"}}}},"required":true},"responses":{"200":{"description":"Check result containing WorkerAccount objects.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerCheck"}}}}}}}},"/v03/api/import/einvoice/receiver":{"get":{"tags":["Import"],"summary":"Queries the eInvoice address for the given official id (Y-tunnus).","operationId":"Import_GetEInvoiceAddress","parameters":[{"name":"officialId","in":"query","description":"The official identifier of the company (Y-tunnus).","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of eInvoice addresses for the company.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EInvoiceAddress"}}}}}}}},"/v03/api/records":{"get":{"tags":["Record"],"summary":"Performs an OData query to the search index.","operationId":"Record_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfRecordListItem"}}}}}},"post":{"tags":["Record"],"summary":"Updates or creates a new object","operationId":"Record_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}}}}}},"/v03/api/records/{entityType}/{entityId}":{"get":{"tags":["Record"],"summary":"Lists records for employment.","operationId":"Record_CrudListForEntity","parameters":[{"name":"entityType","in":"path","description":"Entity type","required":true,"schema":{"type":"string"}},{"name":"entityId","in":"path","description":"Entity id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Record"}}}}}}}},"/v03/api/records/{id}":{"get":{"tags":["Record"],"summary":"Gets a single object based on identier","operationId":"Record_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}}}}},"delete":{"tags":["Record"],"summary":"Deletes an object from the storage","operationId":"Record_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/records/new":{"get":{"tags":["Record"],"summary":"Factory method that creates a new object","operationId":"Record_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}}}}}},"/v03/api/records/recordTypes":{"get":{"tags":["Record"],"summary":"Lists all distinct employment record types for the employer","operationId":"Record_ListRecordTypes","responses":{"200":{"description":"List of record types","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/v03/api/records/{entityType}/files":{"post":{"tags":["Record"],"summary":"Saves an attachment file for the employment.","operationId":"Record_SaveFiles","parameters":[{"name":"entityType","in":"path","description":"Entity type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Uploaded attachments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}}},"/v03/api/records/{entityType}/{entityId}/files":{"post":{"tags":["Record"],"summary":"Saves an attachment file for the employment.","operationId":"Record_SaveFilesByEntityId","parameters":[{"name":"entityType","in":"path","description":"Entity type","required":true,"schema":{"type":"string"}},{"name":"entityId","in":"path","description":"Entity id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Uploaded attachments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}}},"/v03/api/reference-objects":{"get":{"tags":["ReferenceObject"],"summary":"Performs an OData query to the search index.","operationId":"ReferenceObject_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfReferenceObjectListItem"}}}}}},"post":{"tags":["ReferenceObject"],"summary":"Updates or creates a new object.","operationId":"ReferenceObject_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceObject"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceObject"}}}}}}},"/v03/api/reference-objects/{id}":{"get":{"tags":["ReferenceObject"],"summary":"Gets a single object based on identier.","operationId":"ReferenceObject_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceObject"}}}}}},"delete":{"tags":["ReferenceObject"],"summary":"Deletes an object from the storage.","operationId":"ReferenceObject_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\".","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/reference-objects/new":{"get":{"tags":["ReferenceObject"],"summary":"Factory method that creates a new object.","operationId":"ReferenceObject_CrudGetNew","responses":{"200":{"description":"New object with default values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceObject"}}}}}}},"/v03/api/reference-objects/delete-containers":{"get":{"tags":["ReferenceObject"],"operationId":"ReferenceObject_DeleteContainersLegacy","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/reference-objects/create-containers/{count}":{"get":{"tags":["ReferenceObject"],"operationId":"ReferenceObject_CreateContainersLegacy","parameters":[{"name":"count","in":"path","required":true,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/reference-objects/update-containers/{count}":{"get":{"tags":["ReferenceObject"],"operationId":"ReferenceObject_UpdateContainersLegacy","parameters":[{"name":"count","in":"path","required":true,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/reference-objects/get-containers/{count}":{"get":{"tags":["ReferenceObject"],"operationId":"ReferenceObject_GetContainersLegacy","parameters":[{"name":"count","in":"path","required":true,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/reference-objects/find-containers/{count}":{"get":{"tags":["ReferenceObject"],"operationId":"ReferenceObject_FindContainersLegacy","parameters":[{"name":"count","in":"path","required":true,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/service-models":{"get":{"tags":["ServiceModel"],"summary":"Performs an OData query to the search index.","operationId":"ServiceModel_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfServiceModelListItem"}}}}}},"post":{"tags":["ServiceModel"],"summary":"Updates or creates a new object","operationId":"ServiceModel_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceModel"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceModel"}}}}}}},"/v03/api/service-models/{id}":{"get":{"tags":["ServiceModel"],"summary":"Gets a single object based on identier","operationId":"ServiceModel_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceModel"}}}}}},"delete":{"tags":["ServiceModel"],"summary":"Deletes an object from the storage","operationId":"ServiceModel_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/service-models/new":{"get":{"tags":["ServiceModel"],"summary":"Factory method that creates a new object","operationId":"ServiceModel_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceModel"}}}}}}},"/v03/api/settings/company":{"get":{"tags":["Settings"],"summary":"Returns the main account settings for company employers.\r\nThis is the full set of employer settings.","operationId":"Settings_CrudGetCompany","responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAccountSettings"}}}}}},"post":{"tags":["Settings"],"summary":"Saves the main account settings for company employers.","operationId":"Settings_CrudPostCompany","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAccountSettings"}}},"required":true},"responses":{"200":{"description":"The object as saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAccountSettings"}}}}}}},"/v03/api/settings/irCertificate":{"get":{"tags":["Settings"],"summary":"Get current Incomes Register certificate details.","operationId":"Settings_GetIrCertificate","responses":{"200":{"description":"Current Incomes Register certificate details.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}},"post":{"tags":["Settings"],"summary":"Create a new Incomes Register certificate.","operationId":"Settings_CreateIrCertificate","parameters":[{"name":"transferId","in":"query","schema":{"type":"string"}},{"name":"transferPassword","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"New Incomes Register certificate details.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}}},"/v03/api/settings/irCertificate/renew":{"post":{"tags":["Settings"],"summary":"Renews an existing Incomes Register certificate.","operationId":"Settings_RenewIrCertificate","responses":{"200":{"description":"Renewed Incomes Register certificate details.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}}},"/v03/api/settings/brands":{"get":{"tags":["Settings"],"summary":"Returns all brands in service models.","operationId":"Settings_ODataSearchBrands","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Array of service models with brand data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfBrandListItem"}}}}}}},"/v03/api/settings/layout/{id}":{"get":{"tags":["Settings"],"summary":"Gets the layout template.","operationId":"Settings_CrudGetLayoutTemplate","parameters":[{"name":"id","in":"path","description":"Id of the layout template in format id@owner","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Template data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingLayoutTemplate"}}}}}}},"/v03/api/settings/logo/{id}":{"get":{"tags":["Settings"],"summary":"Gets the logo for the layout template.","operationId":"Settings_CrudGetLogo","parameters":[{"name":"id","in":"path","description":"Id of the logo in format id@owner","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Logo html markup as string.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/settings/primary-partners":{"get":{"tags":["Settings"],"summary":"Returns the primary partners.","operationId":"Settings_ODataSearchPrimaryPartners","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Array of primary partner index objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfPrimaryPartnerListItem"}}}}}}},"/v03/api/settings/ytj-companies":{"get":{"tags":["Settings"],"summary":"Makes a search to ytj for companies.","operationId":"Settings_SearchYtj","parameters":[{"name":"search","in":"query","description":"Sarch text. Company name or business id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of search result.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountInIndex"}}}}}}}},"/v03/api/settings/partners":{"get":{"tags":["Settings"],"summary":"Returns the partners.","operationId":"Settings_SearchPartners","parameters":[{"name":"search","in":"query","description":"Search text. Company name or business id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of search result.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountInIndex"}}}}}}}},"/v03/api/settings/dimensions":{"get":{"tags":["Settings"],"summary":"Returns all the cost accounting dimensions for the account.","operationId":"Settings_CrudGetDimensions","responses":{"200":{"description":"Current cost accounting dimensions.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"}}}}}}},"post":{"tags":["Settings"],"summary":"Saves a single cost accounting dimensions for the account.","operationId":"Settings_CrudSaveDimension","requestBody":{"description":"Cost accounting dimension.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"}}},"required":true},"responses":{"200":{"description":"The saved cost accounting dimension.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"}}}}}}},"/v03/api/settings/dimensions/{id}":{"get":{"tags":["Settings"],"summary":"Returns a single cost accounting dimension for the account.","operationId":"Settings_CrudGetDimension","parameters":[{"name":"id","in":"path","description":"Identifier for the dimension.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cost accounting dimension.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"}}}}}},"delete":{"tags":["Settings"],"summary":"Removes a single cost accounting dimension from the account.","operationId":"Settings_CrudDeleteDimension","parameters":[{"name":"id","in":"path","description":"Identifier for the dimension.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/settings/dimensions/all":{"post":{"tags":["Settings"],"summary":"Saves the cost accounting dimensions for the account.\r\nPlease note that this method replaces all the dimensions with the posted dimensions.","operationId":"Settings_CrudSaveDimensions","requestBody":{"description":"Cost accounting dimensions for the account.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"}}}},"required":true},"responses":{"200":{"description":"The saved cost accounting dimensions.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"}}}}}}}},"/v03/api/settings/pensionContracts":{"get":{"tags":["Settings"],"summary":"Returns all the pension contracts for the account.","operationId":"Settings_CrudGetPensionContracts","responses":{"200":{"description":"Current pension contracts.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PensionContract"}}}}}}},"post":{"tags":["Settings"],"summary":"Saves a single pension contract for the account.","operationId":"Settings_CrudSavePensionContract","requestBody":{"description":"Pension contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PensionContract"}}},"required":true},"responses":{"200":{"description":"The saved pension contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PensionContract"}}}}}}},"/v03/api/settings/pensionContracts/{contractNumber}":{"get":{"tags":["Settings"],"summary":"Returns a single pension contract for the account.","operationId":"Settings_CrudGetPensionContract","parameters":[{"name":"contractNumber","in":"path","description":"Pension contract number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pension contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PensionContract"}}}}}},"delete":{"tags":["Settings"],"summary":"Removes a single pension contract from the account.","operationId":"Settings_CrudDeletePensionContract","parameters":[{"name":"contractNumber","in":"path","description":"The number for the pension contract.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/settings/pensionContracts/all":{"post":{"tags":["Settings"],"summary":"Saves the pension contracts for the account.\r\nPlease note that this method replaces all the pension contracts with the posted pension contracts.","operationId":"Settings_CrudSavePensionContracts","requestBody":{"description":"Pension contracts for the account.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PensionContract"}}}},"required":true},"responses":{"200":{"description":"The saved pension contracts.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PensionContract"}}}}}}}},"/v03/api/task-definitions":{"get":{"tags":["TaskDefinition"],"summary":"Performs an OData query to the search index.","operationId":"TaskDefinition_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfTaskDefinitionListItem"}}}}}},"post":{"tags":["TaskDefinition"],"summary":"Updates or creates a new object","operationId":"TaskDefinition_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDefinition"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDefinition"}}}}}}},"/v03/api/task-definitions/{id}":{"get":{"tags":["TaskDefinition"],"summary":"Gets a single object based on identier","operationId":"TaskDefinition_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.\r\nThe indentifier should be in format id@owner if the template is a public read-only item owned by another owner.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDefinition"}}}}}},"delete":{"tags":["TaskDefinition"],"summary":"Deletes an object from the storage","operationId":"TaskDefinition_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/task-definitions/new":{"get":{"tags":["TaskDefinition"],"summary":"Factory method that creates a new object","operationId":"TaskDefinition_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDefinition"}}}}}}},"/v03/api/task-runs":{"get":{"tags":["TaskRun"],"summary":"Performs an OData query to the search index.","operationId":"TaskRun_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfTaskRunListItem"}}}}}},"post":{"tags":["TaskRun"],"summary":"Updates or creates a new object","operationId":"TaskRun_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}}}}}},"/v03/api/task-runs/{id}":{"get":{"tags":["TaskRun"],"summary":"Gets a single object based on identier","operationId":"TaskRun_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.\r\nThe indentifier should be in format id@owner if the template is a public read-only item owned by another owner.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}}}}},"delete":{"tags":["TaskRun"],"summary":"Deletes an object from the storage","operationId":"TaskRun_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/task-runs/new":{"get":{"tags":["TaskRun"],"summary":"Factory method that creates a new object","operationId":"TaskRun_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}}}}}},"/v03/api/task-runs/{id}/logs":{"get":{"tags":["TaskRun"],"summary":"Retruns log entries for the task run.","operationId":"TaskRun_ListLogEntries","parameters":[{"name":"id","in":"path","description":"Id of the task run..","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of log entries for the task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskLogEntry"}}}}}}},"/v03/api/task-runs/schedule":{"post":{"tags":["TaskRun"],"summary":"Schedules a new run for the task definition. The schedule parameter of the task definition must be defined.","operationId":"TaskRun_Schedule","requestBody":{"description":"Id of the task definitions.","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"A new run in scheduled state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}}}}}},"/v03/api/task-runs/start":{"post":{"tags":["TaskRun"],"summary":"Starts a new run immediately for the task definition.","operationId":"TaskRun_Start","requestBody":{"description":"Id of the task definitions.","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"A new run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}}}}}},"/v03/api/taxcards/calculate/{id}":{"get":{"tags":["Taxcards"],"summary":"Calculates the widhholding tax based on a given tax card","operationId":"Taxcards_CalculateWithId","parameters":[{"name":"id","in":"path","description":"Identifier of the tax card","required":true,"schema":{"type":"string"}},{"name":"income","in":"query","description":"New salary or other income, for which the widthholding tax is calculated.","schema":{"type":"number","format":"double"}},{"name":"paymentDate","in":"query","description":"Date of payment (typically SalaryDate) determines the taxation year.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxcardResult"}}}}}}},"/v03/api/taxcards/calculate":{"post":{"tags":["Taxcards"],"summary":"Calculates the widhholding tax based on a given tax card","operationId":"Taxcards_Calculate","parameters":[{"name":"income","in":"query","description":"New salary or other income, for which the widthholding tax is calculated.","schema":{"type":"number","format":"double"}},{"name":"paymentDate","in":"query","description":"Date of payment (typically SalaryDate) determines the taxation year.","schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"Tax card based on which the widthholding tax is calculated.\r\nThis method will not connect to database in any way so the taxcard may or may not be stored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxcardResult"}}}}}}},"/v03/api/taxcards":{"get":{"tags":["Taxcards"],"summary":"Performs an OData query to the search index.","operationId":"Taxcards_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfTaxcardListItem"}}}}}},"post":{"tags":["Taxcards"],"summary":"Updates or creates a new object.\r\nPaid calculations may be checked and added as Diff rows depending on taxcardOnly parameter.","operationId":"Taxcards_CrudSave","parameters":[{"name":"calcDiffCheck","in":"query","description":"Defines the behavior of how to check and handle existing paid calculations when saving the taxcard.","schema":{"default":"getDiff","$ref":"#/components/schemas/TaxcardCalcDiffCheck"}}],"requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.\r\nPaid calculations may be checked and added as Diff rows depending on taxcardOnly parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}}}}}},"/v03/api/taxcards/{id}":{"get":{"tags":["Taxcards"],"summary":"Gets a single object based on identier. \r\nBy default also returns Diff if paid calculations are different in database than in the taxcard.","operationId":"Taxcards_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object","required":true,"schema":{"type":"string"}},{"name":"calcDiffCheck","in":"query","description":"Defines the behavior of how to check and handle existing paid calculations.\r\nDefault is \"getDiff\" where the system fetches the paid calculations in the database and adds them as Diff-rows.\r\nNote that \"commitDiff\" is not currently supported. May later be supported if necessary.","schema":{"default":"getDiff","$ref":"#/components/schemas/TaxcardCalcDiffCheck"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}}}}},"delete":{"tags":["Taxcards"],"summary":"Deletes an object from the storage","operationId":"Taxcards_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/taxcards/new":{"get":{"tags":["Taxcards"],"summary":"Factory method that creates a new object","operationId":"Taxcards_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}}}}}},"/v03/api/taxcards/auto-set":{"post":{"tags":["Taxcards"],"summary":"Sets the automatic taxcard on for the given personal ID.\r\nMethod will make the request to tax authorities API immediately.\r\nNOTE: In current implementation, the income type is always Salary (00024: Palkkaa).","operationId":"Taxcards_SetAuto","parameters":[{"name":"personalId","in":"query","description":"Personal ID for which the auto taxcard is set.\r\nIf null, the current user is used: Must be a Worker account.","schema":{"type":"string"}},{"name":"taxPercentMinimum","in":"query","description":"A Worker may request a minimum percent that is deducted even if the effective tax percent would be lower.\r\nThis can be used if Worker knows that he/she will be earning more in the year than what was estimated when the taxcard was created.","schema":{"type":"number","format":"double"}},{"name":"salaryDate","in":"query","description":"The first salary date for which the taxcard is fetched. If null, uses today.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"The taxcard that is fetched from tax authorities. If null, there was no taxcard available and auto is not set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}}}}}},"/v03/api/taxcards/auto-refresh":{"post":{"tags":["Taxcards"],"summary":"Checks automatic taxcards from the Tax authorities API: If the taxcard has been checked within 2 days, does nothing.\r\nIf there are no changes, updates the LastChecked date only. If there are changes, creates a new taxcard container and returns it instead.","operationId":"Taxcards_RefreshAuto","parameters":[{"name":"taxcardIds","in":"query","description":"List of taxcards ids that should be checked","schema":{"type":"array","items":{"type":"string"}}},{"name":"salaryDate","in":"query","description":"The salary date for which the taxcard is fetched. If null, uses today.","schema":{"type":"string","format":"date-time"}},{"name":"forceUpdate","in":"query","description":"If true, skips the 2 day rule and always checks from the tax athorities API.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of taxcards as potentially refreshed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaxcardListItem"}}}}}}}},"/v03/api/taxcards/file/{id}":{"get":{"tags":["Taxcards"],"summary":"Gets a file download (typically PDF or original image) for the taxcard.\r\nShows owned taxcards, taxcards that have the same personal ID as Worker account or that are copies of Worker account's shared card.","operationId":"Taxcards_File","parameters":[{"name":"id","in":"path","description":"Identifier of the taxcard if owned. \r\nFor a shared card or employer added card, may also be the URI of the Employer copy \r\nif the current user is the Worker account with the personal ID or owns the original copy.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"File stream or 404 error if not found."}}}},"/v03/api/taxcards/preview/{id}":{"get":{"tags":["Taxcards"],"summary":"Gets a file preview (typically png) for the taxcard.\r\nShows owned taxcards, taxcards that have the same personal ID as Worker account or that are copies of Worker account's shared card.","operationId":"Taxcards_Preview","parameters":[{"name":"id","in":"path","description":"Identifier of the taxcard if owned. \r\nFor a shared card or employer added card, may also be the URI of the Employer copy \r\nif the current user is the Worker account with the personal ID or owns the original copy.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"File stream or 404 error if not found."}}}},"/v03/api/taxcards/reload-calcs/{id}":{"post":{"tags":["Taxcards"],"summary":"Reloads the income log based on the calculations.\r\nGets all the paid calculations that are relevant to this taxcard and lists them in the income log.\r\nThis method does not yet save the changes.","operationId":"Taxcards_ReloadCalculations","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Taxcard for which the calculations are fetched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}},"required":true},"responses":{"200":{"description":"The single object or null if none is found."}}}},"/v03/api/taxcards/approve/{method}":{"post":{"tags":["Taxcards"],"summary":"Sets the approval for a taxcard.","operationId":"Taxcards_ApproveTaxcard","parameters":[{"name":"method","in":"path","description":"Method of approval. AssureWaiting does not yet approve/reject.\r\nIt just assures that there is a taxcard that can be viewed by the Employer.\r\nThis information is stored in the database so that Worker can see who has looked at his/her taxcards (Data protetion / GDPR).","required":true,"schema":{"$ref":"#/components/schemas/TaxcardApprovalMethod"}},{"name":"ownedId","in":"query","description":"Taxcard that will be approved / rejected. This an ID of the local copy (Employer / current account is owner).\r\nEither ownerId or sharedUri is required.","schema":{"type":"string"}},{"name":"sharedUri","in":"query","description":"Taxcard that will be approved / rejected. This an URI of the Shared taxcard (Worker / owner is part of the URI).\r\nEither ownerId or sharedUri is required.","schema":{"type":"string"}}],"responses":{"200":{"description":"The new instance of the local copy. This may be completely new or just state changed.\r\nEven when the taxcard is rejected there is a local copy that marks the rejection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taxcard"}}}}}}},"/v03/api/taxcards/my":{"get":{"tags":["Taxcards"],"summary":"Gets all the current taxcards for the current Worker account: \r\nThe cards that the account has uploaded as well as the cards created by all Employers.\r\nThis method can only be run for a personal account (not for a Company account).","operationId":"Taxcards_GetMyTaxcards","parameters":[{"name":"paymentDate","in":"query","description":"Payment date for which the validity (current card in use) is calculated. If null, Next workday is used.\r\nThis may be changed to next default payment date without that being a breaking change.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"The cards that the account has uploaded as well as the cards created by all Employers. Only current cards (not expired) are provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerCurrentTaxcards"}}}}}}},"/v03/api/taxcards/issued":{"get":{"tags":["Taxcards"],"summary":"Performs an OData query to the search index. Returns\r\nall","operationId":"Taxcards_ODataSearchIssuedTaxcards","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfTaxcardListItem"}}}}}}},"/v03/api/taxcards/employment/{id}":{"get":{"tags":["Taxcards"],"summary":"Gets all available / current taxcards for an employment.\r\nBy default, these taxcards are added by the Employer, but there may also be the latest taxcard added by the Worker.","operationId":"Taxcards_GetTaxcardsForEmployment","parameters":[{"name":"id","in":"path","description":"Employent ID","required":true,"schema":{"type":"string"}},{"name":"paymentDate","in":"query","description":"Payment date for which the validity (current card in use) is calculated. If null, Next workday is used.\r\nThis may be changed to next default payment date without that being a breaking change.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"The cards that the account has uploaded as well as the cards created by all Employers. Only current cards (not expired) are provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerCurrentTaxcards"}}}}}}},"/v03/api/taxcards/shared-exists/{personalId}":{"get":{"tags":["Taxcards"],"summary":"For an employment relationship that is not yet created, allows checking if there is a shared taxcard.\r\nReturns true if there is a shared taxcard available for the given Personal ID.\r\nNOTE: There are unspecified and potentially changing restrictions on how many times this interface can be called to remove the risk of Phishing.\r\nIf such restriciton hits, the IsError property will be true. In this case, you should currently create the employment relation and fetch the taxcard info after that. \r\nWe may later introduce a \"Are you robot\" type of interface to go around this (if necessary).","operationId":"Taxcards_GetSharedTaxcardExists","parameters":[{"name":"personalId","in":"path","description":"Personal ID of the Worker that will be added.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Anonymous information of the shared taxcard if found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedTaxcardExistsResult"}}}}}}},"/v03/api/taxcards/current":{"get":{"tags":["Taxcards"],"summary":"Gets a list of all non-terminated employments of the employer and resolves their current taxcards.\r\nThe current taxcards may be for the current year or for next year if the current date is either December or January.","operationId":"Taxcards_GetCurrentTaxcards","parameters":[{"name":"paymentDate","in":"query","description":"Payment date for which the validity (current card in use) is calculated. If null, Next workday is used.\r\nThis may be changed to next default payment date without that being a breaking change.","schema":{"type":"string","format":"date-time"}},{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Tax card list items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfTaxcardListItem"}}}}}}},"/v03/api/taxcards/current/{paymentDate}":{"get":{"tags":["Taxcards"],"summary":"Gets a list of all non-terminated employments of the employer and resolves their current taxcards for the\r\npayment date in the path. The current taxcards may be for the current year or for next year if the current\r\ndate is either December or January.","operationId":"Taxcards_GetCurrentTaxcardsByPaymentDate","parameters":[{"name":"paymentDate","in":"path","description":"Payment date for which the validity (current card in use) is calculated. A value that is not a date is\r\nignored, and the next workday is used.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Tax card list items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfTaxcardListItem"}}}}}}},"/v03/api/taxcards/file":{"post":{"tags":["Taxcards"],"summary":"Saves the tax card file for the user.\r\nIn the future returns parsed data from the file.","operationId":"Taxcards_SaveFile","responses":{"200":{"description":"Tax card."}}}},"/v03/api/templates":{"get":{"tags":["Template"],"summary":"Performs an OData query to the search index.","operationId":"Template_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfTemplateListItem"}}}}}},"post":{"tags":["Template"],"summary":"Updates or creates a new object","operationId":"Template_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}}}},"/v03/api/templates/{id}":{"get":{"tags":["Template"],"summary":"Gets a single object based on identier","operationId":"Template_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.\r\nThe indentifier should be in format id@owner if the template is a public read-only item owned by another owner.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}}},"delete":{"tags":["Template"],"summary":"Deletes an object from the storage","operationId":"Template_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/templates/new":{"get":{"tags":["Template"],"summary":"Factory method that creates a new object","operationId":"Template_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}}}},"/v03/api/usecases":{"get":{"tags":["Usecases"],"summary":"Performs an OData query to the search index.","operationId":"Usecases_ODataSearch","parameters":[{"name":"$search","in":"query","schema":{"type":"string"}},{"name":"$filter","in":"query","description":"Specifies the logic to pull back a subset of records.","schema":{"type":"string"}},{"name":"$orderby","in":"query","description":"Specifies the values used to sort the collection of entries.","schema":{"type":"string"}},{"name":"$select","in":"query","description":"The $select system query option allows the clients to requests a limited set of properties for each entry.","schema":{"type":"string"}},{"name":"$top","in":"query","description":"Specifies the subset of entries by count.","schema":{"type":"number"}},{"name":"$skip","in":"query","description":"Specifies the count of entries to skip.","schema":{"type":"number"}},{"name":"$count","in":"query","description":"Indicates whether or not to include a total entry count.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List items according to query options and search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResultOfUsecaseListItem"}}}}}},"post":{"tags":["Usecases"],"summary":"Updates or creates a new object","operationId":"Usecases_CrudSave","requestBody":{"description":"The object to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usecase"}}},"required":true},"responses":{"200":{"description":"The object as saved into the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usecase"}}}}}}},"/v03/api/usecases/{id}":{"get":{"tags":["Usecases"],"summary":"Gets a single object based on identier","operationId":"Usecases_CrudGet","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.\r\nThe indentifier may in format id@owner if the use case is a public read-only item owned by another owner.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The single object or null if none is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usecase"}}}}}},"delete":{"tags":["Usecases"],"summary":"Deletes an object from the storage","operationId":"Usecases_CrudDelete","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\"","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/usecases/{id}/views/{ix}":{"get":{"tags":["Usecases"],"summary":"Gets an html view from a usecase.","operationId":"Usecases_CrudGetView","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.\r\nThe indentifier may in format id@owner if the use case is a public read-only item owned by another owner.","required":true,"schema":{"type":"string"}},{"name":"ix","in":"path","description":"Index number of the view if there are several. Default is 0.","required":true,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"The view HTML or 404 error if none is found.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/usecases/new":{"get":{"tags":["Usecases"],"summary":"Factory method that creates a new object","operationId":"Usecases_CrudGetNew","responses":{"200":{"description":"New object with default values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usecase"}}}}}}},"/v03/api/{apiType}/{id}/versions":{"get":{"tags":["Version"],"summary":"Get list of available versions.","operationId":"Version_ListVersions","parameters":[{"name":"apiType","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VersionInfo"}}}}}}}},"/v03/api/{apiType}/{id}/versions/{versionId}":{"get":{"tags":["Version"],"summary":"Get specific version of the resource","operationId":"Version_GetVersion","parameters":[{"name":"apiType","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCrudObject"}}}}}}},"/v03/api/{apiType}/{id}/list-item":{"get":{"tags":["ApiCrudUtility"],"summary":"Returns the api list item for the given API object.","operationId":"ApiCrudUtility_CrudGetAsListItem","parameters":[{"name":"apiType","in":"path","description":"API type for the object: calculations, payroll, workers","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Unique identifier for the API object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List item for the given API object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiListItem"}}}}}}},"/v03/api/{apiType}/{id}/workflows":{"get":{"tags":["Workflow"],"summary":"Returns workflow data for the given API object.","operationId":"Workflow_CrudGet","parameters":[{"name":"apiType","in":"path","description":"API type for the object: calculations, payroll, workers","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Unique identifier for the API object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow data for the given API object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowData"}}}}}},"post":{"tags":["Workflow"],"summary":"Adds or updates workflow event for the given API object.","operationId":"Workflow_CrudSave","parameters":[{"name":"apiType","in":"path","description":"API type for the object: calculations, payroll, workers","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Unique identifier for the API object","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Event to add or update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowEvent"}}},"required":true},"responses":{"200":{"description":"Workflow data for the given API object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowData"}}}}}}},"/v03/api/{apiType}/{id}/workflows/events/{eventId}":{"get":{"tags":["Workflow"],"summary":"Returns workflow event for the given API object and event id.","operationId":"Workflow_CrudGetEvent","parameters":[{"name":"apiType","in":"path","description":"API type for the object: calculations, payroll, workers","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Unique identifier for the API object","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","description":"Unique id for the event.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow data for the given API object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowEvent"}}}}}}},"/v03/api/{apiType}/{id}/workflows/{eventIdOrType}":{"delete":{"tags":["Workflow"],"summary":"Deletes the workflow event from the given API object.","operationId":"Workflow_CrudDelete","parameters":[{"name":"apiType","in":"path","description":"API type for the object: calculations, payroll, workers","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Unique identifier for the API object","required":true,"schema":{"type":"string"}},{"name":"eventIdOrType","in":"path","description":"Id or type of the event to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text \"Object deleted\".","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v03/api/row-usecases/CarBenefit":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for CarBenefit usecase.","operationId":"RowUsecases_CarBenefit","parameters":[{"name":"ageGroup","in":"query","description":"Age group as in A,B,C or I for international.","schema":{"$ref":"#/components/schemas/AgeGroupCode"}},{"name":"isKilometersBased","in":"query","description":"If true, the calculation is kilometers based.","schema":{"type":"boolean"}},{"name":"kilometers","in":"query","description":"Number of kilometers is filled in only if that type of benefit calculation is used.","schema":{"type":"integer","format":"int32"}},{"name":"emissionsValue","in":"query","description":"Car emissions value\r\n\r\nThe car emissions value must be greater than or equal to 0, and smaller than or\r\nequal to 100. The car emissions value can only be reported if the payment date\r\nor other reporting date is in 2022–2025.","schema":{"type":"number","format":"double"}},{"name":"deduction","in":"query","description":"Deduction from salary","schema":{"type":"number","format":"double"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/CarBenefitKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/BicycleBenefit":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for BicycleBenefit usecase.","operationId":"RowUsecases_BicycleBenefit","parameters":[{"name":"deduction","in":"query","description":"Deduction from salary","schema":{"type":"number","format":"double"}},{"name":"taxable","in":"query","description":"Taxable amount of the benefit.","schema":{"type":"number","format":"double"}},{"name":"periodDivider","in":"query","description":"Number of periods if Kind is PeriodicalDeduction. \r\nOtherwise this value is null.","schema":{"type":"integer","format":"int32"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/BicycleBenefitKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/AbsencePeriod":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for AbsencePeriod usecase.","operationId":"RowUsecases_AbsencePeriod","parameters":[{"name":"isPaid","in":"query","description":"If true, the absence is paid by the employer.\r\nIf null, uses the default value from the absence cause.","schema":{"type":"boolean"}},{"name":"isHolidayAccrual","in":"query","description":"If true, annual leaves are accrued from the absence. If false, these days are deducted from the accrual.\r\nBy default, you may leave this null and it always follows the IsPaid.","schema":{"type":"boolean"}},{"name":"applyPricing","in":"query","description":"If true, resolves the price for the absence day from the employee's pricing rows or holiday year","schema":{"type":"boolean"}},{"name":"bonusDaysCount","in":"query","description":"Number of Bonus days to be paid. This is applicable only for AbsenceCauseCode.AnnualLeaveAnnualLeave.","schema":{"type":"number","format":"double"}},{"name":"bonus","in":"query","description":"Resolved runtime. Bonus percent for holiday bonus.","schema":{"type":"number","format":"double"}},{"name":"notes","in":"query","description":"Additional information as recorded by the Employer.","schema":{"type":"string"}},{"name":"hasDeductionRow","in":"query","description":"Resolved runtime. The deduction for the standard salary will be added.","schema":{"type":"boolean"}},{"name":"deductionRowType","in":"query","description":"Resolved runtime. Deduction row type.","schema":{"$ref":"#/components/schemas/CalculationRowType"}},{"name":"deductionType","in":"query","description":"Resolved runtime. Deduction type.","schema":{"type":"string"}},{"name":"deductionKind","in":"query","description":"Resolved runtime. Deduction kind.","schema":{"type":"string"}},{"name":"deductionPrice","in":"query","description":"Resolved runtime. Deduction price.","schema":{"type":"number","format":"double"}},{"name":"monthlySalary","in":"query","description":"Resolved runtime. Monthly salary used in pricing.","schema":{"type":"number","format":"double"}},{"name":"workDaysInMonth","in":"query","description":"Resolved runtime. Work days in month.","schema":{"type":"integer","format":"int32"}},{"name":"wageBasis","in":"query","description":"Resolved runtime. Wage basis.","schema":{"$ref":"#/components/schemas/WageBasis"}},{"name":"holidayYear","in":"query","description":"Holiday year to consume, if the period is outside the normal holiday pay period for the holiday year.","schema":{"type":"integer","format":"int32"}},{"name":"usecaseId","in":"query","description":"Usecase id.","schema":{"type":"string"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/AbsenceCauseCode"}},{"name":"start","in":"query","description":"Start date of the period","schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","description":"End date of the period.","schema":{"type":"string","format":"date-time"}},{"name":"daysCount","in":"query","description":"Number of days in the range.\r\nDepending of the context, this may be mathematical (end - start) or \r\nexplicitly specified (typically working days).\r\nTypically an integer, and calculations and UI's may choose to round it.","schema":{"type":"number","format":"double"}},{"name":"days","in":"query","description":"The collection of days contained in the DateRange if specified by the user.\r\nAlternative to DaysCount. If set, should also set DaysCount for backward compatibility.","schema":{"type":"array","items":{"type":"string","format":"date-time"}}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/DailyAllowance":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for DailyAllowance usecase.","operationId":"RowUsecases_DailyAllowance","parameters":[{"name":"isHalf","in":"query","description":"If true, the daily allowance is paid in half: The Worker has received 2 free meals (1 if PartialDailyAllowance).\r\nThis information is currently not reported to Incomes Register, it is only as information for calculation.","schema":{"type":"boolean"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/DailyAllowanceKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/MealBenefit":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for MealBenefit usecase.","operationId":"RowUsecases_MealBenefit","parameters":[{"name":"deduction","in":"query","description":"Deduction from salary","schema":{"type":"number","format":"double"}},{"name":"taxablePrice","in":"query","description":"The taxable price calculated by the server.","schema":{"type":"number","format":"double"}},{"name":"isTaxValue","in":"query","description":"If true, the deduction from Worker salary corresponds to taxable value.","schema":{"type":"boolean"}},{"name":"isTaxValueDeductionDone","in":"query","description":"If true, the deduction from Worker Salary has already been done or will be done and is not added to this calculation.","schema":{"type":"boolean"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/MealBenefitKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/NonProfitOrg":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for NonProfitOrg usecase.","operationId":"RowUsecases_NonProfitOrg","parameters":[{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/NonProfitOrgKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/SubsidisedCommute":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for SubsidisedCommute usecase.","operationId":"RowUsecases_SubsidisedCommute","parameters":[{"name":"deduction","in":"query","description":"Deduction from salary","schema":{"type":"number","format":"double"}},{"name":"taxable","in":"query","description":"Taxable amount of the benefit.","schema":{"type":"number","format":"double"}},{"name":"periodDivider","in":"query","description":"Number of periods if Kind is PeriodicalDeduction. \r\nOtherwise this value is null.","schema":{"type":"integer","format":"int32"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/SubsidisedCommuteKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/UnionPayment":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for UnionPayment usecase.","operationId":"RowUsecases_UnionPayment","parameters":[{"name":"referenceNumber","in":"query","description":"Reference for the union payment.","schema":{"type":"string"}},{"name":"recipientFullName","in":"query","description":"The full name of the union for payment purposes.","schema":{"type":"string"}},{"name":"iban","in":"query","description":"The International Bank Account Number of the union.","schema":{"type":"string"}},{"name":"paymentPercentage","in":"query","description":"Percentage of the total taxable amount to pay.\r\nPlease note that this is only applicable for UnionPaymentKind.PercentageAndLimits.","schema":{"type":"number","format":"double"}},{"name":"maximumPayment","in":"query","description":"Maximum payment limit, or null if not desired.\r\nPlease note that this is only applicable for UnionPaymentKind.PercentageAndLimits.","schema":{"type":"number","format":"double"}},{"name":"minimumPayment","in":"query","description":"Minimum payment limit, or null if not desired.\r\nPlease note that this is only applicable for UnionPaymentKind.PercentageAndLimits.","schema":{"type":"number","format":"double"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/UnionPaymentKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/IrIncomeType":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for IrIncomeType usecase.","operationId":"RowUsecases_IrIncomeType","parameters":[{"name":"IrData.Code","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"IrData.Flags","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/IrFlags"}}},{"name":"IrData.InsuranceExceptions","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/IrInsuranceExceptions"}}},{"name":"IrData.DailyAllowance","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/AllowanceCode"}}},{"name":"IrData.MealBenefitIsTaxValue","in":"query","schema":{"type":"boolean"}},{"name":"IrData.CarBenefit.CarBenefitCode","in":"query","schema":{"$ref":"#/components/schemas/CarBenefitCode"}},{"name":"IrData.CarBenefit.AgeGroupCode","in":"query","schema":{"$ref":"#/components/schemas/AgeGroupCode"}},{"name":"IrData.CarBenefit.Kilometers","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"IrData.CarBenefit.EmissionsValue","in":"query","schema":{"type":"number","format":"double"}},{"name":"IrData.NoTransactionAmount","in":"query","schema":{"type":"boolean"}},{"name":"IrData.TaxDefault","in":"query","schema":{"$ref":"#/components/schemas/IrTaxDefault"}},{"name":"unit","in":"query","description":"IR unit.","schema":{"$ref":"#/components/schemas/Unit"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/TransactionCode"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Overrides the tax default of the income type (e.g. no tax for late-payment interest, VH/2593/00.01.00/2019).\r\nOnly supported for CapitalIncomePayment (332), ignored for other codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/Board":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for Board usecase.","operationId":"RowUsecases_Board","parameters":[{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/BoardKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/Remuneration":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for Remuneration usecase.","operationId":"RowUsecases_Remuneration","parameters":[{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/RemunerationKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/OtherCompensation":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for OtherCompensation usecase.","operationId":"RowUsecases_OtherCompensation","parameters":[{"name":"taxDefault","in":"query","description":"Overrides the tax default of the income type (e.g. no tax for late-payment interest).\r\nOnly supported for CapitalIncomePayment.","schema":{"$ref":"#/components/schemas/IrTaxDefault"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/OtherCompensationKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/WorkingTimeCompensation":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for WorkingTimeCompensation usecase.","operationId":"RowUsecases_WorkingTimeCompensation","parameters":[{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/WorkingTimeCompensationKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/EmploymentTermination":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for EmploymentTermination usecase.","operationId":"RowUsecases_EmploymentTermination","parameters":[{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/EmploymentTerminationKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/HourlySalaryWithWorkingTimeCompensation":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for HourlySalaryWithWorkingTimeCompensation usecase.","operationId":"RowUsecases_HourlySalaryWithWorkingTimeCompensation","parameters":[{"name":"compensationRows","in":"query","description":"Collection of compensation rows.","schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkingTimeCompensationRow"}}},{"name":"pricing","in":"query","description":"Pricing for the compensation row.","schema":{"$ref":"#/components/schemas/WorkingTimeCompensationPricing"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/WorkingTimeCompensationKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/PaidSickLeave":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for PaidSickLeave usecase.","operationId":"RowUsecases_PaidSickLeave","parameters":[{"name":"unit","in":"query","description":"IR unit.","schema":{"$ref":"#/components/schemas/Unit"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/PaidSickLeaveKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/Training":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for Training usecase.","operationId":"RowUsecases_Training","parameters":[{"name":"unit","in":"query","description":"IR unit.","schema":{"$ref":"#/components/schemas/Unit"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/TrainingKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/Foreclosure":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for Foreclosure usecase.","operationId":"RowUsecases_Foreclosure","parameters":[{"name":"referenceNumber","in":"query","description":"Reference for the payment.","schema":{"type":"string"}},{"name":"periodLength","in":"query","description":"Length of the salary payment period.","schema":{"type":"integer","format":"int32"}},{"name":"dependantsCount","in":"query","description":"Count of dependants of the debtor. Typically spouse and children.","schema":{"type":"integer","format":"int32"}},{"name":"protectedPortionBase","in":"query","description":"Amount of the protected portion for each day.","schema":{"type":"number","format":"double"}},{"name":"protectedPortionDependant","in":"query","description":"Amount of the protected portion for each dependant for each day.","schema":{"type":"number","format":"double"}},{"name":"incomeFromOtherSources","in":"query","description":"Income from other sources.","schema":{"type":"number","format":"double"}},{"name":"additionalAmountLeftToDebtor","in":"query","description":"Additional amount to be left to debtor.","schema":{"type":"number","format":"double"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/ForeclosureKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/PayStats":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for PayStats usecase.","operationId":"RowUsecases_PayStats","parameters":[{"name":"id","in":"query","description":"Id for the pay statistics type.","schema":{"type":"string"}},{"name":"periodLength","in":"query","description":"Period type for the pay statistics calculation.","schema":{"$ref":"#/components/schemas/PayStatsPeriodLength"}},{"name":"periodDateKind","in":"query","description":"Date kind for the period.","schema":{"$ref":"#/components/schemas/PeriodDateKind"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/PayStatsKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/TotalWorkerPayment":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for TotalWorkerPayment usecase.","operationId":"RowUsecases_TotalWorkerPayment","parameters":[{"name":"rowType","in":"query","description":"Calculation row type for adjusting the amount.","schema":{"$ref":"#/components/schemas/CalculationRowType"}},{"name":"message","in":"query","description":"Message for the row.","schema":{"type":"string"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/TotalWorkerPaymentKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/TaxAtSource":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for TaxAtSource usecase.","operationId":"RowUsecases_TaxAtSource","parameters":[{"name":"taxValue","in":"query","description":"Tax value is either the fixed value (euro) or percentage (0-1) depending on the kind.","schema":{"type":"number","format":"double"}},{"name":"deductionPrice","in":"query","description":"Deduction for the tax at source: Fixed, Monthly or Daily","schema":{"type":"number","format":"double"}},{"name":"deductionCount","in":"query","description":"Count of deduction units: 1 or number of months or days.","schema":{"type":"number","format":"double"}},{"name":"deduction","in":"query","description":"Value of the deduction: Deduction * DeductionCount","schema":{"type":"number","format":"double"}},{"name":"totalTaxable","in":"query","description":"Total taxable value of the salary calculation.","schema":{"type":"number","format":"double"}},{"name":"EmploymentData.Percent","in":"query","schema":{"type":"number","format":"double"}},{"name":"EmploymentData.DeductionMonthly","in":"query","schema":{"type":"number","format":"double"}},{"name":"EmploymentData.DeductionDaily","in":"query","schema":{"type":"number","format":"double"}},{"name":"allowedKinds","in":"query","description":"List of allowed kinds (deductions based on source data).\r\nCurrently as a comma separated string.","schema":{"type":"string"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/TaxAtSourceKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Daily deduction (e.g. 17 €/day) if one can be used for this card.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}},"/v03/api/row-usecases/TaxWithholding":{"post":{"tags":["RowUsecases"],"summary":"Stand-alone test method for TaxWithholding usecase.","operationId":"RowUsecases_TaxWithholding","parameters":[{"name":"taxValue","in":"query","description":"Tax percent (0 - 1) TaxWithholdingKind.Percentage or fixed euro amount TaxWithholdingKind.FixedValue for tax with holding.","schema":{"type":"number","format":"double"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/TaxWithholdingKind"}},{"name":"price","in":"query","description":"Row price","schema":{"type":"number","format":"double"}},{"name":"count","in":"query","description":"Row count, default is 1","schema":{"type":"number","format":"double","default":1}},{"name":"message","in":"query","description":"Message for the usecase row.","schema":{"type":"string"}}],"requestBody":{"description":"Calculation that is the bases for testing. If null, a new one is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}},"required":true},"responses":{"200":{"description":"Usecase calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calculation"}}}}}}}},"components":{"schemas":{"AbsenceCauseCode":{"enum":["undefined","unpaidLeave","personalReason","illness","partTimeSickLeave","parentalLeave","specialMaternityLeave","rehabilitation","childIllness","partTimeChildCareLeave","training","jobAlternationLeave","studyLeave","industrialAction","interruptionInWorkProvision","leaveOfAbsence","militaryRefresherTraining","militaryService","layOff","childCareLeave","midWeekHoliday","accruedHoliday","occupationalAccident","annualLeave","partTimeAbsenceDueToRehabilitation","other"],"type":"string","description":"Absence causes (All: Paid as well as Unpaid in one enumeration.)"},"AbsencePeriod":{"type":"object","properties":{"id":{"type":"string","description":"Identifies a single leave."},"period":{"description":"Period for the absance.","$ref":"#/components/schemas/DateRange"},"causeCode":{"description":"Cause / type of the absence","$ref":"#/components/schemas/AbsenceCauseCode"},"isPaid":{"type":["null","boolean"],"description":"If true, the absence is paid by the employer."},"isHolidayAccrual":{"type":["null","boolean"],"description":"If true, annual leaves are accrued from the absence. If false, these days are deducted from the accrual.\r\nBy default, you may leave this null and it always follows the IsPaid."},"amount":{"type":"number","description":"Amount of salary that is paid for the absense.\r\nCurrently not in use: Would be used in Incomes Register integration.","format":"double"},"notes":{"type":"string","description":"Additional information as recorded by the Employer."},"sourceId":{"type":"string","description":"Identifier in the source system is a key defined by a source system / partner system.\r\nThis is a pass-through string that is passed to the result calculations."},"bonusDaysCount":{"type":["null","number"],"description":"Number of Bonus days to be paid. This is applicable only for AbsenceCauseCode.AnnualLeaveAnnualLeave.","format":"double"},"holidayYear":{"type":["null","integer"],"description":"Holiday year to consume, if the period is outside the normal holiday pay period for the holiday year.","format":"int32"}},"additionalProperties":false,"description":"Period of absence"},"AbsencePeriodUsecase":{"type":"object","properties":{"isPaid":{"type":["null","boolean"]},"isHolidayAccrual":{"type":["null","boolean"]},"applyPricing":{"type":["null","boolean"]},"bonusDaysCount":{"type":["null","number"],"format":"double"},"bonus":{"type":["null","number"],"format":"double"},"notes":{"type":["null","string"]},"hasDeductionRow":{"type":["null","boolean"]},"deductionRowType":{"enum":["unknown","salary","hourlySalary","monthlySalary","totalWorkerPayment","totalEmployerPayment","timeRatePay","compensation","overtime","tesWorktimeShortening","eveningAddition","nightimeAddition","saturdayAddition","sundayWork","otherAdditions","paidSickLeaveSalary","paidSickLeaveHourlySalary","paidSickLeaveMonthlySalary","trainingSalary","trainingHourlySalary","trainingMonthlySalary","accomodationBenefit","mealBenefit","phoneBenefit","carBenefit","bicycleBenefit","otherBenefit","holidayCompensation","holidayBonus","holidaySalary","dailyAllowance","dailyAllowanceHalf","mealCompensation","milageOwnCar","toolCompensation","expenses","milageDaily","milageOther","unionPayment","foreclosure","advance","foreclosureByPalkkaus","prepaidExpenses","otherDeductions","deductibleOfExerciseAndCultureBenefit","childCareSubsidy","chainsawReduction","nonProfitOrg","subsidisedCommute","irIncomeType","board","remuneration","otherCompensation","workingTimeCompensation","employmentTermination","hourlySalaryWithWorkingTimeCompensation","paidSickLeave","training","payStats","taxAtSource","taxWithholding","absencePeriod","serviceCharge","service","info","totals"],"type":"string"},"deductionType":{"type":["null","string"]},"deductionKind":{"type":["null","string"]},"deductionPrice":{"type":["null","number"],"format":"double"},"monthlySalary":{"type":["null","number"],"format":"double"},"workDaysInMonth":{"type":["null","integer"]},"wageBasis":{"enum":["undefined","monthly","hourly","performanceBased","other"],"type":"string"},"holidayYear":{"type":["null","integer"]},"usecaseId":{"type":["null","string"]},"kind":{"enum":["undefined","unpaidLeave","personalReason","illness","partTimeSickLeave","parentalLeave","specialMaternityLeave","rehabilitation","childIllness","partTimeChildCareLeave","training","jobAlternationLeave","studyLeave","industrialAction","interruptionInWorkProvision","leaveOfAbsence","militaryRefresherTraining","militaryService","layOff","childCareLeave","midWeekHoliday","accruedHoliday","occupationalAccident","annualLeave","partTimeAbsenceDueToRehabilitation","other"],"type":"string"}},"additionalProperties":false},"Account":{"type":"object","properties":{"webServiceAccount":{"type":"boolean","description":"Gets or sets a value indicating whether the account is a web service account."},"webServicePaymentId":{"type":"string","description":"Gets or sets the web service payment ID associated with the account."},"bank":{"description":"Gets or sets the name of the bank associated with the account.","$ref":"#/components/schemas/Bank"},"iban":{"type":"string","description":"Gets or sets the International Bank Account Number (IBAN) of the account."},"name":{"type":"string","description":"Gets or sets the name of the account."},"owner":{"type":"string","description":"Gets or sets the owner of the account."},"product":{"type":"string","description":"Gets or sets the product type of the account."},"currency":{"description":"Gets or sets the currency of the account.","$ref":"#/components/schemas/Currency"},"bic":{"type":"string","description":"Gets or sets the Bank Identifier Code (BIC) of the account."},"authorizations":{"description":"Gets or sets the account authorizations.","$ref":"#/components/schemas/AccountAuthorizations"},"created":{"type":["null","string"],"description":"Gets or sets the creation date of the entity.","format":"date-time"},"updated":{"type":["null","string"],"description":"Gets or sets the last updated date of the entity.","format":"date-time"},"id":{"type":"string","description":"Gets or sets the unique identifier of the entity."}},"additionalProperties":false,"description":"Represents a bank account in the Visma BankConnect system."},"AccountantInfo":{"type":"object","properties":{"accountantEmailsOrdered":{"type":"boolean","description":"If true, the customer wants to receive monthly accounting emails to the specified email address.\r\nThis setting applies currently on primary partners only."},"avatar":{"description":"Avatar for the account","$ref":"#/components/schemas/Avatar"},"officialId":{"type":"string","description":"Official id of the person or company."},"email":{"type":"string","description":"Email address."},"telephone":{"type":"string","description":"Telephone number."},"ibanNumber":{"type":"string","description":"Bank account number (IBAN)"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"language":{"description":"Preferred language. Not in index.","$ref":"#/components/schemas/Language"},"authorizations":{"type":"array","items":{"type":"string"},"description":"Account authorizations. Not in index."}},"additionalProperties":false,"description":"Accountant details."},"AccountantType":{"enum":["unknown","unlinkedPrimaryPartner","unlinkedAccountingOnly","pendingPrimaryPartner","primaryPartner","none"],"type":"string"},"AccountAuthorizations":{"type":"object","properties":{"accounts":{"$ref":"#/components/schemas/Authorization"},"payments":{"$ref":"#/components/schemas/Authorization"}},"additionalProperties":false},"AccountBase":{"type":"object","properties":{"entityType":{"description":"Entity type of the account.\r\nType PersonCreatedByEmployer means that the Worker has not yet signed into the system and there may be multiple instances of the same logical person (Official ID) - one for each employer.","$ref":"#/components/schemas/LegalEntityType"},"isEmployer":{"type":"boolean","description":"If true the object Account is and Employer account - it has the EmployerInfo object"},"isWorker":{"type":"boolean","description":"If true the object Account is and Worker account - it has the WorkerInfo object"},"isVerified":{"type":"boolean","description":"If true, the account has been verified. Typically this means a digitally signed contract.\r\nThis means that the account also has an Identity object.\r\nHowever, as the Identity object contains confidential information, it is not necessarily present in all method calls."},"avatar":{"description":"Avatar is the visual representation of the Account.","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the Account.","$ref":"#/components/schemas/Contact"},"language":{"description":"Language of the person/company.","$ref":"#/components/schemas/Language"},"serviceModelId":{"type":"string","description":"Service model for the account."},"workflowData":{"description":"Workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Account - either Person or Company - is a juridical entity Paying or receiving salaries, making contracts etc.\r\nIt may be related to zero, one or multiple UserAccounts/Credentials."},"AccountingChannel":{"enum":["undefined","procountor","vismaNetvisor","vismaFivaldi"],"type":"string","description":"Technical channel into which Salaxy can send the accounting data."},"AccountingData":{"type":"object","properties":{"ledgerAccounts":{"type":"array","items":{"$ref":"#/components/schemas/LedgerAccount"},"description":"All ledgers."},"target":{"description":"Basic information and visualization for the accounting target.\r\nAvatar provides the visualization and the name for the target.\r\nE-mail may be used in sending of the material and telephone in contacting the accounting target.\r\nIBAN number has no use.","$ref":"#/components/schemas/AccountInIndex"},"format":{"type":"string","description":"The default export format for tabular (csv, excel) data."},"officialId":{"type":"string","description":"Finnish Business Identifier (Y-tunnus) for the company."},"employer":{"description":"Employer avatar","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the report. Typically the employer, but may be something else.","$ref":"#/components/schemas/Contact"},"period":{"description":"Period for the report.","$ref":"#/components/schemas/DateRange"},"summary":{"description":"Summary containing relevant numbers for the report. For example,\r\nnumber of calculations, gross and net amounts, payment amounts and Palkkaus fee.","$ref":"#/components/schemas/AccountingDataSummary"}},"additionalProperties":false,"description":"Accounting data for reports."},"AccountingDataSummary":{"type":"object","properties":{"calculationCount":{"type":"integer","description":"The total number of calculations included in the report.","format":"int32"},"workerCount":{"type":"integer","description":"The total number of distinct workers included in the report.","format":"int32"},"totalGrossSalary":{"type":"number","description":"Total gross salary of the calculations included in the report.","format":"double","readOnly":true},"totalPayment":{"type":"number","description":"Total payment of the calculations included in the report.","format":"double","readOnly":true},"totals":{"description":"Calculation totals that are common to both Worker and Employer.","$ref":"#/components/schemas/TotalCalculationDTO"},"employerCalc":{"description":"The calculation from the Employer point-of-view","$ref":"#/components/schemas/EmployerCalculationDTO"},"workerCalc":{"description":"The calculation from the Worker point-of-view","$ref":"#/components/schemas/WorkerCalculationDTO"},"holidayCalc":{"description":"Calculation totals of accrued total holiday pay and related sidecosts.","$ref":"#/components/schemas/HolidayCalculationDTO"},"validation":{"description":"Validation messages for the accounting data.","$ref":"#/components/schemas/ApiValidation"}},"additionalProperties":false,"description":"Summary of the accounting data. Contains main figures: totals and workers and employer total figures."},"AccountingHolidayPayDebtReportData":{"type":"object","properties":{"officialId":{"type":"string","description":"Finnish Business Identifier (Y-tunnus) for the company."},"employer":{"description":"Employer avatar","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the report. Typically the employer, but may be something else.","$ref":"#/components/schemas/Contact"},"period":{"description":"Period for the report.","$ref":"#/components/schemas/DateRange"},"holidayCalc":{"description":"Calculated totals of accrued total holiday pay and related sidecosts.","$ref":"#/components/schemas/HolidayCalculationDTO"},"holidayYears":{"type":"array","items":{"$ref":"#/components/schemas/AccountingHolidayPayDebtReportDataYear"},"description":"Individual holiday years and their debt data included in the report."}},"additionalProperties":false,"description":"The holiday pay debt data report based on given holiday years."},"AccountingHolidayPayDebtReportDataYear":{"type":"object","properties":{"holidayYear":{"description":"Holiday year for which the debt is calculated.","$ref":"#/components/schemas/HolidayYear"},"holidayCalc":{"description":"Calculation totals of accrued total holiday pay and related sidecosts.","$ref":"#/components/schemas/HolidayCalculationDTO"}},"additionalProperties":false,"description":"Individual holiday year with the debt data."},"AccountingPeriodClosingOption":{"enum":["default","accounting","periodicInvoices","accountingAndPeriodicInvoices","irReports","accountingAndIrReports","periodicInvoicesAndIrReports","accountingAndPeriodicInvoicesAndIrReports"],"type":"string","description":"Accounting period closing options."},"AccountingProduct":{"type":"object","properties":{"status":{"type":"string","readOnly":true},"accountantName":{"type":"string"},"accountantEmail":{"type":"string"},"accountantPhone":{"type":"string"},"enabled":{"type":"boolean","description":"Enabled property set automatically by AccountantName, AccountantEmail and AccountantPhone."},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"First version of the product that integrates the Palkkaus.fi-salary payments \r\nto employers accounting."},"AccountingReportDelivery":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"If true, the delivery is active."},"address":{"type":"string","description":"Address for delivery. Currently only email supported."}},"additionalProperties":false,"description":"Settings for Accounting report delivery."},"AccountingReportRow":{"type":"object","properties":{"rowType":{"description":"Row type. Default is the Booking.","$ref":"#/components/schemas/AccountingReportRowType"},"amount":{"type":"number","description":"Amount for the row: May be positive or negative(depending on the depet/credit and account type).","format":"double"},"vatPercent":{"type":"number","description":"Percentage of the value added tax that is included in the amount.","format":"double"},"accountNumber":{"type":"string","description":"Proposed account number for the row."},"accountText":{"type":"string","description":"Proposed account text for the row."},"code":{"oneOf":[{"type":"null"},{"description":"Salaxy calculation row type.","$ref":"#/components/schemas/CalculationRowType"}]},"resultCode":{"oneOf":[{"type":"null"},{"description":"Salaxy calculation result row type.","$ref":"#/components/schemas/CalculationResultRowType"}]},"productCode":{"type":"string","description":"Returns product code."},"productName":{"type":"string","description":"Returns product name. (Code or ResultCode in this order)."},"text":{"type":"string","description":"Text for the booking entry / header."},"styles":{"type":"string","description":"Space separated set of class names for CSS styling purposes."},"count":{"type":"number","description":"Count of units. Default is 1.","format":"double"},"price":{"type":"number","description":"Price for the unit.","format":"double"},"unit":{"type":"string","description":"Unit identifier;"},"additionalInformation":{"type":"string","description":"Additional information for the row."}},"additionalProperties":false,"description":"Accounting report table row."},"AccountingReportRowType":{"enum":["debit","credit","total","groupHeader","groupTotal","childRow"],"type":"string","description":"Row type for the accounting row."},"AccountingReportTable":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/AccountingReportRow"},"description":"All rows in the report table."},"tableType":{"description":"Accounting report table type.","$ref":"#/components/schemas/AccountingReportTableType"},"businessId":{"type":"string","description":"Finnish Business Identifier (Y-tunnus) for the company."},"employer":{"description":"Employer avatar","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the report. Typically the employer, but may be something else.","$ref":"#/components/schemas/Contact"},"period":{"description":"Period for the report.","$ref":"#/components/schemas/DateRange"},"summary":{"description":"Summary containing relevant numbers for the report. For example,\r\nnumber of calculations, gross and net amounts, payment amounts and Palkkaus fee.","$ref":"#/components/schemas/AccountingReportTableSummary"}},"additionalProperties":false,"description":"Contains accounting rows for one or many calculations."},"AccountingReportTableSummary":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of calculations included in the report.","format":"int32"},"totals":{"description":"Calculation totals that are common to both Worker and Employer.","$ref":"#/components/schemas/TotalCalculationDTO"},"employerCalc":{"description":"The calculation from the Employer point-of-view","$ref":"#/components/schemas/EmployerCalculationDTO"},"workerCalc":{"description":"The calculation from the Worker point-of-view","$ref":"#/components/schemas/WorkerCalculationDTO"}},"additionalProperties":false,"description":"Summary of the accounting report. Contains main figures: totals and workers and employer total figures."},"AccountingReportTableType":{"enum":["classic","simple","mapped"],"type":"string","description":"Types for the accounting report table."},"AccountingRowReportData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/AccountingRowReportDataRow"},"description":"Report row created from accounting base rows."},"officialId":{"type":"string","description":"Finnish Business Identifier (Y-tunnus) for the company."},"employer":{"description":"Employer avatar","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the report. Typically the employer, but may be something else.","$ref":"#/components/schemas/Contact"},"period":{"description":"Period for the report.","$ref":"#/components/schemas/DateRange"},"summary":{"description":"Summary containing relevant numbers for the report. For example,\r\nnumber of calculations, gross and net amounts, payment amounts and Palkkaus fee.","$ref":"#/components/schemas/AccountingDataSummary"}},"additionalProperties":false,"description":"Container for accounting based report data."},"AccountingRowReportDataRow":{"type":"object","properties":{"entryCodeGroup":{"type":"string","description":"Entry group: income type or total type"},"entryCode":{"type":"string","description":"A single code in the code group: single income type code or total row."},"entryDate":{"type":["null","string"],"description":"Entry date.","format":"date"},"message":{"type":"string","description":"Entry description."},"amount":{"type":"number","description":"Posted amount. Includes VAT.","format":"double"},"vatPercent":{"type":["null","number"],"description":"VAT percent.","format":"double"},"vatAmount":{"type":["null","number"],"description":"VAT amount of specific VAT rate.","format":"double"},"vatRate":{"description":"Applied VAT rate. This is always mandatory.","$ref":"#/components/schemas/VatRate"},"dimension":{"type":"object","additionalProperties":false,"description":"Dimension data."},"flags":{"type":"array","items":{"type":"string"},"description":"Additional flags for directing the logic for creating accounting entry based on given entries."}},"additionalProperties":false,"description":"Report row created from accounting base row data."},"AccountingRuleSet":{"type":"object","properties":{"templateId":{"type":"string","description":"Template to which this ruleset is based on."},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountingRuleSetAccount"},"description":"Accounts which are used in the tabular logic for creating accounting entries."},"targetCoA":{"type":"array","items":{"$ref":"#/components/schemas/AccountingRuleSetAccount"},"description":"Optional target Chart of Accounts: All the accounts in the target system, not just the ones in use."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/AccountingRuleSetRow"},"description":"Tabular logic for creating accounting entries."}},"additionalProperties":false,"description":"Ruleset containing required tabular logic (rules) and accounts for creating accounting entries."},"AccountingRuleSetAccount":{"type":"object","properties":{"id":{"type":"string","description":"Id for the account."},"isReadOnly":{"type":"boolean","description":"Boolean indicating if the account is non-removable template."},"account":{"type":"string","description":"Account number."},"text":{"type":"string","description":"Text for the account."}},"additionalProperties":false,"description":"Single account with number, grouping and default text."},"AccountingRuleSetRow":{"type":"object","properties":{"id":{"type":"string","description":"Id for the row."},"entryCodeGroup":{"type":"string","description":"Entry group: income type or total type."},"entryCode":{"type":"string","description":"A single code in the code group: single income type code or total row type."},"isReadOnly":{"type":"boolean","description":"Boolean indicating if the row is non-removable template."},"enabled":{"type":"boolean","description":"Boolean indicating if the row is in use."},"isIncluded":{"type":"boolean","description":"Boolean indicating whether the system should make an accounting entry based on this row."},"debitId":{"type":"string","description":"Id of the debit account."},"debitGrouping":{"type":"string","description":"Grouping text for the account.\r\nIf the account has a grouping defined, it will be listed as a separate row group."},"creditId":{"type":"string","description":"Id of the credit account."},"creditGrouping":{"type":"string","description":"Grouping text for the account.\r\nIf the account has a grouping defined, it will be listed as a separate row group."},"flags":{"type":"array","items":{"type":"string"},"description":"Additional flags for directing the logic for creating accounting entry based on given entries."}},"additionalProperties":false,"description":"Contains a single row of the tabular logic for creating accounting entries."},"AccountingSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"defaultTargetId":{"type":"string","description":"Default accounting target."},"targets":{"type":"array","items":{"$ref":"#/components/schemas/AccountingTargetSettings"},"description":"Accounting target systems and the rulesets assigned to them."},"defaultPeriodDateKind":{"description":"Default period selection method:  PaidAt date (paid by employer), Salary date (paid to worker) or Work date (work done). The default is PaidAt date.","$ref":"#/components/schemas/PeriodDateKind"},"reportDelivery":{"description":"Options for accounting report delivery for the company.\r\nThese are not affected by the service model.","$ref":"#/components/schemas/AccountingReportDelivery"},"accountantReportDelivery":{"description":"Options for accounting report delivery for the Accountant.\r\nThese are not affected by the service model.","$ref":"#/components/schemas/AccountingReportDelivery"}},"additionalProperties":false,"description":"Settings related to Accounting"},"AccountingTarget":{"type":"object","properties":{"info":{"description":"Information and configuration related to the system where the accounting data is to be sent.","$ref":"#/components/schemas/AccountingTargetInfo"},"ruleSet":{"description":"The rule set that defines the Chart of Accounts and the mapping of salary payment to it.","$ref":"#/components/schemas/AccountingRuleSet"},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Defines an accounting target (system), CoA and ruleset that maps the calculation to the CoA (Chart of Accounts)."},"AccountingTargetData":{"type":"object","properties":{"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"channel":{"description":"Channel is the technical transport mechanism to accounting software","$ref":"#/components/schemas/AccountingChannel"},"method":{"description":"The default export method for exports: whether automatic or manual.","$ref":"#/components/schemas/ExportMethod"},"availableMethods":{"type":"string","description":"Available methods in manual exports (comma separated string)."},"format":{"type":"string","description":"The default export format for tabular (csv, excel) data."},"templateId":{"type":"string","description":"Template to which this is based on."}},"additionalProperties":false,"description":"Accounting Target specific business data for index."},"AccountingTargetInfo":{"type":"object","properties":{"target":{"description":"Basic information and visualization for the accounting target.\r\nAvatar provides the visualization and the name for the target.\r\nE-mail may be used in sending of the material and telephone in contacting the accounting target.\r\nIBAN number has no use.","$ref":"#/components/schemas/AccountInIndex"},"channel":{"description":"Channel is the technical transport mechanism to accounting software","$ref":"#/components/schemas/AccountingChannel"},"method":{"description":"The default export method for exports: whether automatic or manual.","$ref":"#/components/schemas/ExportMethod"},"availableMethods":{"type":"array","items":{"$ref":"#/components/schemas/ExportMethod"},"description":"If specified, defines the available methods in manual exports."},"format":{"type":"string","description":"The default export format for tabular (csv, excel) data."},"data":{"type":"object","additionalProperties":false,"description":"Accounting channel specific data (default settings) for the accounting target setup."}},"additionalProperties":false,"description":"Specifies the general information of the behavior of Accounting target:\r\nEspecially the channel and the related properties."},"AccountingTargetListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/AccountingTargetStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/AccountingTargetData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of Accounting targets."},"AccountingTargetSettings":{"type":"object","properties":{"id":{"type":"string","description":"Id of the target definition."},"channel":{"description":"Channel is the technical transport mechanism to accounting software","$ref":"#/components/schemas/AccountingChannel"},"method":{"description":"The default export method for exports: whether automatic or manual.","$ref":"#/components/schemas/ExportMethod"},"availableMethods":{"type":"array","items":{"$ref":"#/components/schemas/ExportMethod"},"description":"If specified, defines the available methods in manual exports."},"format":{"type":"string","description":"The default export format for tabular (csv, excel) data."},"avatar":{"description":"Name and visualization for selection lists.","$ref":"#/components/schemas/Avatar"},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data"}},"additionalProperties":false,"description":"Specifies thee properties that are set for this accounting target in relation to the accounting channel."},"AccountingTargetStatus":{"enum":["undefined","ownedTarget","productTarget","sharedTarget"],"type":"string","description":"Defines the status of an accounting target"},"AccountInIndex":{"type":"object","properties":{"avatar":{"description":"Avatar for the account","$ref":"#/components/schemas/Avatar"},"officialId":{"type":"string","description":"Official id of the person or company."},"email":{"type":"string","description":"Email address."},"telephone":{"type":"string","description":"Telephone number."},"ibanNumber":{"type":"string","description":"Bank account number (IBAN)"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"language":{"description":"Preferred language. Not in index.","$ref":"#/components/schemas/Language"},"authorizations":{"type":"array","items":{"type":"string"},"description":"Account authorizations. Not in index."}},"additionalProperties":false,"description":"Object that represents a Salaxy account."},"AccountProducts":{"type":"object","properties":{"baseService":{"description":"The basic services for Salary payment.","$ref":"#/components/schemas/BaseSalaryProduct"},"tax":{"description":"Reports and payments to tax authorities.","$ref":"#/components/schemas/TaxProduct"},"unemployment":{"description":"Reports and payments to TVR (the unemployment insurance fund of Finland)","$ref":"#/components/schemas/UnemploymentProduct"},"pension":{"description":"Reports ant payments to Pension companies.","$ref":"#/components/schemas/PensionProduct"},"insurance":{"description":"Reports and payments for mandatory employment insurances.","$ref":"#/components/schemas/InsuranceProduct"},"accounting":{"description":"Bookkeeping reports for salarypayments","$ref":"#/components/schemas/AccountingProduct"},"healthCareHeltti":{"description":"Employer health care from the company Heltti","$ref":"#/components/schemas/HealthCareHelttiProduct"},"pensionEntrepreneur":{"description":"Pension payments for an entrepreneur","$ref":"#/components/schemas/PensionEntrepreneurProduct"},"pricing":{"description":"Defines the pricing partner, service model and pricing model.","$ref":"#/components/schemas/PricingProduct"}},"additionalProperties":false,"description":"Provides an overview and the possibility to edit products that are enabled to this account"},"AccountSettingsInSession":{"type":"object","properties":{"pensionContracts":{"type":"array","items":{"$ref":"#/components/schemas/PensionContract"},"description":"Pension contracts for optional selection of cotnract in Worker / Calc UI's"},"insuranceContracts":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceContract"},"description":"Insurance contracts for optional selection of cotnract in Worker / Calc UI's"},"hasCustomReport":{"type":"boolean","description":"If true, the reporting layout is customized and should be loadded from the server in preview and reporting."},"accountingTarget":{"description":"The default accounting target for accounting reports.","$ref":"#/components/schemas/AccountingTargetSettings"},"partner":{"description":"Partner and service model","$ref":"#/components/schemas/PrimaryPartnerSettings"},"paymentChannels":{"type":"array","items":{"$ref":"#/components/schemas/PaymentChannel"},"description":"The payment channels that are enabled for the current user."},"defaultPaymentChannel":{"description":"Current default payment channel","$ref":"#/components/schemas/PaymentChannel"},"usecases":{"type":"array","items":{"$ref":"#/components/schemas/UsecaseInSettings"},"description":"Available usecases for the current user."},"integration":{"description":"Basic information about the avialable integrations: Server URL and supported behaviors in the future.","$ref":"#/components/schemas/IntegrationInSession"},"partnerMessages":{"type":"boolean","description":"Partner messages enabled."},"costAccounting":{"description":"Cost accounting model.","$ref":"#/components/schemas/CostAccountingInSession"},"forms":{"description":"Forms settings for session.","$ref":"#/components/schemas/FormsInSession"},"preferences":{"type":"array","items":{"$ref":"#/components/schemas/Preference"},"description":"Customer specific preferences."}},"additionalProperties":false,"description":"Read-only account settings in Session: These are the settings that should be immediately available\r\nin the regular UI without separate loading."},"AccountValidation":{"type":"object","properties":{"isOfficialIdValid":{"type":"boolean","description":"If true the official ID is technically valid.\r\nOfficial ID is either Finnish Personal ID (HETU, Henkilötunnus) or Business ID (Y-tunnus)."},"isAuthorized":{"type":"boolean","description":"If false, none of the accounts in ExistingAccounts cannot be accessed by the current user."},"canStartSign":{"type":"boolean","description":"TODO: NOt implemented yet - should be implemented\r\nIf true, the onboarding object has sufficient data to start the Digital Signature process (Visma Sign).\r\nDepending on the use case this may or may not be required for committing the data as account data."},"isCompleted":{"type":"boolean","description":"If true, the validation process has been completed. The IsValid may be true or false."},"existingAccount":{"description":"Existing account based on official id (Personal ID / Business ID).","$ref":"#/components/schemas/Avatar"},"isValid":{"type":"boolean","description":"If true, the data is valid - no errors.","readOnly":true},"hasAllRequiredFields":{"type":"boolean","description":"If true, has required fields missing data.","readOnly":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiValidationError"},"description":"Validation errors on invalid field values. \r\nNote that required fields missing error messages are not here. Only the invalid values.","readOnly":true}},"additionalProperties":false,"description":"Validation errors for the onboarding process"},"AddressFamily":{"enum":["unspecified","unix","interNetwork","impLink","pup","chaos","nS","ipx","iso","osi","ecma","dataKit","ccitt","sna","decNet","dataLink","lat","hyperChannel","appleTalk","netBios","voiceView","fireFox","banyan","atm","interNetworkV6","cluster","ieee12844","irda","networkDesigners","max","packet","controllerAreaNetwork","unknown"],"type":"string","readOnly":true},"AgeGroupCode":{"enum":["a","b","c","u"],"type":"string"},"AgeRange":{"enum":["unknown","age_15","age16","age17","age18_52","age53_62","age63_64","age65_67","age68AndOVer"],"type":"string","description":"Age groups for legistlative purposes.\r\nTrying to make the numbering future-proof as much as possible.","readOnly":true},"AllowanceCode":{"enum":["mealAllowance","partialDailyAllowance","fullDailyAllowance","internationalDailyAllowance","taxExemptReimbursementsAbroad"],"type":"string"},"AnnualLeave":{"type":"object","properties":{"id":{"type":"string","description":"Identifies a single leave."},"period":{"description":"The planned holiday period.","$ref":"#/components/schemas/DateRange"},"notes":{"type":"string","description":"Additional information as recorded by the Employer."}},"additionalProperties":false,"description":"A planned annual Leave - not sure whether it will kept or is it just planned"},"AnnualLeavePayment":{"type":"object","properties":{"kind":{"description":"Type of the payment entry","$ref":"#/components/schemas/AnnualLeavePaymentKind"},"date":{"type":["null","string"],"description":"The reference date: Typically the Paid at date.\r\nThe items are typically sorted based on this.","format":"date-time"},"holidayDays":{"type":["null","number"],"description":"Days of holidays that are paid or compensated","format":"double"},"holidaySalary":{"type":["null","number"],"description":"Salary that is paid for holidays","format":"double"},"holidayCompensation":{"type":["null","number"],"description":"Compensation that is paid for holidays not kept.","format":"double"},"holidayBonus":{"type":["null","number"],"description":"Bonus for either Holiday Salary or Compensation.","format":"double"},"calcId":{"type":"string","description":"If the payment is defined by a calculation, stores the calculation ID."},"isDisabled":{"type":"boolean","description":"If true, the payment can be ignored."},"id":{"type":"string","description":"Identifies a single leave."},"period":{"description":"The planned holiday period.","$ref":"#/components/schemas/DateRange"},"notes":{"type":"string","description":"Additional information as recorded by the Employer."}},"additionalProperties":false,"description":"Payment related to annual leave: holiday salary, bonus and compensation"},"AnnualLeavePaymentKind":{"enum":["undefined","planned","manualSalary","manualCompensation","manualBonus","paidCalc","draftCalc"],"type":"string","description":"Types of entries in annual leave payment list"},"AnnualLeaves":{"type":"object","properties":{"planned":{"type":"array","items":{"$ref":"#/components/schemas/AnnualLeave"},"description":"Planned annual leaves."},"paid":{"type":"array","items":{"$ref":"#/components/schemas/AnnualLeavePayment"},"description":"Paid or otherwise handled annual leaves.\r\nPRELIMINARY: This property is under revision - it may be moved or renamed without being a breaking change."}},"additionalProperties":false,"description":"Data about the annual leaves planned and used during the holiday year."},"ApiCheckResultOfInvoiceSettings":{"type":"object","properties":{"status":{"description":"Status of the check","$ref":"#/components/schemas/ApiCheckStatus"},"item":{"$ref":"#/components/schemas/InvoiceSettings"}},"additionalProperties":false,"description":"Result of the check. Both status and possible item are returned."},"ApiCheckResultOfWorkerAccountArray":{"type":"object","properties":{"status":{"description":"Status of the check","$ref":"#/components/schemas/ApiCheckStatus"},"item":{"type":"array","items":{"$ref":"#/components/schemas/WorkerAccount"}}},"additionalProperties":false,"description":"Result of the check. Both status and possible item are returned."},"ApiCheckStatus":{"enum":["ignored","success","warning","error"],"type":"string","description":"Result of the check."},"ApiCrudObject":{"type":"object","properties":{"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Abstract base class for implementing CRUD objects in the Salaxy API."},"ApiImportResultOfInvoiceArray":{"type":"object","properties":{"status":{"description":"Status of the import","$ref":"#/components/schemas/ApiImportStatus"},"item":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}},"additionalProperties":false,"description":"Result of the import. Both status and possible item are returned."},"ApiImportResultOfObject":{"type":"object","properties":{"status":{"description":"Status of the import","$ref":"#/components/schemas/ApiImportStatus"},"item":{"type":"object","additionalProperties":false}},"additionalProperties":false,"description":"Result of the import. Both status and possible item are returned."},"ApiImportResultOfPartnerCompanyAccountInfo":{"type":"object","properties":{"status":{"description":"Status of the import","$ref":"#/components/schemas/ApiImportStatus"},"item":{"$ref":"#/components/schemas/PartnerCompanyAccountInfo"}},"additionalProperties":false,"description":"Result of the import. Both status and possible item are returned."},"ApiImportResultOfstring":{"type":"object","properties":{"status":{"description":"Status of the import","$ref":"#/components/schemas/ApiImportStatus"},"item":{"type":"string"}},"additionalProperties":false,"description":"Result of the import. Both status and possible item are returned."},"ApiImportStatus":{"enum":["ignored","success","warning","error"],"type":"string","description":"Result of the import."},"ApiItemType":{"enum":["undefined","calculation","calculationPaid","dataset","payrollDetails","invoice","earningsPaymentReport","payerSummaryReport","employment","companyAccountSettings","messageThread","listItems"],"type":"string","description":"Enumerates the different types of objects in the API"},"ApiListItem":{"type":"object","properties":{"type":{"description":"The payload type of the item.","$ref":"#/components/schemas/ApiListItemType"},"listType":{"type":"string","description":"List item type of the item if the item supports a custom OData interface."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"type":"object","additionalProperties":false,"description":"Business data to include further information of the object."},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"The line item class for search and listing results.\r\nUse this class for building user interfaces."},"ApiListItemType":{"enum":["unknown","accountBase","companyAccount","personAccount","workerAccount","certificate","sessionUserCredential","onboarding","profile","calculation","calculationPaid","eSalaryPayment","payment","earningsPayment","employment","workerAbsences","holidayYear","taxcard","payrollDetails","invoice","report","blobFile","payerSummary","usecase","dataset","article","messageThread","emailMessage","accountProducts","varmaPensionOrder","ifInsuranceOrder","historical"],"type":"string","description":"Type of the list item"},"ApiListItemValidation":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the item this validation is for.\r\nIdentifiers are not always available (if the item has not been saved), so index is a more generic approach."},"index":{"type":"integer","description":"Zero based index of the item this validation is for.","format":"int32"},"isValid":{"type":"boolean","description":"If true, the data is valid - no errors.","readOnly":true},"hasAllRequiredFields":{"type":"boolean","description":"If true, has required fields missing data.","readOnly":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiValidationError"},"description":"Validation errors on invalid field values. \r\nNote that required fields missing error messages are not here. Only the invalid values.","readOnly":true}},"additionalProperties":false,"description":"ApiValidation object that is specialized for list items.\r\nProvides if and index properties for connecting a validation to a specific item in the list"},"ApiTestErrorType":{"enum":["default","userFriendly"],"type":"string","description":"Test error type."},"ApiValidation":{"type":"object","properties":{"isValid":{"type":"boolean","description":"If true, the data is valid - no errors.","readOnly":true},"hasAllRequiredFields":{"type":"boolean","description":"If true, has required fields missing data.","readOnly":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiValidationError"},"description":"Validation errors on invalid field values. \r\nNote that required fields missing error messages are not here. Only the invalid values.","readOnly":true}},"additionalProperties":false,"description":"Common base class / interface for data validation."},"ApiValidationError":{"required":["type","msg"],"type":"object","properties":{"key":{"type":"string","description":"Full path to Name of the property / field (Member name in JSON).\r\nThis may be null/empty for type General."},"type":{"description":"High level type: Specifies the relation to object and its Member.","$ref":"#/components/schemas/ApiValidationErrorType"},"msg":{"type":"string","description":"Validation error message in the requested language."},"description":{"type":"string","description":"Validation error long description in the requested language."},"code":{"type":"string","description":"Some error providers may have a unique technical code for error or validator"}},"additionalProperties":false,"description":"Validation errors used in API output."},"ApiValidationErrorType":{"enum":["general","required","invalid","warning"],"type":"string","description":"High level type of validation errors."},"ApplyClause":{"type":"object","properties":{"transformations":{"type":"array","items":{"$ref":"#/components/schemas/TransformationNode"},"readOnly":true}},"additionalProperties":false,"readOnly":true},"ApplyQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"resultClrType":{"$ref":"#/components/schemas/Type"},"applyClause":{"$ref":"#/components/schemas/ApplyClause"},"rawValue":{"type":"string","readOnly":true}},"additionalProperties":false,"readOnly":true},"AsnEncodedData":{"type":"object","properties":{"oid":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Oid"}]},"rawData":{"type":"string","format":"byte"}},"additionalProperties":false,"readOnly":true},"AssertionDemoCertificateRequest":{"type":"object","properties":{"certificateBytes":{"type":"string","description":"Certificate bytes as Base64String"},"password":{"type":"string","description":"Certificate password for signing."},"subject":{"type":"string","description":"Account to impersonate as: Will be set as sub in the token."},"proxyActor":{"type":"string","description":"Potential proxy (partner) account that is in between the current user and the subject.\r\nWill be set as salaxy_proxy_act in the token."},"userEmail":{"type":"string","description":"E-mail for the user / credential that is using the system.\r\nWill be set as salaxy_user.email."}},"additionalProperties":false,"description":"Request model for Assertion demo"},"AssertionDemoCertificateResponse":{"type":"object","properties":{"token":{"type":"string","description":"Token as string"},"tokenDecoded":{"type":"object","additionalProperties":false,"description":"Token decoded for deisplay purposes."},"error":{"type":"string","description":"If there is an error creating hte certificate, it is displayed here."}},"additionalProperties":false,"description":"Response model for Assertion demo"},"AssureCompanyAccountRequest":{"required":["officialId"],"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678"},"partnerAccountId":{"type":"string","description":"The account identifier at the partner site. \r\nIf present, this ID is used to restrict the authorization to one account at partner site only."},"email":{"type":"string","description":"Contact e-mail"},"telephone":{"type":"string","description":"Telephone number for the contact person"},"contactFirstName":{"type":"string","description":"First name of the contact person"},"contactLastName":{"type":"string","description":"Last name of the contact person"},"proxyPartner":{"type":"string","description":"The primary partner account for the new company to create.\r\nIf the company already exists and has given authorization to the primary partner, and does not have any primary partner, the primary partner will be set.\r\nPlease note, that the calling account must have the authorization to the primary partner account, or\r\nbe the primary partner itself."},"language":{"description":"Language preference.","$ref":"#/components/schemas/Language"}},"additionalProperties":false,"description":"Request to assure that a company account exists:\r\nEither an account is returned or an account stub (non-verified) will be created."},"AsymmetricAlgorithm":{"type":"object","properties":{"keySize":{"type":"integer","format":"int32"},"legalKeySizes":{"type":"array","items":{"$ref":"#/components/schemas/KeySizes"},"readOnly":true},"signatureAlgorithm":{"type":["null","string"],"readOnly":true},"keyExchangeAlgorithm":{"type":["null","string"],"readOnly":true}},"additionalProperties":false},"Attachment":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the attachment. E.g. monthly-details-2018-01.pdf"},"contentId":{"type":"string","description":"Content for data."}},"additionalProperties":false,"description":"Attachment."},"AuthenticationMethod":{"enum":["undefined","emailPwdLocal","facebook","google","microsoft","linkedIn","auth0Database","x509","salaxy","test","webAuthn","microsoftOAuth","googleOAuth","internalLocalhost"],"type":"string","description":"The authentication method for the given UserCredential (Partition key of UserAccount in the Storage)"},"Authority":{"type":"object","properties":{"name":{"type":"string","description":"Name of the authority."},"telephone":{"type":"string","description":"Telephone number of the person. This is currently optional.\r\nIdea is to send SMS invitations in some scenarios."},"email":{"type":"string","description":"E-mail of the person. This is currently not used, but is expected to be used in the future. \r\nSo fill it in as it was required unless you have very compelling reasons."},"personalId":{"type":"string","description":"Finnish Person ID is the key to signature. This is currently always required."},"accountId":{"type":"string","description":"The Palkkaus.fi Account ID. This is optional and should not be set if the ID is the same as the target account / Person."},"authorizedAt":{"type":["null","string"],"description":"Date for the authorization.","format":"date-time"}},"additionalProperties":false,"description":"A person or other party that authorized the current person."},"Authorization":{"type":"object","properties":{"expires":{"type":"string","format":"date-time"}},"additionalProperties":false},"AuthorizationContract":{"type":"object","properties":{"signedAt":{"type":["null","string"],"description":"Time when the contract was signed","format":"date-time"},"isSigned":{"type":"boolean","description":"If true, there is a valid authorization - the account has been validated."},"authorizationType":{"description":"Type of the authorization","$ref":"#/components/schemas/AuthorizationType"},"authorizedBy":{"description":"A person or other party that authorized the current person.","$ref":"#/components/schemas/Authority"}},"additionalProperties":false,"description":"Contract / authorization document that is the bases for Salaxy acting in behalf of this account"},"AuthorizationStatus":{"enum":["undefined","oK","accessDenied","expiredOauthToken","invalidOAuthToken","noOauthToken"],"type":"string","description":"The different possible statuses in the authentication and autheorization process."},"AuthorizationType":{"enum":["none","employerAuthorization","workerContract","companyContract","partnerContract","manual","temporary"],"type":"string"},"AuthorizedAvatar":{"type":"object","properties":{"partnerKey":{"type":"string","description":"Optional ID for partner authorization.\r\nUsed to restrict the authorization based on Partner data (typically user account, role etc.).\r\nCurrent implementation compares this to partnerAccountId and allows acces only if the two match."},"authorizedAt":{"type":["null","string"],"description":"The time when the authorization was done","format":"date-time"},"scope":{"type":"string","description":"Scope for the account authorization.\r\nThe value of the scope  is expressed as a list of space-delimited, case-sensitive strings."},"entityType":{"description":"Entity type: person/company","$ref":"#/components/schemas/LegalEntityType"},"firstName":{"maxLength":100,"type":"string","description":"First name or company name"},"lastName":{"maxLength":100,"type":"string","description":"Last name, for companies, this should be null"},"displayName":{"maxLength":201,"type":"string","description":"Display name. For a person this is 'FirstName LastName' (auto-created)."},"sortableName":{"maxLength":202,"type":"string","description":"Sortable name for ordered lists etc. For a person this is 'LastName, FirstName' (auto-created).\r\nDepending on the data storage, this may be all-lowercase for easier sorting and search."},"pictureType":{"description":"Type of the Avatar picture.","$ref":"#/components/schemas/AvatarPictureType"},"color":{"maxLength":32,"type":"string","description":"Color - currently only used by type Icon","format":"color"},"initials":{"type":"string","description":"Initials - currently only used by type Icon"},"url":{"maxLength":512,"type":"string","description":"URL of the picture if specified as picture (null in a case of type Icon)"},"description":{"maxLength":1024,"type":"string","description":"Short description of the user. \r\nThis may be overriden by a context specific value by the business logic."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Avatar for authorized account."},"Avatar":{"type":"object","properties":{"entityType":{"description":"Entity type: person/company","$ref":"#/components/schemas/LegalEntityType"},"firstName":{"maxLength":100,"type":"string","description":"First name or company name"},"lastName":{"maxLength":100,"type":"string","description":"Last name, for companies, this should be null"},"displayName":{"maxLength":201,"type":"string","description":"Display name. For a person this is 'FirstName LastName' (auto-created)."},"sortableName":{"maxLength":202,"type":"string","description":"Sortable name for ordered lists etc. For a person this is 'LastName, FirstName' (auto-created).\r\nDepending on the data storage, this may be all-lowercase for easier sorting and search."},"pictureType":{"description":"Type of the Avatar picture.","$ref":"#/components/schemas/AvatarPictureType"},"color":{"maxLength":32,"type":"string","description":"Color - currently only used by type Icon","format":"color"},"initials":{"type":"string","description":"Initials - currently only used by type Icon"},"url":{"maxLength":512,"type":"string","description":"URL of the picture if specified as picture (null in a case of type Icon)"},"description":{"maxLength":1024,"type":"string","description":"Short description of the user. \r\nThis may be overriden by a context specific value by the business logic."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Defines an avatar for an account, profile etc. - mainly the image that should be shown, names and short description"},"AvatarPictureType":{"enum":["icon","uploaded","gravatar"],"type":"string","description":"Type of the Avatar picture"},"Bank":{"enum":["uNDEFINED","oSUUSPANKKI","nORDEA","nORDEA_PERSONAL","hOLVI","pOPPANKKI","oMASÄÄSTÖPANKKI","sÄÄSTÖPANKKI","aKTIA","åLANDSBANKEN","sPANKKI","oSUUSPANKKI_TEST","nORDEA_TEST","nORDEA_PERSONAL_TEST","pOPPANKKI_TEST","oMASÄÄSTÖPANKKI_TEST","sÄÄSTÖPANKKI_TEST","aKTIA_TEST","åLANDSBANKEN_TEST","sPANKKI_TEST","oSUUSPANKKI_MOCK","nORDEA_MOCK","nORDEA_PERSONAL_MOCK","hOLVI_MOCK","pOPPANKKI_MOCK","oMASÄÄSTÖPANKKI_MOCK","sÄÄSTÖPANKKI_MOCK","aKTIA_MOCK","åLANDSBANKEN_MOCK","sPANKKI_MOCK","sALAXY_TEST"],"type":"string","description":"Represents different banks supported by the system."},"BaseSalaryProduct":{"type":"object","properties":{"isWorkerSelfHandling":{"type":"boolean","description":"If true, worker salary and expense payments are paid directly by the employer."},"eInvoiceReceiver":{"type":"string","description":"Receiver's address for the e-invoice."},"eInvoiceIntermediator":{"type":"string","description":"Receiver's operator for the e-invoice."},"sepaBankPartyId":{"type":"string","description":"SEPA maksatustunnus"},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"status":{"maxLength":56,"type":"string","description":"The status text that should give the user.\r\nRestrict the length to 56 characters.","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"enabled":{"type":"boolean","description":"If true, the product is enabled for the current user"},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"First version of the product that integrates the Palkkaus.fi-salary payments \r\nto employers accounting."},"BeneficialOwner":{"type":"object","properties":{"numberOfShares":{"type":["null","number"],"description":"Owned number of shares.","format":"double"},"percentOfShares":{"type":["null","number"],"description":"Owned percent of shares.","format":"double"},"address":{"type":"string","description":"Address."},"avatar":{"description":"Avatar for the account","$ref":"#/components/schemas/Avatar"},"officialId":{"type":"string","description":"Official id of the person or company."},"email":{"type":"string","description":"Email address."},"telephone":{"type":"string","description":"Telephone number."},"ibanNumber":{"type":"string","description":"Bank account number (IBAN)"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"language":{"description":"Preferred language. Not in index.","$ref":"#/components/schemas/Language"},"authorizations":{"type":"array","items":{"type":"string"},"description":"Account authorizations. Not in index."}},"additionalProperties":false,"description":"Name and ids of the owner and the number/percent of shares."},"BeneficialOwners":{"type":"object","properties":{"ownedCompanyDetails":{"description":"Additional info about the owned company, e.g. the total number of shares.","$ref":"#/components/schemas/OwnedCompanyInfo"},"owners":{"type":"array","items":{"$ref":"#/components/schemas/BeneficialOwner"},"description":"List of beneficial owners of the company."},"beneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/Beneficiary"},"description":"List of other beneficiaries than beneficial owners of the company"},"workflowData":{"description":"The workflow data for manual editing and approval purposes.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Contains lists of beneficial owners and other beneficiaries of the company."},"Beneficiary":{"type":"object","properties":{"nationality":{"type":"string","description":"Nationality of the beneficiary."},"avatar":{"description":"Avatar for the account","$ref":"#/components/schemas/Avatar"},"officialId":{"type":"string","description":"Official id of the person or company."},"email":{"type":"string","description":"Email address."},"telephone":{"type":"string","description":"Telephone number."},"ibanNumber":{"type":"string","description":"Bank account number (IBAN)"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"language":{"description":"Preferred language. Not in index.","$ref":"#/components/schemas/Language"},"authorizations":{"type":"array","items":{"type":"string"},"description":"Account authorizations. Not in index."}},"additionalProperties":false,"description":"Other beneficiary of the company than beneficial owner."},"BicycleBenefitKind":{"enum":["undefined","noDeduction","singleDeduction","periodicalDeduction"],"type":"string","description":"Main subtypes of bicycle benefit codes."},"BicycleBenefitUsecase":{"type":"object","properties":{"deduction":{"type":["null","number"],"format":"double"},"taxable":{"type":["null","number"],"format":"double"},"periodDivider":{"type":["null","integer"]},"kind":{"enum":["undefined","noDeduction","singleDeduction","periodicalDeduction"],"type":"string"}},"additionalProperties":false},"BleConfig":{"type":"object","properties":{"description":{"type":"string","description":"Description for the business logic engine configuration."},"disabled":{"type":"boolean","description":"Flag for disabling the logic without deleting it."},"startDate":{"type":["null","string"],"description":"If specified, defines the start date for the settings.\r\nIf in the future, the the settings is inactive. Null (default) means the settings is valid indefinetely from the past.","format":"date"},"endDate":{"type":["null","string"],"description":"If specified, defines the end date for the settings. \r\nDate is inclusive meaning that if EndDate is 31.12., settings is valid until end-of-year: Valid on 31.12. and invalid 1.1.\r\nIf in the past, the the settings is inactive. Null (default) means the settings is valid indefinetely to future.","format":"date"},"cbaCode":{"type":["null","integer"],"description":"Applicable collective agreement","format":"int32"},"employeeGroup":{"type":"string","description":"Employee group."},"scripts":{"description":"Scripts for the calculation.","$ref":"#/components/schemas/BleScriptModule"},"updatedAt":{"type":["null","string"],"description":"Last time the logic was created/updated.","format":"date-time"},"updatedBy":{"type":"string","description":"User who last updated the configuration."}},"additionalProperties":false,"description":"Business logic engine configuration."},"BleScriptInterface":{"enum":["undefined","beforeCalcScripts","afterCalcScripts","rowTypeScripts"],"type":"string","description":"Enumerates the extension point interfaces for Salaxy Business Logic Engine (BLE)."},"BleScriptMetadata":{"type":"object","properties":{"interface":{"description":"Extension point in the business logic engine where the script is applied.","$ref":"#/components/schemas/BleScriptInterface"},"class":{"type":"string","description":"Name of the class implementing the extension point interface."},"methods":{"type":"array","items":{"type":"string"},"description":"Methods implemented by the class."}},"additionalProperties":false,"description":"Business logic engine script meta data."},"BleScriptModule":{"type":"object","properties":{"code":{"type":"string","description":"Code for the extension point."},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/BleScriptMetadata"},"description":"Scripts for the calculation."}},"additionalProperties":false,"description":"Business logic engine script module.\r\nContains the source code for the scripts as well as script metadata."},"BlobFile":{"type":"object","properties":{"id":{"type":"string"},"container":{"description":"The logical container - first level folder for the file.","$ref":"#/components/schemas/BlobRepository"},"type":{"description":"Strongly typed logical type of the file. For user files, this is a sub folder.","$ref":"#/components/schemas/BlobFileType"},"fileType":{"description":"File type (mime type etc.) based on the ending of the file name.\r\nNull for folders.","$ref":"#/components/schemas/FileType"},"userFriendlyName":{"type":"string","description":"A user friendly name that can be used in listings.\r\nIn the upload scenarios this is usually the original file name when uploaded. \r\nIt is not necessarily unique. No path information"},"filePath":{"type":"string","description":"Technical file name in storage.  In practical terms, this is the relative path\r\nexcluding the container part \"/[container]/\". \r\nI.e. this property is without the starting slash \"/\". \r\nIt must be unique and is used for Uri.\r\nFor user files this is constructed \"[Username]/[Type]/[UniqueFileName].[xxx]\""},"blobUri":{"type":"string","description":"Full unique URI in the storage"},"previewUri":{"type":"string","description":"If created, contains uri to a PNG image for preview purposes."},"updatedAt":{"type":"string","format":"date-time"},"length":{"type":"integer","description":"The length of the file in bytes.","format":"int64"},"isSigned":{"type":"boolean","description":"This property is for deserialization of old objects only.\r\nUse Metadata.IsSigned instead.\r\nTODO: Eventually, should rerun all objects to database and remove this property."},"isCollection":{"type":"boolean","description":"If true, this is a collection (folder in file system)"},"metadata":{"$ref":"#/components/schemas/BlobFileMetadata"},"workflowData":{"description":"The workflow data for manual editing and approval purposes.","$ref":"#/components/schemas/WorkflowData"}},"additionalProperties":false,"description":"The BlobFile stores metadata about miscellaneous BLOB-files that are stored to the system.\r\nFor example Receipts and Authorizations."},"BlobFileMetadata":{"type":"object","properties":{"isSigned":{"type":"boolean","description":"Whether the document is digitally signed (or manually checked as being signed).\r\nAt the time of writing, this is used only for AuthorizationPdf documents."},"logicalDate":{"type":"string","description":"Logical date for the file. E.g. first of the month for a monthly report."},"subType":{"type":"string","description":"Subtype is internal typing within a BlobFileType. This may or may not be a sub-folder.\r\nThere is no enumeration on File level - there may be one under services specific to one BlobFileType."},"avatar":{"description":"Avatar object related to the report.\r\nFor example for the salary payments this is the other party (employer or worker)","$ref":"#/components/schemas/Avatar"},"grossSalary":{"type":["null","number"],"description":"Identifier of the original calculation etc. business object.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.","format":"double"},"data":{"type":"object","additionalProperties":false,"description":"Arbitrary metadata."}},"additionalProperties":false,"description":"Metadata related to blob files as a strongly typed object."},"BlobFileType":{"enum":["unknown","authorizationPdf","avatar","taxCard","expensesReceipt","raksaloki","template","eInvoice","temporary","settings","messages","record","monthlyReport","yearlyReport","calcReport"],"type":"string","description":"Different file types in the blob storage."},"BlobRepository":{"enum":["userFiles","versionHistory","systemFiles","payload","reports","cdnImages","iam","gitContent","fileSystemContent"],"type":"string"},"BoardKind":{"enum":["undefined"],"type":"string","description":"Kind for BoardUsecase.\r\nCurrently there is only Undefined kind, and it has no effects.\r\nUsecase maps to income type 308 \"Compensation for membership of a governing body\"."},"BoardUsecase":{"type":"object","properties":{"kind":{"enum":["undefined"],"type":"string"}},"additionalProperties":false},"BootstrapStyle":{"enum":["default","primary","success","info","warning","danger"],"type":"string","description":"Styles in Bootstrap."},"BrandData":{"type":"object","properties":{"logo":{"type":"string","description":"Url to logo."},"skin":{"type":"string","description":"Css path."}},"additionalProperties":false,"description":"Brand specific business data for index."},"BrandListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/BrandData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of brands."},"CalcEmployer":{"type":"object","properties":{"avatar":{"description":"Display image information and type of employer.\r\nNOTE: Recalculate-method retains the values for display purposes if AccountId or IsSelf is not set.\r\nThis is mainly for demo and testing in anonymous mode.\r\nHowever, in storage methods, the value is reset based on values of AccountId or IsSelf\r\neven if they are not set: Anything stored in Avatar will be ignored.","$ref":"#/components/schemas/Avatar"},"accountId":{"type":"string","description":"The Palkkaus.fi Account identifier for the Employer."},"isSelf":{"type":["null","boolean"],"description":"True if Profile is the current Authorization.\r\nIf set to true, will set current Authorization as this contract party.\r\nThis overrides any value in AccountId, so be sure to switch this back to false if this is switchable.\r\nSetting to False does not have any immediate effect."},"contact":{"description":"Current address of the employer.\r\nPlease note that this is a read only field.","$ref":"#/components/schemas/Contact"},"officialId":{"type":"string","description":"Official id of the person or company.\r\nPlease note that this is a read only field."}},"additionalProperties":false,"description":"Employer of a calculation"},"CalcGroup":{"enum":["undefined","baseSalary","salaryAdditions","benefits","expenses","deductions","otherNoPayment","totals","disabled"],"type":"string"},"CalcInfo":{"type":"object","properties":{"workStartDate":{"type":["null","string"],"description":"Start date of the work","format":"date"},"workEndDate":{"type":["null","string"],"description":"End date of the work","format":"date"},"workDescription":{"maxLength":32,"minLength":0,"type":"string","description":"Description of the work for reporting purposes. Max 32 chars."},"workerMessage":{"type":"string","description":"Message from worker to employer - when worker sends the salary calculation to the employer."},"salarySlipMessage":{"type":"string","description":"Message which will be displayed in the payslip."},"paymentId":{"type":"string","description":"Payment reference number in payment service"},"originalPaymentId":{"type":"string","description":"Original Payment reference number"},"irSenderOfficialId":{"type":"string","description":"Earnings Payment Report Official id of the sender."},"paymentChannel":{"description":"Channel that is used for payment.","$ref":"#/components/schemas/PaymentChannel"},"applicationId":{"type":"string","description":"Application id for invoicing etc. purposes."},"messageThreadId":{"type":"string","description":"The MessageThread Id, if this calculation is referred in a message thread."},"reportDate":{"type":["null","string"],"description":"Assumed earnings payment report date for the report.","format":"date-time"},"backofficeNotes":{"type":"string","description":"Notes related to the payment and other backoffice operations: \r\nFor example the justification why the sum is in calculation vs. Paytrail payment."},"occupationCode":{"type":"string","description":"Occupation classification, used at least for Accident insurance purposes, but may be used for other reporting. \r\nFor Finnish Salaries use the Statistics Finland \r\n\"Classification of Occupations 2010\" (TK10): https://www.stat.fi/meta/luokitukset/ammatti/017-2018-05-15/index_en.html"},"occupationCode2":{"type":"string","description":"Secondary occupation classification. Some earnings payment reports may require two occupation codes."},"cbaCode":{"type":["null","integer"],"description":"Applicable collective agreement","format":"int32"},"employeeGroup":{"type":"string","description":"Employee group."},"pensionPaymentDate":{"type":["null","string"],"description":"Calculated pension insurance payment date.","format":"date-time"},"pensionPaymentRef":{"type":"string","description":"Pension insurance reference number."},"pensionPaymentSpecifier":{"type":"string","description":"Pension insurance payment specifier."},"payrollId":{"type":"string","description":"The Payroll Id, if this calculation is part of a Payroll list."},"projectNumber":{"type":"string","description":"Project number for reporting purposes."},"costCenter":{"type":"string","description":"Cost center for reporting purposes."},"workerSourceId":{"type":"string","description":"Identifier of the worker in a source system. Used in imports etc.\r\nThis is automatically set from the source id of the employment."},"sourceId":{"type":"string","description":"Identifier of the calculation in a source system. Used in imports etc."}},"additionalProperties":false,"description":"Informational object that stores data about the salary calculation / payment that is not directly related to calculating the salary."},"CalcRowAmountConfig":{"type":"object","properties":{"label":{"type":"string","description":"Label for the input"},"default":{"type":["null","number"],"description":"Default value","format":"double"},"input":{"oneOf":[{"type":"null"},{"description":"Type of the input control to use","$ref":"#/components/schemas/CalcRowConfigNumberInput"}]},"unit":{"oneOf":[{"type":"null"},{"description":"Default unit.","$ref":"#/components/schemas/CalculationRowUnit"}]},"units":{"type":"array","items":{"$ref":"#/components/schemas/CalculationRowUnit"},"description":"Allowed units. If not set, only default unit allowed."}},"additionalProperties":false,"description":"Amount input"},"CalcRowConfig":{"type":"object","properties":{"name":{"type":"string","description":"Name / unique identifier of the row type."},"rowType":{"description":"The built-in row type","$ref":"#/components/schemas/CalculationRowType"},"type":{"type":"string","description":"The type string, e.g. \"/builtIn/salary\" or \"/custom/boardMember\""},"order":{"type":"integer","description":"Order number in the lists","format":"int32"},"label":{"type":"string","description":"Label for the row type"},"descr":{"type":"string","description":"Description for the row type"},"moreInfo":{"type":"string","description":"More info HTML"},"category":{"description":"Categorization of the row types.","$ref":"#/components/schemas/CalculationRowCategory"},"favorite":{"type":["null","integer"],"description":"Favorite row types and their sort order.\r\nThis is currently fixed, but may later be based on user profile (e.g. most used types).","format":"int32"},"color":{"type":"string","description":"Color is based on the category"},"iconText":{"type":"string","description":"Icon short text is 1-5 characters suitable for icon.\r\nHas 5 characters only if very narrow, e.g. \"1\" and comma - typically 2-3 chars."},"kind":{"description":"If the row has a kind selection (the main subtype), definition of the subtypes.","$ref":"#/components/schemas/CalcRowKindsConfig"},"group":{"description":"Group is the first \"folder\" in the name. Currently either \"builtIn\" or \"custom\", but later may have other groupings (e.g. employment groups or just free text).","$ref":"#/components/schemas/CalcRowConfigTypeGroup"},"price":{"description":"Price input","$ref":"#/components/schemas/CalcRowPriceConfig"},"amount":{"description":"Amount input","$ref":"#/components/schemas/CalcRowAmountConfig"},"total":{"description":"The total input or read-only field.","$ref":"#/components/schemas/CalcRowTotalConfig"},"incomeTypes":{"type":"array","items":{"type":"integer","format":"int32"},"description":"This is only info field for ui"},"scripts":{"type":"array","items":{"$ref":"#/components/schemas/CalcRowScriptConfig"},"description":"Scripts for the type."}},"additionalProperties":false,"description":"Configuration for user interface of a Calculation row type: Either built-in or custom."},"CalcRowConfigNumberInput":{"enum":["number","hidden","readOnly"],"type":"string"},"CalcRowConfigTypeGroup":{"enum":["builtIn","custom"],"type":"string","description":"Wage type group."},"CalcRowKindConfig":{"type":"object","properties":{"name":{"type":"string","description":"Text value of the enumeration (lowerCamelCase)."},"order":{"type":"integer","description":"Sorting order number of the value within the enum.","format":"int32"},"label":{"type":"string","description":"Label of the enumeration if the translations have been applied."},"descr":{"type":"string","description":"Description of the kind."},"price":{"description":"Price input","$ref":"#/components/schemas/CalcRowPriceConfig"},"amount":{"description":"Amount input","$ref":"#/components/schemas/CalcRowAmountConfig"},"total":{"description":"The total input or read-only field.","$ref":"#/components/schemas/CalcRowTotalConfig"}},"additionalProperties":false,"description":"Defines a single row kind (sub type) within a row type."},"CalcRowKindsConfig":{"type":"object","properties":{"name":{"type":"string","description":"Name of the base enumeration (as defined in the usecase / built-in type).\r\nThis is not unique in custom row types."},"values":{"type":"array","items":{"$ref":"#/components/schemas/CalcRowKindConfig"},"description":"Values of the enumeration."}},"additionalProperties":false,"description":"Describes the set of kinds (sub types) used by a row type."},"CalcRowPriceConfig":{"type":"object","properties":{"label":{"type":"string","description":"Label for the input"},"default":{"type":["null","number"],"description":"Default value","format":"double"},"input":{"oneOf":[{"type":"null"},{"description":"Type of the input control to use","$ref":"#/components/schemas/CalcRowConfigNumberInput"}]}},"additionalProperties":false,"description":"Price input."},"CalcRowScriptConfig":{"type":"object","properties":{"name":{"type":"string","description":"Name of the property."},"kind":{"type":"string","description":"Optional kind for types with kind."},"script":{"type":"string","description":"Script for the property."}},"additionalProperties":false,"description":"Property script configuration for a calculation row."},"CalcRowTotalConfig":{"type":"object","properties":{"input":{"oneOf":[{"type":"null"},{"description":"Type of the input control to use","$ref":"#/components/schemas/CalcRowConfigNumberInput"}]}},"additionalProperties":false,"description":"The total input or read-only field."},"CalcTax":{"type":"object","properties":{"taxcardId":{"type":"string","description":"Identifier for a stored tax card if one is applied to this calculation.\r\nSystem updates the TaxCardId automatically in Recalculate / Save if it finds a better candidate\r\nand also updates the Snapshot."},"snapshot":{"description":"Snapshot of the tax card for salary slip etc. purposes.\r\nUpdated in Recalculate / Save based on TaxCardId","$ref":"#/components/schemas/TaxcardSnapshot"},"fixedTaxAmount":{"type":["null","number"],"description":"Possibility to set a fixed widthholding tax amount for this calculation regardless of \r\nthe percentage etc. in the tax card.","format":"double"},"isValid":{"type":"boolean","description":"The API returns true if there is a valid taxcard for the PaidAt date for this calculation\r\nor if FixedTaxAmount is set for th calculation."},"estimatedTax":{"type":"number","description":"Calculated widthholding tax. Note that this is an estimation until the calculation is actually paid.\r\nAlso, if the salary is not paid as cash (e.g. fringe benefits), there may not be enough money to make the full deduction.","format":"double"},"taxPercent":{"type":"number","description":"Appliend base tax percent.","format":"double"},"taxPercentTax":{"type":"number","description":"The taxes that were deducted from the worker salary using base percentage rate.","format":"double"},"taxPercentBase":{"type":"number","description":"The taxable amount for tax witholding with base percent.","format":"double"},"taxPercent2":{"type":"number","description":"Applied additional tax percent.","format":"double"},"taxPercent2Tax":{"type":"number","description":"he taxes that were deducted from the worker salary using additional percentage rate.","format":"double"},"taxPercent2Base":{"type":"number","description":"The taxable amount for tax witholding with additional percent.","format":"double"},"hasNewSharedCard":{"type":"boolean","description":"A flag that during last recalculation, there was a new shared taxcard that was waiting approval."},"taxPercentForVisualization":{"type":["null","number"],"description":"Tax percent that is used in visualization. This is mainly used in Unit testing and anonymous calcultors.\r\nNot used in real paid calculations. This is percent. I.e. for 50% set 50, not 0.5.\r\nIf PaymentData or AccountId lead to a valid tax card type and percent, or if there is FixedTaxAmount, this value is not used.","format":"double"}},"additionalProperties":false,"description":"Tax card information stored as part of the Calculation object"},"Calculation":{"type":"object","properties":{"employer":{"description":"The employer object for this calculation.\r\nTypically, you do not need to set this before the actual payment process.","$ref":"#/components/schemas/CalcEmployer"},"worker":{"description":"The Worker (employee) that has performed the work.","$ref":"#/components/schemas/CalcWorker"},"workflow":{"description":"Information about the workflow and state of the calculation.","$ref":"#/components/schemas/CalcWorkflow"},"salary":{"description":"The main salary element. \r\nAlternatively the salary can be set in the Rows object - this will be the only way to set multiple salary rows (not yet supported).","$ref":"#/components/schemas/Salary"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserDefinedRow"},"description":"Set of rows that make up the salary calculation:\r\nExpenses, Benefits, deductions etc. Note that side costs are not rows."},"framework":{"description":"DEPRECIATED: Usecase will be replacing this functionality in a next major release.\r\nThe Framework Agreement (TES) parameters that affect the framework based side costs etc. of this calculation","$ref":"#/components/schemas/TesParameters"},"usecase":{"description":"A usecase for creating and editing salary calculations.\r\nIn practice, a usecase is either a user interface or a microservice that provides a salary calculation\r\nand it may be implemented outside Salaxy.\r\nProvides the possibility to store useacase specific data as part of calculation.\r\nNOTE: This functionality will replace Framework property in a next major release.","$ref":"#/components/schemas/UsecaseData"},"result":{"description":"The results of the calculation. In the API, this is a read-only object.","$ref":"#/components/schemas/CalculationResult"},"info":{"description":"Information about the work that is not directly related to calculating salary and expenses.","$ref":"#/components/schemas/CalcInfo"},"sharing":{"description":"Sharing of the calculation. This object cannot be modified directly, \r\nuse specialized methods in Calculations service.","$ref":"#/components/schemas/CalculationSharing"},"accounting":{"description":"Contains calculation specific data for accounting (both cost and financial accounting).","$ref":"#/components/schemas/CalculationAccounting"},"worktime":{"description":"Worktime data that is stored as part of Salary calculation:\r\nwork days, absences, holidays and holiday accrual.\r\nIn the future may also contain relevant part of timesheet data (work hours).","$ref":"#/components/schemas/CalcWorktime"},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"scripts":{"description":"Scripts for the calculation.","$ref":"#/components/schemas/BleScriptModule"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Calculation is the most important model in the Palkkaus.fi API.\r\nWe suggest you open the separately provided documentation and especially the class diagram to understand the whole model in detail."},"CalculationAccounting":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimension"},"description":"Values for cost accounting dimensions"}},"additionalProperties":false,"description":"Contains calculation specific data for accounting (both cost and financial accounting)."},"CalculationCollection":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Collection of calculation ID's to be fetched from storage"},"payrollIds":{"type":"array","items":{"type":"string"},"description":"Collection of payroll ID's to be fetched from storage"},"calcs":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"},"description":"Collection of inline calculations that may be saved or not"},"payrolls":{"type":"array","items":{"$ref":"#/components/schemas/PayrollDetails"},"description":"Collection of inline Payroll objects that may be saved or not"}},"additionalProperties":false,"description":"Defines a set of calculations based on identifiers potentially unsaved Calculation objects as well as Payrolls."},"CalculationCopyOptions":{"type":"object","properties":{"startDate":{"type":["null","string"],"format":"date-time"},"endDate":{"type":["null","string"],"format":"date-time"},"numberOfDays":{"type":["null","integer"]}},"additionalProperties":false},"CalculationData":{"type":"object","properties":{"requestedSalaryDate":{"type":"string","description":"A flag indicating if the requested date for the SalaryDate has been set.\r\nIf the date has been set, the value of the flag is 'SALA'."},"workerPayment":{"type":["null","number"],"description":"The sum that is at the end paid to the Worker:\r\nSalary payment + expenses","format":"double"},"pensionPayment":{"type":["null","number"],"description":"The total pension payment for this calculation.","format":"double"},"taxPayment":{"type":["null","number"],"description":"The taxes that were deducted from the worker salary a paid as part of taxation.","format":"double"},"socialSecurityPayment":{"type":["null","number"],"description":"The social security payment- paid as part of taxation.","format":"double"},"status":{"oneOf":[{"type":"null"},{"description":"Status of the calculation from the end-user point-of-view.","$ref":"#/components/schemas/CalculationStatus"}]},"payrollId":{"type":"string","description":"Payroll id."},"employmentId":{"type":"string","description":"Employment id."},"originalId":{"type":"string","description":"The original id the calculation which this calculation is a copy of."},"usecaseUri":{"type":"string","description":"Use case uri."},"messageThreadId":{"type":"string","description":"The MessageThread Id, if this calculation is referred in a message thread."},"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"workStartDate":{"type":["null","string"],"description":"Work start date.","format":"date"},"workEndDate":{"type":["null","string"],"description":"Work end date.","format":"date"},"paymentChannel":{"oneOf":[{"type":"null"},{"description":"Payment channel.","$ref":"#/components/schemas/PaymentChannel"}]},"totalTaxable":{"type":["null","number"],"description":"Taxable salary is the salary from the taxation point of view - includes some benefits.","format":"double"},"salary":{"type":["null","number"],"description":"Base salary.","format":"double"},"allowances":{"type":["null","number"],"description":"Salary additions","format":"double"},"benefits":{"type":["null","number"],"description":"Benefits.","format":"double"},"deductions":{"type":["null","number"],"description":"Deductions","format":"double"},"expenses":{"type":["null","number"],"description":"Expenses","format":"double"},"inputSalaryDate":{"type":["null","string"],"description":"The requested salary date.","format":"date-time"},"originalSalaryDate":{"type":["null","string"],"description":"The requested salary date, kept when a recalculation drops it; else the first calculated one.","format":"date-time"},"salaryDateKind":{"description":"Defines the re-setting of the salary date in the calculation re-calculation.","$ref":"#/components/schemas/SalaryDateKind"},"repairedAt":{"type":["null","string"],"description":"Last date and time when this calculation was repaired after payment.","format":"date-time"},"hasWorktimeRows":{"type":["null","boolean"],"description":"Flag indicating if the pay period contains planned or actual holidays or absences."},"employmentType":{"oneOf":[{"type":"null"},{"description":"Type of the employment relation at the time of the calculation (e.g. monthly salary, board member).","$ref":"#/components/schemas/EmploymentRelationType"}]}},"additionalProperties":false,"description":"Calculation specific business data for index."},"CalculationFlag":{"enum":["exclude","pensionInsurance","accidentInsurance","unemploymentInsurance","healthInsurance","insurancesDeduction","noTax","tax","taxDeduction","cfNoPayment","cfPayment","cfDeduction","cfDeductionAtSalaxy"],"type":"string","description":"Flags how the row is processed in calculation logic."},"CalculationImport":{"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678\r\nThis field is optional and defaults to the company number of the current account."},"parameters":{"type":"object","additionalProperties":false,"description":"Additional parameters for import. Defaults to string."},"item":{"$ref":"#/components/schemas/Calculation"},"validation":{"description":"Validation for the import","$ref":"#/components/schemas/ApiValidation"},"result":{"description":"Result object of the import.","$ref":"#/components/schemas/ApiImportResultOfstring"}},"additionalProperties":false,"description":"API calculation import object.\r\nThe API uses this object for mass operations for adding calculations to a new or existing payroll object.\r\nIf the calculation object does not contain a valid payroll-ID, a new payroll will be created.\r\nReturns payroll ID."},"CalculationListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/CalculationStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/CalculationData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of calculations in the user interface.\r\nIt contains all essential information of the calculation and is basis for searching, filtering and sorting."},"CalculationReportData":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":false},"description":"Calculations as report rows."},"irLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"Ir Income type code labels"},"typeLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"Calculation row type labels"},"totalLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"Total labels"}},"additionalProperties":false,"description":"Container for calculation report data."},"CalculationResult":{"type":"object","properties":{"totals":{"description":"Calculation totals that are common to both Worker and Employer.","$ref":"#/components/schemas/TotalCalculationDTO"},"irRows":{"type":"array","items":{"$ref":"#/components/schemas/IrRow"},"description":"Rows that are compatible with Incomes Register (tulorekisteri) process.\r\nThese are available only for calculations paid after 7.2.2019 (TODO: estimation as of writing)."},"employerCalc":{"description":"The calculation from the Employer point-of-view","$ref":"#/components/schemas/EmployerCalculationDTO"},"workerCalc":{"description":"The calculation from the Worker point-of-view","$ref":"#/components/schemas/WorkerCalculationDTO"},"percentages":{"description":"Percentages used in the calculation.","$ref":"#/components/schemas/IPercentages"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ResultRow"},"description":"The result rows. Note that this collection also contains the main Salary entry as one of the rows."},"responsibilities":{"description":"Responsibilities of Employer and parameters that affect those responsibilities.","$ref":"#/components/schemas/IEmployerResponsibilities"},"validation":{"description":"The validation result for the current calculation.\r\nPlease note that this is not serialized into the data storage.","$ref":"#/components/schemas/ApiValidation"}},"additionalProperties":false},"CalculationResultRowType":{"enum":["undefined","totalBenefits","totalExpenses","totalSocialSecurityEmployer","totalSocialSecurityEmployerDebt","totalSocialSecurityEmployerPayment","totalPension","totalPensionPayment","totalPensionEmployer","totalPensionEmployerDebt","totalPensionWorker","totalUnemployment","totalUnemploymentPayment","totalUnemploymentEmployer","totalUnemploymentEmployerDebt","totalUnemploymentWorker","totalPalkkaus","totalSalary","totalTax","totalTaxPayment","totalPayment","totalWorkerPayment","totalService"],"type":"string"},"CalculationRowCategory":{"enum":["salary","salaryAdditions","salaryCalc","holidays","benefits","expenses","deductions","other"],"type":"string","description":"Groups together categories of rows"},"CalculationRowSource":{"enum":["undefined","disabled","manualRow","worktimeImport","priceEmployment","priceCompany","copyEmployment","copyCompany","customRowtype"],"type":"string","description":"Source of the calculation row - affects how the row is handled in editing / recalculation scenarios."},"CalculationRowType":{"enum":["unknown","salary","hourlySalary","monthlySalary","totalWorkerPayment","totalEmployerPayment","timeRatePay","compensation","overtime","tesWorktimeShortening","eveningAddition","nightimeAddition","saturdayAddition","sundayWork","otherAdditions","paidSickLeaveSalary","paidSickLeaveHourlySalary","paidSickLeaveMonthlySalary","trainingSalary","trainingHourlySalary","trainingMonthlySalary","accomodationBenefit","mealBenefit","phoneBenefit","carBenefit","bicycleBenefit","otherBenefit","holidayCompensation","holidayBonus","holidaySalary","dailyAllowance","dailyAllowanceHalf","mealCompensation","milageOwnCar","toolCompensation","expenses","milageDaily","milageOther","unionPayment","foreclosure","advance","foreclosureByPalkkaus","prepaidExpenses","otherDeductions","deductibleOfExerciseAndCultureBenefit","childCareSubsidy","chainsawReduction","nonProfitOrg","subsidisedCommute","irIncomeType","board","remuneration","otherCompensation","workingTimeCompensation","employmentTermination","hourlySalaryWithWorkingTimeCompensation","paidSickLeave","training","payStats","taxAtSource","taxWithholding","absencePeriod","serviceCharge","service","info","totals"],"type":"string","description":"All calculation types as defined by the Finnish tax authority"},"CalculationRowUnit":{"enum":["undefined","count","percent","days","kilometers","hours","weeks","months"],"type":"string"},"CalculationSettings":{"type":"object","properties":{"pensionContracts":{"type":"array","items":{"$ref":"#/components/schemas/PensionContract"},"description":"Collection of pension contracts. In most cases, employer has only one, but in edge cases there may be several."},"insuranceContracts":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceContract"},"description":"Collection of mandatory accident insurance contracts.\r\nIn most cases, employer has only one, but in edge cases there may be several."},"unemploymentInsurance":{"description":"Settings related to unemployment insurance.","$ref":"#/components/schemas/UnemploymentInsuranceSettings"},"incomesRegister":{"description":"Settings related to reporting the salaries to authorities through Incomes Register.","$ref":"#/components/schemas/IncomesRegisterSettings"},"salaryDefaults":{"type":"array","items":{"$ref":"#/components/schemas/RowTypeDefinition"},"description":"Contains default calculation rows, default prices and custom row types for calculations."},"employeeGroups":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeGroupDefinition"},"description":"List of company employee groups."},"bleConfigs":{"type":"array","items":{"$ref":"#/components/schemas/BleConfig"},"description":"Customer specific business logic configurations for salary calculations."}},"additionalProperties":false,"description":"Settings that affect the calculation result of the salaries."},"CalculationSharing":{"type":"object","properties":{"type":{"description":"Type of sharing for this calculation.","$ref":"#/components/schemas/SharingUriType"},"uri":{"type":"string","description":"Sharing uri."},"lastSharedTo":{"type":"string","description":"Email address to which the calculation was shared last time."},"lastSharedCc":{"type":"string","description":"Email address which the calculation was shared as cc last time."},"lastSharedMessage":{"type":"string","description":"Last shared message to the employer"}},"additionalProperties":false,"description":"Defines the properties related to sharing and sending of the calculation."},"CalculationStatus":{"enum":["draft","paymentStarted","paymentSucceeded","paymentCanceled","paymentError","paymentWorkerCopy","workerRequested","workerRequestAccepted","workerRequestDeclined","paymentRefunded","paymentRepairCopy","feePending","waitingApproval","payrollDraft","repair","proDraft","sharedWaiting","sharedApproved","sharedRejected","history","template"],"type":"string","description":"Workflow status (the main status) for the calculation."},"CalculationStatusCategory":{"enum":["all","readonly","editable","sent","shared","received","error"],"type":"string","description":"Groups calculations by the status."},"CalcWorker":{"type":"object","properties":{"accountId":{"type":"string","description":"Palkkaus.fi Account Id for the worker.\r\nAlternatively you can set the Payment data with the required infromation"},"employmentId":{"type":"string","description":"Employment Id for the worker."},"paymentData":{"description":"Data that is needed for salary payment.\r\nThis object may be null if AccountId has been set. \r\nAlso, if AccountId has been set, these properties will be ignored: \r\nThe Worker will decide on payment properties herself.","$ref":"#/components/schemas/CalcWorkerPaymentData"},"avatar":{"description":"Display image and properties of the Worker. \r\nBased on either the AccountId or PaymentData","$ref":"#/components/schemas/Avatar"},"isSelf":{"type":["null","boolean"],"description":"True if Profile is the currently Account\r\nIf set to true, will set current Account as this contract party.\r\nThis overrides any value in AccountId, so be sure to switch this back to false if this is switchable.\r\nSetting to False does not have any immediate effect."},"dateOfBirth":{"type":["null","string"],"description":"Date of birth for the Worker - this affects the side costs. \r\nPlease also set the DateOfBirthAccuracy, if you set this property.\r\nIf PaymentData or AccountId lead to a valid Social security number, it will override any age set here.","format":"date"},"dateOfBirthAccuracy":{"description":"Accuracy of the date of birth\r\nIf PaymentData or AccountId lead to a valid Social security number, it will override any age set here.","$ref":"#/components/schemas/DateOfBirthAccuracy"},"tax":{"description":"New Widthholding tax logic that is based on separately stored tax cards.","$ref":"#/components/schemas/CalcTax"},"contact":{"description":"Current address of the worker.\r\nPlease note that this is a read only field.","$ref":"#/components/schemas/Contact"}},"additionalProperties":false,"description":"Worker object for the current calculation"},"CalcWorkerPaymentData":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the person."},"lastName":{"type":"string","description":"Last name / Surname of the person."},"socialSecurityNumber":{"type":"string","description":"Gets the Social security number the way the user set it in input.\r\nHOWEVER: The getter will change the string to upper invariant/trim and if the last character is \"*\", it will be replaced by calculated checksum."},"socialSecurityNumberValid":{"type":"string","description":"Social security number if valid or null","readOnly":true},"ibanNumber":{"type":"string","description":"IBAN number for the Bank account"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"email":{"type":"string","description":"Contact e-mail address."},"telephone":{"type":"string","description":"Telephone number"}},"additionalProperties":false,"description":"The required information for paying the Salary to Worker."},"CalcWorkflow":{"type":"object","properties":{"status":{"description":"Status of the calculation from Draft to PaymentSucceeded","$ref":"#/components/schemas/CalculationStatus"},"paidAt":{"type":["null","string"],"description":"Time when this calculation was paid (if it was paid) to Palkkaus service.","format":"date"},"salaryPaidAt":{"type":["null","string"],"description":"Time when the salary was paid by Palkkaus service.","format":"date"},"repairedAt":{"type":["null","string"],"description":"Last date and time when this calculation was repaired after payment.","format":"date"},"salaryDate":{"type":["null","string"],"description":"The estimated date when the salary is withdrawable by the worker.","format":"date"},"requestedSalaryDate":{"type":["null","string"],"description":"The requested date for the SalaryDate from the employer.","format":"date"},"salaryDateKind":{"description":"Defines the re-setting of the salary date in the calculation re-calculation.","$ref":"#/components/schemas/SalaryDateKind"},"originalId":{"type":"string","description":"The original id the calculation which this calculation is a copy of."}},"additionalProperties":false,"description":"Defines the properties of salary calculation workflow \r\n- typically the workflow from draft to Payment."},"CalcWorktime":{"type":"object","properties":{"employmentPeriod":{"description":"Employment period that is updated from employment at each recalculation (as opposed to holiday specification).","$ref":"#/components/schemas/DateRange"},"employmentEndingCode":{"oneOf":[{"type":"null"},{"description":"Termination of employment","$ref":"#/components/schemas/EmploymentEndingCode"}]},"workDays":{"description":"Describes the working days in the period.\r\nCurrently, uses the DaysCount, but later the full days array will be taken to use.\r\nThis includes the absence days (divider in AbsencesDaySalary).","$ref":"#/components/schemas/DateRange"},"accruals":{"type":"array","items":{"$ref":"#/components/schemas/MonthlyHolidayAccrual"},"description":"Accruals for each calendar month in this calculation."},"accrualDateKind":{"oneOf":[{"type":"null"},{"description":"Date kind which determines to which accrual year the calculation accrues holidays.\r\nDefault is the workStartDate.","$ref":"#/components/schemas/PeriodDateKind"}]},"isPeriodRequired":{"type":"boolean","description":"Flag indicating if the working period is mandatory for this calculation."},"hasPlannedRows":{"type":"boolean","description":"Flag indicating if the pay period contains planned holidays or absences.\r\nPlease note that this is the snapshot of the state when the calculation was still editable."},"wageBasis":{"description":"Wage basis from the current employment relation.\r\nThis is for absences and does not presume that holiday years exist for the worker.","$ref":"#/components/schemas/WageBasis"},"absencesPeriods":{"type":"array","items":{"$ref":"#/components/schemas/AbsencePeriod"},"description":"Periods of 'absences'."},"absencesDailySalary":{"type":"number","description":"Price for a single absence day. Typically based on MonthlySalary, but may be modified.","format":"double"},"absencesDays":{"type":"integer","description":"Number of days of non-paid absences. This affecst the accrual calculation.\r\nThese are deducted from the Monthly salary, not from Hourly salary at the moment.","format":"int32"},"holidaySpec":{"description":"Specification for the holiday calculation","$ref":"#/components/schemas/HolidaySpecificationForYear"},"leavesDailySalary":{"type":"number","description":"Price for a single holiday day","format":"double"},"bonusDailySalary":{"type":"number","description":"Price for a single bonus day","format":"double"},"leavesDays":{"type":"integer","description":"Number of paid Leave days that is paid in this salary calculation / for this period.","format":"int32"},"holidayPayAccrualRemaining":{"type":"number","description":"Total remaining amount of holiday pay accrual.","format":"double"},"holidayBonusAccrualRemaining":{"type":"number","description":"Total remaining amount of holiday bonus accrual.","format":"double"},"accrualSpec":{"description":"Specification for the accrual calculation","$ref":"#/components/schemas/HolidayAccrualCalcSpecification"}},"additionalProperties":false,"description":"Worktime data that is stored as part of Salary calculation:\r\nwork days, absences, holidays and holiday accrual.\r\nIn the future may also contain relevant part of timesheet data (work hours)."},"CancellationToken":{"type":"object","properties":{"isCancellationRequested":{"type":"boolean","readOnly":true},"canBeCanceled":{"type":"boolean","readOnly":true},"waitHandle":{"$ref":"#/components/schemas/WaitHandle"}},"additionalProperties":false},"CarBenefit":{"type":"object","properties":{"carBenefitCode":{"$ref":"#/components/schemas/CarBenefitCode"},"ageGroupCode":{"$ref":"#/components/schemas/AgeGroupCode"},"kilometers":{"type":["null","integer"],"format":"int32"},"emissionsValue":{"type":["null","number"],"format":"double"}},"additionalProperties":false},"CarBenefitCode":{"enum":["limitedCarBenefit","fullCarBenefit"],"type":"string"},"CarBenefitKind":{"enum":["undefined","limitedCarBenefit","fullCarBenefit"],"type":"string","description":"Main subtypes of car benefit codes."},"CarBenefitUsecase":{"type":"object","properties":{"ageGroup":{"enum":["a","b","c","u"],"type":"string"},"isKilometersBased":{"type":"boolean"},"kilometers":{"type":["null","integer"]},"emissionsValue":{"type":["null","number"],"format":"double"},"deduction":{"type":["null","number"],"format":"double"},"kind":{"enum":["undefined","limitedCarBenefit","fullCarBenefit"],"type":"string"}},"additionalProperties":false},"Certificate":{"type":"object","properties":{"thumbprint":{"type":"string","description":"Certificate thumbprint."},"bytes":{"type":"string","description":"Certificate bytes Used in returning the certificate to the user as PFX or ZIP.\r\nNot persisted.","format":"byte"},"title":{"type":"string","description":"End user description for the certificate."},"password":{"type":"string","description":"Password for issuing a new certificate. Not persisted.\r\nAlso used for passing the CSR in request if it is passed as Base64 encoded text. Not persisted."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"User certificate."},"Claim":{"type":"object","properties":{"issuer":{"type":"string","readOnly":true},"originalIssuer":{"type":"string","readOnly":true},"properties":{"type":"object","additionalProperties":{"type":"string"},"readOnly":true},"subject":{"$ref":"#/components/schemas/ClaimsIdentity"},"type":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true},"valueType":{"type":"string","readOnly":true}},"additionalProperties":false},"ClaimsIdentity":{"type":"object","properties":{"authenticationType":{"type":["null","string"],"readOnly":true},"isAuthenticated":{"type":"boolean","readOnly":true},"actor":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ClaimsIdentity"}]},"bootstrapContext":{"type":"object","additionalProperties":false},"claims":{"type":"array","items":{"type":"string"},"readOnly":true},"label":{"type":["null","string"]},"name":{"type":["null","string"],"readOnly":true},"nameClaimType":{"type":"string","readOnly":true},"roleClaimType":{"type":"string","readOnly":true}},"additionalProperties":false,"readOnly":true},"ClaimsPrincipal":{"type":"object","properties":{"claims":{"type":"array","items":{"$ref":"#/components/schemas/Claim"},"readOnly":true},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ClaimsIdentity"},"readOnly":true},"identity":{"$ref":"#/components/schemas/IIdentity"}},"additionalProperties":false},"CompanyAccount":{"type":"object","properties":{"identity":{"description":"Information about the verification of the account. \r\nNOTE that this object may not be present in many method calls - this is because it contains confidential information.","$ref":"#/components/schemas/Identity"},"companyType":{"description":"High level company type","$ref":"#/components/schemas/CompanyType"},"entityType":{"description":"Entity type of the account.\r\nType PersonCreatedByEmployer means that the Worker has not yet signed into the system and there may be multiple instances of the same logical person (Official ID) - one for each employer.","$ref":"#/components/schemas/LegalEntityType"},"isEmployer":{"type":"boolean","description":"If true the object Account is and Employer account - it has the EmployerInfo object"},"isWorker":{"type":"boolean","description":"If true the object Account is and Worker account - it has the WorkerInfo object"},"isVerified":{"type":"boolean","description":"If true, the account has been verified. Typically this means a digitally signed contract.\r\nThis means that the account also has an Identity object.\r\nHowever, as the Identity object contains confidential information, it is not necessarily present in all method calls."},"avatar":{"description":"Avatar is the visual representation of the Account.","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the Account.","$ref":"#/components/schemas/Contact"},"language":{"description":"Language of the person/company.","$ref":"#/components/schemas/Language"},"serviceModelId":{"type":"string","description":"Service model for the account."},"workflowData":{"description":"Workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"A company account - note that this can also be an association etc. - something that has a Company ID."},"CompanyAccountSettings":{"type":"object","properties":{"calc":{"description":"Salary calculation related settings.","$ref":"#/components/schemas/CalculationSettings"},"reporting":{"description":"Reporting and layout related settings.","$ref":"#/components/schemas/ReportingSettings"},"partner":{"description":"Primary partner, service model and pricing.","$ref":"#/components/schemas/PrimaryPartnerSettings"},"accounting":{"description":"Defines how accounting is done and to which target it is exported / sent.","$ref":"#/components/schemas/AccountingSettings"},"costAccounting":{"description":"Cost accounting settings, e.g. cost centers and projects.","$ref":"#/components/schemas/CostAccountingSettings"},"holiday":{"description":"Holiday settings for accruals and holiday pay calculations.","$ref":"#/components/schemas/HolidaySettings"},"payments":{"description":"Settings related to making of the payments.","$ref":"#/components/schemas/PaymentSettings"},"usecase":{"description":"Custom usecases.","$ref":"#/components/schemas/UsecaseSettings"},"messaging":{"description":"Settings related to messaging.","$ref":"#/components/schemas/MessagingSettings"},"forms":{"description":"Settings related to the calculation data delivery by forms.","$ref":"#/components/schemas/FormsSettings"},"payStats":{"description":"Settings related to pay statistics calculations.","$ref":"#/components/schemas/PayStatsSettings"},"configs":{"type":"array","items":{"type":"object","additionalProperties":false},"description":"OBSOLETE. DO NOT use."},"preferences":{"type":"array","items":{"$ref":"#/components/schemas/Preference"},"description":"Customer specific preferences."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."}},"additionalProperties":false,"description":"Provides the settings for a Company Employer account (all settings details for employer)."},"CompanyImport":{"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678\r\nThis field is optional and defaults to the company number of the current account."},"parameters":{"type":"object","additionalProperties":false,"description":"Additional parameters for import. Defaults to string."},"item":{"$ref":"#/components/schemas/AssureCompanyAccountRequest"},"validation":{"description":"Validation for the import","$ref":"#/components/schemas/ApiValidation"},"result":{"description":"Result object of the import.","$ref":"#/components/schemas/ApiImportResultOfPartnerCompanyAccountInfo"}},"additionalProperties":false,"description":"API company import object.\r\nThe API uses this object for mass operations for creating or assuring the customer companies in the system."},"CompanyInput":{"required":["name","businessId","companyType"],"type":"object","properties":{"doCreate":{"type":"boolean","description":"If true, creates a company account based on company data."},"name":{"maxLength":100,"type":"string","description":"Official name of the company"},"logo":{"maxLength":512,"type":"string","description":"URL to a Logo picture (preferably PNG). This logo should be a square - icon type of logo for avatar."},"businessId":{"type":"string","description":"The Business ID (Y-tunnus / Business Identity Code) is a code given to businesses and organizations by the PRH or the Tax Administration. \r\nIt consists of seven digits, a dash and a control mark, for example 1234567-8.\r\nAlternative accepted formats incule international VAT number \"FI12345678\" or number without the dash: \"12345678\"."},"officialName":{"type":"string","description":"This is an official name of the actor.\r\nIt originates from the YTJ or Bank authentication."},"resolvedId":{"type":"string","description":"If an object with the given BusinessID exists, it is resolved here: The unique ID is set here by the onboarding service. This field cannot be set."},"partnerAccountId":{"type":"string","description":"Identifier at the partner site - typically an organization ID."},"ownership":{"description":"Company ownership for KYC","$ref":"#/components/schemas/Ownership"},"doYtjUpdate":{"type":"boolean","description":"If true, will fetch the data from the Finnish Business Infromation System (YTJ/BIS).\r\nFetching is done firstly based on Business ID, if that is not valid then based on name."},"ytjDetails":{"description":"The details of company data as provided by the Finnish Business Infromation System (YTJ/BIS)","$ref":"#/components/schemas/YtjCompany"},"ytjSearch":{"description":"A search to Finnish Business Infromation System (YTJ/BIS). This search is triggered if you set the RawInput field.","$ref":"#/components/schemas/YtjSearchResult"},"companyType":{"description":"The legal type of the company, as categorized by Palkkaus / used in generating IBAN numbers.","$ref":"#/components/schemas/CompanyType"},"contact":{"description":"Contact information for the company","$ref":"#/components/schemas/Contact"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"List of roles which this account is member of."},"language":{"description":"Language of the company.","$ref":"#/components/schemas/Language"}},"additionalProperties":false,"description":"Represents the input for creating a company account."},"CompanyType":{"enum":["unknown","fiOy","fiTm","fiRy","fiYy"],"type":"string","description":"Company type for the purposes of Account number"},"ComputeClause":{"required":["computedItems"],"type":"object","properties":{"computedItems":{"type":"array","items":{"$ref":"#/components/schemas/ComputeExpression"},"readOnly":true}},"additionalProperties":false,"readOnly":true},"ComputeExpression":{"required":["expression","alias","typeReference"],"type":"object","properties":{"expression":{"$ref":"#/components/schemas/SingleValueNode"},"alias":{"type":"string","readOnly":true},"typeReference":{"$ref":"#/components/schemas/IEdmTypeReference"}},"additionalProperties":false},"ComputeQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"resultClrType":{"$ref":"#/components/schemas/Type"},"computeClause":{"$ref":"#/components/schemas/ComputeClause"},"rawValue":{"type":"string","readOnly":true},"validator":{"$ref":"#/components/schemas/IComputeQueryValidator"}},"additionalProperties":false},"ConnectionInfo":{"type":"object","properties":{"id":{"type":"string"},"remoteIpAddress":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/IPAddress"}]},"remotePort":{"type":"integer","format":"int32"},"localIpAddress":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/IPAddress"}]},"localPort":{"type":"integer","format":"int32"},"clientCertificate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/X509Certificate2"}]}},"additionalProperties":false,"readOnly":true},"Contact":{"type":"object","properties":{"email":{"maxLength":256,"type":"string","description":"Contact e-mail address. Always lower invariant, trimmed and empty string set to null."},"telephone":{"maxLength":32,"type":"string","description":"Telephone number"},"street":{"maxLength":128,"type":"string","description":"Street address"},"postalCode":{"maxLength":10,"type":"string","description":"Postal code"},"city":{"maxLength":32,"type":"string","description":"City or community (postitoimipaikka)"},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"This is the ISO code for country.\r\nCurrently, it should always be \"fi\"."}},"additionalProperties":false,"description":"Common contact information object for Person, Company, Location etc."},"ContactAdvanced":{"type":"object","properties":{"type":{"description":"Type of contact when specification allows several contacts.","$ref":"#/components/schemas/ContactType"},"email":{"maxLength":256,"type":"string","description":"Contact e-mail address. Always lower invariant, trimmed and empty string set to null."},"telephone":{"maxLength":32,"type":"string","description":"Telephone number"},"street":{"maxLength":128,"type":"string","description":"Street address"},"postalCode":{"maxLength":10,"type":"string","description":"Postal code"},"city":{"maxLength":32,"type":"string","description":"City or community (postitoimipaikka)"},"country":{"description":"Country as defined as","$ref":"#/components/schemas/Country"},"countryOtherName":{"type":"string","description":"Name of the country as free text if Country is Other."}},"additionalProperties":false,"description":"Advanced contact information with strongly typed country and type information."},"ContactPerson":{"type":"object","properties":{"name":{"type":"string"},"telephone":{"type":"string"},"email":{"type":"string"},"responsibilityCode":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ResponsibilityCode"}]}},"additionalProperties":false},"ContactType":{"enum":["default","workerAccount","employerOverride","foreign"],"type":"string","description":"Typing of contacts for different special situations."},"ContentPackage":{"type":"object","properties":{"type":{"description":"Api Item Type","$ref":"#/components/schemas/ApiItemType"},"propertyPath":{"type":"string","description":"Path to the property."},"content":{"type":"object","additionalProperties":false,"description":"Content for the property."},"action":{"description":"Action to be performed with the content.","$ref":"#/components/schemas/ContentPackageAction"}},"additionalProperties":false,"description":"Content for a API object property."},"ContentPackageAction":{"enum":["undefined","overwrite","preserve","append"],"type":"string","description":"Defines how the content package is applied."},"ContractParty":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for the party: Currently always an account, but may be an external ID later."},"avatar":{"description":"Avatar for the Party. \r\nNote that this is not automatically fetched by all methods: Especially when IsSelf is true.","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information - note that for most signatures, only E-mail and phone number are required.","$ref":"#/components/schemas/Contact"},"isSelf":{"type":["null","boolean"],"description":"True if Profile is the current Authorization.\r\nIf set to true, will set current Authorization as this contract party.\r\nIf set to false AND was previously true, will set the Profile properties null (unless explicitly set to something else)"},"officialId":{"type":"string","description":"Official ID if needed in signature"},"role":{"type":"string","description":"Role of the person - justification for authorization"},"isSigned":{"type":"boolean","description":"True if the person has signed the contract."},"signatureUrl":{"type":"string","description":"Reserved for cases where there are several signees and each has a separate signature document."},"iban":{"type":"string","description":"Bank account IBAN number"},"contractPartyType":{"description":"Party type (Person or Prospect)","$ref":"#/components/schemas/ContractPartyType"},"isEmployer":{"type":"boolean","description":"If true, contact is an employer"}},"additionalProperties":false,"description":"A signing party in a contract."},"ContractPartyType":{"enum":["person","customContact"],"type":"string"},"ContractToAccept":{"type":"object","properties":{"authorizationType":{"description":"Type of the contract to accept: WorkerContract for a worker. For a company, PartnerContract: the company accepts the\r\npartner contract; EmployerAuthorization: the company signs the power of attorney.","$ref":"#/components/schemas/AuthorizationType"},"hasValidContract":{"type":"boolean","description":"If true, the account already has a valid contract with Salaxy and accepts or signs nothing. False also when the company's partner contract\r\nacceptance has lapsed: the partner whose permission it used has left the account hierarchy or lost the permission."},"isParentIrCertificateRequiredButMissingOrExpired":{"type":"boolean","description":"If true, the primary parent account (the accountant in three-tier) must hold its own Incomes Register certificate\r\nand it is missing or expired. The terms cannot be accepted until the parent account adds a valid certificate."}},"additionalProperties":false,"description":"The contract that the current account accepts on the signing page, and what stops the acceptance."},"CostAccountingDimension":{"type":"object","properties":{"id":{"type":"string","description":"Dimension Id."},"value":{"type":"string","description":"Cost accounting dimension value id."},"percent":{"type":["null","number"],"description":"Sharing percent for the dimension.","format":"percent"}},"additionalProperties":false,"description":"Id of the cost accounting dimension with optional percentage for shared costs."},"CostAccountingDimensionDefinition":{"type":"object","properties":{"id":{"type":"string","description":"Id for the dimension."},"label":{"type":"string","description":"Default label for the dimension entry."},"options":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionOption"},"description":"Hierarchial object containing selection options for dimension values."},"allowCostSharing":{"type":"boolean","description":"If true, multiple values can be set to the dimension and the costs are shared between dimension values."},"scope":{"description":"Defines the visible scopes of the dimension. For example, Scope.Row shows the dimension on row level only.","$ref":"#/components/schemas/CostAccountingDimensionScope"}},"additionalProperties":false,"description":"Cost accounting dimension definition."},"CostAccountingDimensionOption":{"type":"object","properties":{"value":{"type":"string","description":"Value for the option."},"text":{"type":"string","description":"Description of the value."},"path":{"type":"string","description":"For option hiearchies, path to this option not including the value itself."},"scope":{"description":"Defines the visible scopes of the dimension values. For example, Scope.Row shows the dimension value on row level only.\r\nThe default is, that the scope is not defined and that the value is visible everywhere.","$ref":"#/components/schemas/CostAccountingDimensionScope"}},"additionalProperties":false,"description":"Selectable cost accounting dimension value."},"CostAccountingDimensionScope":{"enum":["none","calculation","row","hidden"],"type":"string","description":"Defines the scope of dimension."},"CostAccountingInSession":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"},"description":"Cost accounting dimensions"}},"additionalProperties":false,"description":"Cost accounting models for session."},"CostAccountingSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"},"description":"Cost accounting dimensions"}},"additionalProperties":false,"description":"Settings related to Cost Accounting"},"CountQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValue":{"type":"string","readOnly":true},"value":{"type":"boolean","readOnly":true},"validator":{"$ref":"#/components/schemas/ICountQueryValidator"}},"additionalProperties":false,"readOnly":true},"Country":{"enum":["fi","ae","at","ba","bg","by","cn","de","eg","fr","gg","hr","ie","in","je","kr","lk","lv","me","mx","no","pk","rs","sg","th","tr","us","vg","zm","am","au","bb","bm","ca","cy","dk","es","gb","gr","hu","il","is","jp","ky","lt","ma","mk","my","nz","pl","ru","si","tj","tz","uy","vn","ar","az","be","br","ch","cz","ee","ge","hk","id","im","it","kg","kz","lu","md","mt","nl","ph","ro","se","sk","tm","ua","uz","za","other"],"type":"string","description":"Country for salary purposes as specified by the tax authorities.\r\nTaken as of 06/2023 from here: https://www.vero.fi/tulorekisteri/yritykset-ja-organisaatiot/suorituksen-maksajat/palkkatiedot/pakolliset-ja-t%C3%A4ydent%C3%A4v%C3%A4t-tiedot/maakoodit/"},"CumulativeCalculation":{"type":"object","properties":{"cumulative":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CumulativeData"},"description":"Cumulative data for the calculation."},"employer":{"description":"The employer object for this calculation.\r\nTypically, you do not need to set this before the actual payment process.","$ref":"#/components/schemas/CalcEmployer"},"worker":{"description":"The Worker (employee) that has performed the work.","$ref":"#/components/schemas/CalcWorker"},"workflow":{"description":"Information about the workflow and state of the calculation.","$ref":"#/components/schemas/CalcWorkflow"},"salary":{"description":"The main salary element. \r\nAlternatively the salary can be set in the Rows object - this will be the only way to set multiple salary rows (not yet supported).","$ref":"#/components/schemas/Salary"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserDefinedRow"},"description":"Set of rows that make up the salary calculation:\r\nExpenses, Benefits, deductions etc. Note that side costs are not rows."},"framework":{"description":"DEPRECIATED: Usecase will be replacing this functionality in a next major release.\r\nThe Framework Agreement (TES) parameters that affect the framework based side costs etc. of this calculation","$ref":"#/components/schemas/TesParameters"},"usecase":{"description":"A usecase for creating and editing salary calculations.\r\nIn practice, a usecase is either a user interface or a microservice that provides a salary calculation\r\nand it may be implemented outside Salaxy.\r\nProvides the possibility to store useacase specific data as part of calculation.\r\nNOTE: This functionality will replace Framework property in a next major release.","$ref":"#/components/schemas/UsecaseData"},"result":{"description":"The results of the calculation. In the API, this is a read-only object.","$ref":"#/components/schemas/CalculationResult"},"info":{"description":"Information about the work that is not directly related to calculating salary and expenses.","$ref":"#/components/schemas/CalcInfo"},"sharing":{"description":"Sharing of the calculation. This object cannot be modified directly, \r\nuse specialized methods in Calculations service.","$ref":"#/components/schemas/CalculationSharing"},"accounting":{"description":"Contains calculation specific data for accounting (both cost and financial accounting).","$ref":"#/components/schemas/CalculationAccounting"},"worktime":{"description":"Worktime data that is stored as part of Salary calculation:\r\nwork days, absences, holidays and holiday accrual.\r\nIn the future may also contain relevant part of timesheet data (work hours).","$ref":"#/components/schemas/CalcWorktime"},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"scripts":{"description":"Scripts for the calculation.","$ref":"#/components/schemas/BleScriptModule"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Calculation with additional cumulative data."},"CumulativeData":{"type":"object","properties":{"salaryDates":{"description":"First and last Salary dates (days when Worker receives the salary) and number of payment days.","$ref":"#/components/schemas/DateRange"},"workingDays":{"description":"Working days based on the salary calculations.","$ref":"#/components/schemas/DateRange"},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of labels of the current data"},"data":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"The cumulative data of the calculations."},"units":{"type":"object","additionalProperties":{"type":"string"},"description":"The cumulative units of the calculations."}},"additionalProperties":false,"description":"Cumulative data for a single calculation"},"Currency":{"enum":["eUR"],"type":"string","description":"Represents supported currencies."},"CustomerFundsSettings":{"type":"object","properties":{"isWorkerSelfHandling":{"type":"boolean","description":"If true, worker salary and expense payments are paid directly by the employer."},"isPensionSelfHandling":{"type":"boolean","description":"If true, the user handles the reporting and payments himself/herself."},"isTaxAndSocialSecuritySelfHandling":{"type":"boolean","description":"If true, tax and social security payments are paid directly by the employer."}},"additionalProperties":false,"description":"Settings related to payment methods that use the customer funds account (gross payment)."},"CustomerWebApp":{"enum":["palkkaus","customSso","customPalkkaus","noCustomerUi"],"type":"string","description":"Defines the type of web app that the customer is using."},"DailyAllowanceKind":{"enum":["undefined","fullDailyAllowance","partialDailyAllowance","internationalDailyAllowance","mealAllowance"],"type":"string"},"DailyAllowanceUsecase":{"type":"object","properties":{"isHalf":{"type":"boolean"},"kind":{"enum":["undefined","fullDailyAllowance","partialDailyAllowance","internationalDailyAllowance","mealAllowance"],"type":"string"},"country":{"type":["null","string"]}},"additionalProperties":false},"Dataset":{"type":"object","properties":{"info":{"description":"Editable metadata info about a dataset.","$ref":"#/components/schemas/DatasetInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DatasetDataObject"},"description":"The payload of the dataset: The objects or tables that are stored."},"usecase":{"description":"Usecase is data related to the source and processing of the Employment data outside the Salaxy backend service / system.\r\nTypically, Usecase data would be processed by an external system that has originally created the \r\nEmployment Relation (Worker / Employee in many systems). E.g. expenses system, hourly reporting system.","$ref":"#/components/schemas/UsecaseData"},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Dataset models some arbitrary data that is store in storage.\r\nThis is any data that is not \"strongly modeled\", for example:\r\nImports from / exports to external systems, reports, data analyses and control data for batch processes."},"DatasetDataObject":{"type":"object","properties":{"name":{"type":"string","description":"Technical name (unique key) for the data object"},"label":{"type":"string","description":"User friendly label."},"schemaDoc":{"type":"string","description":"Schema document that contains the schema."},"schema":{"type":"string","description":"Identifier / path to the schema that defines the data structure for the content."},"isArray":{"type":"boolean","description":"If true, the schema should be interpreted as an array (display in table by default)."},"content":{"type":"array","items":{"type":"object","additionalProperties":false},"description":"Data payload / content of the object."},"validation":{"description":"Potential validation data for content.\r\nNote that in many scenarios, validation may not be done / may not be serialized to storage so this property may be null.","$ref":"#/components/schemas/ApiValidation"},"views":{"type":"array","items":{"$ref":"#/components/schemas/DatasetView"},"description":"Defines one or multiple views for the dataset object. Typically this is fields to include / exclude from\r\nthe views and definitions on how the views should be formatted / edited.\r\nFirst view is considered the default view and some UI's will only support that one view."}},"additionalProperties":false},"DatasetInfo":{"type":"object","properties":{"status":{"description":"Status of the dataset.","$ref":"#/components/schemas/DatasetStatus"},"label":{"type":"string","description":"End-user friendly label that describes the dataset in listings etc."},"type":{"description":"The logical type / purpose of the dataset.","$ref":"#/components/schemas/DatasetType"}},"additionalProperties":false,"description":"Editable metadata info about a dataset."},"DatasetListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/DatasetStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/DatasetListItemData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of datasets."},"DatasetListItemData":{"type":"object","properties":{"usecaseUri":{"type":"string","description":"Key for the usecase based on which it is resolved. \r\nLater, this may resolve to a user interface, microservice or a to manifest registering one.\r\nFor now, just use a unique string starting with a domain you own."}},"additionalProperties":false,"description":"Dataset specific business data for index."},"DatasetStatus":{"enum":["draft","instance","template"],"type":"string","description":"Status for the Dataset"},"DatasetType":{"enum":["undefined","reportAdHoc","import","export","batch"],"type":"string","description":"Logical usage type of dataset"},"DatasetView":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"},"description":"Properties / columns that should be shown in the view.\r\nThese may be either simple column names or property paths (e.g. \"personalInfo.avatar.sortableName\") for hierarchical objects."},"exclude":{"type":"array","items":{"type":"string"},"description":"Properties / columns that should be shown excluded from the view.\r\nExclusion is used only if Include is not set and it is applied to the \"default view\":\r\nDefault view depends on the renderer, but it is typically just the first level of a hierarchical view,\r\nso exclude values are typically just simple column / property names, not property paths."}},"additionalProperties":false,"description":"Defines a view, typically an array view, for a dataset."},"DateOfBirthAccuracy":{"enum":["assumption","ageBased","ageGroupBased","monthCorrect","exact","verified"],"type":"string"},"DateRange":{"type":"object","properties":{"start":{"type":["null","string"],"description":"Start date of the period","format":"date"},"end":{"type":["null","string"],"description":"End date of the period.","format":"date"},"daysCount":{"type":"number","description":"Number of days in the range.\r\nDepending of the context, this may be mathematical (end - start) or \r\nexplicitly specified (typically working days).\r\nTypically an integer, and calculations and UI's may choose to round it.","format":"double"},"days":{"type":"array","items":{"type":"string","format":"date-time"},"description":"The collection of days contained in the DateRange if specified by the user.\r\nAlternative to DaysCount. If set, should also set DaysCount for backward compatibility."}},"additionalProperties":false,"description":"Describes the range of dates from start to end and the number of days in between."},"DefaultQueryConfigurations":{"type":"object","properties":{"enableExpand":{"type":"boolean"},"enableSelect":{"type":"boolean"},"enableCount":{"type":"boolean"},"enableOrderBy":{"type":"boolean"},"enableFilter":{"type":"boolean"},"maxTop":{"type":["null","integer"],"format":"int32"},"enableSkipToken":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"DocumentFlowItem":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/IApiListItem"},"children":{"type":"array","items":{"$ref":"#/components/schemas/DocumentFlowItem"},"description":"Child items, for example invoices for the calculation."}},"additionalProperties":false,"description":"Document in the document flow."},"EdmContainerElementKind":{"enum":["none","entitySet","actionImport","functionImport","singleton"],"type":"string","readOnly":true},"EdmExpressionKind":{"enum":["none","binaryConstant","booleanConstant","dateTimeOffsetConstant","decimalConstant","floatingConstant","guidConstant","integerConstant","stringConstant","durationConstant","null","record","collection","path","if","cast","isType","functionApplication","labeledExpressionReference","labeled","propertyPath","navigationPropertyPath","dateConstant","timeOfDayConstant","enumMember","annotationPath"],"type":"string","readOnly":true},"EdmOnDeleteAction":{"enum":["none","cascade"],"type":"string","readOnly":true},"EdmPropertyKind":{"enum":["none","structural","navigation"],"type":"string"},"EdmReferentialConstraintPropertyPair":{"required":["dependentProperty","principalProperty"],"type":"object","properties":{"dependentProperty":{"$ref":"#/components/schemas/IEdmStructuralProperty"},"principalProperty":{"$ref":"#/components/schemas/IEdmStructuralProperty"}},"additionalProperties":false},"EdmSchemaElementKind":{"enum":["none","typeDefinition","term","action","entityContainer","function"],"type":"string","readOnly":true},"EdmTypeKind":{"enum":["none","primitive","entity","complex","collection","entityReference","enum","typeDefinition","untyped","path"],"type":"string","readOnly":true},"EInvoiceAddress":{"type":"object","properties":{"receiverName":{"type":"string","description":"Name for the company."},"receiverOfficialId":{"type":"string","description":"Official id of the company."},"receiver":{"type":"string","description":"Receiver EInvoice address of company."},"intermediator":{"type":"string","description":"Intermediator id for this receiver address."},"intermediatorName":{"type":"string","description":"Intermediator name for this receiver address."}},"additionalProperties":false,"description":"Result item of the EInvoice address query."},"EInvoicingRequest":{"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678\r\nThis field is optional and defaults to the company number of the current account."},"parameters":{"type":"object","additionalProperties":false,"description":"Additional parameters for import. Defaults to string."},"item":{"type":"string"},"validation":{"description":"Validation for the import","$ref":"#/components/schemas/ApiValidation"},"result":{"description":"Result object of the import.","$ref":"#/components/schemas/ApiImportResultOfObject"}},"additionalProperties":false,"description":"Import object for E-invoice delivery."},"EmployeeGroupDefinition":{"type":"object","properties":{"id":{"type":"string","description":"Id for the Employee Group."},"name":{"type":"string","description":"Name for the Employee Group."}},"additionalProperties":false,"description":"Definition for an employee group, e.g. \"Office workers\", \"Blue collar workers\" etc."},"EmployerCalculationDTO":{"type":"object","properties":{"allSideCosts":{"type":"number","description":"All side cost: The mandatory side costs + Palkkaus and partner fees","format":"double"},"finalCost":{"type":"number","description":"The final cost after household decuction from the tax authorities:\r\nAdd to the payment the deductions (paid by employer) and deduct House hold deduction (later potentially other such subsidies)","format":"double"},"householdDeduction":{"type":"number","description":"Household deduction that the tax man will reimburse in taxation.\r\nThis is an estimation: There is minimum and maximum limits etc.","format":"double"},"mandatorySideCosts":{"type":"number","description":"The mandatory side costs are Pension (TyEL), Social secuirty and Unemployment insurance.","format":"double"},"palkkaus":{"type":"number","description":"The Palkkaus.fi fee including potential partner fees.","format":"double"},"service":{"type":"number","description":"Extra service charge in addition to Palkkaus fee.","format":"double"},"pension":{"type":"number","description":"The part of the Pension that Employer pays","format":"double"},"socialSecurity":{"type":"number","description":"The social security payment- paid as part of taxation (ennakonpidätys).","format":"double"},"totalPayment":{"type":"number","description":"Total payment that is Paid to Palkkaus.fi","format":"double"},"totalPaymentLegacy":{"type":"number","description":"Total payment using pre Insiders register calculation logic.\r\nDEPRICATED: This is provided for special scenarios and may be removed without warning","format":"double"},"totalSalaryCost":{"type":"number","description":"Total salary cost is the paid salary, deductions and side costs, but not expenses.","format":"double"},"unemployment":{"type":"number","description":"The part of the unemployment insurance that the employer pays","format":"double"},"totalDeductions":{"type":"number","description":"Total deductions that are made from the payment that is paid to Palkkaus and then to Worker","format":"double"},"deductionUnionPayment":{"type":"number","description":"Union payment if it is deducted from the final figure","format":"double"},"deductionPensionSelfPayment":{"type":"number","description":"Pension payments, when paid directly by the Employer - not by Palkkaus.fi","format":"double"},"deductionUnemploymentSelfPayment":{"type":"number","description":"Unemployment insurance (TVR) payments, when paid directly by the Employer - not by Palkkaus.fi","format":"double"},"deductionSalaryAdvance":{"type":"number","description":"Salary advance - this part has already been paid.","format":"double"},"deductionForeclosure":{"type":"number","description":"Foreclosure that has already been paid by the employer.","format":"double"},"deductionTaxAndSocialSecuritySelfPayment":{"type":"number","description":"Tax and social security payments, when paid directly by the Employer - not by Palkkaus.fi","format":"double"},"deductionWorkerSelfPayment":{"type":"number","description":"Worker salary and expense payments, when paid directly by the Employer - not by Palkkaus.fi","format":"double"},"foreclosureByPalkkaus":{"type":"number","description":"Foreclosure that Palkkaus.fi pays in behalf of employer.","format":"double"},"deductionOtherDeductions":{"type":"number","description":"Other deductions that are deducted from the net salary.","format":"double"}},"additionalProperties":false,"description":"Models the business logic of Employer side of the calculation. \r\nFor documentation, see the IEmployerCalculation interface."},"EmployerGroups":{"type":"object","properties":{"isPrivatePerson":{"type":"boolean","description":"If true, the Employer is a private person.\r\nOtherwise Company or Unknown."}},"additionalProperties":false,"description":"Employer groups that are set on Example calculations.\r\nThese will be replaced by properties from Worker / Employer"},"EmployerInfo":{"type":"object","properties":{"isPensionContractDone":{"type":"boolean","description":"Indicates if the employer has a pension contract."},"pensionCompany":{"description":"The id of the pension company.","$ref":"#/components/schemas/PensionCompany"},"pensionContractNumber":{"type":"string","description":"Pension contract number."},"isPensionSelfHandling":{"type":"boolean","description":"If true, the mployer handles the pension himself."},"pensionDiscountPercent":{"type":"number","description":"Pension discount percent.","format":"percent"},"pensionPercent":{"type":["null","number"],"description":"Customer specific pension percent","format":"percent"},"isPartnerInsurance":{"type":"boolean","description":"Indicates if the insurance is provided by Palkkaus partnership insurance company."},"isInsuranceContractDone":{"type":"boolean","description":"Indicates if the employer has an insurance."},"insuranceCompany":{"description":"The id of the insurance company.","$ref":"#/components/schemas/InsuranceCompany"},"insuranceContractNumber":{"type":"string","description":"Insurance contract number."},"insurancePercent":{"type":"number","description":"Percent for calculating the estimate for the accident insurance amount to pay.","format":"percent"},"groupLifeInsurancePercent":{"type":"number","description":"Percent for calculating the estimate for the group life insurance amount to pay.","format":"percent"}},"additionalProperties":false,"description":"Employer insurance information."},"EmployingRelation":{"type":"object","properties":{"employer":{"description":"Employer avatar","$ref":"#/components/schemas/AccountInIndex"},"contact":{"description":"Contact information for the report. Typically the employer, but may be something else.\r\nBy desing, the contact information is not filled in for Private Person employers.","$ref":"#/components/schemas/Contact"},"settings":{"description":"Relevant and public employer settings.","$ref":"#/components/schemas/EmployingRelationSettings"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Employing relation info for the worker."},"EmployingRelationCostAccounting":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"},"description":"Cost accounting dimensions"}},"additionalProperties":false,"description":"Cost accounting settings in the employing relation."},"EmployingRelationSettings":{"type":"object","properties":{"costAccounting":{"description":"Cost accounting settings for employing relation.","$ref":"#/components/schemas/EmployingRelationCostAccounting"}},"additionalProperties":false,"description":"Settings for the employing relation."},"Employment":{"type":"object","properties":{"info":{"description":"General information about the Employment relation.","$ref":"#/components/schemas/EmploymentRelationInfo"},"work":{"description":"Describes the work that is being performed in this Employment Relation.","$ref":"#/components/schemas/WorkDescription"},"identity":{"description":"Contains values that are needed when creating an employment, but where changing is restricted in the future:\r\nE.g. names and personalId are required when creating a new employment, but once a calculation is created (or at least paid),\r\nediting of theses is no longer possible. See the editing rules for individual properties.","$ref":"#/components/schemas/EmploymentIdentity"},"international":{"description":"Properties of the employment for international situations: Working abroad or foreign worker.","$ref":"#/components/schemas/EmploymentRelationInternational"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ContactAdvanced"},"description":"Contacts stored in the employment."},"usecase":{"description":"Usecase is data related to the source and processing of the Employment data outside the Salaxy backend service / system.\r\nTypically, Usecase data would be processed by an external system that has originally created the \r\nEmployment Relation (Worker / Employee in many systems). E.g. expenses system, hourly reporting system.","$ref":"#/components/schemas/UsecaseData"},"holidays":{"description":"Defines how the holidays are specified to this Worker.","$ref":"#/components/schemas/HolidaySpecification"},"personalInfo":{"description":"Contains read-only personal information for the worker typically managed by the Worker account:\r\nNames, personal ID and contact. Currently, this data is edited in Person or WorkerAccount containers, not in the employment relation.","$ref":"#/components/schemas/AccountInIndex"},"isRegistered":{"type":"boolean","description":"If true, the Worker has registered and maintains his / her own personal info.\r\nIf false, the Worker account is created and still maintained by the Employer."},"accruals":{"type":"array","items":{"type":"object","additionalProperties":false},"description":"OBSOLETE. DO NOT use."},"workflowData":{"description":"Workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Employment relation: The relation between Employer and Worker as well as the personal info of the worker."},"EmploymentData":{"type":"object","properties":{"pensionCalculation":{"oneOf":[{"type":"null"},{"description":"Type for the pension insurance.","$ref":"#/components/schemas/PensionCalculation"}]},"taxcard":{"description":"Taxcard type from the employment point of view.","$ref":"#/components/schemas/EmploymentRelationTaxcard"},"type":{"oneOf":[{"type":"null"},{"description":"Type of the employment relation","$ref":"#/components/schemas/EmploymentRelationType"}]},"startDate":{"type":["null","string"],"description":"Start date of the Employment Relation.","format":"date-time"},"endDate":{"type":["null","string"],"description":"End date of the Employment Relation.","format":"date-time"},"isFixedTerm":{"type":["null","boolean"],"description":"Duration of the employment. If true, the employment relation is for a fixed term.\r\nOtherwise (which is the default) the employment relation continues until further notice."},"isTerminated":{"type":["null","boolean"],"description":"Indicates that the employment relation has been terminated.\r\nThis is the value stored in the database as opposed to"},"isActive":{"type":["null","boolean"],"description":"The search logic returns the active state of the employment here in relation to queried date (or today).\r\nNote that you cannot query based on this dynamic parameter: All values in the search index are null."}},"additionalProperties":false,"description":"Employment specific business data for index."},"EmploymentEndingCode":{"enum":["employeesResignation","other","terminationGroundsRelatedToEmployeesPerson","financialAndProductionRelatedGrounds","jointAgreement","retirement","terminationOfaFixedTermEmployment"],"type":"string"},"EmploymentIdentity":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the Worker. Value is required when creating a new employment, it cannot be modified after initial create:\r\nInstead you should just delete the Worker (only allowed if no paid salaries etc.) and create a new one."},"lastName":{"type":"string","description":"Last name of the worker. Editing rules are the same as with FirstName."},"personalId":{"type":"string","description":"Personal ID (hetu) of the worker (currently required). Editing rules are the same as with FirstName."},"avatarImg":{"type":"string","description":"Avatar picture. If set, this is used in avatar instead of Initials (automatic FirstName/LastName) and color.\r\nMay be changed until the Worker registers to the service. After this, the Worker can upload their own image or choose to remove the image."},"color":{"type":"string","description":"Avatar color for visual icon together with initials. Use web compatible rgb values, e.g. \"#FF00FF\" or \"rgb(255, 0, 255)\".\r\nEditing rules are the same as with AvatarImg."},"language":{"description":"Language of the user in user interfaces and print-outs (most significantly the salary slip).\r\nEditing rules are the same as with AvatarImg.","$ref":"#/components/schemas/Language"}},"additionalProperties":false,"description":"Contains values that are needed when creating an employment, but where changing is restricted in the future:\r\nE.g. names and personalId are required when creating a new employment, but once a calculation is created (or at least paid),\r\nediting of theses is no longer possible. See the editing rules for individual properties."},"EmploymentListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/EmploymentRelationStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/EmploymentData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of employment relations in the user interface."},"EmploymentRelationInfo":{"type":"object","properties":{"workerAccountId":{"type":"string","description":"The Account ID of the Worker if Worker"},"sourceId":{"type":"string","description":"Identifier in a source system. Used in imports etc."},"type":{"description":"User friendly employment relation type that is used to set other more technical types and Incomes Registry properties.","$ref":"#/components/schemas/EmploymentRelationType"},"ibanNumber":{"type":"string","description":"The bank account number for salary payment."},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"irIncomeEarnerTypes":{"type":"array","items":{"$ref":"#/components/schemas/IncomeEarnerType"},"description":"Type of additional income earner data by National Incomer Register classification . If several types apply, all of them should be selected."},"cbaCode":{"type":["null","integer"],"description":"Applicable collective agreement","format":"int32"},"employeeGroup":{"type":"string","description":"Employee group."},"pensionCalculation":{"description":"Type for the pension insurance.","$ref":"#/components/schemas/PensionCalculation"},"pensionRule":{"description":"Rules (e.g. effect of monthly lower limit) for pension calculation.","$ref":"#/components/schemas/PensionRule"},"pensionCompany":{"oneOf":[{"type":"null"},{"description":"The id of the pension company.","$ref":"#/components/schemas/PensionCompany"}]},"pensionContractNumber":{"type":"string","description":"The pension contract number.","format":"pension-contract-number"},"insuranceCompany":{"oneOf":[{"type":"null"},{"description":"The id of the insurance company.","$ref":"#/components/schemas/InsuranceCompany"}]},"insuranceContractNumber":{"type":"string","description":"The accident insurance contract number.","format":"insurance-contract-number"},"taxcard":{"description":"Taxcard type from the employment point of view.","$ref":"#/components/schemas/EmploymentRelationTaxcard"},"status":{"description":"Status of this employment relationship","$ref":"#/components/schemas/EmploymentRelationStatus"},"salaryPaymentMethod":{"description":"Worker's preferred salary payment method: bank account, external etc.","$ref":"#/components/schemas/EmploymentRelationSalaryPaymentMethod"},"startDate":{"type":["null","string"],"description":"Start date of the Employment Relation.","format":"date-time"},"endDate":{"type":["null","string"],"description":"End date of the Employment Relation.","format":"date-time"},"isFixedTerm":{"type":"boolean","description":"Duration of the employment. If true, the employment relation is for a fixed term.\r\nOtherwise (which is the default) the employment relation continues until further notice."},"isTerminated":{"type":"boolean","description":"Indicates that the employment relation has been terminated.\r\nSaving with this status also makes the employment relation Archived."},"employmentEndingCode":{"oneOf":[{"type":"null"},{"description":"Employment ending code.","$ref":"#/components/schemas/EmploymentEndingCode"}]},"employmentRegCode":{"type":"string","description":"Employment registration code for Incomes Registry."}},"additionalProperties":false,"description":"General information about the Employment relation."},"EmploymentRelationInternational":{"type":"object","properties":{"country":{"description":"Country of residence for non-recident of Finland (rajatusti verovelvollinen)","$ref":"#/components/schemas/Country"},"foreignId":{"type":"string","description":"Identifier for non-recident of Finland in the country of residence.\r\nType of the identifier is specified in IdType."},"idType":{"description":"Type of ForeignId.","$ref":"#/components/schemas/InternationalIdentifier"},"taxAtSource":{"description":"The non-resident taxcard (or percent without taxcard) that is used if the taxcard in Employment.Info.Taxcard is set to TaxAtSource.","$ref":"#/components/schemas/TaxAtSource"},"socialSecurity":{"description":"Types of social security for international situations.","$ref":"#/components/schemas/InternationalSocialSecurityType"},"socialSecurityExceptions":{"type":"array","items":{"$ref":"#/components/schemas/InternationalSocialSecurityException"},"description":"Exceptions to standard social security cases."}},"additionalProperties":false,"description":"Properties of the employment for international situations: Working abroad or foreign worker."},"EmploymentRelationSalaryPaymentMethod":{"enum":["bankAccount","external"],"type":"string","description":"Worker's preferred salary payment method: bank account, external etc."},"EmploymentRelationStatus":{"enum":["unknown","primary","secondaryCurrent","archived"],"type":"string"},"EmploymentRelationTaxcard":{"enum":["undefined","auto","manual","noTaxCard","taxAtSource"],"type":"string","description":"Taxcard type from the employment point of view."},"EmploymentRelationType":{"enum":["undefined","salary","hourlySalary","monthlySalary","compensation","boardMember","entrepreneur","farmer","employedByStateEmploymentFund","athlete","performingArtist","foreignWorker","workingAbroad"],"type":"string","description":"Type of the Employment Relation"},"EmploymentTerminationKind":{"enum":["undefined","noticePeriodCompensation","monetaryWorkingTimeBankCompensation","terminationAndLayOffDamages","voluntaryTerminationCompensation","pensionPaidByEmployer"],"type":"string","description":"Kind for EmploymentTerminationUsecase."},"EmploymentTerminationUsecase":{"type":"object","properties":{"kind":{"enum":["undefined","noticePeriodCompensation","monetaryWorkingTimeBankCompensation","terminationAndLayOffDamages","voluntaryTerminationCompensation","pensionPaidByEmployer"],"type":"string"}},"additionalProperties":false},"ETagOfAccountingTargetListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfApiListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfBrandListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfCalculationListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfDatasetListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfEmploymentListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfFileListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfHolidayYearListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfHouseholdYearListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfInvoiceListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfMessageListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfPaymentMessageListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfPayrollListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfPrimaryPartnerListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfRecordListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfReferenceObjectListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfServiceModelListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfTaskDefinitionListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfTaskRunListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfTaxcardListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfTemplateListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ETagOfUsecaseListItem":{"type":"object","properties":{"isWellFormed":{"type":"boolean"},"entityType":{"$ref":"#/components/schemas/Type"},"isAny":{"type":"boolean"},"isIfNoneMatch":{"type":"boolean"}},"additionalProperties":false,"readOnly":true},"ExportMethod":{"enum":["undefined","fileExcel","fileCsv","filePdf","fileText","copyExcel","copyCsv","copyText","paymentChannel","api"],"type":"string","description":"Defines an export method.\r\nCurrently used only in Accounting data, but may be later used in other integrations."},"FederationSampleViewModel":{"type":"object","properties":{"federationData":{"description":"The federation data based on the current user","$ref":"#/components/schemas/OpenIdUserInfoSupportedClaims"},"federationDataJson":{"type":"string","description":"Federation data as JSON: Only used by depricated Asp.Net MVC version of the demo view."},"customFederationDataJson":{"type":"string"},"token":{"type":"string","description":"Federation data as JWT"},"certificatePwd":{"type":"string","description":"Certificate password for signing"},"certificateFile":{"description":"Uploaded certificate file","$ref":"#/components/schemas/IFormFile"},"certificateBytes":{"type":"string","description":"Certificate bytes as Base64String"},"accountId":{"type":"string","description":"Account to impersonate."}},"additionalProperties":false,"description":"View model data for Simple Federation Flow sample page in /MyAccount/Federation"},"FileData":{"type":"object","properties":{"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"workerCount":{"type":["null","integer"],"description":"Number of workers in the report.","format":"int32"},"calculationCount":{"type":["null","integer"],"description":"Number of calculations in the report.","format":"int32"},"officialId":{"type":"string","description":"Official id for the report."},"userFriendlyName":{"type":"string","description":"A user friendly name that can be used in listings.\r\nIn the upload scenarios this is usually the original file name when uploaded. \r\nIt is not necessarily unique. No path information"},"filePath":{"type":"string","description":"Technical file name in storage.  In practical terms, this is the relative path\r\nexcluding the container part \"/[container]/\". \r\nI.e. this property is without the starting slash \"/\". \r\nIt must be unique and is used for Uri.\r\nFor user files this is constructed \"[Username]/[Type]/[UniqueFileName].[xxx]\""}},"additionalProperties":false,"description":"Report specific business data for index."},"FileListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/FileData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of reports in the user interface.\r\nIt contains all essential information of the report and is basis for searching, filtering and sorting."},"FileType":{"type":"object","properties":{"extension":{"type":"string"},"mimeType":{"type":"string"},"isImage":{"type":"boolean"},"isText":{"type":"boolean","readOnly":true}},"additionalProperties":false,"readOnly":true},"FilterClause":{"required":["expression","rangeVariable"],"type":"object","properties":{"expression":{"$ref":"#/components/schemas/SingleValueNode"},"rangeVariable":{"$ref":"#/components/schemas/RangeVariable"},"itemType":{"$ref":"#/components/schemas/IEdmTypeReference"}},"additionalProperties":false,"readOnly":true},"FilterQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"validator":{"$ref":"#/components/schemas/IFilterQueryValidator"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filterClause":{"$ref":"#/components/schemas/FilterClause"},"rawValue":{"type":"string","readOnly":true}},"additionalProperties":false,"readOnly":true},"ForeclosureKind":{"enum":["undefined","fixed","periodic","nonPeriodic"],"type":"string","description":"Foreclosure kind."},"ForeclosureUsecase":{"type":"object","properties":{"referenceNumber":{"type":["null","string"]},"periodLength":{"type":"integer"},"dependantsCount":{"type":"integer"},"protectedPortionBase":{"type":["null","number"],"format":"double"},"protectedPortionDependant":{"type":["null","number"],"format":"double"},"incomeFromOtherSources":{"type":["null","number"],"format":"double"},"additionalAmountLeftToDebtor":{"type":["null","number"],"format":"double"},"kind":{"enum":["undefined","fixed","periodic","nonPeriodic"],"type":"string"}},"additionalProperties":false},"FormsInSession":{"type":"object","additionalProperties":false,"description":"Settings for session related to the calculation data delivery by forms."},"FormsSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."}},"additionalProperties":false,"description":"Settings related to the calculation data delivery by forms."},"FrameworkAgreement":{"enum":["notDefined","construction","mll","childCare","cleaning","santaClaus","entrepreneur","other"],"type":"string"},"HealthCareHelttiProduct":{"type":"object","properties":{"package":{"description":"Defines the product package","$ref":"#/components/schemas/HelttiProductPackage"},"industry":{"description":"Industry of work","$ref":"#/components/schemas/HelttiIndustry"},"status":{"type":"string","readOnly":true},"enabled":{"type":"boolean","description":"Enabled property set automatically by HelttiProductPackage."},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"Employer health care from the company Heltti"},"HelttiIndustry":{"enum":["notDefined","i","j","k","m","o","n","p","q","r","s","other"],"type":"string"},"HelttiProductPackage":{"enum":["notDefined","small","medium","large"],"type":"string","description":"Defines the availabel product packages."},"Holiday":{"enum":["newYearsDay","epiphany","goodFriday","easterSunday","easterSaturday","easterMonday","mayDay","ascensionDay","pentecost","midsummerEve","midsummerDay","allSaintsDay","independenceDay","christmasEve","christmasDay","stStephensDay"]},"HolidayAccrual":{"type":"object","properties":{"months":{"type":"array","items":{"$ref":"#/components/schemas/HolidayAccrualEntry"},"description":"Holiday accrual entries during the period."},"period":{"description":"The period for holiday accrual.\r\nThis is also the period of the holiday year that the Worker is Employed,\r\ni.e. it may be shorter than HolidayYear Period if the employment relation \r\nbegins or ends within the holiday year.","$ref":"#/components/schemas/DateRange"},"defaultAccrual":{"type":"number","description":"Default accrual for months where the Accrual occurs.\r\nWhen Holiday year is recalculated, this is determined either from Employment Period or AccrualFixed if set.","format":"double"},"startSaldo":{"type":"number","description":"Start saldo from the previous year.","format":"double"},"total":{"type":"number","description":"Total for the current year. This does not include Start saldo.","format":"double","readOnly":true},"endSaldo":{"type":"number","description":"End saldo from the previous year. This is Total + Start Saldo.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Yearly log for Holiday accrual."},"HolidayAccrualCalcSpecification":{"type":"object","properties":{"year":{"type":"integer","description":"Year as integer","format":"int32"},"code":{"description":"Defines how the holidays are handled for the worker.","$ref":"#/components/schemas/HolidayCode"},"wageBasis":{"description":"Wage basis for a Holiday Year.","$ref":"#/components/schemas/WageBasis"},"defaultAccrual":{"type":"number","description":"Default accrual for months where the Accrual occurs.","format":"double"}},"additionalProperties":false,"description":"Info covering most important accrual year parameters."},"HolidayAccrualEntry":{"type":"object","properties":{"index":{"type":"integer","description":"Index of the month from 0-11 for easier iteration.\r\nThis is also the real identifier of the month when editing the entries through API.\r\nMonths 4-12 are index 0-8 and month 1-3 are index 9-11","format":"int32"},"month":{"type":"string","description":"First day of month for the holiday month","format":"date"},"daysAccrued":{"type":"number","description":"Days added to holiday Accrual: Typically days per month.","format":"double"},"source":{"description":"Source of the holiday accrual.","$ref":"#/components/schemas/HolidayAccrualSource"},"calcId":{"type":"string","description":"Identier of the calculation if Kind"},"notes":{"type":"string","description":"Additional information as recorded by the Employer."}},"additionalProperties":false,"description":"Entry in the Yearly Holiday Accrual list."},"HolidayAccrualSettings":{"type":"object","properties":{"code":{"description":"Defines how the holidays are handled for the worker.","$ref":"#/components/schemas/HolidayCode"},"cbaCode":{"type":["null","integer"],"description":"Applicable collective agreement","format":"int32"},"employeeGroup":{"type":"string","description":"Employee group."},"disabled":{"type":"boolean","description":"Flag for disabling the setting."},"startYear":{"type":["null","integer"],"description":"If specified, defines the start holiday year for the settings.\r\nIf in the future, the settings is inactive. Null (default) means the settings is valid indefinetely from the past.","format":"int32"},"endYear":{"type":["null","integer"],"description":"If specified, defines the end holiday year for the settings. \r\nThe year is inclusive meaning.\r\nIf in the past, the the settings is inactive. Null (default) means the settings is valid indefinetely to future.","format":"int32"},"workingTimeTypes":{"type":"array","items":{"type":"string"},"description":"RowTypes, WageTypes or IncomeTypes which accumulate working time.\r\nDefault is  null, which means that a default set of types is used."},"script":{"type":"string","description":"Script for the holiday accrual calculation. Used if HolidayCode HolidayAccrualSettings.Code is HolidayCode.Script."}},"additionalProperties":false,"description":"Settings for the holiday accrual calculations."},"HolidayAccrualSource":{"enum":["initial","manual","calcDraft","calcPaid"],"type":"string","description":"Kind of Holiday accrual."},"HolidayBonusPaymentMethod":{"enum":["none","payForHolidaySalary","paySummerBonus","paySelectedDays","pay24Days","payAllBonus"],"type":"string","description":"The way that the holiday bonus is handled in this salary calculation"},"HolidayCalculationDTO":{"type":"object","properties":{"totalAccruedHolidayPay":{"type":"number","description":"Total sum of accrued holiday pays.","format":"double"},"totalAccruedHolidayBonus":{"type":"number","description":"Total sum of accrued holiday pays.","format":"double"},"totalAccruedHolidaySocialSecurity":{"type":"number","description":"Total sum of social security payments for accrued holiday pays.","format":"double"},"totalAccruedHolidayPension":{"type":"number","description":"Total sum of pension payments for accrued holiday pays.","format":"double"},"totalAccruedHolidayUnemployment":{"type":"number","description":"Total sum of unemployment insurance payments for accrued holiday pays.","format":"double"},"totalAccruedHolidayAccidentInsurance":{"type":"number","description":"Total accident insurance.","format":"double"},"totalAccruedHolidayGroupLifeInsurance":{"type":"number","description":"Total accident insurance.","format":"double"}},"additionalProperties":false,"description":"Calculation totals of accrued total holiday pay and related sidecosts."},"HolidayCode":{"enum":["undefined","permanent14Days","permanent35Hours","temporaryTimeOff","holidayCompensation","holidayCompensationIncluded","noHolidays","other","script"],"type":"string","description":"Defines how the holidays are handled for the worker"},"HolidayCompensationPlan":{"type":"object","properties":{"days":{"type":["null","number"],"description":"Number of days from which the compensation will be paid.","format":"double"},"bonusDaysCount":{"type":["null","number"],"description":"Number of Bonus days to be paid.","format":"double"},"holidayYear":{"type":["null","integer"],"description":"Holiday year to consume, if the period is outside the normal holiday pay period for the holiday year.","format":"int32"}},"additionalProperties":false,"description":"Plan for paying holiday compensation."},"HolidayDate":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"holiday":{"$ref":"#/components/schemas/Holiday"},"holidayGroup":{"$ref":"#/components/schemas/HolidayGroup"},"holidayGroups":{"type":"array","items":{"$ref":"#/components/schemas/HolidayGroup"},"readOnly":true},"localName":{"type":"string"},"name":{"type":"string"}}},"HolidayGroup":{"enum":["official","nonBanking","holiday"],"type":"string"},"HolidayPay":{"type":"object","properties":{"normalMonthlyPayDailySalary":{"type":"number","description":"Calculated price for a single holiday day based on the regular monthly salary.\r\nPlease note that this is applicable for accounting purposes (holiday pay debt) only.","format":"double","readOnly":true},"normalMonthlyPay":{"type":"number","description":"The picked monthly salary from the holiday year's calculations.\r\nPlease note that the calculator logic does not use this value but the NormalMonthlyPayManual or enterd monthly salary in the calculation.","format":"double","readOnly":true},"normalMonthlyPayManual":{"type":["null","number"],"description":"For NormalMonthlyPay the manually entered regular monthly salary.","format":"double"},"averageDailyPayDailySalary":{"type":"number","description":"For AverageDailyPay the calculated price for a single holiday day.","format":"double"},"averageDailyPay":{"type":"number","description":"For AverageDailyPay the calculated average daily pay.","format":"double"},"averageDailyPayManual":{"type":["null","number"],"description":"For AverageDailyPay the manually entered average daily pay.","format":"double"},"averageDailyPayBase":{"type":"number","description":"For AverageDailyPay the total pay received or due for time worked during the holiday credit year.","format":"double"},"averageDailyPayDays":{"type":"number","description":"For AverageDailyPay the number of days the employee was at work.\r\nThis number does not include the one eighth of the hours worked in excess of the  statutory regular daily working hours which is added to the number of days at work used in the calculation.","format":"double"},"averageDailyPayMultiplier":{"type":"number","description":"Multiplier used in the calculation of the average daily pay.","format":"double"},"averageHourlyPayDailySalary":{"type":"number","description":"For AverageHourlyPay the calculated price for a single holiday day.","format":"double"},"averageHourlyPay":{"type":"number","description":"For AverageHourlyPay the calculated average hourly pay.","format":"double"},"averageHourlyPayManual":{"type":["null","number"],"description":"For AverageHourlyPay the manually entered average hourly pay.","format":"double"},"averageHourlyPayBase":{"type":"number","description":"For AverageHourlyPay the total pay received or due for time worked during the holiday credit year.","format":"double"},"averageHourlyPayHours":{"type":"number","description":"For AverageHourlyPay the number of hours the employee was at work.","format":"double"},"averageHourlyPayMultiplier":{"type":"number","description":"Multiplier used in the calculation of the average hourly pay.","format":"double"},"percentageBasedPayDailySalary":{"type":"number","description":"For PercentageBasedPay the calculated price for a single holiday day.","format":"double"},"percentageBasedPay":{"type":"number","description":"For PercentageBasedPay the calculated total holiday pay.","format":"double"},"percentageBasedPayManual":{"type":["null","number"],"description":"For PercentageBasedPay the manually entered total holiday pay.","format":"double"},"percentageBasedPayBase":{"type":"number","description":"For PercentageBasedPay the total pay received or due for time worked during the holiday credit year.","format":"double"},"percentageBasedPayPercent":{"type":"number","description":"For PercentageBasedPay the percent for the calculation.","format":"double"},"otherPay":{"type":"number","description":"For OtherPay the manually entered pay, the price for a single holiday day.","format":"double"},"compensationPayDailySalary":{"type":"number","description":"For HolidayCompensation the calculated price for a single holiday day.","format":"double"},"compensationPay":{"type":"number","description":"For HolidayCompensation the calculated total holiday compensation pay.","format":"double"},"compensationPayManual":{"type":["null","number"],"description":"For HolidayCompensation the manually entered total holiday compensation pay.","format":"double"},"compensationPayBase":{"type":"number","description":"For HolidayCompensation the total pay received or due for time worked during the holiday credit year.","format":"double"},"scriptPay":{"type":"number","description":"For Script the result of the calculation by the script.","format":"double"},"accrual":{"type":"number","description":"Accrual used in the calculation of the holiday daily pay.","format":"double"}},"additionalProperties":false,"description":"Calculated holiday pay for the year."},"HolidayPayCalculation":{"enum":["undefined","normalMonthlyPay","averageDailyPay","percentageBasedPay","averageHourlyPay","holidayCompensation","otherPay","scriptPay"],"type":"string","description":"Rule for calculation holiday pay."},"HolidayPayCalculationReportData":{"type":"object","properties":{"holidayYear":{"description":"Holiday year for which the holiday pay is calculated.","$ref":"#/components/schemas/HolidayYear"},"holidayAccrualSettings":{"description":"Current settings for the accrual calculations.","$ref":"#/components/schemas/HolidayAccrualSettings"},"holidayPaySettings":{"description":"Applied settings for the holiday pay calculation.","$ref":"#/components/schemas/HolidayPaySettings"},"calculations":{"type":"array","items":{"$ref":"#/components/schemas/HolidayPayCalculationReportDataCalc"},"description":"Detailed calculation data with rows on which the holiday pay calculation is based."}},"additionalProperties":false,"description":"Report for containing all the result data and rules for the holiday pay calculation."},"HolidayPayCalculationReportDataCalc":{"type":"object","properties":{"calculationId":{"type":"string","description":"Calculation id."},"calculationTitle":{"type":"string","description":"Calculation title."},"salaryDate":{"type":["null","string"],"description":"Calculation salary date.","format":"date-time"},"workStartDate":{"type":["null","string"],"description":"Calculation work start date.","format":"date-time"},"workEndDate":{"type":["null","string"],"description":"Calculation work end date.","format":"date-time"},"workingDays":{"type":["null","number"],"description":"Working days in the calculation.\r\nThis is applicable only for HolidayPayCalculation.AverageDailyPay","format":"double"},"absenceDays":{"type":["null","number"],"description":"Absences days in the calculation.\r\nThis is applicable only for HolidayPayCalculation.AverageDailyPay.","format":"double"},"total":{"type":["null","number"],"description":"Total salary in the calculation which is calculated into holiday pay.","format":"double"},"hours":{"type":["null","number"],"description":"Total hours in the calculation which is calculated into holiday pay.\r\nThis is applicable only for HolidayPayCalculation.AverageHourlyPay","format":"double"},"overtimeHours":{"type":["null","number"],"description":"Total over time hours in the calculation which is calculated into holiday pay.\r\nThis is applicable only for HolidayPayCalculation.AverageDailyPay.\"/&gt;","format":"double"},"holidayYear":{"type":"integer","description":"Holiday year for pays.","format":"int32"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/HolidayPayCalculationReportDataCalcRow"},"description":"Detailed row data on which the holiday pay calculation is based."}},"additionalProperties":false,"description":"Detailed calculation data with rows on which the holiday pay calculation is based."},"HolidayPayCalculationReportDataCalcRow":{"type":"object","properties":{"irRow":{"description":"The row of the calculation.","$ref":"#/components/schemas/IrRow"},"salaryType":{"type":"string","description":"Matching RowType, Type or IncomeType which accumulates salary."},"workingTimeType":{"type":"string","description":"Matching RowType, Type or IncomeType which accumulates working time.\r\nThis is applicable only for HolidayPayCalculation.AverageHourlyPay"},"overtimeType":{"type":"string","description":"Matching RowType, Type or IncomeType which accumulates overtime.\r\nThis is applicable only for HolidayPayCalculation.AverageDailyPay"},"total":{"type":["null","number"],"description":"Total salary which is calculated into holiday pay.","format":"double"},"hours":{"type":["null","number"],"description":"Total hours which is calculated into holiday pay.\r\nThis is applicable only for HolidayPayCalculation.AverageHourlyPay","format":"double"},"overtimeHours":{"type":["null","number"],"description":"Total over time hours which is calculated into holiday pay.\r\nThis is applicable only for HolidayPayCalculation.AverageDailyPay.\"/&gt;","format":"double"},"holidayYear":{"type":"integer","description":"Holiday year for pays.","format":"int32"}},"additionalProperties":false,"description":"Detailed row data on which the holiday pay calculation is based."},"HolidayPaySettings":{"type":"object","properties":{"holidayPayCalculation":{"description":"Defines how the holiday pay is calculated.","$ref":"#/components/schemas/HolidayPayCalculation"},"cbaCode":{"type":["null","integer"],"description":"Applicable collective agreement","format":"int32"},"employeeGroup":{"type":"string","description":"Employee group."},"disabled":{"type":"boolean","description":"Flag for disabling the setting."},"startYear":{"type":["null","integer"],"description":"If specified, defines the start holiday year for the settings.\r\nIf in the future, the settings is inactive. Null (default) means the settings is valid indefinetely from the past.","format":"int32"},"endYear":{"type":["null","integer"],"description":"If specified, defines the end holiday year for the settings. \r\nThe year is inclusive meaning.\r\nIf in the past, the the settings is inactive. Null (default) means the settings is valid indefinetely to future.","format":"int32"},"multipliers":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Possible multipliers for the holiday pay calculation.\r\nDefault is  null, which means that a default set of multipliers is used."},"workingTimeTypes":{"type":"array","items":{"type":"string"},"description":"RowTypes, WageTypes or IncomeTypes that are used in the holiday pay calculation and which accumulate working time.\r\nDefault is  null, which means that a default set of types is used.\r\nThis is applicable only for HolidayPayCalculation.AverageHourlyPay"},"overtimeTypes":{"type":"array","items":{"type":"string"},"description":"RowTypes, WageTypes or IncomeTypes that are used in the holiday pay calculation and which accumulate overtime.\r\nDefault is  null, which means that a default set of types is used.\r\nThis is applicable only for HolidayPayCalculation.AverageDailyPay"},"salaryTypes":{"type":"array","items":{"type":"string"},"description":"RowTypes, WageTypes or IncomeTypes that are used in the holiday pay calculation and which accumulate salary.\r\nDefault is  null, which means that a default set of types is used."},"script":{"type":"string","description":"Script for the holiday pay calculation. Used if HolidayPayCalculation HolidayPaySettings.HolidayPayCalculation is HolidayPayCalculation.ScriptPay."}},"additionalProperties":false,"description":"Settings for the holiday pay calculations."},"HolidaySettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"holidayPaySettings":{"type":"array","items":{"$ref":"#/components/schemas/HolidayPaySettings"},"description":"Settings for holiday pay calculations.\r\nThe default is null and the default settings are used."},"holidayAccrualSettings":{"type":"array","items":{"$ref":"#/components/schemas/HolidayAccrualSettings"},"description":"Settings for the accrual calculations.\r\nThe default is null and the default settings are used."}},"additionalProperties":false,"description":"Settings related to holiday pay and accrual calculations."},"HolidaySpecification":{"type":"object","properties":{"code":{"description":"Defines how the holidays are handled for the worker.","$ref":"#/components/schemas/HolidayCode"},"holidayPayCalculation":{"description":"Defines how the holiday pay is calculated.","$ref":"#/components/schemas/HolidayPayCalculation"},"accrualFixed":{"type":"number","description":"Defines the number of holidays that the worker is entitled per month worked.\r\nIf the value is set to 0 (default), the number is 2 for first year and 2,5 thereafter as defined in the law.\r\nTo actually se the daysPerMonth to zero, use code value other than Permanent14Days or Permanent35Hours.","format":"double"},"compensation":{"type":"number","description":"For HolidayPayCalculation.HolidayCompensation the compensation percent.\r\nHoliday compensation as percent of salary (11.5% is 0.115)","format":"double"},"holidayPayPercent":{"type":"number","description":"For HolidayPayCalculation.PercentageBasedPay the percent.\r\nHoliday pay as percent of salary (11.5% is 0.115)","format":"double"},"bonusMethod":{"description":"Method for paying holiday bonus in this salary calculation.","$ref":"#/components/schemas/HolidayBonusPaymentMethod"},"bonus":{"type":"number","description":"Holiday bonus for the worker (lomaraha, lomaltapaluuraha).\r\nTypically 0.5 for 50%.","format":"double"},"dailyHours":{"type":["null","number"],"description":"Number of hours per day defined in the employment contract.\r\nDefaults to daily hours defined in the employment details, or\r\n8.0 for hourly workers and 7.5 for monthly workers.","format":"double"},"monthlyHolidayDivider":{"type":["null","number"],"description":"Divider for calculating a holiday price for a single day from monthly salary.\r\nDefaults to 25.","format":"double"}},"additionalProperties":false,"description":"Specifies how the holidays are handled for this Worker."},"HolidaySpecificationForYear":{"type":"object","properties":{"wageBasis":{"description":"Wage basis for a Holiday Year.\r\nWhen this is changed, you need to make a rerun to the previous calculations in the holiday year.\r\nNOTE: This is not in HolidaySpecification because, the same value is stored in Employment relation.","$ref":"#/components/schemas/WageBasis"},"employmentPeriod":{"description":"Employment period for the purposes of holiday calculation (annual leave accrual).\r\nWhen this is changed, you need to make a rerun to the previous calculations in the holiday year.","$ref":"#/components/schemas/DateRange"},"code":{"description":"Defines how the holidays are handled for the worker.","$ref":"#/components/schemas/HolidayCode"},"holidayPayCalculation":{"description":"Defines how the holiday pay is calculated.","$ref":"#/components/schemas/HolidayPayCalculation"},"accrualFixed":{"type":"number","description":"Defines the number of holidays that the worker is entitled per month worked.\r\nIf the value is set to 0 (default), the number is 2 for first year and 2,5 thereafter as defined in the law.\r\nTo actually se the daysPerMonth to zero, use code value other than Permanent14Days or Permanent35Hours.","format":"double"},"compensation":{"type":"number","description":"For HolidayPayCalculation.HolidayCompensation the compensation percent.\r\nHoliday compensation as percent of salary (11.5% is 0.115)","format":"double"},"holidayPayPercent":{"type":"number","description":"For HolidayPayCalculation.PercentageBasedPay the percent.\r\nHoliday pay as percent of salary (11.5% is 0.115)","format":"double"},"bonusMethod":{"description":"Method for paying holiday bonus in this salary calculation.","$ref":"#/components/schemas/HolidayBonusPaymentMethod"},"bonus":{"type":"number","description":"Holiday bonus for the worker (lomaraha, lomaltapaluuraha).\r\nTypically 0.5 for 50%.","format":"double"},"dailyHours":{"type":["null","number"],"description":"Number of hours per day defined in the employment contract.\r\nDefaults to daily hours defined in the employment details, or\r\n8.0 for hourly workers and 7.5 for monthly workers.","format":"double"},"monthlyHolidayDivider":{"type":["null","number"],"description":"Divider for calculating a holiday price for a single day from monthly salary.\r\nDefaults to 25.","format":"double"}},"additionalProperties":false,"description":"Extends the Holiday specification with the properties of employment relation that are required for a specific year."},"HolidayYear":{"required":["year","employmentId"],"type":"object","properties":{"year":{"type":"integer","description":"Year as integer. This value is required when inserting and cannot be edited later. \r\nPeriod will be set accordingly, or adjusted in case it is set below.","format":"int32"},"workerId":{"type":"string","description":"Salaxy ID of the worker. This value is required when inserting and cannot be edited later.\r\nWorkerSnapshot is automatically updated upon save."},"employmentId":{"type":"string","description":"The employment relation for the worker whose holidays are managed."},"period":{"description":"The holiday period for the year: Should always be 2.5.[Year]-30.4.[Year+1]","$ref":"#/components/schemas/DateRange"},"spec":{"description":"Specifies how the holidays are handled.\r\nIf the Spec.Code is Undefined in Save, the contents is fetched from the current employment relation.","$ref":"#/components/schemas/HolidaySpecificationForYear"},"holidayPay":{"description":"Calculated Holiday pay for the year.","$ref":"#/components/schemas/HolidayPay"},"accrual":{"description":"Accrual of holidays (lomakirjanpito).","$ref":"#/components/schemas/HolidayAccrual"},"leaves":{"description":"Payments related to Annual Leaves (holidays).","$ref":"#/components/schemas/AnnualLeaves"},"workerSnapshot":{"description":"Basic information for the Worker. \r\nAutomatically updated upon save based on WorkerId.\r\nMainly for the listings etc.","$ref":"#/components/schemas/Avatar"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Holiday year is in Finland from April to end of march.\r\nThis is the time from which the holidays for the following summer and year are determined."},"HolidayYearData":{"type":"object","properties":{"year":{"type":"integer","description":"Holiday year.","format":"int32"},"employmentId":{"type":"string","description":"Employment id."}},"additionalProperties":false,"description":"Holiday year specific business data for index."},"HolidayYearListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/HolidayYearData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of holiday years  in the user interface."},"HostString":{"type":"object","properties":{"value":{"type":["null","string"],"readOnly":true},"hasValue":{"type":"boolean","readOnly":true},"host":{"type":"string","readOnly":true},"port":{"type":["null","integer"],"format":"int32","readOnly":true}},"additionalProperties":false},"HourlySalaryWithWorkingTimeCompensationUsecase":{"type":"object","properties":{"compensationRows":{"type":"array","items":{"$ref":"#/components/schemas/WorkingTimeCompensationRow"}},"pricing":{"enum":["undefined","percent","fixed"],"type":"string"},"kind":{"enum":["undefined","emergencyWorkCompensation","eveningWorkCompensation","eveningShiftAllowance","saturdayPay","extraWorkPremium","otherCompensation","waitingTimeCompensation","sundayWorkCompensation","standByCompensation","weeklyRestCompensation","overtimeCompensation","nightWorkAllowance","nightShiftCompensation"],"type":"string"}},"additionalProperties":false},"HouseholdYear":{"type":"object","properties":{"year":{"type":"integer","description":"Year for the salaries","format":"int32"},"processingStatus":{"description":"Status of the household deduction process.","$ref":"#/components/schemas/HouseholdYearProcessingStatus"},"status":{"description":"Status of user feedback.","$ref":"#/components/schemas/HouseholdYearStatus"},"userFeedbackText":{"type":"string","description":"Free text from the account holder to Salaxy backoffice."},"userFeedbackTime":{"type":["null","string"],"description":"Time when the feedback was given.","format":"date-time"},"insuranceAmount":{"type":["null","number"],"description":"Amount of accident insurance paid during this year as reported by the user\r\nThis is relevant for households for Household deduction: \r\nThis amount can be deducted from the yearly salaries and needs to be reported to tax authorities.","format":"double"},"spouseName":{"type":"string","description":"Name of the spouse with who the household deduction is split"},"spousePersonalId":{"type":"string","description":"Finnish Personal ID of the spouse with who the household deduction is split"},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Household yearly data."},"HouseholdYearData":{"type":"object","properties":{"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."}},"additionalProperties":false,"description":"Household year specific business data for index."},"HouseholdYearListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/HouseholdYearStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/HouseholdYearData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents household yearly deduction data."},"HouseholdYearProcessingStatus":{"enum":["open","closed","printed"],"type":"string","description":"Status of the yearly processing of the household deductions."},"HouseholdYearStatus":{"enum":["undefined","ok","okWithModifications","willHandleMyself"],"type":"string","description":"Status of user feedback for the household year deduction."},"HttpContext":{"type":"object","properties":{"features":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairOfTypeAndObject"},"readOnly":true},"request":{"$ref":"#/components/schemas/HttpRequest"},"response":{"$ref":"#/components/schemas/HttpResponse"},"connection":{"$ref":"#/components/schemas/ConnectionInfo"},"webSockets":{"$ref":"#/components/schemas/WebSocketManager"},"user":{"$ref":"#/components/schemas/ClaimsPrincipal"},"items":{"type":"object","additionalProperties":false},"requestServices":{"$ref":"#/components/schemas/IServiceProvider"},"requestAborted":{"$ref":"#/components/schemas/CancellationToken"},"traceIdentifier":{"type":"string"},"session":{"$ref":"#/components/schemas/ISession"}},"additionalProperties":false,"readOnly":true},"HttpRequest":{"type":"object","properties":{"httpContext":{"$ref":"#/components/schemas/HttpContext"},"method":{"type":"string"},"scheme":{"type":"string"},"isHttps":{"type":"boolean"},"host":{"$ref":"#/components/schemas/HostString"},"pathBase":{"$ref":"#/components/schemas/PathString"},"path":{"$ref":"#/components/schemas/PathString"},"queryString":{"$ref":"#/components/schemas/QueryString"},"query":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairOfstringAndStringValues"}},"protocol":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairOfstringAndstring"}},"contentLength":{"type":["null","integer"],"format":"int64"},"contentType":{"type":["null","string"]},"body":{"$ref":"#/components/schemas/Stream"},"bodyReader":{"$ref":"#/components/schemas/PipeReader"},"hasFormContentType":{"type":"boolean","readOnly":true},"form":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairOfstringAndStringValues"}},"routeValues":{"type":"object","additionalProperties":false}},"additionalProperties":false,"readOnly":true},"HttpResponse":{"type":"object","properties":{"httpContext":{"$ref":"#/components/schemas/HttpContext"},"statusCode":{"type":"integer","format":"int32"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"body":{"$ref":"#/components/schemas/Stream"},"bodyWriter":{"$ref":"#/components/schemas/PipeWriter"},"contentLength":{"type":["null","integer"],"format":"int64"},"contentType":{"type":["null","string"]},"cookies":{"$ref":"#/components/schemas/IResponseCookies"},"hasStarted":{"type":"boolean","readOnly":true}},"additionalProperties":false,"readOnly":true},"IApiListItem":{"type":"object","properties":{"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date-time"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date-time"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date-time"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed."},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"id":{"type":["null","string"],"description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated","format":"date-time"},"owner":{"maxLength":64,"type":["null","string"],"description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":["null","string"],"description":"Pricing partner information."}},"additionalProperties":false,"description":"Interface for the line item for search and listing results."},"IComputeQueryValidator":{"type":"object","additionalProperties":false},"ICountQueryValidator":{"type":"object","additionalProperties":false},"Identity":{"type":"object","properties":{"officialId":{"type":"string","description":"This is an official identifier of the actor:\r\nFinnish HETU (Soc. sec. number) for a Person or Y-tunnus (Company ID for a company or association)"},"officialName":{"type":"string","description":"This is an official name of the actor.\r\nIt originates from the YTJ or Bank authentication."},"firstName":{"type":"string","description":"First name OR company name"},"lastName":{"type":"string","description":"Last name\r\nAvailable only to real persons (as opposed to companies)."},"contract":{"description":"The latest authorization contract that is the bases for this Identity","$ref":"#/components/schemas/AuthorizationContract"},"ibanNumber":{"type":"string","description":"Tha bank account number of the Worker - in Iban format."},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"isPep":{"type":"boolean","description":"Indicates whether the principal user of the customer is a politically exposed person or not."},"primaryContact":{"description":"Mainly for company accounts, but in special cases for Persons,\r\nthis is the main Contact party and usually the signer for the account.","$ref":"#/components/schemas/ContractParty"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"List of roles which this account is member of."},"permissions":{"type":"array","items":{"type":"string"},"description":"Permissions list for the account.\r\nPermissions are typically expressed as resource:action -combination."},"identityUpdatedAt":{"type":["null","string"],"description":"Latest contact, bank account or name update.","format":"date-time"},"kycUpdatedAt":{"type":["null","string"],"description":"Latest KYC update, if done.","format":"date-time"}},"additionalProperties":false,"description":"Identity is the official identity of an actor.\r\nThis part is not freely editable as changing it requires signature or some other means.\r\nIdentity is also often fetched from external sources such as govenment registries."},"IEdmDirectValueAnnotationsManager":{"type":"object","additionalProperties":false,"readOnly":true},"IEdmEntityContainer":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/IEdmEntityContainerElement"},"readOnly":true},"schemaElementKind":{"$ref":"#/components/schemas/EdmSchemaElementKind"},"namespace":{"type":["null","string"]},"name":{"type":["null","string"]}},"additionalProperties":false,"readOnly":true},"IEdmEntityContainerElement":{"type":"object","properties":{"containerElementKind":{"$ref":"#/components/schemas/EdmContainerElementKind"},"container":{"$ref":"#/components/schemas/IEdmEntityContainer"},"name":{"type":["null","string"]}},"additionalProperties":false},"IEdmExpression":{"type":"object","properties":{"expressionKind":{"$ref":"#/components/schemas/EdmExpressionKind"}},"additionalProperties":false,"readOnly":true},"IEdmModel":{"type":"object","properties":{"schemaElements":{"type":"array","items":{"$ref":"#/components/schemas/IEdmSchemaElement"},"readOnly":true},"vocabularyAnnotations":{"type":"array","items":{"$ref":"#/components/schemas/IEdmVocabularyAnnotation"},"readOnly":true},"referencedModels":{"type":"array","items":{"$ref":"#/components/schemas/IEdmModel"},"readOnly":true},"declaredNamespaces":{"type":"array","items":{"type":"string"},"readOnly":true},"directValueAnnotationsManager":{"$ref":"#/components/schemas/IEdmDirectValueAnnotationsManager"},"entityContainer":{"$ref":"#/components/schemas/IEdmEntityContainer"}},"additionalProperties":false,"readOnly":true},"IEdmNavigationProperty":{"type":"object","properties":{"partner":{"$ref":"#/components/schemas/IEdmNavigationProperty"},"onDelete":{"$ref":"#/components/schemas/EdmOnDeleteAction"},"containsTarget":{"type":"boolean","readOnly":true},"referentialConstraint":{"$ref":"#/components/schemas/IEdmReferentialConstraint"},"propertyKind":{"$ref":"#/components/schemas/EdmPropertyKind"},"type":{"$ref":"#/components/schemas/IEdmTypeReference"},"declaringType":{"$ref":"#/components/schemas/IEdmStructuredType"},"name":{"type":["null","string"]}},"additionalProperties":false,"readOnly":true},"IEdmNavigationPropertyBinding":{"type":"object","properties":{"navigationProperty":{"$ref":"#/components/schemas/IEdmNavigationProperty"},"target":{"$ref":"#/components/schemas/IEdmNavigationSource"},"path":{"$ref":"#/components/schemas/IEdmPathExpression"}},"additionalProperties":false},"IEdmNavigationSource":{"type":"object","properties":{"navigationPropertyBindings":{"type":"array","items":{"$ref":"#/components/schemas/IEdmNavigationPropertyBinding"},"readOnly":true},"path":{"$ref":"#/components/schemas/IEdmPathExpression"},"type":{"$ref":"#/components/schemas/IEdmType"},"name":{"type":["null","string"]}},"additionalProperties":false,"readOnly":true},"IEdmPathExpression":{"type":"object","properties":{"pathSegments":{"type":"array","items":{"type":"string"},"readOnly":true},"path":{"type":"string","readOnly":true},"expressionKind":{"$ref":"#/components/schemas/EdmExpressionKind"}},"additionalProperties":false,"readOnly":true},"IEdmReferentialConstraint":{"type":"object","properties":{"propertyPairs":{"type":"array","items":{"$ref":"#/components/schemas/EdmReferentialConstraintPropertyPair"},"readOnly":true}},"additionalProperties":false,"readOnly":true},"IEdmSchemaElement":{"type":"object","properties":{"schemaElementKind":{"$ref":"#/components/schemas/EdmSchemaElementKind"},"namespace":{"type":"string","readOnly":true},"name":{"type":["null","string"]}},"additionalProperties":false},"IEdmStructuralProperty":{"type":"object","properties":{"defaultValueString":{"type":"string","readOnly":true},"propertyKind":{"$ref":"#/components/schemas/EdmPropertyKind"},"type":{"$ref":"#/components/schemas/IEdmTypeReference"},"declaringType":{"$ref":"#/components/schemas/IEdmStructuredType"},"name":{"type":["null","string"]}},"additionalProperties":false,"readOnly":true},"IEdmStructuredType":{"type":"object","properties":{"isAbstract":{"type":"boolean","readOnly":true},"isOpen":{"type":"boolean","readOnly":true},"baseType":{"$ref":"#/components/schemas/IEdmStructuredType"},"declaredProperties":{"type":"array","items":{"type":"string"},"readOnly":true},"typeKind":{"$ref":"#/components/schemas/EdmTypeKind"}},"additionalProperties":false},"IEdmTerm":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IEdmTypeReference"},"appliesTo":{"type":"string","readOnly":true},"defaultValue":{"type":"string","readOnly":true},"schemaElementKind":{"$ref":"#/components/schemas/EdmSchemaElementKind"},"namespace":{"type":["null","string"]},"name":{"type":["null","string"]}},"additionalProperties":false,"readOnly":true},"IEdmType":{"type":"object","properties":{"typeKind":{"$ref":"#/components/schemas/EdmTypeKind"}},"additionalProperties":false,"readOnly":true},"IEdmTypeReference":{"type":"object","properties":{"isNullable":{"type":"boolean","readOnly":true},"definition":{"$ref":"#/components/schemas/IEdmType"}},"additionalProperties":false,"readOnly":true},"IEdmVocabularyAnnotatable":{"type":"object","additionalProperties":false,"readOnly":true},"IEdmVocabularyAnnotation":{"type":"object","properties":{"qualifier":{"type":"string","readOnly":true},"term":{"$ref":"#/components/schemas/IEdmTerm"},"target":{"$ref":"#/components/schemas/IEdmVocabularyAnnotatable"},"value":{"$ref":"#/components/schemas/IEdmExpression"}},"additionalProperties":false},"IEmployerResponsibilities":{"type":"object","properties":{"employerGroups":{"description":"Employer groups that are set on Example calculations.\r\nThese will be replaced by properties from Worker / Employer when these persons are set.","$ref":"#/components/schemas/EmployerGroups"},"noPensionPayment":{"type":"boolean","description":"Pension is not paid if the salary to this Worker is less than a certain amount in a month (about 60€)\r\nor worker is less than 17 or more than 64 years old.","readOnly":true},"noSocialSecurity":{"type":"boolean","description":"If worker is less than 16 or more than 67, social secuiry payment is not paid","readOnly":true},"noTvr":{"type":"boolean","description":"If Worker is less than 17 or more than 64, TVR is not paid.\r\nAlso if the Employer has no accident insurance.","readOnly":true},"pensionCompany":{"description":"The name of the Pension company because this affects the Pension percentage used in the calculation (only in contract situation).\r\nIt also needs to be shown in the reports.","$ref":"#/components/schemas/PensionCompany"},"pensionDiscountPercent":{"type":"number","description":"Pension discount percent.","format":"percent","readOnly":true},"pensionPercent":{"type":["null","number"],"description":"Customer specific pension percent.","format":"percent","readOnly":true},"insuranceCompany":{"description":"Company for the current insurance","$ref":"#/components/schemas/InsuranceCompany"},"insurancePercent":{"type":"number","description":"Percent for calculating the estimate for the accident insurance amount to pay.","format":"percent","readOnly":true},"groupLifeInsurancePercent":{"type":"number","description":"Percent for calculating the estimate for the group life insurance amount to pay.","format":"percent","readOnly":true},"insuranceContractNumber":{"type":"string","description":"Accident insurance contract number.","readOnly":true},"pensionOldAgePayment":{"type":"boolean","description":"If the Worker is from 53 to 62 years old, more of the Pension payment \r\nis deducted from the Worker side of the salary (less for the Employer).\r\nNOTE: People from 63 to 67 years pay the same amount as 17-52 years old.","readOnly":true},"pensionRegularEmployer":{"type":"boolean","description":"The employer should have a Pension contract (not a temporary employer).\r\nIt does not necessarily mean that the user has a contract yet.\r\nNOTE: At the moment, this is not used for calculation - only in the Side costs visualizer tool.","readOnly":true},"isPensionMonthlyContract":{"type":"boolean","description":"If true, the employer has a Pension contract and makes the payments \r\nin a monthly schedule which means that Pension interest is calculated for the 20th of the next month.\r\nCurrently, this is only enabled to Etera - other companies will follow.","readOnly":true},"unemploymentSelfPayment":{"type":"boolean","description":"If true, the employer pays the Unemployment insurance directly to TVR.\r\nAs of writing, this is true for all companies and with calculations starting 1.8.2018,\r\nfalse for households or calculations before the date.","readOnly":true},"calculationPaymentDate":{"type":"string","description":"The assumed salary payment date from the worker perspective.\r\nThe system calculates the nearest possible salary date if no any salary date has been given by the\r\nemployer. If given, the system confirms the given date.\r\nThis date affects the yearly percents used in the salary calculation.","format":"date-time","readOnly":true},"pensionAgeRange":{"description":"The age range that is used in the business logic that determines the employer responsibilities.\r\nThis property replaces the EmployerGroups.AgeRange that was previous get/set. \r\nThis is based on WorkerDateOfBirth and CalculationPaymentDate.","$ref":"#/components/schemas/AgeRange"},"workerDateOfBirth":{"type":["null","string"],"description":"Date of birth for the Worker - this affects the side costs. \r\nPlease also set the DateOfBirthAccuracy, if you set this property.\r\nIf SocialSecurityNumber is set, it will override any value set here.","format":"date","readOnly":true},"workerDateOfBirthAccuracy":{"description":"Accuracy of the date of birth\r\nIf SocialSecurityNumber is set, it will override any value set here.","$ref":"#/components/schemas/DateOfBirthAccuracy"},"pensionCalculation":{"description":"Pension calculation type.","$ref":"#/components/schemas/PensionCalculation"},"pensionRule":{"description":"Rules (e.g. effect of monthly lower limit) for pension calculation.","$ref":"#/components/schemas/PensionRule"},"employmentType":{"description":"Type of the employment relation","$ref":"#/components/schemas/EmploymentRelationType"},"employmentTaxcard":{"description":"Taxcard type from the employment point of view.","$ref":"#/components/schemas/EmploymentRelationTaxcard"},"salaryPaymentMethod":{"description":"Worker's preferred salary payment method: bank account, external etc.","$ref":"#/components/schemas/EmploymentRelationSalaryPaymentMethod"},"irIncomeEarnerTypes":{"type":"array","items":{"$ref":"#/components/schemas/IncomeEarnerType"},"description":"Type of additional income earner data by National Incomer Register classification . If several types apply, all of them should be selected."},"subOrgCode":{"type":"string","description":"Sub organization code for the Incomes Registry.","readOnly":true},"employmentRegCode":{"type":"string","description":"Employment registration code for Incomes Registry."},"taxAndSocialSecuritySelfPayment":{"type":"boolean","description":"Tax and social security payments are paid directly by the Employer - not by Palkkaus.fi","readOnly":true},"workerSelfPayment":{"type":"boolean","description":"Worker salary and expense payments are paid directly by the Employer - not by Palkkaus.fi","readOnly":true},"pensionSelfPayment":{"type":"boolean","description":"Pension payments are paid directly by the Employer - not by Palkkaus.fi","readOnly":true},"pensionContractNumber":{"type":"string","description":"Pension insurance contract number.","readOnly":true},"unemploymentPayrollLimitStatus":{"description":"Status for indicating whether the total amount of paid salaries exceeds the thresold for higher unemployment insurance percent.","$ref":"#/components/schemas/UnemploymentPayrollLimitStatus"},"salarySlipDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/WorkerSalarySlipDeliveryMethod"},"description":"Options for the delivery of the payslip to the worker.","readOnly":true}},"additionalProperties":false,"description":"Parameters that affect the calculation. \r\nEmployerResponsibilities is historical name - currentlty to object holds also other properties \r\nthat are not well described as responsibilities.\r\nThese based on the EmployerGroups selection or properties of the Employer and Worker snapshots as well as this Calculation"},"IFilterQueryValidator":{"type":"object","additionalProperties":false},"IFormFile":{"type":"string","format":"binary"},"IIdentity":{"type":"object","properties":{"name":{"type":["null","string"],"readOnly":true},"authenticationType":{"type":["null","string"],"readOnly":true},"isAuthenticated":{"type":"boolean","readOnly":true}},"additionalProperties":false,"readOnly":true},"IncomeEarnerType":{"enum":["employedByStateEmploymentFund","jointOwnerWithPayer","partialOwner","keyEmployee","leasedEmployeeLivingAbroad","personWorkingInFrontierDistrict","personWorkingAbroad","athlete","performingArtist","restrictedPeriodInFinland","netOfTaxContract","organization","personWorkingOnAlandFerry","entrepreneurOrFarmerNoPensionRequired","dimplomaticMission","eppo","lightEntrepreneur"],"type":"string"},"IncomeLogDiff":{"enum":["default","new","changed","removed"],"type":"string","description":"When loading calculations from the database (in taxcard Save and FindBy with diff), describes the differences in the entry."},"IncomesRegisterSettings":{"type":"object","properties":{"taxReferenceNumber":{"type":"string","description":"The reference number for the tax authorities"},"irReporting":{"description":"Defines how the reporting is done for Incomes registry (Tulorekisteri).","$ref":"#/components/schemas/TaxReportHandling"},"irDelivery":{"description":"IR report delivery settings.","$ref":"#/components/schemas/IrDelivery"}},"additionalProperties":false},"InsuranceCompany":{"enum":["none","lähiTapiola","pohjola","if","fennia","aVakuutus","aktia","pohjantähti","tryg","ålands","turva","redarnas","folksam","alandia","protector","other","pending"],"type":"string","readOnly":true},"InsuranceContract":{"type":"object","properties":{"isPartnerInsurance":{"type":"boolean","description":"If set to true, the insurance is set to a partner insurance."},"company":{"description":"Company for the current insurance","$ref":"#/components/schemas/InsuranceCompany"},"contractNumber":{"type":"string","description":"The accident insurance contract number that should be validated accordingly.","format":"insurance-contract-number"},"insurancePercent":{"type":"number","description":"Percent for calculating the estimate for the accident insurance amount to pay.","format":"percent"},"groupLifeInsurancePercent":{"type":"number","description":"Percent for calculating the estimate for the group life insurance amount to pay.","format":"percent"},"id":{"type":"string","description":"Unique identifier (guid) for the contract.\r\nThe value is automaticallyh added on the server side: Any input is ignored/invalid. Set as null for new contracts."},"status":{"description":"Status of the contract","$ref":"#/components/schemas/SettingsStatus"},"startDate":{"type":["null","string"],"description":"If specified, defines the start date for the contract.\r\nIf in the future, the the contract is inactive. Null (default) means the contract is valid indefinetely from the past.","format":"date"},"endDate":{"type":["null","string"],"description":"If specified, defines the end date for the contract. \r\nDate is inclusive meaning that if EndDate is 31.12., contract is valid until end-of-year: Valid on 31.12. and invalid 1.1.\r\nIf in the past, the the contract is inactive. Null (default) means the contract is valid indefinetely to future.","format":"date"}},"additionalProperties":false,"description":"Represents an insurance contract for employer or information that the employer knowingly does not have an \r\ninsurance contract. The latter is legal when only a very small amount of salaries is paid."},"InsuranceProduct":{"type":"object","properties":{"status":{"type":"string","readOnly":true},"isPartnerInsurance":{"type":"boolean","description":"If set to true, the insurance is set to a partner insurance."},"isInsuranceContractDone":{"type":"boolean","description":"If true, the user indicates that he/she has already made an insurance contract.\r\nShould also fill in the InsuranceCompany and InsuranceContractNumber"},"insuranceCompany":{"description":"Company for the current insurance","$ref":"#/components/schemas/InsuranceCompany"},"insuranceContractNumber":{"type":"string","description":"Contract number for the current insurance."},"enabled":{"type":"boolean","description":"Enabled property set automatically by IsPartnerInsurance."},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"Employer insurance. Currently, this is the mandatory employer insurance only."},"IntegrationInSession":{"type":"object","properties":{"serverUrl":{"type":"string","description":"URL to custom staging / integration server.\r\nUsed in running custom usecases and other custom integrations (currently imports)."}},"additionalProperties":false,"description":"Settings related to Integrations that should be immediately available with session without separate load."},"InternationalIdentifier":{"enum":["undefined","taxIdentificationNumber","foreignPersonalIdentificationNumber","other"],"type":"string","description":"Income earner identifier for international purposes / non-resident taxpayer..\r\nBy default, this is currently a TIN (Tax Identification Number)"},"InternationalSocialSecurityException":{"enum":["notSubjectToEarningsRelatedPensionInsurance","notSubjectToAccidentAndOccupationalDiseaseInsurance","notSubjectToUnemploymentInsurance","notSubjectToHealthInsurance","voluntaryEarningsRelatedPensionInsurance","noObligationToHealthInsuranceDailyAllowanceContribution"],"type":"string","description":"Type of exception to insurance (ExceptionCode)"},"InternationalSocialSecurityType":{"enum":["default","foreign","mixed"],"type":"string","description":"User friendly types of social security for international situations."},"Invoice":{"type":"object","properties":{"group":{"type":"string","description":"Group indicator.\r\nInvoices with the same group id can be paid in the same batch."},"header":{"description":"Invoice header details.","$ref":"#/components/schemas/InvoiceHeader"},"recipient":{"description":"Invoice recipient details.","$ref":"#/components/schemas/InvoiceRecipient"},"payer":{"description":"Invoice payer details.","$ref":"#/components/schemas/InvoicePayer"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceRow"},"description":"List of invoice rows."},"content":{"type":"string","description":"Invoice data in XML or json format."},"pdf":{"type":"string","description":"Invoice in pdf format.","format":"byte"},"workflowData":{"description":"The workflow data for manual editing and approval purposes.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Invoice for the pending payment in the business system.\r\nFor example, a salary gross payment created for the salary calculation and delivered as an e-invoice to the employer.\r\nFor example, a salary net payment, created for the employer which is self paying the net payment to the worker."},"InvoiceData":{"type":"object","properties":{"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"channel":{"description":"Channel that is used for paying the invoice.","$ref":"#/components/schemas/PaymentChannel"},"date":{"type":"string","description":"Invoice Date.","format":"date"},"dueDate":{"type":"string","description":"Due date for the invoice.","format":"date"},"periodStart":{"type":"string","description":"Start of period for the Invoice: Work period, month / quarter of sidecosts etc.","format":"date"},"periodEnd":{"type":["null","string"],"description":"End of period for the Invoice: Work period, month / quarter of sidecosts etc.","format":"date"},"totalPaid":{"type":["null","number"],"description":"Already paid amount of the invoice.\r\nThis is applicable only for some periodic invoices, like tax invoices, which may be paid in parts.","format":"double"},"paidBusinessObjectsCount":{"type":["null","integer"],"description":"The count of paid business objects (typically calculations) which the invoices is based on.\r\nThis is applicable only for some periodic invoices, like tax invoices, which may be paid in parts.","format":"int32"},"statusAt":{"type":["null","string"],"description":"The time when the object status was last updated.","format":"date-time"},"payrollId":{"type":"string","description":"The payroll ID of the calculation this invoice is based on (applicable only for Net and Foreclosure)."},"payrollTitle":{"type":"string","description":"The payroll Title of the calculation this invoice is based on (applicable only for Net and Foreclosure)."},"externalStatusAt":{"type":["null","string"],"description":"Invoice/payment status in the external system.","format":"date-time"},"externalStatus":{"type":"string","description":"External status of the invoice in the external system."},"paymentMessageId":{"type":"string","description":"Id of the payment message (maksuaineisto) that holds the invoice, or empty if it is in none. The search index\r\ncopy lags the write; invoices indexed before RND-4787 have no value."}},"additionalProperties":false,"description":"Invoice specific business data for index."},"InvoiceDateKind":{"enum":["invoiceDate","dueDate","logicalDate"],"type":"string","description":"Defines the date kind for the invoice."},"InvoiceHeader":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"Payment reference (e.g. RF0710010831).\r\nPlease note that in salary payment scenarios, this is not necessarily unique."},"date":{"type":"string","description":"Invoice Date.","format":"date"},"dueDate":{"type":"string","description":"Due date for the invoice.","format":"date"},"logicalDate":{"type":"string","description":"The date for the actual period for which this invoice is done.\r\nFor salaries, this is salary date, for monthly / quarterly payments, this is the first day of period.","format":"date"},"totalExVat":{"type":"number","description":"Total amount for the invoice excluding VAT.","format":"double"},"total":{"type":"number","description":"Total payable amount for the invoice including VAT.","format":"double"},"totalPaid":{"type":["null","number"],"description":"Already paid amount of the invoice.\r\nThis is applicable only for some periodic invoices, like tax invoices, which may be paid in parts.","format":"double"},"message":{"type":"string","description":"The free text that is displayed / sent with the invoice.\r\nMay have multiple lines."},"channel":{"description":"Channel that is used for paying the invoice.","$ref":"#/components/schemas/PaymentChannel"},"type":{"description":"Invoice type.","$ref":"#/components/schemas/InvoiceType"},"externalId":{"type":"string","description":"The external ID is used for matching the executed payment from the 3rd party system\r\nto the pending payment in the Palkkaus system."},"status":{"description":"The current notified status of the invoice in external system.","$ref":"#/components/schemas/InvoiceStatus"},"statusAt":{"type":["null","string"],"description":"The time when the object status was last updated.","format":"date-time"},"externalStatusAt":{"type":["null","string"],"description":"Invoice/payment status in the external system.","format":"date-time"},"externalStatus":{"type":"string","description":"External status of the invoice in the external system."},"businessObjects":{"type":"array","items":{"type":"string"},"description":"List of business object ids (typically calculations) on which the payment is based on."},"payrollId":{"type":"string","description":"The payroll ID of the calculation this invoice is based on (applicable only for Net and Foreclosure)."},"payrollTitle":{"type":"string","description":"The payroll Title of the calculation this invoice is based on (applicable only for Net and Foreclosure)."},"paidBusinessObjectsCount":{"type":["null","integer"],"description":"The count of paid business objects (typically calculations) which the invoices is based on.\r\nThis is applicable only for some periodic invoices, like tax invoices, which may be paid in parts.","format":"int32"},"period":{"description":"Period for the Invoice: Work period, month / quarter of sidecosts etc.","$ref":"#/components/schemas/DateRange"},"paymentType":{"description":"The payment type of the invoice. If the payment channel does not support the requested payment type (e.g. Salary),\r\nit should set here the payment type that it used (e.g. Default).\r\nPayment channel should also expect new types to be introduced, without that being a breaking change.\r\nCurrently, we expect Default always be supported.","$ref":"#/components/schemas/InvoicePaymentType"},"paymentMessageId":{"type":"string","description":"Id of the payment message (maksuaineisto) that currently carries this invoice.\r\nDenormalized pointer for cheap queries; the message's frozen snapshot is the source of truth.\r\nNull when the invoice is not in any payment message."}},"additionalProperties":false,"description":"Header for the invoice"},"InvoiceListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/InvoiceStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/InvoiceData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of invoices in the user interface.\r\nIt contains all essential information of the report and is basis for searching, filtering and sorting."},"InvoiceParty":{"type":"object","properties":{"companyId":{"type":"string","description":"Finnish Company ID (Y-tunnus)."},"companyName":{"type":"string","description":"Organisation name"},"contact":{"description":"Contact information","$ref":"#/components/schemas/Contact"},"contactPersonName":{"type":"string","description":"Contact person Full name"}},"additionalProperties":false,"description":"Party in an Varma Invoice: Either Payer or Recipient."},"InvoicePayer":{"type":"object","properties":{"avatar":{"description":"Avatar is the visual representation of the party.","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the party.","$ref":"#/components/schemas/Contact"},"officialId":{"type":"string","description":"Official identifier of the party:\r\nFinnish HETU (Soc. sec. number) for a Person or Y-tunnus (Company ID for a company or association)."},"partnerKey":{"type":"string","description":"Optional ID for identifying the party in the third party system.\r\nThis is the same partner key that is given as part of Single Sign-On process."}},"additionalProperties":false,"description":"Payment payer party of the invoice."},"InvoicePaymentType":{"enum":["default","salary","salaryInPast"],"type":"string","description":"Types of payments used to pay the invoices.\r\nWe expect adding types like e.g. \"Express\", \"International\" in the future."},"InvoicePreview":{"type":"object","properties":{"invoice":{"description":"The invoice that exists / would be created.","$ref":"#/components/schemas/InvoiceListItem"},"exists":{"type":"boolean","description":"If true, this invoice has already been created."}},"additionalProperties":false,"description":"Provides a preview of how an invoice should be created.\r\nIn the future versions, it is expected to return DIFF information on how\r\npotential previously created invoices would behave (e.g. if som invoices would be canceled or changed)."},"InvoiceRecipient":{"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the payment receiver for payment purposes."},"iban":{"type":"string","description":"The International Bank Account Number of the receiver."},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"officialId":{"type":"string","description":"This is an official identifier of the party: Finnish Personal Id (HETU) for a Person or Company Id (Y-tunnus) for a company or association.\r\nWARNING: This is currently needed for Finvoice only (https://www.finanssiala.fi/finvoice/Sivut/default.aspx). As such we consider removing it from persons. \r\nPlease inform if you use this property!"},"sourceId":{"type":"string","description":"Identifier in a source system. Used in imports etc."},"contact":{"description":"Optional contact info. Not available for all recipients.","$ref":"#/components/schemas/Contact"},"beneficiary":{"description":"The ultimate beneficiary of the money: \r\nThis may be a Palkkaus.fi Worker Account (Avatar id is not null)\r\nor some other entity: Tax authorities, pension company etc. (Avatar id is null).\r\nTypically beneficiary is the same as Iban, OfficialId, FullName and Contact in this object,\r\nbut this is not true in edge cases (e.g. customer funds account).","$ref":"#/components/schemas/AccountInIndex"}},"additionalProperties":false,"description":"Payment receiver party of the invoice."},"InvoiceRow":{"type":"object","properties":{"articleId":{"type":"string","description":"Article Identifier is given by seller, EAN etc.\r\nIn the case of Salaxy salaries, this is CalculationRowType."},"articleName":{"type":"string","description":"Name of the product or service.\r\nIn the case of Salaxy salaries, this is language versioned text of CalculationRowType."},"message":{"type":"string","description":"Message (RowFreeText in Finvoice) is the message is mainly designed for accounting systems."},"count":{"type":"number","description":"Count (DeliveredQuantity in Finvoice) is the quantity of product or service.","format":"double"},"price":{"type":"number","description":"Price including VAT (UnitPriceVatIncludedAmount, Yksikköhinta verollinen)","format":"double"},"priceExVat":{"type":"number","description":"Price of one product or service without Vat (UnitPriceAmount, Yksikköhinta veroton). \r\nYksikköhinta voidaan ilmoittaa myös verollisena UnitPriceVatIncludedAmount- elementissä laskutuskäytännön ja verottajan ALV-ohjeistuksen mukaan.","format":"double"},"vatPercent":{"type":"number","description":"Vat percent related to the product or service (RowVatRatePercent, Alv%)\r\nPlease note that eg. 24% is valued as 0.24","format":"double"},"totalExVat":{"type":"number","description":"Row total excluding VAT (RowVatExcludedAmount, Yhteensä veroton)","format":"double"},"total":{"type":"number","description":"Row total with VAT (RowAmount, Yhteensä verollinen)","format":"double"},"accountingAccountNumber":{"type":"string","description":"Suggested account number (RowNormalProposedAccountIdentifier)."},"accountingCode":{"type":"string","description":"Textual code for accounting mapping (RowProposedAccountText, Raportointikoodi).\r\nIn Finvoice: \"Accounting information agreed between seller and buyer.\""},"businessObject":{"type":"string","description":"Business object id (typically calculation) on which the row is based on."}},"additionalProperties":false,"description":"Row for the invoice"},"InvoiceSettings":{"type":"object","properties":{"eInvoiceReceiver":{"type":"string","description":"Receiver's address for the e-invoice."},"eInvoiceIntermediator":{"type":"string","description":"Receiver's operator for the e-invoice."},"sepaBankPartyId":{"type":"string","description":"SEPA maksatustunnus"},"ibanNumber":{"type":"string","description":"Employer's bank account number"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."}},"additionalProperties":false,"description":"Settings related to invoices that are sent to customers."},"InvoiceSettingsCheck":{"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678\r\nThis field is optional and defaults to the company number of the current account."},"id":{"type":"string","description":"Item id to check.\r\nThis can be external ID, official ID or Salaxy ID."},"validation":{"description":"Validation for the import","$ref":"#/components/schemas/ApiValidation"},"result":{"description":"Result object of the import.","$ref":"#/components/schemas/ApiCheckResultOfInvoiceSettings"}},"additionalProperties":false,"description":"Check object for invoice settings."},"InvoiceStatus":{"enum":["undefined","forecast","preview","waitingPalkkaus","unread","read","waitingConfirmation","paymentStarted","warning","paid","canceled","error"],"type":"string","description":"Status of the invoice from the 3rd party system perspective."},"InvoiceStatusNotification":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID for the invoice in Salaxy system.\r\nIf omitted, the resolving to an invoice will be made using external id."},"externalId":{"type":"string","description":"External id can be set in the notification for the invoice for later messaging.\r\nIf the notification message contains an External Id AND regular Id, the External Id is updated in the Salaxy database.\r\nIf the notification contains External Id, but NO regular Id, an invoice is fetched based on External Id.\r\nIn the latter case, a non-existent Id or multiple invoices with the same External Id will throw an exception and the entire update process is canceled."},"status":{"description":"New status for the invoice. Required main payload of the call.","$ref":"#/components/schemas/InvoiceStatus"},"date":{"type":"string","description":"Required Date for the transaction (booking date).","format":"date"},"amount":{"type":"number","description":"Required realized amount of the transaction.","format":"double"},"receiverFullName":{"type":"string","description":"Optional full name of the payment receiver. Should be sent only if the user or process has the possibility of changing the name."},"receiverIban":{"type":"string","description":"Optional bank account IBAN of the receiver. Should be sent only if the user or process has the possibility of changing the IBAN."},"receiverBic":{"type":"string","description":"Optional bank identifier code of the receiver. Should be sent only if the user or process has the possibility of changing the IBAN."},"referenceNumber":{"type":"string","description":"Optional payment reference number. Should be sent only if the user or process has the possibility of changing or removing the reference number.\r\nChanging the reference number will typically lead to an error in the back office process that needs to be manually handled."},"paymentType":{"description":"The payment type of the invoice. If the payment channel does not support the requested payment type (e.g. Salary),\r\nit should set here the payment type that it used (e.g. Default).\r\nPayment channel should also expect new types to be introduced, without that being a breaking change.\r\nCurrently, we expect Default always be supported.","$ref":"#/components/schemas/InvoicePaymentType"},"externalStatusAt":{"type":["null","string"],"description":"Invoice/payment status in the external system.","format":"date-time"},"externalStatus":{"type":"string","description":"External status of the invoice in the external system."}},"additionalProperties":false,"description":"Contents for the invoice status notification message."},"InvoiceType":{"enum":["undefined","net","tax","taxWithholding","taxSocialSecurity","taxAtSource","unemployment","pension","union","foreclosure","payroll","service","fee","gross","verification"],"type":"string","description":"Type of the invoice."},"InvoicingRequest":{"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678\r\nThis field is optional and defaults to the company number of the current account."},"parameters":{"type":"object","additionalProperties":false,"description":"Additional parameters for import. Defaults to string."},"item":{"type":"string"},"validation":{"description":"Validation for the import","$ref":"#/components/schemas/ApiValidation"},"result":{"description":"Result object of the import.","$ref":"#/components/schemas/ApiImportResultOfInvoiceArray"}},"additionalProperties":false,"description":"Import object for invoice creation."},"IODataQueryValidator":{"type":"object","additionalProperties":false},"IOrderByQueryValidator":{"type":"object","additionalProperties":false},"IPAddress":{"type":"object","properties":{"addressFamily":{"$ref":"#/components/schemas/AddressFamily"},"scopeId":{"type":"integer","format":"int64"},"isIPv6Multicast":{"type":"boolean","readOnly":true},"isIPv6LinkLocal":{"type":"boolean","readOnly":true},"isIPv6SiteLocal":{"type":"boolean","readOnly":true},"isIPv6Teredo":{"type":"boolean","readOnly":true},"isIPv6UniqueLocal":{"type":"boolean","readOnly":true},"isIPv4MappedToIPv6":{"type":"boolean","readOnly":true},"address":{"type":"integer","format":"int64"}},"additionalProperties":false},"IPercentages":{"type":"object","properties":{"householdDeduction":{"type":"number","format":"double","readOnly":true},"palkkaus":{"type":"number","format":"double"},"pensionEmployer":{"type":"number","format":"double","readOnly":true},"pensionFull":{"type":"number","format":"double","readOnly":true},"pensionWorker":{"type":"number","format":"double","readOnly":true},"socialSecurity":{"type":"number","format":"double","readOnly":true},"socialSecurityWorker":{"type":"number","format":"double","readOnly":true},"tax":{"type":"number","format":"double","readOnly":true},"unemploymentEmployer":{"type":"number","format":"double","readOnly":true},"unemploymentFull":{"type":"number","format":"double","readOnly":true},"unemploymentWorker":{"type":"number","format":"double","readOnly":true},"unionPayment":{"type":"number","format":"double","readOnly":true}},"additionalProperties":false},"IrDelivery":{"type":"object","properties":{"senderOfficialId":{"type":"string","description":"Official id of the sender."},"contactPersons":{"type":"array","items":{"$ref":"#/components/schemas/ContactPerson"},"description":"Contact persons for the IR records"}},"additionalProperties":false,"description":"IR Delivery settings."},"IrDetails":{"type":"object","properties":{"code":{"type":"integer","description":"The number code in Incomes Register.","format":"int32"},"flags":{"type":"array","items":{"$ref":"#/components/schemas/IrFlags"},"description":"Boolean flags that can be set on transaction."},"insuranceExceptions":{"type":"array","items":{"$ref":"#/components/schemas/IrInsuranceExceptions"},"description":"Defines the exceptions to Insurance / Sidecost defaults that are set by the row type."},"dailyAllowance":{"type":"array","items":{"$ref":"#/components/schemas/AllowanceCode"},"description":"Daily allowance code."},"mealBenefitIsTaxValue":{"type":["null","boolean"],"description":"Set this to true if meak benefit is of tax value - false if it si not.\r\nThe value should be null if the row is not mealBenefit."},"carBenefit":{"description":"Provides the additional data needed for car benefit.","$ref":"#/components/schemas/CarBenefit"},"noTransactionAmount":{"type":"boolean","description":"If true, report zero amount to IR."},"taxDefault":{"description":"Overrides the tax default of the income type (e.g. no tax for late-payment interest, VH/2593/00.01.00/2019).\r\nOnly supported for CapitalIncomePayment (332), ignored for other codes.","$ref":"#/components/schemas/IrTaxDefault"}},"additionalProperties":false,"description":"Reporting details to Incomes registry (Tulorekisteri)."},"IResponseCookies":{"type":"object","additionalProperties":false,"readOnly":true},"IrFlags":{"enum":["noMoney","oneOff","unjustEnrichment"],"type":"string","description":"Collection of misc flags that may be se in Incomes registry"},"IrIncomeTypeUsecase":{"type":"object","properties":{"irData":{"type":"object","properties":{"code":{"type":"integer"},"flags":{"type":"array","items":{"enum":["noMoney","oneOff","unjustEnrichment"],"type":"string"}},"insuranceExceptions":{"type":"array","items":{"enum":["includeAll","includePension","includeHealthInsurance","includeUnemployment","includeAccidentInsurance","excludeAll","excludePension","excludeHealthInsurance","excludeUnemployment","excludeAccidentInsurance"],"type":"string"}},"dailyAllowance":{"type":"array","items":{"enum":["mealAllowance","partialDailyAllowance","fullDailyAllowance","internationalDailyAllowance","taxExemptReimbursementsAbroad"],"type":"string"}},"mealBenefitIsTaxValue":{"type":["null","boolean"]},"carBenefit":{"type":"object","properties":{"carBenefitCode":{"enum":["limitedCarBenefit","fullCarBenefit"],"type":"string"},"ageGroupCode":{"enum":["a","b","c","u"],"type":"string"},"kilometers":{"type":["null","integer"]},"emissionsValue":{"type":["null","number"],"format":"double"}},"additionalProperties":false},"noTransactionAmount":{"type":"boolean"},"taxDefault":{"enum":["default","noTax","tax","taxDeduction"],"type":"string"}},"additionalProperties":false},"unit":{"enum":["undefined","hours","days","weeks","period","one","count","percent","kilometers","euro"],"type":"string"},"kind":{"enum":["unknown","ignored","timeRatePay","initiativeFee","bonusPay","complementaryWagePaidDuringBenefitPeriod","emergencyWorkCompensation","eveningWorkCompensation","eveningShiftAllowance","noticePeriodCompensation","kilometreAllowanceTaxable","meetingFee","saturdayPay","extraWorkPremium","holidayBonus","lectureFee","compensationForTrustPosition","otherCompensation","waitingTimeCompensation","workingConditionCompensation","partialPayDuringSickLeave","commission","sundayWorkCompensation","benefitArisingFromSyntheticOption","performanceBonus","monetaryCompensationFromWorkingTimeBank","compensationForAccruedTimeOff","shareIssueForEmployees","contractPay","damagesInConjunctionWithTermination","standByCompensation","voluntaryCompensationInConjunctionWithTermination","weeklyRestCompensation","profitSharingBonus","annualHolidayCompensation","overtimeCompensation","nightWorkAllowance","nightShiftCompensation","otherRegularCompensation","compensationForUnusedCompensatoryLeave","accommodationBenefit","interestBenefitForHousingLoan","mealAllowance","carBenefit","compensationForGoverningBodyMembership","shareOfReserveDrawnFromPersonnelFund","monetaryGiftForEmployees","kilometreAllowanceTaxExempt","treatmentFeeForMunicipalVeterinarian","compensationForUseEarnedIncome","compensationForUseCapitalIncome","otherTaxableBenefitForEmployees","otherTaxableIncomeDeemedEarnedIncome","otherFringeBenefit","kinshipCarersFee","stockOptions","wagesPaidBySubstitutePayerIncludingSocialInsurance","wagesPaidBySubstitutePayerIncludingEarningsRelatedPensionInsurance","wagesPaidBySubstitutePayerIncludingUnemploymentInsurance","wagesPaidBySubstitutePayerIncludingAccidentAndOccupationalDiseaseInsurance","wagesPaidBySubstitutePayerIncludingHealthInsurance","compensationForEmployeeInvention","reimbursementOfPrivateCaretakersExpenses","privateCaretakersFee","reimbursementOfFamilyDayCareProvidersExpenses","telephoneBenefit","dailyAllowance","capitalIncomePayment","mealBenefit","reimbursementOfCostsPaidToConciliator","nonWageCompensationForWork","supplementaryDailyAllowancePaidByEmployerSpecificHealthInsuranceFund","pensionPaidByEmployer","dividendsBasedOnWages","dividendsBasedOnNonWage","employerSubsidisedCommuterTicketTaxExempt","employerSubsidisedCommuterTicketTaxable","employeeStockOption","wagesTransferredToAthletesSpecialFund","wagesPaidFromAthletesSpecialFund","wagesForInsurancePurposes","taxableReimbursementOfExpenses","privateDayCareAllowanceMunicipalSupplement","privateDayCareAllowanceWages","privateDayCareAllowanceNonWage","kilometreAllowancePaidByNonProfitOrganisation","dailyAllowancePaidByNonProfitOrganisation","unjustEnrichment","employeeStockOptionLowerMarketPrice","royaltyPaidToNonResidentTaxpayer","bicycleBenefitTaxExempt","bicycleBenefitTaxable","conditionalStockOptions","copyrightRoyaltiesEarnedIncome","stockGrantPaidInMoney","employeeStockOptionPaidInMoney","earningsFromJuELEmployerToLightEntrepreneur","compensationCollectedForCarBenefit","withholdingTax","electedOfficialFee","taxAtSource","taxAtSourceDeduction","wagesPaid","reimbursementCollectedForOtherFringeBenefits","otherItemDeductibleFromNetWage","netWage","employerPaidPremiumForCollectiveAdditionalPensionInsurance","employerPaidPremiumForCollectiveAdditionalPensionInsuranceEmployeesContribution","employeesHealthInsuranceContribution","employeesPensionInsuranceContribution","employeesUnemploymentInsuranceContribution","reimbursementForEmployerSubsidisedCommuterTicket","taxPaidAbroad","distraint","voluntaryIndividualPensionInsurancePremium","deductionBeforeWithholding","reimbursementCollectedForBicycleBenefit"],"type":"string"}},"additionalProperties":false},"IrInsuranceExceptions":{"enum":["includeAll","includePension","includeHealthInsurance","includeUnemployment","includeAccidentInsurance","excludeAll","excludePension","excludeHealthInsurance","excludeUnemployment","excludeAccidentInsurance"],"type":"string","description":"Collection of flags that may be se in Incomes registry"},"IrRow":{"type":"object","properties":{"type":{"description":"Type of the row - basically describes the source for this row: \r\nEither Manual (default) or Usecase logic, which may be legacy / API v02 or new / API v03.","$ref":"#/components/schemas/IrRowSourceType"},"message":{"type":"string","description":"Description text of the row that is shown in reports."},"count":{"type":"number","description":"Count for the row. Default is one.","format":"double"},"price":{"type":"number","description":"Price for the row.","format":"double"},"total":{"type":"number","description":"Simple multiplication: Count * Price - no other logic. Not used as Input.","format":"double"},"unit":{"description":"Unit for the row. If specified as Undefined, set by the server-logic based on row type etc.","$ref":"#/components/schemas/Unit"},"irData":{"description":"Details for the National Incomes registry","$ref":"#/components/schemas/IrDetails"},"calcData":{"description":"Details from Salaxy internal calulcation point-of-view (logic not in IR).","$ref":"#/components/schemas/IrRowCalculationProperties"},"earningPeriod":{"description":"Earnings period if different than the report period.\r\nNote that this property may be (and by default is) null.","$ref":"#/components/schemas/DateRange"},"period":{"description":"Period for the calculation row. This is mainly used for absences (AbsencePeriod row type), leaves and holidays (HolidaySalary, HolidayBonus and HolidayCompensation).\r\nNote that this property may be (and by default is) null.","$ref":"#/components/schemas/DateRange"},"accounting":{"description":"Accounting related data for the row.","$ref":"#/components/schemas/RowAccounting"},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data"}},"additionalProperties":false,"description":"Business level modeling corresponding to WageReportsToIRTypes Transaction.\r\nAlso contains additional data for accounting and integration purposes."},"IrRowCalculationProperties":{"type":"object","properties":{"grouping":{"description":"Grouping for reports etc.","$ref":"#/components/schemas/CalcGroup"},"behavior":{"type":"array","items":{"$ref":"#/components/schemas/CalculationFlag"},"description":"Defines the behavior of the row in Salaxy calculation process."},"type":{"type":"string","description":"Wage type. Either a built in wage type in Salaxy or a custom wage type created by the user.\r\nPlease note that this type fully determines the CalculationRowType and the kind."}},"additionalProperties":false,"description":"Details from Salaxy internal calulcation point-of-view (logic not in IR)."},"IrRowSourceType":{"enum":["manual","usecase","usecaseV02"],"type":"string"},"IrTaxDefault":{"enum":["default","noTax","tax","taxDeduction"],"type":"string","description":"Row level override for the tax (withholding) default that is set by the income type."},"ISelectExpandQueryValidator":{"type":"object","additionalProperties":false},"IServiceProvider":{"type":"object","additionalProperties":false},"ISession":{"type":"object","properties":{"isAvailable":{"type":"boolean","readOnly":true},"id":{"type":"string","readOnly":true},"keys":{"type":"array","items":{"type":"string"},"readOnly":true}},"additionalProperties":false},"ISkipQueryValidator":{"type":"object","additionalProperties":false},"ISkipTokenQueryValidator":{"type":"object","additionalProperties":false,"readOnly":true},"IssuedCertificate":{"type":"object","properties":{"thumbprint":{"type":"string","description":"Certificate thumbprint: A unique identifier for the created certificate."},"bytes":{"type":"string","description":"Certificate bytes when the certifcate is a file. Currently PFX or ZIP.","format":"byte"},"cert":{"type":"string","description":"Certificate / public key as text (PEM) if provided by the generation process."},"key":{"type":"string","description":"Private key as text (PEM) if provided by the generation process."}},"additionalProperties":false,"description":"Provides information about a new issued certificate."},"ITopQueryValidator":{"type":"object","additionalProperties":false},"IVerifiedAccount":{"type":"object","properties":{"identity":{"description":"Information about the verification of the account. \r\nNOTE that this object may not be present in many method calls - this is because it contains confidential information.","$ref":"#/components/schemas/Identity"},"isVerified":{"type":"boolean","description":"If true, the account has been verified. Typically this means a digitally signed contract.\r\nThis means that the account also has an Identity object.\r\nHowever, as the Identity object contains confidential information, it is not necessarily present in all method calls.","readOnly":true},"avatar":{"description":"Avatar is the visual representation of the Account.","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the Account.","$ref":"#/components/schemas/Contact"},"language":{"description":"Language of the person/company.","$ref":"#/components/schemas/Language"},"id":{"type":["null","string"],"description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated","format":"date-time"},"owner":{"maxLength":64,"type":["null","string"],"description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":["null","string"],"description":"Pricing partner information."}},"additionalProperties":false,"description":"An account that is verified. Typically this means a digitally signed contract.\r\nThis means that the account also has an Identity object.\r\nHowever, as the Identity object contains confidential information, it is not necessarily present in all method calls."},"KeySizes":{"required":["minSize","maxSize","skipSize"],"type":"object","properties":{"minSize":{"type":"integer","format":"int32","readOnly":true},"maxSize":{"type":"integer","format":"int32","readOnly":true},"skipSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false},"KeyValuePairOfstringAndstring":{"required":["key","value"],"type":"object","properties":{"key":{"type":["null","string"],"readOnly":true},"value":{"type":["null","string"],"readOnly":true}},"additionalProperties":false},"KeyValuePairOfstringAndStringValues":{"required":["key","value"],"type":"object","properties":{"key":{"type":["null","string"],"readOnly":true},"value":{"type":"array","items":{"type":"string"},"readOnly":true}},"additionalProperties":false},"KeyValuePairOfTypeAndObject":{"required":["key","value"],"type":"object","properties":{"key":{"$ref":"#/components/schemas/Type"},"value":{"type":"object","additionalProperties":false,"readOnly":true}},"additionalProperties":false},"Language":{"enum":["default","fi","sv","en"],"type":"string","description":"Language enumeration."},"LedgerAccount":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/LedgerEntry"},"description":"Legder entries"},"accountNumber":{"type":"string","description":"Account number."},"accountName":{"type":"string","description":"Account name."},"accountGrouping":{"type":"string","description":"Account grouping."},"saldo":{"type":"number","description":"Current saldo for the ledger.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Represents a single accounting ledger."},"LedgerEntry":{"type":"object","properties":{"id":{"type":"string","description":"Id for the entry."},"entryDate":{"type":["null","string"],"description":"Entry date.","format":"date"},"description":{"type":"string","description":"Entry description."},"isDebit":{"type":"boolean","description":"Debit indicator."},"amount":{"type":"number","description":"Posted amount. Includes VAT.","format":"double"},"vatPercent":{"type":["null","number"],"description":"VAT percent.","format":"double"},"vatAmount":{"type":["null","number"],"description":"VAT amount of specific VAT rate.","format":"double"},"vatRate":{"description":"Applied VAT rate.","$ref":"#/components/schemas/VatRate"},"accountNumber":{"type":"string","description":"Account number."},"accountName":{"type":"string","description":"Account name."},"accountGrouping":{"type":"string","description":"Account grouping."},"dimension":{"type":"object","additionalProperties":false,"description":"Dimension data."}},"additionalProperties":false,"description":"Represents a single ledger entry."},"LegacyServiceModel":{"enum":["shared","partnerOnly"],"type":"string","description":"Service model for the partner - customer relation."},"LegalEntityType":{"enum":["undefined","person","company","personCreatedByEmployer","partner"],"type":"string","description":"Legal entity type"},"LocalTapiolaBeneficiary":{"type":"object","properties":{"dateOfBirth":{"type":["null","string"],"description":"Date of birth of the beneficiary.","format":"date-time"},"countryOfResidence":{"type":"string","description":"The country of residence of the beneficiary."},"nationality":{"type":"string","description":"Nationality of the beneficiary."},"avatar":{"description":"Avatar for the account","$ref":"#/components/schemas/Avatar"},"officialId":{"type":"string","description":"Official id of the person or company."},"email":{"type":"string","description":"Email address."},"telephone":{"type":"string","description":"Telephone number."},"ibanNumber":{"type":"string","description":"Bank account number (IBAN)"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"language":{"description":"Preferred language. Not in index.","$ref":"#/components/schemas/Language"},"authorizations":{"type":"array","items":{"type":"string"},"description":"Account authorizations. Not in index."}},"additionalProperties":false},"LocalTapiolaInsuranceOrder":{"type":"object","properties":{"status":{"description":"Status of the Local Tapiola insurance order.","$ref":"#/components/schemas/LocalTapiolaInsuranceOrderStatus"},"company":{"description":"Information about the company placing the Local Tapiola insurance order.","$ref":"#/components/schemas/LocalTapiolaInsuranceOrderCompanyInfo"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LocalTapiolInsuranceOrderInfo"},"description":"Information about the Local Tapiola worker insurance order."},"validation":{"description":"Validation information.","$ref":"#/components/schemas/ApiValidation"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Local Tapiola insurance order API object."},"LocalTapiolaInsuranceOrderAuthorizationType":{"enum":["procuration","powerOfAttorney","apparentAuthority","other"],"type":"string","description":"Enumeration for Local Tapiola insurance orders contact person authorization type."},"LocalTapiolaInsuranceOrderCompanyContactPerson":{"type":"object","properties":{"authorizationType":{"description":"The authorization type of for the contact person.","$ref":"#/components/schemas/LocalTapiolaInsuranceOrderAuthorizationType"},"avatar":{"description":"Avatar for the account","$ref":"#/components/schemas/Avatar"},"officialId":{"type":"string","description":"Official id of the person or company."},"email":{"type":"string","description":"Email address."},"telephone":{"type":"string","description":"Telephone number."},"ibanNumber":{"type":"string","description":"Bank account number (IBAN)"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"language":{"description":"Preferred language. Not in index.","$ref":"#/components/schemas/Language"},"authorizations":{"type":"array","items":{"type":"string"},"description":"Account authorizations. Not in index."}},"additionalProperties":false,"description":"Information required for a company contact person with a Local Tapiola occupational accident\r\ninsurance."},"LocalTapiolaInsuranceOrderCompanyInfo":{"type":"object","properties":{"details":{"description":"Company details.","$ref":"#/components/schemas/AccountInIndex"},"address":{"description":"Company address.","$ref":"#/components/schemas/Contact"},"physicalAddress":{"description":"The company address","$ref":"#/components/schemas/Contact"},"hasPrincipalBusinessAddress":{"type":"boolean","description":"If true, the address of the Principal Place Of Business differs from the company address."},"principalBusinessAddress":{"description":"Address of the principal place of business.","$ref":"#/components/schemas/Contact"},"contactPerson":{"description":"Information of the insured companys delegate person.","$ref":"#/components/schemas/LocalTapiolaInsuranceOrderCompanyContactPerson"},"complexOwnerStructure":{"type":"boolean","description":"Company owner structure is too complex to be fully represented with simple form data\r\ni.e. list of InsuranceOrderCompanyOwnerInfo objects."},"owners":{"type":"array","items":{"$ref":"#/components/schemas/BeneficialOwner"},"description":"List of beneficial owners of the company."},"beneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/LocalTapiolaBeneficiary"},"description":"List of other beneficiaries than beneficial owners of the company"},"boardMembers":{"type":"array","items":{"$ref":"#/components/schemas/LocalTapiolaBeneficiary"},"description":"List of board members of the company"},"businessDescription":{"type":"string","description":"Overall description of the customer business."},"keyPartners":{"type":"string","description":"List of the customer's key partners."},"personnelCount":{"type":"integer","description":"Number of personnel in the company.","format":"int32"},"revenue":{"type":"number","description":"Revenue range of the company.","format":"double"},"operatingAreas":{"type":"array","items":{"$ref":"#/components/schemas/LocalTapiolaOperatingAreaInfo"},"description":"Operating areas of the company"},"ibanNumber":{"type":"string","description":"Bank IBAN"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."}},"additionalProperties":false,"description":"Information required for an insured company with a Local Tapiola occupational accident\r\ninsurance."},"LocalTapiolaInsuranceOrderOccupation":{"type":"object","properties":{"occupationCode":{"type":"string","description":"Occupation code."},"occupationName":{"type":"string","description":"Occupation name."},"estimatedIncome":{"type":"number","description":"Estimated annual salary income.","format":"double"}},"additionalProperties":false,"description":"Occupation information required with a new Local Tapiola worker occupational accident\r\ninsurance order."},"LocalTapiolaInsuranceOrderStatus":{"enum":["draft","waitingApproval","checked","sent","handled","canceled"],"type":"string","description":"Status of a Local Tapiola insurance order."},"LocalTapiolaInsuranceOrderType":{"enum":["newWorkerInsurance","moveWorkerInsurance","newEntrepreneurInsurance","moveEntrepreneurInsurance","other"],"type":"string","description":"Type of a Local Tapiola insurance order."},"LocalTapiolaOperatingArea":{"enum":["finland","foreignCountries"],"type":"string"},"LocalTapiolaOperatingAreaInfo":{"type":"object","properties":{"operatingArea":{"description":"The operating area of the company.","$ref":"#/components/schemas/LocalTapiolaOperatingArea"},"description":{"type":"string","description":"Description for the operating area, in case the selected area is \"ForeignCountries\"."}},"additionalProperties":false,"description":"Information about the company's operating area (domestic or foreign and the optional description of the foreign countries/area)"},"LocalTapiolInsuranceOrderInfo":{"type":"object","properties":{"orderType":{"description":"Type of the Local Tapiola insurance order.","$ref":"#/components/schemas/LocalTapiolaInsuranceOrderType"},"startDate":{"type":["null","string"],"description":"Start date of the insurance. Only valid for new occupational accident insurance and\r\nentrepreneur insurance. If insurance is moved to Local Tapiola from another insurance\r\ncompany, StartingPoint should be used instead.","format":"date"},"billingInterval":{"type":["null","integer"],"description":"Billing interval (1, 2, 3 or 4 times per year). Applies only to entrepreneur insurance.","format":"int32"},"oldInsuranceCompany":{"type":"string","description":"Name of the old insurance company, if the insurance is transferred to Local Tapiola\r\nfrom some other insurance company."},"industry":{"type":"string","description":"Industry that the company operates in."},"occupations":{"type":"array","items":{"$ref":"#/components/schemas/LocalTapiolaInsuranceOrderOccupation"},"description":"Occupation types and income estimates. Can be many entries for an occupational accident\r\ninsurance and only a single entry for an entrepreneur insurance."},"insuredName":{"type":"string","description":"Name of the entrepreneur."},"insuredOfficialId":{"type":"string","description":"Social security number of the entrepreneur."}},"additionalProperties":false,"description":"Information required with a Local Tapiola worker accident insurance order."},"MealBenefitKind":{"enum":["undefined","cateringContract","mealTicket","taxableAmount","mealAllowance","institute","teacher","restaurantWorker","collectedReimbursement"],"type":"string"},"MealBenefitUsecase":{"type":"object","properties":{"deduction":{"type":["null","number"],"format":"double"},"taxablePrice":{"type":"number","format":"double"},"isTaxValue":{"type":"boolean"},"isTaxValueDeductionDone":{"type":"boolean"},"kind":{"enum":["undefined","cateringContract","mealTicket","taxableAmount","mealAllowance","institute","teacher","restaurantWorker","collectedReimbursement"],"type":"string"}},"additionalProperties":false},"Message":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the message."},"time":{"type":"string","description":"Time for the message","format":"date-time"},"type":{"description":"Content type of the message","$ref":"#/components/schemas/ThreadedMessageType"},"content":{"type":"string","description":"Textual content: If message, this is the content text.\r\nIf other type, short title / description typically shown in the title bar."},"contentId":{"type":"string","description":"Identifier of the external content.\r\nBlobFile Id for attachments, Calculation ID for calculations etc."},"contentData":{"type":"object","additionalProperties":false,"description":"Other misc. data that is used in displaying the content in the immediate message view.\r\nDo not include the entire object here. Just the immediately available data."},"preview":{"type":"string","description":"Content type specific text for preview.\r\nThis may be URI, ID or boolean.\r\nFor BlobFile, it is currently the BlobFile Guid (the same as ContentId) or null, \r\nbut in the future, the field may also contain an URL without that being a breaking change!"},"fromParty":{"description":"The party / type of the message sender.","$ref":"#/components/schemas/MessageFrom"},"readByOwner":{"type":["null","string"],"description":"If set, specifies the time when the message has been read by the thread owner.","format":"date-time"},"readByOtherParty":{"type":["null","string"],"description":"If set, specifies the time when the message has been read by the other party.","format":"date-time"},"validation":{"description":"Validates the object that is the payload of the message.","$ref":"#/components/schemas/ApiValidation"}},"additionalProperties":false,"description":"A message within a messaging thread."},"MessageData":{"type":"object","properties":{"title":{"type":"string","description":"Title for the message"},"ownerLastMessage":{"type":"string","description":"Last message that was was created by the owner"},"otherPartyLastMessage":{"type":"string","description":"Last message that was created by the other party"},"ownerUnreadCount":{"type":"integer","description":"Number of messages by Owner that have not been read by the other party","format":"int32"},"otherPartyUnreadCount":{"type":"integer","description":"Number of messages that have been read by the Other party and have not been read by the owner.","format":"int32"},"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"usecaseUri":{"type":"string","description":"Key for the usecase based on which it is resolved. \r\nLater, this may resolve to a user interface, microservice or a to manifest registering one.\r\nFor now, just use a unique string starting with a domain you own."},"isSalaxyEmail":{"type":"boolean","description":"If true, the message is a salaxy email, generated by the system."},"periodStart":{"type":["null","string"],"description":"Start date of the default salary period","format":"date"},"periodEnd":{"type":["null","string"],"description":"End date of the default salary period","format":"date"},"calcCount":{"type":["null","integer"],"description":"Count of calculations in this Payroll","format":"int32"},"ownerUpdatedAt":{"type":["null","string"],"description":"Time of the last message posted by owner.","format":"date-time"},"otherPartyUpdatedAt":{"type":["null","string"],"description":"Time of the last message posted by other party.","format":"date-time"},"ownerUnreadSince":{"type":["null","string"],"description":"Time of the oldest message posted by owner that the other party has not read.","format":"date-time"}},"additionalProperties":false,"description":"Message thread specific business data for index."},"MessageFrom":{"enum":["undefined","owner","otherParty","system"],"type":"string","description":"The party / type of the message sender.\r\nThis is the entity (company, household, partner) rather than the individual behaving in behalf of the entity."},"MessageListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/MessageData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of message threads in the user interface.\r\nIt contains header data of the message thread and is basis for searching, filtering and sorting."},"MessageThread":{"type":"object","properties":{"title":{"type":"string","description":"Title for the message"},"status":{"description":"Status for the entire message thread.","$ref":"#/components/schemas/MessageThreadStatus"},"ownerInfo":{"description":"The owner of the thread: The entity that has the right to delete or move the thread.\r\nThis may or may not be the originator the message thread.\r\nThe owner is typically Company or Household, in some cases Worker person.\r\nIt should NOT be partner or person from a company.","$ref":"#/components/schemas/Avatar"},"otherParty":{"type":"string","description":"Palkkaus.fi id (IBAN) of the other party.\r\nThe other party is the second entity(besides the owner) in that is juridically in the message.\r\nThis may or may not be the originator the message thread.\r\nIt is typically the Partner or Palkkaus.fi, but may also be the Worker in the future."},"otherPartyInfo":{"description":"The other party is the second entity (besides the owner) in that is juridically in the message.\r\nThis may or may not be the originator the message thread.\r\nIt is typically the Partner or Palkkaus.fi, but may also be the Worker in the future.","$ref":"#/components/schemas/Avatar"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"},"description":"List of messages and attachments in this thread"},"ownerWorkflow":{"description":"The workflow from the Owner point-of-view.","$ref":"#/components/schemas/MessageThreadWorkflow"},"otherPartyWorkflow":{"description":"The workflow from the other party point-of-view.","$ref":"#/components/schemas/MessageThreadWorkflow"},"workflowData":{"description":"The workflow data for manual editing and approval purposes.","$ref":"#/components/schemas/WorkflowData"},"usecase":{"description":"Provides data for the usecase: The customer or service model level customization that is done for this object.\r\nThe customization may define user interface, data model and even scripts or worflow related to the object.","$ref":"#/components/schemas/UsecaseData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Messages thread groups togehter a set of related messages and/or attachments."},"MessageThreadStatus":{"enum":["draft","active","approved","rejected","archived","template"],"type":"string","description":"Status for the entire message thread."},"MessageThreadWorkflow":{"type":"object","properties":{"unreadCount":{"type":"integer","description":"Number of messages that this party has posted that have not been read by the other party.","format":"int32"},"salaryDate":{"type":["null","string"],"description":"The salary date for the discussion.\r\nOwner's and other party's are typically the same, but they may differ: \r\ne.g. one may be the requested / estimated date and the other the first possible date if the requested is unrealistic.\r\nNOTE: Unlike in Salaxy, this is always UTC.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"Time of the last message posted by this party. \r\nNOTE: Unlike in Salaxy, this is always UTC.","format":"date-time"},"lastMessageText":{"type":"string","description":"Text for the last message (written by this party). This is for preview purposes: May be shortened."}},"additionalProperties":false,"description":"Defines workflow actions for a message thread."},"MessagingSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"partnerMessages":{"type":"boolean","description":"Partner messages enabled."},"workerSalaryNotifications":{"type":"array","items":{"$ref":"#/components/schemas/WorkerSalaryNotification"},"description":"Options for the notification to be sent to the worker after the salary payment."},"workerSalarySlipDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/WorkerSalarySlipDeliveryMethod"},"description":"Options for the delivery of the payslip to the worker."}},"additionalProperties":false,"description":"Settings related to Messaging"},"MonthlyHolidayAccrual":{"type":"object","properties":{"month":{"type":"string","description":"First day of month for the holiday month","format":"date"},"daysAccrued":{"type":"number","description":"Holiday accrual for this month.\r\nNote that -1 is indication that accrual should not be updated for this particylar month.\r\nThere is no possiblity for negative accrual.","format":"double"},"absencesDays":{"type":"integer","description":"Number of absence days used in the calculation.","format":"int32"},"workDays":{"type":["null","integer"],"description":"Work days in determining the accrual for the month in 14 days rule.","format":"int32"},"workHours":{"type":["null","integer"],"description":"Work hours in determining the accrual fot the month in 35 hour rule.","format":"int32"},"calcId":{"type":"string","description":"Id of the calculation that this accrual is related to."}},"additionalProperties":false,"description":"Holiday Accrual for a calendar month in releation to a calculation."},"NonProfitOrgKind":{"enum":["undefined","kilometreAllowance","dailyAllowance","accomodationAllowance"],"type":"string"},"NonProfitOrgUsecase":{"type":"object","properties":{"kind":{"enum":["undefined","kilometreAllowance","dailyAllowance","accomodationAllowance"],"type":"string"}},"additionalProperties":false},"ODataPathSegment":{"type":"object","properties":{"edmType":{"$ref":"#/components/schemas/IEdmType"},"identifier":{"type":"string"}},"additionalProperties":false},"ODataQueryContext":{"type":"object","properties":{"defaultQueryConfigurations":{"$ref":"#/components/schemas/DefaultQueryConfigurations"},"model":{"$ref":"#/components/schemas/IEdmModel"},"elementType":{"$ref":"#/components/schemas/IEdmType"},"navigationSource":{"$ref":"#/components/schemas/IEdmNavigationSource"},"elementClrType":{"$ref":"#/components/schemas/Type"},"path":{"type":"array","items":{"$ref":"#/components/schemas/ODataPathSegment"},"readOnly":true},"requestContainer":{"$ref":"#/components/schemas/IServiceProvider"}},"additionalProperties":false,"readOnly":true},"ODataQueryOptionsOfAccountingTargetListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfAccountingTargetListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfAccountingTargetListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfApiListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfApiListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfApiListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfBrandListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfBrandListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfBrandListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfCalculationListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfCalculationListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfCalculationListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfDatasetListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfDatasetListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfDatasetListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfEmploymentListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfEmploymentListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfEmploymentListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfFileListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfFileListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfFileListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfHolidayYearListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfHolidayYearListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfHolidayYearListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfHouseholdYearListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfHouseholdYearListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfHouseholdYearListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfInvoiceListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfInvoiceListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfInvoiceListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfMessageListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfMessageListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfMessageListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfPaymentMessageListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfPaymentMessageListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfPaymentMessageListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfPayrollListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfPayrollListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfPayrollListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfPrimaryPartnerListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfPrimaryPartnerListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfPrimaryPartnerListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfRecordListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfRecordListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfRecordListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfReferenceObjectListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfReferenceObjectListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfReferenceObjectListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfServiceModelListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfServiceModelListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfServiceModelListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfTaskDefinitionListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfTaskDefinitionListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfTaskDefinitionListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfTaskRunListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfTaskRunListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfTaskRunListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfTaxcardListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfTaxcardListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfTaxcardListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfTemplateListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfTemplateListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfTemplateListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataQueryOptionsOfUsecaseListItem":{"required":["request","context"],"type":"object","properties":{"ifMatch":{"$ref":"#/components/schemas/ETagOfUsecaseListItem"},"ifNoneMatch":{"$ref":"#/components/schemas/ETagOfUsecaseListItem"},"request":{"$ref":"#/components/schemas/HttpRequest"},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValues":{"$ref":"#/components/schemas/ODataRawQueryOptions"},"selectExpand":{"$ref":"#/components/schemas/SelectExpandQueryOption"},"apply":{"$ref":"#/components/schemas/ApplyQueryOption"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"filter":{"$ref":"#/components/schemas/FilterQueryOption"},"search":{"$ref":"#/components/schemas/SearchQueryOption"},"orderBy":{"$ref":"#/components/schemas/OrderByQueryOption"},"skip":{"$ref":"#/components/schemas/SkipQueryOption"},"skipToken":{"$ref":"#/components/schemas/SkipTokenQueryOption"},"top":{"$ref":"#/components/schemas/TopQueryOption"},"count":{"$ref":"#/components/schemas/CountQueryOption"},"validator":{"$ref":"#/components/schemas/IODataQueryValidator"}},"additionalProperties":false},"ODataRawQueryOptions":{"type":"object","properties":{"filter":{"type":"string","readOnly":true},"apply":{"type":"string","readOnly":true},"compute":{"type":"string","readOnly":true},"search":{"type":"string","readOnly":true},"orderBy":{"type":"string","readOnly":true},"top":{"type":"string","readOnly":true},"skip":{"type":"string","readOnly":true},"select":{"type":"string","readOnly":true},"expand":{"type":"string","readOnly":true},"count":{"type":"string","readOnly":true},"format":{"type":"string","readOnly":true},"skipToken":{"type":"string","readOnly":true},"deltaToken":{"type":"string","readOnly":true}},"additionalProperties":false,"readOnly":true},"Oid":{"type":"object","properties":{"value":{"type":["null","string"]},"friendlyName":{"type":["null","string"]}},"additionalProperties":false},"Onboarding":{"required":["accountType"],"type":"object","properties":{"accountType":{"description":"Type of the account to be created.","$ref":"#/components/schemas/WebSiteUserRole"},"authorizePartner":{"type":"string","description":"Partner that should be added as primary authorization when the object is created.\r\nCurrently not used in update operations (only New and Signature / VismaSign)\r\nand does not set as primary partner except if exception specifically made for a partner."},"status":{"description":"The server-side status of the onboarding process.\r\nNOTE that there is a more relaxed user interface-level state in ui.state and ui.stateFullText \r\nthat can be used in onboarding user interfaces.","$ref":"#/components/schemas/OnboardingStatus"},"company":{"description":"Input that is needed for creating a company account.","$ref":"#/components/schemas/CompanyInput"},"person":{"description":"Input that is needed for creating a personal account.\r\nThis may be \r\n1) the principal account if the account is created for 1a) Worker or 1b) Household or \r\n2) creator owner if the account is created for a Company.","$ref":"#/components/schemas/PersonInput"},"products":{"description":"Possibility to define products. \r\nThese can only be defined to one account as part of the onboarding process: \r\nIf company account is created, the products are always for Company, not for the Person =&gt; \r\nPerson will have default products in that case and they need to be edited in a separate process once the accounts have been created.","$ref":"#/components/schemas/AccountProducts"},"signature":{"description":"Input and post data for digital signature.","$ref":"#/components/schemas/SignatureData"},"validation":{"description":"Validation status and errors.","$ref":"#/components/schemas/AccountValidation"},"ui":{"description":"User interface related data: Mainly the state of the UI.","$ref":"#/components/schemas/OnboardingUIState"},"credentials":{"$ref":"#/components/schemas/OnboardingCredentials"},"appState":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom state object that is guaranteed to survive the round-trip in the onboarding process.\r\nCalling application to the onboarding may pass here any data that it needs after the onboarding process is ready and user has been authenticated."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Provides the data for onboarding process for a company.\r\nOnboarding is the process where Salaxy gathers sufficient information to at least create an acccount,\r\noften even more so that the user can pay a salaary with the account."},"OnboardingContactVerification":{"type":"object","properties":{"pin":{"type":"string","description":"Given pin code."}},"additionalProperties":false,"description":"Contact verification object for single message type."},"OnboardingContactVerifications":{"type":"object","properties":{"email":{"description":"Verification for email contact.","$ref":"#/components/schemas/OnboardingContactVerification"},"telephone":{"description":"Verification for telephone contact.","$ref":"#/components/schemas/OnboardingContactVerification"}},"additionalProperties":false,"description":"Contact verification object for onboarding."},"OnboardingCredentials":{"type":"object","properties":{"credentialId":{"type":"string","description":"Identifier of the credentials (UserAccount Guid in the database)."},"partnerId":{"type":"string","description":"The partner that initiated the Onboarding process."}},"additionalProperties":false,"description":"Stores information about the credentials that were used in the Onboarding process."},"OnboardingStatus":{"enum":["created","open","error","cancel","done","expired"],"type":"string","description":"Database level status of Onboarding"},"OnboardingUIState":{"type":"object","properties":{"state":{"type":"string","description":"State of the user interface. Typically an enumeration that stores where the UI was. E.g. Wizard step."},"stateFullText":{"type":"string","description":"Full description of the user interface state for admin and analyses purposes."},"successUrl":{"type":"string","description":"URL where the user should be redirected back to when the onboarding process is complete."},"cancelUrl":{"type":"string","description":"URL where the user should be redirected back to if the process is canceled or there is an urecoverable error."},"oAuthResponseType":{"type":"string","description":"Response type to OAuth -request"},"invitationKey":{"type":"string","description":"Salaxy worker invitation key that points to a Salary slip / calculation that the user is coming to fetch \r\nin this onboarding process. The Onboarding data is prefilled with the data from th Salary calculation."}},"additionalProperties":false,"description":"Stores data for the onboarding user interface."},"OpenIdUserInfoAddress":{"type":"object","properties":{"street_address":{"type":"string","description":"Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information."},"locality":{"type":"string","description":"City or locality component."},"postal_code":{"type":"string","description":"Zip code or postal code component."}},"additionalProperties":false,"description":"The Address Claim represents a physical mailing address in OpenID Connect UserInfo response message.\r\nThis object is modeled according to: http://openid.net/specs/openid-connect-basic-1_0.html#AddressClaim"},"OpenIdUserInfoSupportedClaims":{"required":["sub"],"type":"object","properties":{"iss":{"type":"string","description":"REQUIRED. Issuer Identifier for the Issuer of the response. \r\nThe iss value is a case-sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components."},"aud":{"type":"string","description":"In Salaxy federation this should be the federation endpoint: \"https://secure.salaxy.com/security/federation\" in production\r\nOR \"https://test-api.salaxy.com/security/federation\" in the test environment.\r\nFrom the spec: REQUIRED. Audience(s) that this ID Token is intended for. \r\nIt MUST contain the OAuth 2.0 client_id of the Relying Party as an audience value. \r\nIt MAY also contain identifiers for other audiences.\r\nIn the general case, the aud value is an array of case-sensitive strings.\r\nIn the common special case when there is one audience, the aud value MAY be a single case-sensitive string."},"exp":{"type":["null","number"],"description":"REQUIRED. Expiration time on or after which the ID Token MUST NOT be accepted for processing. \r\nThe processing of this parameter requires that the current date/time MUST be before the expiration date/time listed in the value.\r\nImplementers MAY provide for some small leeway, usually no more than a few minutes, to account for clock skew. \r\nIts value is a JSON [RFC7159] number representing the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time.\r\nSee RFC 3339 [RFC3339] for details regarding date/times in general and UTC in particular.","format":"double"},"sub":{"type":"string","description":"REQUIRED. Subject - Identifier for the End-User at the Issuer."},"name":{"type":"string","description":"End-User's full name in displayable form including all name parts, possibly including titles and suffixes, \r\nordered according to the End-User's locale and preferences.\r\nNOTE: In creating account etc., Salaxy will use given_name and family_name separately and therefore ignore the name."},"given_name":{"type":"string","description":"Given name(s) or first name(s) of the End-User."},"family_name":{"type":"string","description":"Surname(s) or last name(s) of the End-User."},"picture":{"type":"string","description":"URL of the End-User's profile picture.\r\nThis URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image."},"email":{"type":"string","description":"End-User's preferred e-mail address.\r\nIts value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax.\r\nThe RP MUST NOT rely upon this value being unique, as discussed in Section 2.5.3."},"email_verified":{"type":["null","boolean"],"description":"True if the End-User's e-mail address has been verified; otherwise false. \r\nIMPORTANT: In Salaxy federation context, avoid sending non-confirmed e-mails. This may later become an error without being considered a breaking change.\r\nWhen this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. \r\nThe means by which an e-mail address is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating."},"birthdate":{"type":["null","string"],"description":"End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.\r\nThe year MAY be 0000, indicating that it is omitted.\r\nTo represent only the year, YYYY format is allowed.\r\nNote that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.","format":"date-time"},"locale":{"type":"string","description":"End-User's locale, represented as a BCP47 [RFC5646] language tag.\r\nThis is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash.\r\nFor example, en-US or fr-CA."},"phone_number":{"type":"string","description":"End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400.\r\nIf the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678."},"phone_number_verified":{"type":["null","boolean"],"description":"True if the End-User's phone number has been verified; otherwise false.\r\nWhen this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed.\r\nThe means by which a phone number is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.\r\nWhen true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format."},"address":{"description":"End-User's preferred postal address.\r\nThe value of the address member is a JSON [RFC4627] structure containing some or all of the members defined in Section 2.5.1.","$ref":"#/components/schemas/OpenIdUserInfoAddress"},"updated_at":{"type":["null","number"],"description":"Time the End-User's information was last updated.\r\nIts value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time.","format":"double"},"company":{"description":"Salaxy extension to Open ID Connect UserInfo claims for Company federation.","$ref":"#/components/schemas/UserInfoCompanyAccount"},"person":{"description":"Salaxy extension to Open ID Connect UserInfo claims for Personal account federation.","$ref":"#/components/schemas/UserInfoPersonAccount"},"app":{"description":"Salaxy extension to Open ID Connect UserInfo claims for Application data.","$ref":"#/components/schemas/UserInfoApplication"}},"additionalProperties":false,"description":"Part of the OpenId specification that is supported by Salaxy federated authentication / Authorization."},"OrderByClause":{"required":["thenBy","expression","direction","rangeVariable"],"type":"object","properties":{"thenBy":{"$ref":"#/components/schemas/OrderByClause"},"expression":{"$ref":"#/components/schemas/SingleValueNode"},"direction":{"$ref":"#/components/schemas/OrderByDirection"},"rangeVariable":{"$ref":"#/components/schemas/RangeVariable"},"itemType":{"$ref":"#/components/schemas/IEdmTypeReference"}},"additionalProperties":false,"readOnly":true},"OrderByDirection":{"enum":["ascending","descending"],"type":"string","readOnly":true},"OrderByNode":{"type":"object","properties":{"direction":{"$ref":"#/components/schemas/OrderByDirection"}},"additionalProperties":false},"OrderByQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"orderByNodes":{"type":"array","items":{"$ref":"#/components/schemas/OrderByNode"},"readOnly":true},"rawValue":{"type":"string","readOnly":true},"validator":{"$ref":"#/components/schemas/IOrderByQueryValidator"},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"orderByClause":{"$ref":"#/components/schemas/OrderByClause"}},"additionalProperties":false,"readOnly":true},"OtherCompensationKind":{"enum":["undefined","meetingFee","lectureFee","positionOfTrustCompensation","accruedTimeOffCompensation","membershipOfGoverningBodyCompensation","monetaryGiftForEmployees","useCompensationAsEarnedIncome","useCompensationAsCapitalIncome","otherTaxableIncomeAsEarnedIncome","stockOptionsAndGrants","employeeInventionCompensation","capitalIncomePayment","workEffortBasedDividendsAsWage","workEffortBasedDividendsAsNonWage","employeeStockOption","employeeStockOptionWithLowerPrice","copyrightRoyaltiesEarnedIncome","stockGrantPaidInMoney","employeeStockOptionPaidInMoney"],"type":"string","description":"Kind for OtherCompensationUsecase."},"OtherCompensationUsecase":{"type":"object","properties":{"taxDefault":{"enum":["default","noTax","tax","taxDeduction"],"type":"string"},"kind":{"enum":["undefined","meetingFee","lectureFee","positionOfTrustCompensation","accruedTimeOffCompensation","membershipOfGoverningBodyCompensation","monetaryGiftForEmployees","useCompensationAsEarnedIncome","useCompensationAsCapitalIncome","otherTaxableIncomeAsEarnedIncome","stockOptionsAndGrants","employeeInventionCompensation","capitalIncomePayment","workEffortBasedDividendsAsWage","workEffortBasedDividendsAsNonWage","employeeStockOption","employeeStockOptionWithLowerPrice","copyrightRoyaltiesEarnedIncome","stockGrantPaidInMoney","employeeStockOptionPaidInMoney"],"type":"string"}},"additionalProperties":false},"OwnedCompanyInfo":{"type":"object","properties":{"totalNumberOfShares":{"type":["null","integer"],"description":"Total count of shares.","format":"int32"}},"additionalProperties":false,"description":"Contains additional info of the owned company."},"Ownership":{"type":"object","properties":{"isRequiredTracking":{"type":"boolean","description":"If true, authorities require tracking the shareholders.\r\nIn Finland, with current legistlation, this is if a shareholder has over 25% of the shares."},"shareHolders":{"type":"array","items":{"$ref":"#/components/schemas/Shareholder"},"description":"List of shareholders for the company"}},"additionalProperties":false},"PageResultOfAccountingTargetListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountingTargetListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfApiListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ApiListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfBrandListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BrandListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfCalculationListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CalculationListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfDatasetListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DatasetListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfEmploymentListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EmploymentListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfFileListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FileListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfHolidayYearListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/HolidayYearListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfHouseholdYearListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/HouseholdYearListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfInvoiceListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfMessageListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MessageListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfPaymentMessageListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMessageListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfPayrollListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PayrollListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfPrimaryPartnerListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PrimaryPartnerListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfRecordListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RecordListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfReferenceObjectListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceObjectListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfServiceModelListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ServiceModelListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfTaskDefinitionListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TaskDefinitionListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfTaskRunListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TaskRunListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfTaxcardListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TaxcardListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfTemplateListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TemplateListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PageResultOfUsecaseListItem":{"required":["items","nextPageLink","count"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UsecaseListItem"}},"nextPageLink":{"type":"string","format":"uri"},"count":{"type":["null","integer"],"format":"int64"}},"additionalProperties":false},"PaidSickLeaveKind":{"enum":["undefined","paidSickLeaveSalary","paidSickLeaveHourlySalary","paidSickLeaveMonthlySalary"],"type":"string","description":"Kind for PaidSickLeave."},"PaidSickLeaveUsecase":{"type":"object","properties":{"unit":{"enum":["undefined","hours","days","weeks","period","one","count","percent","kilometers","euro"],"type":"string"},"kind":{"enum":["undefined","paidSickLeaveSalary","paidSickLeaveHourlySalary","paidSickLeaveMonthlySalary"],"type":"string"}},"additionalProperties":false},"PartnerCompanyAccountInfo":{"type":"object","properties":{"accountId":{"type":"string","description":"Account Id"},"accountIdFormatted":{"type":"string","description":"Account Id formatted for dispaly to end user"},"avatar":{"description":"Avatar for display information","$ref":"#/components/schemas/Avatar"},"isVerified":{"type":"boolean","description":"If true, the account has a verified owner."},"isAuthorized":{"type":"boolean","description":"If true, the current user (the partner) is authorized to access the account"},"partnerAccountId":{"type":"string","description":"The partner account ID to which the access is currently restricted."}},"additionalProperties":false,"description":"Information about a Customer account for a Partner"},"PartnerServiceModel":{"type":"object","properties":{"features":{"description":"The main product package that defines the product features.","$ref":"#/components/schemas/ServiceModelFeatures"},"pricing":{"description":"Picing settings.","$ref":"#/components/schemas/ServiceModelPricing"},"branding":{"description":"Partner branding settings: site logo, css etc.","$ref":"#/components/schemas/ServiceModelBranding"},"site":{"description":"Default site for customers.","$ref":"#/components/schemas/ServiceModelSite"}},"additionalProperties":false,"description":"Defines how the primary partner services the customer\r\nTODO: To be designed, see G:\\My Drive\\Tech\\Phase 7\\Settings\\Palvelumallit.pptx"},"PathString":{"type":"object","properties":{"value":{"type":["null","string"],"readOnly":true},"hasValue":{"type":"boolean","readOnly":true}},"additionalProperties":false},"PaymentChannel":{"enum":["undefined","test","zeroPayment","external","palkkausManual","palkkausWS","palkkausPersonal","palkkausInvoices","palkkausPSD","palkkausCfaPaytrail","palkkausCfaReference","palkkausCfaFinvoice","palkkausEcfaPaytrail","palkkausEcfaReference","palkkausEcfaFinvoice","palkkausCfaTest","accountorGo","talenomOnline","talenomCfa","holviCfa","finagoSolo","procountor","kevytyrittaja","vismaNetvisor","askelma","briox","lemonaid","laskupiste","holvi","kompassi","domus","passeliMerit","odoo","ecom","kitsas","talenomManual","hausvise","nordea","easorPro","laskusankari","billiPro","viilu","aallonAvalo","noCfo"],"type":"string","description":"Different payment channels that receive Invoices and handle their payment."},"PaymentChannelConfig":{"type":"object","properties":{"channel":{"description":"Payment channel of the config. Set from the path; a value in a request must match the path.","$ref":"#/components/schemas/PaymentChannel"},"debitAccount":{"oneOf":[{"type":"null"},{"description":"Account the channel debits. No fallback to the company account. Required when the channel declares it\r\n(PaymentChannelDefinitions.ConfigFields); otherwise null when not given.","$ref":"#/components/schemas/PaymentChannelDebitAccount"}]},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"The values the channel declares (PaymentChannelDefinitions.ConfigFields); no other key is accepted. Nordea CA Lite:\r\nagreementId, the CCM agreement ID, to pain.001 Dbtr/Id (scheme BANK)."},"createdAt":{"type":["null","string"],"description":"When the config was created. Set by the server.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"When the config was last written. Set by the server.","format":"date-time"}},"additionalProperties":false,"description":"Payment channel config: the payer company's own values that a payment channel needs to pay for it, such as the ID the\r\nprovider gave the company and the account the provider debits. Given by the company or its provider, never inherited\r\nthrough a service model. Stored in the company settings, payments.channelConfigs[]; a company has at most one config\r\nper channel."},"PaymentChannelDebitAccount":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN, stored in electronic format (no spaces)."},"bic":{"type":"string","description":"BIC. Filled from the IBAN on save when missing; a given value must match the IBAN's bank."}},"additionalProperties":false,"description":"The account a payment channel config debits."},"PaymentChannelSettings":{"type":"object","properties":{"channel":{"description":"Identifies the channel","$ref":"#/components/schemas/PaymentChannel"},"isEnabled":{"type":"boolean","description":"If true, the channel is enabled for the current user"},"isAvailable":{"type":"boolean","description":"Read-only property that tells whether the payment channel is available in the current session."},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data"},"paymentMessages":{"description":"Payment-message (maksuaineisto) settings of the channel for this account. Null = the channel defaults.\r\nNull on save means \"keep the stored value\".","$ref":"#/components/schemas/PaymentMessageChannelSettings"}},"additionalProperties":false,"description":"Channel-specific payment settings"},"PaymentMessage":{"type":"object","properties":{"id":{"type":"string","description":"Id of the message. The MsgId in the file is \"SX-\" + id."},"displayNumber":{"type":"integer","description":"Running number per channel and payer.","format":"int64"},"channel":{"description":"Payment channel.","$ref":"#/components/schemas/PaymentChannel"},"status":{"type":"string","description":"Status. The set is open: treat an unknown value as \"unknown - take no action\", never as an error."},"format":{"type":"string","description":"ISO 20022 format of the file, e.g. pain.001.001.02."},"fileName":{"type":"string","description":"File name of the download, from the channel's fileName setting."},"created":{"type":"string","description":"Creation time (UTC).","format":"date-time"},"parentMessageId":{"type":"string","description":"Id of the message this one resends, or null."},"supersededByMessageIds":{"type":"array","items":{"type":"string"},"description":"Ids of the resends of this message, oldest first."},"transactionCount":{"type":"integer","description":"Number of transactions (invoices).","format":"int32"},"totalAmount":{"type":"number","description":"Sum of the transactions.","format":"double"},"batches":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMessageBatch"},"description":"Batches (PmtInf) of the file."},"transactionIds":{"type":"array","items":{"type":"string"},"description":"Invoice ids in the message: the frozen snapshot."},"excluded":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMessageExclusion"},"description":"Resend only: the parent's transactions that this message left out, and why."}},"additionalProperties":false,"description":"A payment message (maksuaineisto) with its batches and transaction ids. Lists return PaymentMessageListItem from the\r\nsearch index instead."},"PaymentMessageBatch":{"type":"object","properties":{"pmtInfId":{"type":"string","description":"PmtInfId in the file."},"status":{"type":"string","description":"Status of the batch (open set)."},"debtorAccount":{"type":"string","description":"Debtor account (IBAN)."},"requestedExecutionDate":{"type":"string","description":"Requested execution date, yyyy-MM-dd."},"paymentType":{"description":"Payment type: the invoice type.","$ref":"#/components/schemas/InvoiceType"},"transactionCount":{"type":"integer","description":"Number of transactions in the batch.","format":"int32"},"totalAmount":{"type":"number","description":"Sum of the transactions in the batch.","format":"double"},"rejectionReason":{"type":"string","description":"The bank's rejection reason, or null."}},"additionalProperties":false,"description":"A batch (erä, one PmtInf) of a payment message."},"PaymentMessageChannelInfo":{"type":"object","properties":{"channel":{"description":"Channel.","$ref":"#/components/schemas/PaymentChannel"},"uiActions":{"type":"array","items":{"type":"string"},"description":"Allowed actions: create, download, resend, markPaid, cancel."},"splitBy":{"type":"array","items":{"type":"string"},"description":"Split keys of a create: paymentType, executionDate, payroll."},"format":{"type":"string","description":"ISO 20022 format of new messages."},"fileName":{"type":"string","description":"File-name pattern of new messages."},"createsAutomatically":{"type":"boolean","description":"True if the server puts the channel's new invoices into messages by itself."}},"additionalProperties":false,"description":"The effective payment-message settings of one channel for the current company: the channel default, narrowed by\r\nthe company's settings and its service model. The UI shows only the allowed actions."},"PaymentMessageChannelSettings":{"type":"object","properties":{"partitionPolicy":{"type":"string","description":"\"accept\": a message may span partitions (one file, several batches). \"reject\": a create whose invoices span\r\npartitions is refused with the partitions. Null = the channel default."},"uiActions":{"type":"array","items":{"type":"string"},"description":"Allowed actions: create, download, resend, markPaid, cancel. Can only remove actions from the channel default; an\r\naction that the channel does not allow is ignored. Null = the channel default; an empty list allows nothing."},"splitBy":{"type":"array","items":{"type":"string"},"description":"Split of the messages: paymentType, executionDate, payroll. A message always holds one owner. Null = the channel\r\ndefault; an empty list = no split (one message per owner). A list replaces the default."},"format":{"type":"string","description":"ISO 20022 format of new messages, e.g. pain.001.001.02. Must be one the channel allows. Null = the channel default."},"fileName":{"type":"string","description":"File-name pattern of a downloaded message, e.g. \"SEPA_{displayNumber}.xml\". Placeholders: {displayNumber}, {msgId},\r\n{businessId}, {iban}, {bic}, {created} (yyyyMMdd). \".xml\" is added if missing. Null = the channel default."}},"additionalProperties":false,"description":"Account-tier settings of a channel's payment messages (maksuaineisto). A null value uses the channel default in\r\nPaymentChannelDefinitions."},"PaymentMessageCompanyCreateRequest":{"type":"object","properties":{"channel":{"oneOf":[{"type":"null"},{"description":"Channel of the invoices. Required with invoiceIds.","$ref":"#/components/schemas/PaymentChannel"}]},"invoiceIds":{"type":"array","items":{"type":"string"},"description":"Ids of unread invoices of one payer that are not in any payment message."},"parentMessageId":{"type":"string","description":"Id of the message to resend."}},"additionalProperties":false,"description":"Company-side create: the channel and invoiceIds (a new message, split by the channel's splitBy into one or more\r\nmessages), or parentMessageId (a resend; the channel comes from the parent)."},"PaymentMessageCompanyCreateResult":{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMessage"},"description":"The created messages; one for a resend."}},"additionalProperties":false,"description":"Result of a company-side create: the messages created, in the order of the split (date, type, payroll)."},"PaymentMessageCreateRequest":{"type":"object","properties":{"invoiceIds":{"type":"array","items":{"type":"string"},"description":"Ids of unread invoices of one payer that are not in any payment message."},"parentMessageId":{"type":"string","description":"Id of the message to resend."}},"additionalProperties":false,"description":"Request to create a payment message (maksuaineisto): invoiceIds to create one from invoices, or parentMessageId to\r\nresend a message. Exactly one of them. A resend takes the parent's transactions for which no money moved or is about\r\nto move; the server picks them."},"PaymentMessageData":{"type":"object","properties":{"channel":{"description":"Payment channel.","$ref":"#/components/schemas/PaymentChannel"},"displayNumber":{"type":["null","integer"],"description":"Running number per channel and payer.","format":"int32"},"transactionCount":{"type":["null","integer"],"description":"Number of transactions (invoices).","format":"int32"},"format":{"type":"string","description":"ISO 20022 format of the file, e.g. pain.001.001.03."},"fileName":{"type":"string","description":"File name of the download."},"parentMessageId":{"type":"string","description":"Id of the message this one resends, or null."},"supersededByMessageIds":{"type":"array","items":{"type":"string"},"description":"Ids of the resends of this message, oldest first."}},"additionalProperties":false,"description":"List data of a payment message in the search index (RND-4993). Written as business attributes by\r\nPaymentMessageContainer.UpdateSearchIndex; the property names are the attribute names."},"PaymentMessageExclusion":{"type":"object","properties":{"invoiceId":{"type":"string","description":"Invoice id: one of the parent message's TransactionIds."},"reason":{"type":"string","description":"Why the transaction was left out. Open string set, see PaymentMessageExclusionReason."}},"additionalProperties":false,"description":"A transaction of the parent message that a resend left out, and why."},"PaymentMessageListItem":{"type":"object","properties":{"parentDisplayNumber":{"type":["null","integer"],"description":"Display number of the message this one resends, if the caller can see it. Filled by the list, not stored in the index.","format":"int32"},"supersededByDisplayNumbers":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Display numbers of the visible resends of this message, oldest first. Filled by the list, not stored in the index."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/PaymentMessageData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"A payment message in a list (RND-4993): a search-index row with its owner. The Pro, company and payment-channel lists\r\nreturn it. Get, patch and the file read the table, which the index follows about a second later."},"PaymentMessagePatch":{"type":"object","properties":{"status":{"type":"string","description":"New status."}},"additionalProperties":false,"description":"Status change of a payment message. Writable: sent (after fetching the file, on a channel without bank feedback),\r\ncancellationRequested, and executed (mark paid) where the channel allows it. Other statuses come from the bank."},"PaymentSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"customerFunds":{"description":"Settings related to payment methods that use the customer funds account (gross payment).","$ref":"#/components/schemas/CustomerFundsSettings"},"invoice":{"description":"Settings related to invoices: Either salary payment or other invoicing.","$ref":"#/components/schemas/InvoiceSettings"},"defaultChannel":{"description":"The default channel when making payments.","$ref":"#/components/schemas/PaymentChannel"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/PaymentChannelSettings"},"description":"Channel specific settings."},"channelConfigs":{"type":"array","items":{"$ref":"#/components/schemas/PaymentChannelConfig"},"description":"The company's own values per payment channel, at most one per channel. Written only through\r\n/v04/api/settings/payment-channels/{channel}/config. A whole-settings save ignores this field and keeps the stored entries."}},"additionalProperties":false,"description":"Payment related settings."},"Payroll03Info":{"type":"object","properties":{"date":{"type":["null","string"],"description":"Date that the Info was last updated.","format":"date-time"},"calcCount":{"type":"integer","description":"Count of calculations in this Payroll","format":"int32"},"totalGrossSalary":{"type":"number","description":"Total gross salary","format":"double"},"totalPayment":{"type":"number","description":"Total payment for the Payroll.","format":"double"},"fees":{"type":"number","description":"Total Palkkaus.fi fees for the Payroll","format":"double"},"isReadyForPayment":{"type":"boolean","description":"If true, all calculations have been validated and they are valid for payment.\r\nIf false, validation has not been done or some calculations are not valid for payment."},"status":{"description":"Status for the payroll and its calculations in the payment Workflow.","$ref":"#/components/schemas/PayrollStatus"},"dueDate":{"type":["null","string"],"description":"Due date for the payroll. Date when the payment should be made to achieve SalaryDate.","format":"date"},"paymentDate":{"type":["null","string"],"description":"Paid at date for the payroll. (Date of the employer's payment).","format":"date"},"salaryDate":{"type":["null","string"],"description":"The estimated date when the salary is withdrawable by the worker.","format":"date"},"paymentId":{"type":"string","description":"The reference number of the payment after payment is made."},"originalPaymentId":{"type":"string","description":"Original Payment reference number"},"applicationId":{"type":"string","description":"Application id for invoicing etc. purposes."},"messageThreadId":{"type":"string","description":"The MessageThread Id, if this payroll is referred in a message thread."}},"additionalProperties":false,"description":"Provides Read-only information about the Payroll\r\nIn the case of non-paid Payrolls, this is the latest save/validation.\r\nIn the case of paid Payrolls, this is the status of the Payroll when it was paid."},"PayrollCalculationsSaveOptions":{"type":"object","properties":{"isMerge":{"type":"boolean"},"rowMergeOption":{"enum":["undefined","removeAllRows","removeImportedRows"],"type":"string"},"sourceId":{"type":["null","string"]},"applyEmploymentDefaultRows":{"type":"boolean"},"applyWorktime":{"type":"boolean"}},"additionalProperties":false},"PayrollData":{"type":"object","properties":{"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"title":{"type":"string","description":"Title that can be specified by the end user."},"wageBasis":{"description":"What types of wages are paid with this payroll.\r\nMay affect the rendering of the user interface (e.g. for     holidays, hours and absences).\r\nAlso affects which Workers are show in the add / link dialog by default.","$ref":"#/components/schemas/WageBasis"},"dueDate":{"type":["null","string"],"description":"Due date for the payroll. Date when the payment should be made to achieve SalaryDate.","format":"date"},"isReady":{"type":["null","boolean"],"description":"If true, all calculations have been validated and they are valid for payment.\r\nIf false, validation has not been done or some calculations are not valid for payment."},"paymentDate":{"type":["null","string"],"description":"Paid at date for the payroll. (Date of the employer's payment).","format":"date"},"periodStart":{"type":["null","string"],"description":"Start date of the default salary period","format":"date"},"periodEnd":{"type":["null","string"],"description":"End date of the default salary period","format":"date"},"calcCount":{"type":["null","integer"],"description":"Count of calculations in this Payroll","format":"int32"},"template":{"type":"string","description":"If the Payroll is based on a template, this is the identifier of the template."},"messageThreadId":{"type":"string","description":"The MessageThread Id, if this payroll is referred in a message thread."},"paymentChannel":{"oneOf":[{"type":"null"},{"description":"Payment channel.","$ref":"#/components/schemas/PaymentChannel"}]},"inputSalaryDate":{"type":["null","string"],"description":"The requested salary date.","format":"date-time"},"originalSalaryDate":{"type":["null","string"],"description":"The first requested or calculated salary date: a recalculation does not change it, a user who moves the requested date does.","format":"date-time"},"salaryDateKind":{"description":"Defines the re-setting of the salary date in the calculation re-calculation.","$ref":"#/components/schemas/SalaryDateKind"}},"additionalProperties":false,"description":"Payroll specific business data for index."},"PayrollDetails":{"type":"object","properties":{"input":{"description":"Input that defines the Payroll.","$ref":"#/components/schemas/PayrollInput"},"info":{"description":"General summary information about the Payroll and when it was las processed.","$ref":"#/components/schemas/Payroll03Info"},"calcs":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"},"description":"Snapshots of the calculations based on the ID's specified in Info"},"validations":{"type":"array","items":{"$ref":"#/components/schemas/ApiListItemValidation"},"description":"When saved or validated, provides a validation object for each calculation:\r\nWhether the calculations are ready for payment."},"usecase":{"description":"A usecase for creating and editing Payroll lists.\r\nIn practice, a usecase is either a user interface or a microservice that provides a Payroll processing\r\nand it may be implemented outside Salaxy.\r\nProvides the possibility to store useacase specific data as part of the Payroll.","$ref":"#/components/schemas/UsecaseData"},"workflowData":{"description":"The workflow data for manual editing and approval purposes.","$ref":"#/components/schemas/WorkflowData"},"calculationsFetched":{"type":"boolean","description":"Boolean indicating if the calculations are fetched from the storage."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"New version 03 of Payroll. Payroll (Palkkalista) is a list of employees who receive salary or wages from a particular organization.\r\nTypical usecase is that a a company has e.g. a monthly salary list that is paid\r\nat the end of month. For next month, a copy is then made from the latest list and\r\nthe copy is potentially modified with the changes of that particular month."},"PayrollInput":{"type":"object","properties":{"title":{"type":"string","description":"Title that can be specified by the end user."},"period":{"description":"The Default Salary period for the Payroll.\r\nThis may be overriden for an individual calculation.","$ref":"#/components/schemas/DateRange"},"salaryDate":{"type":["null","string"],"description":"The requested date for the SalaryDate from the employer.","format":"date"},"salaryDateKind":{"description":"Defines the re-setting of the salary date in the calculation re-calculation.","$ref":"#/components/schemas/SalaryDateKind"},"paymentChannel":{"description":"Channel that is used for payment.","$ref":"#/components/schemas/PaymentChannel"},"wageBasis":{"description":"What types of wages are paid with this payroll.\r\nMay affect the rendering of the user interface (e.g. for holidays, hours and absences).\r\nAlso affects which Workers are show in the add / link dialog by default.","$ref":"#/components/schemas/WageBasis"},"noUpdateFromEmployment":{"type":"boolean","description":"If true, the calculation rows are not updated from employment when the Payroll is copied.\r\nDefault is that the rows and other data is updated in copy / create new etc."},"template":{"type":"string","description":"If the Payroll is based on a template, this is the identifier of the template.\r\nThe field can be manually set to null / ID to break / reconnect that connection."},"calculations":{"type":"array","items":{"type":"string"},"description":"List of calculations that are attached to this calculation."},"sourceId":{"type":"string","description":"Identifier of the payroll in a source system. Used in imports etc."}},"additionalProperties":false,"description":"Input that user defines about the Payroll"},"PayrollListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/PayrollStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/PayrollData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of payrolls in the user interface.\r\nIt contains header data of the payroll and is basis for searching, filtering and sorting."},"PayrollStatus":{"enum":["draft","paymentStarted","paymentSucceeded","paymentCanceled","paymentError","paymentAllowed","waitingApproval","waitingPartnerApproval","handled","template"],"type":"string","description":"Status for the payroll"},"PayStatsCalculationReportData":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PayStatsCalculationReportDataResult"},"description":"Detailed calculation data with rows on which the pay stats calculation is based."}},"additionalProperties":false,"description":"Report for containing all the result data and rules for the pay stats calculation."},"PayStatsCalculationReportDataCalc":{"type":"object","properties":{"calculationId":{"type":"string","description":"Calculation id."},"calculationTitle":{"type":"string","description":"Calculation title."},"salaryDate":{"type":["null","string"],"description":"Calculation salary date.","format":"date-time"},"workStartDate":{"type":["null","string"],"description":"Calculation work start date.","format":"date-time"},"workEndDate":{"type":["null","string"],"description":"Calculation work end date.","format":"date-time"},"salary":{"type":"number","description":"Total salary in the calculation which is calculated into the pay stats type.","format":"double"},"workingTime":{"type":"number","description":"Total hours in the calculation which is calculated into the pay stats type.","format":"double"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/PayStatsCalculationReportDataCalcRow"},"description":"Detailed row data on which the pay stats calculation is based."}},"additionalProperties":false,"description":"Detailed calculation data with rows on which the pay stats calculation is based."},"PayStatsCalculationReportDataCalcRow":{"type":"object","properties":{"irRow":{"description":"The row of the calculation.","$ref":"#/components/schemas/IrRow"},"salaryType":{"type":"string","description":"Matching RowType, Type or IncomeType which accumulates salary."},"workingTimeType":{"type":"string","description":"Matching RowType, Type or IncomeType which accumulates working time."},"salary":{"type":"number","description":"Total salary which is calculated into the pay stats type.","format":"double"},"workingTime":{"type":"number","description":"Total working time which is calculated into  the pay stats type.","format":"double"}},"additionalProperties":false,"description":"Detailed row data on which the pay stats calculation is based."},"PayStatsCalculationReportDataResult":{"type":"object","properties":{"calculations":{"type":"array","items":{"$ref":"#/components/schemas/PayStatsCalculationReportDataCalc"},"description":"Detailed calculation data with rows on which the pay statistics calculation is based."},"type":{"description":"Settings for the type of the pay statistics.","$ref":"#/components/schemas/PayStatsTypeDefinition"},"start":{"type":"string","description":"Start date (included) of the period","format":"date"},"end":{"type":"string","description":"End date (included) of the period.","format":"date"},"salary":{"type":"number","description":"Total salary in the calculation which is calculated into the pay statistics type.","format":"double"},"workingTime":{"type":"number","description":"Total working time in the calculation which is calculated into the pay statistics type.","format":"double"},"result":{"type":"number","description":"Total result of the pay statistics calculation, e.g. average hourly pay for the period.","format":"double"},"updatedAt":{"type":"string","description":"Last time the result was created/updated.","format":"date-time"}},"additionalProperties":false,"description":"Report for containing all the result data and rules for the pay stats calculation."},"PayStatsKind":{"enum":["undefined","averageHourlyPay","script"],"type":"string","description":"Pay statistic types."},"PayStatsPeriodLength":{"enum":["undefined","year","halfYear","quarter","month","lastPayPeriod","holidayYear","other"],"type":"string","description":"Period length for the pay statistic."},"PayStatsSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"types":{"type":"array","items":{"$ref":"#/components/schemas/PayStatsTypeDefinition"},"description":"Settings for different types of pay statistics."}},"additionalProperties":false,"description":"Settings for the calculation of pay statistics."},"PayStatsTypeDefinition":{"type":"object","properties":{"id":{"type":"string","description":"Id for the pay statistics type."},"description":{"type":"string","description":"Description for the pay statistics type, e.g. \"Average hourly pay for the period\"."},"kind":{"description":"The pay statistics type.","$ref":"#/components/schemas/PayStatsKind"},"cbaCode":{"type":["null","integer"],"description":"Applicable collective agreement","format":"int32"},"employeeGroup":{"type":"string","description":"Employee group."},"disabled":{"type":"boolean","description":"Flag for disabling the definition."},"startDate":{"type":["null","string"],"description":"If specified, defines the start date for the settings.\r\nIf in the future, the the settings is inactive. Null (default) means the settings is valid indefinetely from the past.","format":"date"},"endDate":{"type":["null","string"],"description":"If specified, defines the end date for the settings. \r\nDate is inclusive meaning that if EndDate is 31.12., settings is valid until end-of-year: Valid on 31.12. and invalid 1.1.\r\nIf in the past, the the settings is inactive. Null (default) means the settings is valid indefinetely to future.","format":"date"},"periodLength":{"description":"Period type for the pay statistics calculation.\r\nPlease note that currently this is on purpose a different enum than the PeriodType which is used for retrieving accounting reports etc.","$ref":"#/components/schemas/PayStatsPeriodLength"},"periodDateKind":{"description":"Date kind for the period.","$ref":"#/components/schemas/PeriodDateKind"},"workingTimeTypes":{"type":"array","items":{"type":"string"},"description":"RowTypes, WageTypes or IncomeTypes that are used in the statistics calculation."},"minWorkingTime":{"type":["null","number"],"description":"Minimum working time required for the statistics calculation.","format":"double"},"salaryTypes":{"type":"array","items":{"type":"string"},"description":"RowTypes, WageTypes or IncomeTypes that are used in the statistics calculation and which accumulate salary."},"script":{"type":"string","description":"Script for the pay statistics calculation. Used if PayStatsKind PayStatsTypeDefinition.Kind is PayStatsKind.Script."}},"additionalProperties":false,"description":"Settings for different types of pay statistics."},"PayStatsUsecase":{"type":"object","properties":{"id":{"type":["null","string"]},"periodLength":{"enum":["undefined","year","halfYear","quarter","month","lastPayPeriod","holidayYear","other"],"type":"string"},"periodDateKind":{"enum":["paidAtDate","salaryDate","workDate","workDateStart","workDateEnd"],"type":"string"},"kind":{"enum":["undefined","averageHourlyPay","script"],"type":"string"}},"additionalProperties":false},"PensionCalculation":{"enum":["undefined","employee","entrepreneur","farmer","partialOwner","athlete","compensation","boardRemuneration","smallEntrepreneur","smallFarmer","publicSector"],"type":"string","description":"Pension calculation type."},"PensionCompany":{"enum":["none","etera","ilmarinen","elo","pensionsAlandia","varma","veritas","apteekkien","verso","kevaMunicipal","kevaAland","kevaChurch","kevaKela","kevaState","valio","other"],"type":"string","readOnly":true},"PensionContract":{"type":"object","properties":{"company":{"description":"The pension company where the user has a contract.","$ref":"#/components/schemas/PensionCompany"},"contractNumber":{"type":"string","description":"The pension contract number that should be validated accordingly.","format":"pension-contract-number"},"subOrgCode":{"type":"string","description":"Sub organization code for the Incomes Registry."},"pensionDiscountPercent":{"type":"number","description":"Pension discount percent.","format":"percent"},"pensionPercent":{"type":["null","number"],"description":"Custom pension percent.","format":"percent"},"pensionDefaultPercent":{"type":"number","description":"Read only pension percent which is valid if pension percent is not set.","format":"percent","readOnly":true},"id":{"type":"string","description":"Unique identifier (guid) for the contract.\r\nThe value is automaticallyh added on the server side: Any input is ignored/invalid. Set as null for new contracts."},"status":{"description":"Status of the contract","$ref":"#/components/schemas/SettingsStatus"},"startDate":{"type":["null","string"],"description":"If specified, defines the start date for the contract.\r\nIf in the future, the the contract is inactive. Null (default) means the contract is valid indefinetely from the past.","format":"date"},"endDate":{"type":["null","string"],"description":"If specified, defines the end date for the contract. \r\nDate is inclusive meaning that if EndDate is 31.12., contract is valid until end-of-year: Valid on 31.12. and invalid 1.1.\r\nIf in the past, the the contract is inactive. Null (default) means the contract is valid indefinetely to future.","format":"date"}},"additionalProperties":false,"description":"Defines a pension contract."},"PensionEntrepreneurProduct":{"type":"object","properties":{"status":{"type":"string","readOnly":true},"tempContractMarker":{"type":"boolean","description":"If true, user wants to order a YEL-contract."},"enabled":{"type":"boolean","description":"Enabled property set automatically by TempContractMarker."},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false},"PensionProduct":{"type":"object","properties":{"status":{"type":"string","readOnly":true},"isPensionContractDone":{"type":"boolean","description":"The use has a pension contract done (as opposed to acting as a temporary employer that pays the pension without a acontract)."},"pensionCompany":{"description":"The pension company where the user has a contract.","$ref":"#/components/schemas/PensionCompany"},"pensionContractNumber":{"type":"string","description":"Number for the contract."},"isPensionSelfHandling":{"type":"boolean","description":"If true, the user handles the reporting and payments himself/herself."},"isPendingContract":{"type":"boolean","description":"If true, there is a new pending contract."},"enabled":{"type":"boolean","description":"Enabled property set automatically by IsPensionSelfHandling."},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"Pension for Workers: The payments and monthly reporting."},"PensionRule":{"enum":["default","monthlyLowerLimit"],"type":"string","description":"Rules for pension calculation."},"PeriodDateKind":{"enum":["paidAtDate","salaryDate","workDate","workDateStart","workDateEnd"],"type":"string"},"PeriodRecalculationData":{"type":"object","properties":{"calc":{"description":"The salary calculation that should be recalculated.","$ref":"#/components/schemas/Calculation"},"employment":{"description":"Current employment data.","$ref":"#/components/schemas/Employment"},"holidayYear":{"description":"Holiday year with holidays that should be added as salary rows.\r\nIf not provided, holidays are not calculated.","$ref":"#/components/schemas/HolidayYear"},"absences":{"description":"Absences that should be deducted from monthly salary.\r\nIf not provided, absences are not calculated.","$ref":"#/components/schemas/WorkerAbsences"}},"additionalProperties":false,"description":"Data that is needed for determening PeriodRecalculationParams and thus at the end recalculating holidays and absences to a calculation."},"PeriodType":{"enum":["month","quarter","year","custom"],"type":"string","description":"Period names."},"PersonAccount":{"type":"object","properties":{"identity":{"description":"Information about the verification of the account. \r\nNOTE that this object may not be present in many method calls - this is because it contains confidential information.","$ref":"#/components/schemas/Identity"},"lastLoginAs":{"description":"Type of the last login - the user role","$ref":"#/components/schemas/WebSiteUserRole"},"contactVerificationPin":{"type":"string","description":"Contact verification pin for securing contact address changes."},"employerInfo":{"description":"The employer information in case the person is an employer","$ref":"#/components/schemas/EmployerInfo"},"entityType":{"description":"Entity type of the account.\r\nType PersonCreatedByEmployer means that the Worker has not yet signed into the system and there may be multiple instances of the same logical person (Official ID) - one for each employer.","$ref":"#/components/schemas/LegalEntityType"},"isEmployer":{"type":"boolean","description":"If true the object Account is and Employer account - it has the EmployerInfo object"},"isWorker":{"type":"boolean","description":"If true the object Account is and Worker account - it has the WorkerInfo object"},"isVerified":{"type":"boolean","description":"If true, the account has been verified. Typically this means a digitally signed contract.\r\nThis means that the account also has an Identity object.\r\nHowever, as the Identity object contains confidential information, it is not necessarily present in all method calls."},"avatar":{"description":"Avatar is the visual representation of the Account.","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the Account.","$ref":"#/components/schemas/Contact"},"language":{"description":"Language of the person/company.","$ref":"#/components/schemas/Language"},"serviceModelId":{"type":"string","description":"Service model for the account."},"workflowData":{"description":"Workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"An account for a Person - can be both Employer and Worker"},"PersonInput":{"type":"object","properties":{"doCreate":{"type":"boolean","description":"If true, creates a personal account based on this data.\r\nOtherwise this is just user data for Company."},"contact":{"description":"Contact information for the user / personal account","$ref":"#/components/schemas/Contact"},"contactVerification":{"description":"Verification objects for contact verification.","$ref":"#/components/schemas/OnboardingContactVerifications"},"personalId":{"type":"string","description":"Finnish Personal ID (Henkilötunnus /HETU)"},"officialName":{"type":"string","description":"This is an official name of the actor.\r\nIt originates from the YTJ or Bank authentication."},"resolvedId":{"type":"string","description":"If an object with the given PersonalId exists, it is resolved here: The unique ID is set here by the onboarding service. This field cannot be set."},"firstName":{"maxLength":100,"type":"string","description":"First name or company name"},"lastName":{"maxLength":100,"type":"string","description":"Last name, for companies, this should be null"},"picture":{"maxLength":512,"type":"string","description":"URL of the picture if specified as picture (null in a case of type Icon)"},"bankAccountIban":{"type":"string","description":"Bank account number for salary payment"},"bankAccountBic":{"type":"string","description":"BIC for salary payment"},"language":{"description":"Language of the person.","$ref":"#/components/schemas/Language"}},"additionalProperties":false},"PersonPricingPartner":{"type":"object","properties":{"accountId":{"type":"string","description":"Partner account id."},"pricingModel":{"description":"Pricing model by the partner.","$ref":"#/components/schemas/PricingModel"},"fixedFee":{"type":"number","description":"Fee for one calculation, which is visible and paid by customer.\r\nThis is not relevant if the PricingModel is PalkkausFee","format":"double"},"serviceModel":{"description":"Service model by the partner.","$ref":"#/components/schemas/LegacyServiceModel"},"serviceModelId":{"type":"string","description":"Service model by the partner."}},"additionalProperties":false,"description":"Legacy pricing partner information stored in the Person object"},"PipeReader":{"type":"string","format":"binary","readOnly":true},"PipeWriter":{"type":"object","properties":{"canGetUnflushedBytes":{"type":"boolean","readOnly":true},"unflushedBytes":{"type":"integer","format":"int64","readOnly":true}},"additionalProperties":false,"readOnly":true},"PlannedRowsRequest":{"type":"object","properties":{"calculation":{"description":"Calculation for the absence and holiday periods/compensations.","$ref":"#/components/schemas/Calculation"},"absencePeriods":{"type":"array","items":{"$ref":"#/components/schemas/AbsencePeriod"},"description":"Absence and holiday periods."},"holidayCompensations":{"type":"array","items":{"$ref":"#/components/schemas/HolidayCompensationPlan"},"description":"Planned holiday compensation payments."}},"additionalProperties":false,"description":"Request payload for planned rows."},"Preference":{"type":"object","properties":{"name":{"type":"string","description":"Name for the configuration."},"dataType":{"type":"string","description":"Type of the configuration data. It can be a value type or object type."},"data":{"type":"object","additionalProperties":false,"description":"Configuration data."},"updatedAt":{"type":["null","string"],"description":"Last time the preference was created/updated.","format":"date-time"},"updatedBy":{"type":"string","description":"User who last updated the configuration."}},"additionalProperties":false,"description":"Customer specific preferences."},"PricingModel":{"enum":["palkkausFee","noFee","fixedFee"],"type":"string","description":"Pricing model for the calculation."},"PricingProduct":{"type":"object","properties":{"status":{"type":"string","description":"Current status of pricing.","readOnly":true},"enabled":{"type":"boolean","description":"Enabled property set automatically if partner set and partner specific pricing model."},"pricingPartner":{"description":"Defines the pricing partner, service model and pricing model.","$ref":"#/components/schemas/PersonPricingPartner"},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"Defines the pricing partner, service model and pricing model."},"PrimaryPartnerData":{"type":"object","properties":{"key":{"type":"string","description":"Human-readable, human decided, recognizable short unique key for the partner:\r\nAll lower-case, a-z, 0-9, \"-\" and \"_\". Used in URL's etc."},"name":{"type":"string","description":"Display name for the account."},"description":{"type":"string","description":"Description of the primary account."}},"additionalProperties":false,"description":"Primary partner specific business data for index."},"PrimaryPartnerListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/PrimaryPartnerData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of primary partners in the user interface.\r\nIt contains all essential information of the report and is basis for searching, filtering and sorting."},"PrimaryPartnerSettings":{"type":"object","properties":{"accountId":{"type":"string","description":"Partner account id."},"info":{"description":"TODO: Consider is this the right place for the all this info or should we have only the input here.","$ref":"#/components/schemas/AccountantInfo"},"type":{"description":"If true, the accountant is a registered Palkkaus.fi account who typically has access to this account.","$ref":"#/components/schemas/AccountantType"},"serviceModelId":{"type":"string","description":"Id of the service model."},"serviceModel":{"description":"Defines the service model for the customer.","$ref":"#/components/schemas/PartnerServiceModel"}},"additionalProperties":false,"description":"Settings related to the primary partner, service model and settings"},"PublicKey":{"type":"object","properties":{"encodedKeyValue":{"$ref":"#/components/schemas/AsnEncodedData"},"encodedParameters":{"$ref":"#/components/schemas/AsnEncodedData"},"key":{"$ref":"#/components/schemas/AsymmetricAlgorithm"},"oid":{"$ref":"#/components/schemas/Oid"}},"additionalProperties":false,"readOnly":true},"QueryNodeKind":{"enum":["none","constant","convert","nonResourceRangeVariableReference","binaryOperator","unaryOperator","singleValuePropertyAccess","collectionPropertyAccess","singleValueFunctionCall","any","collectionNavigationNode","singleNavigationNode","singleValueOpenPropertyAccess","singleResourceCast","all","collectionResourceCast","resourceRangeVariableReference","singleResourceFunctionCall","collectionFunctionCall","collectionResourceFunctionCall","namedFunctionParameter","parameterAlias","entitySet","keyLookup","searchTerm","collectionOpenPropertyAccess","collectionComplexNode","singleComplexNode","count","singleValueCast","collectionPropertyNode","aggregatedCollectionPropertyNode","in","collectionConstant"],"type":"string","readOnly":true},"QueryString":{"type":"object","properties":{"value":{"type":["null","string"],"readOnly":true},"hasValue":{"type":"boolean","readOnly":true}},"additionalProperties":false},"RangeVariable":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"typeReference":{"$ref":"#/components/schemas/IEdmTypeReference"},"kind":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"readOnly":true},"ReadOnlyMemoryOfbyte":{"type":"string","readOnly":true},"Record":{"type":"object","properties":{"otherId":{"type":"string","description":"Salaxy ID of the worker / other paty. This value is required when inserting and cannot be edited later.\r\nWorkerSnapshot is automatically updated upon save."},"entityId":{"type":"string","description":"Optional entity id, for example the employment relation for the worker."},"entityType":{"type":"string","description":"Entity type of the business object, which the records are targeted to."},"recordType":{"type":"string","description":"Record type. This should be based on customer specific enumeration."},"startDate":{"type":["null","string"],"description":"Start date of the record.","format":"date"},"endDate":{"type":["null","string"],"description":"End date of the record.","format":"date"},"title":{"type":"string","description":"Title for the record"},"text":{"type":"string","description":"Textual content"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"description":"Attachments."},"usecase":{"description":"A usecase for creating and editing records.\r\nIn practice, a usecase is either a user interface or a microservice that provides a salary calculation\r\nand it may be implemented outside Salaxy.","$ref":"#/components/schemas/UsecaseData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Record for storing company or employment details."},"RecordData":{"type":"object","properties":{"recordType":{"type":"string","description":"Record type. This should be based on customer specific enumeration."},"usecaseUri":{"type":"string","description":"Key for the usecase based on which it is resolved. \r\nLater, this may resolve to a user interface, microservice or a to manifest registering one.\r\nFor now, just use a unique string starting with a domain you own."}},"additionalProperties":false,"description":"Record specific business data for index."},"RecordListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/RecordData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of records in the user interface."},"ReferenceObject":{"type":"object","properties":{"header":{"description":"Header for the reference object.\r\nContains typical header data of various types.","$ref":"#/components/schemas/ReferenceObjectHeader"},"events":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceObjectEvent"},"description":"Collection of events for the reference object."},"usecase":{"description":"A usecase for reference objects.\r\nIn practice, a usecase is either a user interface or a microservice that provides an extension to the default Salaxy functionality,\r\nand it may be implemented outside Salaxy.","$ref":"#/components/schemas/UsecaseData"},"workflowData":{"description":"The workflow data for manual editing and approval purposes.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Reference object. For testing and development purposes only.\r\nThis object is a typical business object.\r\nThe implementation is based on the current development conventions.\r\nThe reference objects have no meaning or use outside development or testing environments, and they\r\nshould not be used in production for any business purpose."},"ReferenceObjectData":{"type":"object","additionalProperties":false},"ReferenceObjectEvent":{"type":"object","properties":{"name":{"type":"string","description":"A free text property, the name of the event."},"date":{"type":["null","string"],"description":"Nullable date property, the  date for the event.","format":"date"},"result":{"description":"Enumerated property, the result for the event.","$ref":"#/components/schemas/BootstrapStyle"}},"additionalProperties":false,"description":"A single event in the collection of events for the reference object.\r\nContains typical row specific data of various types."},"ReferenceObjectHeader":{"type":"object","properties":{"description":{"type":"string","description":"A free text property, the description of the object."},"status":{"description":"Enumerated property, the status for the object.","$ref":"#/components/schemas/BootstrapStyle"},"referenceDate":{"type":["null","string"],"description":"Nullable date property, the reference date for the object.","format":"date"}},"additionalProperties":false,"description":"Header for the reference object.\r\nContains typical header data of various types."},"ReferenceObjectListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/BootstrapStyle"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/ReferenceObjectData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"List item for Reference object. For testing and development purposes only.\r\nThis object is a typical list item for the business object.\r\nThe implementation is based on the current development conventions.\r\nThe reference objects have no meaning or use outside development or testing environments, and they\r\nshould not be used in production for any business purpose."},"RemunerationKind":{"enum":["undefined","initiativeFee","bonusPay","commission","performanceBonus","shareIssueForEmployees","profitSharingBonus"],"type":"string","description":"Kind for RemunerationUsecase."},"RemunerationUsecase":{"type":"object","properties":{"kind":{"enum":["undefined","initiativeFee","bonusPay","commission","performanceBonus","shareIssueForEmployees","profitSharingBonus"],"type":"string"}},"additionalProperties":false},"Report":{"type":"object","properties":{"title":{"type":"string","description":"Short title for the report that can be shown to the end user."},"reportDate":{"type":"string","description":"Report date: For monthly and yearly reports this is the first day of the year/month.\r\nFor ad-hoc reports, this is the start date of the period.","format":"date"},"type":{"description":"Type of the report","$ref":"#/components/schemas/ReportType"},"pdfUrl":{"type":"string","description":"PDF report for viewing and printing. This is typically the main report.\r\nFor preview and demo, there is typically only HTML version - no PDF."},"thumbnail":{"type":"string","description":"Thumbnail image for the report. \r\nFor preview and demo data this is typically a fixed image - the thumbnail is only generated when PDF is generated."},"htmlUrl":{"type":"string","description":"HTML for the report. Use salaxy-rpt.css for formatting.\r\nFor preview and demo, this is the format to show to the user - PDF is not generated."},"jsonUrl":{"type":"string","description":"Some reports are also available in JSON format, from which you can create lists, CSV, Excel files etc."},"isPreview":{"type":"boolean","description":"If true, the report is in preview state, typically in the middle of the month.\r\nThis means that the data itself is production, its just not final."},"isDemoData":{"type":"boolean","description":"If true, the report is created using demo data - should be used only in the beginning when the user has not paid any salaries. \r\nThis may be e.g. calculations in draft stage or completely invented demo data such as example workers.\r\nDemo data should not be confused to test database (test-api.palkkaus.fi / test-api.salaxy.com): \r\nPaid calculations in test database are production data."},"urlsExpireAt":{"type":["null","string"],"description":"Time when the PDF, HTML or JSON URL's expire IF they are generated in a way that\r\nthey are callable without authentication for a specified time period.\r\nThis property is null if the URL requires authentication.","format":"date-time"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Describes a logical generated report.\r\nThis is a report instance e.g. a monthly report for January 2017. \r\nIt may contain several files of different types: PDF, preview PNG, HTML etc."},"ReportingArea":{"type":"object","properties":{"top":{"type":"integer","description":"Top margin.","format":"int32"},"right":{"type":"integer","description":"Right margin.","format":"int32"},"bottom":{"type":"integer","description":"Bottom margin.","format":"int32"},"left":{"type":"integer","description":"Left margin.","format":"int32"}},"additionalProperties":false},"ReportingCalculation":{"type":"object","properties":{"employer":{"description":"The employer object for this calculation.\r\nTypically, you do not need to set this before the actual payment process.","$ref":"#/components/schemas/CalcEmployer"},"worker":{"description":"The Worker (employee) that has performed the work.","$ref":"#/components/schemas/CalcWorker"},"workflow":{"description":"Information about the workflow and state of the calculation.","$ref":"#/components/schemas/CalcWorkflow"},"salary":{"description":"The main salary element. \r\nAlternatively the salary can be set in the Rows object - this will be the only way to set multiple salary rows (not yet supported).","$ref":"#/components/schemas/Salary"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserDefinedRow"},"description":"Set of rows that make up the salary calculation:\r\nExpenses, Benefits, deductions etc. Note that side costs are not rows."},"framework":{"description":"DEPRECIATED: Usecase will be replacing this functionality in a next major release.\r\nThe Framework Agreement (TES) parameters that affect the framework based side costs etc. of this calculation","$ref":"#/components/schemas/TesParameters"},"usecase":{"description":"A usecase for creating and editing salary calculations.\r\nIn practice, a usecase is either a user interface or a microservice that provides a salary calculation\r\nand it may be implemented outside Salaxy.\r\nProvides the possibility to store useacase specific data as part of calculation.\r\nNOTE: This functionality will replace Framework property in a next major release.","$ref":"#/components/schemas/UsecaseData"},"result":{"description":"The results of the calculation. In the API, this is a read-only object.","$ref":"#/components/schemas/CalculationResult"},"info":{"description":"Information about the work that is not directly related to calculating salary and expenses.","$ref":"#/components/schemas/CalcInfo"},"sharing":{"description":"Sharing of the calculation. This object cannot be modified directly, \r\nuse specialized methods in Calculations service.","$ref":"#/components/schemas/CalculationSharing"},"accounting":{"description":"Contains calculation specific data for accounting (both cost and financial accounting).","$ref":"#/components/schemas/CalculationAccounting"},"worktime":{"description":"Worktime data that is stored as part of Salary calculation:\r\nwork days, absences, holidays and holiday accrual.\r\nIn the future may also contain relevant part of timesheet data (work hours).","$ref":"#/components/schemas/CalcWorktime"},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"scripts":{"description":"Scripts for the calculation.","$ref":"#/components/schemas/BleScriptModule"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Deserializable calculation."},"ReportingCalculationCollection":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids for the objects."},"objects":{"type":"array","items":{"$ref":"#/components/schemas/ReportingCalculation"},"description":"Objects."}},"additionalProperties":false,"description":"Defines a set of calculations for reporting."},"ReportingLayoutTemplate":{"type":"object","properties":{"headerTemplate":{"type":"string","description":"HTML template for the print header.\r\nUse the following handlebars tags to inject values into the header:\r\n\r\n- `{{ date }}` Logical report date, e.g.Salary date for salary slip.\r\n- `{ { today } }` Printing date of the report.\r\n- `{{ title }}` Report specific title, e.g. \"Palkkalaskelma\".\r\n- `{{ subTitle}}` Report specific sub title, e.g. \"Palkkapäivä 1.6.2020\".\r\n- `{{&gt; pageNumber }}` Current page number.Rendered as SPAN element.\r\n- `{ {&gt; totalPages } }` total pages in the document.Rendered as SPAN element.\r\n- `{ {&gt; logo } }` The main logo for the page as uploaded to settings.Rendered as SVG or IMG element.\r\n- `{ {&gt; img2 } }` Secondary image as uploaded to settings.Rendered as SVG or IMG element."},"footerTemplate":{"type":"string","description":"HTML template for the print footer.\r\nUse the following handlebars tags to inject values into the footer:\r\n\r\n- `{{ date }}` Logical report date, e.g.Salary date for salary slip.\r\n- `{ { today } }` Printing date of the report.\r\n- `{{ title }}` Report specific title, e.g. \"Palkkalaskelma\".\r\n- `{{ subTitle}}` Report specific sub title, e.g. \"Palkkapäivä 1.6.2020\".\r\n- `{{&gt; pageNumber }}` Current page number.Rendered as SPAN element.\r\n- `{ {&gt; totalPages } }` total pages in the document.Rendered as SPAN element.\r\n- `{ {&gt; logo } }` The main logo for the page as uploaded to settings.Rendered as SVG or IMG element.\r\n- `{ {&gt; img2 } }` Secondary image as uploaded to settings.Rendered as SVG or IMG element."},"css":{"type":"string","description":"Additional CSS that is used to customize the layout of the report.","example":".salaxy-component div.salaxy-rpt.document { font - size: 15px; }"},"logo":{"type":"string","description":"Main logo image as embedded SVG or image (HTML).\r\nThis should preferably be an SVG or alternatively an image tag with data uri.","example":"SVG or img tag as HTML string"},"img2":{"type":"string","description":"Secondary image that can be used in header / footer as embedded SVG or image (HTML).\r\nThis should preferably be an SVG or alternatively an image tag with data uri.","example":"SVG or img tag as HTML string"},"margin":{"description":"Defines the margins of the content area","$ref":"#/components/schemas/ReportingArea"},"printBackground":{"type":"boolean","description":"Print background graphics if such are added to the report using css property above."}},"additionalProperties":false,"description":"Stores the CSS and images for the report creation."},"ReportingSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"layoutTemplateId":{"type":"string","description":"Identifier of the report layout template in id@partition or URI format."},"layoutTemplateVariables":{"type":"string","description":"Layouts may define some variables that may be overriden, e.g. colors, margins, font-sizes."},"logo":{"type":"string","description":"The company logo that is used by some Layouts"}},"additionalProperties":false,"description":"Defines the settings for producing reports: Mainly PDF's but also HTMl previews."},"ReportType":{"enum":["undefined","example","monthlyDetails","taxMonthly4001","payerSummaryReport","monthlyPension","monthlyLiikekirjuri","monthlyLiikekirjuriLegacy","monthlyRapko","monthlyAccounting","monthlyAccountingExcel","yearlyDetails","yearEndReport","yearlyWorkerSummary","taxYearly7801","unemployment","insurance","householdDeduction","taxHouseholdDeduction14B","taxHouseholdDeduction14BSpouseA","taxHouseholdDeduction14BSpouseB","salarySlip","salarySlipPaid","salarySlipCopy","eSalarySpecification","employerReport","paymentReport","paymentSummaryReport","totalsReport","earningsPaymentReport","accountingReport","invoice","invoiceList","employmentContract","authorization"],"type":"string","description":"Enumerates the different types of reports that are available."},"ResponsibilityCode":{"enum":["contentIssues","technicalIssues"],"type":"string"},"ResultRow":{"type":"object","properties":{"userRowIndex":{"type":"integer","description":"Row index that matches this row to a user defined row (which is zero-based).\r\nIf the row is generated by calculation business logic (e.g. based on framework agreement), the index is -1.","format":"int32","default":-1},"type":{"type":"string","description":"Wage type. Either a built in wage type in Salaxy or a custom wage type created by the user.\r\nPlease note that this type fully determines the CalculationRowType and the kind."},"rowType":{"description":"Logical type of the row","$ref":"#/components/schemas/CalculationRowType"},"rowSource":{"description":"Source of the calculation row - affects how the row is handled in editing / recalculation scenarios.","$ref":"#/components/schemas/CalculationRowSource"},"message":{"type":"string","description":"Description text of the row that is shown in reports. If null, will be set according to type."},"count":{"type":["null","number"],"description":"Count for the row - default is one","format":"double","default":1},"price":{"type":"number","description":"Price for the row","format":"double"},"unit":{"description":"Unit for the row","$ref":"#/components/schemas/CalculationRowUnit"},"total":{"type":"number","description":"Total for the row - always Price * Count","format":"double"},"totalBaseSalary":{"type":"number","description":"Base salary (Peruspalkka) is the monthly salary or total salary without addiotions (overtime, holidays etc.)","format":"double"},"totalGrossSalary":{"type":"number","description":"Gross salary (Bruttopalkka) is \"real\" salary including the additions (overtime, holidays etc.) but not benefits.","format":"double"},"totalTaxable":{"type":"number","description":"Taxable income (Ennakonpidätyksen alainen ansio) is the salary from taxation point-of-view. It is basically the Gross Salary plus benefits.","format":"double"},"totalSocialSecurityBase":{"type":"number","description":"Social Security Base (Sosiaaliturvan alainen ansio) is typically the same as TotalTaxable, \r\nbut e.g. child care subsidy (yksityisen hoidon tuki) is handled differently.","format":"double"},"totalExpenses":{"type":"number","description":"Taxfree expenses compensation","format":"double"},"totalDeduction":{"type":"number","description":"Deductions from the salary: Union payment, Advance, Foreclosure","format":"double"},"sourceId":{"type":"string","description":"Identifier in the source system is a key defined by a source system / partner system.\r\nThis is a pass-through string that is kept as-is in the Salaxy system."},"period":{"description":"Period if different than the Period of calculation.\r\nWill be reported to the National Incomes registry, but also affect some other calculations.\r\nNote that this property may be (and by default is) null.","$ref":"#/components/schemas/DateRange"},"accounting":{"description":"Accounting related data for the row.","$ref":"#/components/schemas/RowAccounting"},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data"}},"additionalProperties":false,"description":"Defines a Calculation row in the calculation results"},"Role":{"enum":["undefined","accountant","trustedPartner","accountantCandidate","pricingPartner","sepaPartner","salaxyPay","technicalAccount"],"type":"string","description":"Palkkaus account roles, e.g. accountant or trusted partner.\r\nThese roles are used for providing more functionalities for certain partners\r\nand allowing certain partners to execute trusted operations (e.g. creating new accounts)."},"RowAccounting":{"type":"object","properties":{"vatPercent":{"type":["null","number"],"description":"Percent for VAT calculation expressed as decimal: 24% is 0.24.","format":"double"},"vatEntries":{"type":"array","items":{"$ref":"#/components/schemas/VatEntry"},"description":"Total VAT amount splitted by VAT rates.\r\nPlease note, that if both decimal? RowAccounting.VatPercent and the VatEntry[] RowAccounting.VatEntries with some entries given,\r\nthe VatEntry[] RowAccounting.VatEntries are applied.\r\nPlease note that this is null by default."},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimension"},"description":"Values for cost accounting dimensions"},"entry":{"description":"Row accounting entries for overriding standard accounting logic.","$ref":"#/components/schemas/RowAccountingEntry"}},"additionalProperties":false,"description":"Provides row specific data for accounting (both cost and financial accounting)."},"RowAccountingEntry":{"type":"object","properties":{"debitAccountNumber":{"type":"string","description":"Debit Account number.\r\nIf given will override the system resolved debit account number."},"creditAccountNumber":{"type":"string","description":"Credit Account number.\r\nIf given will override the system resolved credit account number."}},"additionalProperties":false,"description":"Row accounting entry for overriding standard accounting logic."},"RowMergeOption":{"enum":["undefined","removeAllRows","removeImportedRows"],"type":"string","description":"Merge options for the rows to be added to existing calculations."},"RowTypeDefinition":{"type":"object","properties":{"config":{"description":"Configuration for the row type.","$ref":"#/components/schemas/CalcRowConfig"},"rowIndex":{"type":"integer","description":"Zero based row index that can be used to match the row to result rows or when deleting.\r\nNOTE: The Row ID is given values on the fly so setting this will not have any effect at the moment.\r\nIt may reorder the entries in later implementations.","format":"int32"},"type":{"type":"string","description":"Wage type. Either a built in wage type in Salaxy or a custom wage type created by the user.\r\nPlease note that this type fully determines the CalculationRowType and the kind."},"rowType":{"description":"Logical type of the row","$ref":"#/components/schemas/CalculationRowType"},"message":{"type":"string","description":"Description text of the row that is shown in reports. If null, will be set according to type."},"count":{"type":["null","number"],"description":"Count for the row - default is one","format":"double"},"price":{"type":"number","description":"Price for the row","format":"double"},"unit":{"description":"Unit for the row. Guessed based on the RowType and count, but you are better off setting it to be sure.","$ref":"#/components/schemas/CalculationRowUnit"},"source":{"description":"Source of the calculation row - affects how the row is handled in editing / recalculation scenarios.","$ref":"#/components/schemas/CalculationRowSource"},"sourceId":{"type":"string","description":"Identifier in the source system is a key defined by a source system / partner system.\r\nThis is a pass-through string that is passed to the result calculations."},"accounting":{"description":"Accounting related data for the row.","$ref":"#/components/schemas/RowAccounting"},"period":{"description":"Period if different than the Period of calculation.\r\nWill be reported to the National Incomes registry, but also affect some other calculations.\r\nNote that this property may be (and by default is) null.","$ref":"#/components/schemas/DateRange"},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data"}},"additionalProperties":false,"description":"Extends the UserDefinedRow by adding the configuration: How the row type should behave and and how to show it in the UI."},"SafeWaitHandle":{"type":"object","properties":{"isInvalid":{"type":"boolean","readOnly":true},"isClosed":{"type":"boolean","readOnly":true}},"additionalProperties":false},"Salary":{"required":["kind","price"],"type":"object","properties":{"kind":{"description":"Type of the salary being calculated","$ref":"#/components/schemas/SalaryKind"},"amount":{"type":"number","description":"Amount of e.g. hours, months for the salary. Default is 1.","format":"double","default":1},"price":{"type":"number","description":"Price of one unit - e.g. hour, month.","format":"double"},"unit":{"type":"string","description":"E.g. hour, month. Typically this parameter can be left empty/null and the unit is set according to type."},"message":{"type":"string","description":"Optional message for the salary row that is shown in reports. If null, will be set according to type."},"isHouseholdDeductible":{"type":"boolean","description":"If set to true, will calculate the household deduction. Applies only to natural persons - as oppsed to companies.","default":false},"taxDeductionCategories":{"description":"If tax IsHouseholdDeductible is set to true, please also select the category (categories). \r\nNote that \"OwnPropety\" is a default, it does not need to be set: Only set RelativesProperty if necessary.","$ref":"#/components/schemas/TaxDeductionWorkCategories"}},"additionalProperties":false,"description":"Defines the main salary that is the bases for the calculation"},"SalaryDateKind":{"enum":["default","inPast"],"type":"string","description":"Defines the re-setting of the salary date in the calculation re-calculation."},"SalaryKind":{"enum":["undefined","fixedSalary","hourlySalary","monthlySalary","compensation","totalWorkerPayment","totalEmployerPayment"],"type":"string","description":"Enumerates the different types of salary calculations."},"SearchClause":{"required":["expression"],"type":"object","properties":{"expression":{"$ref":"#/components/schemas/SingleValueNode"}},"additionalProperties":false,"readOnly":true},"SearchQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"resultClrType":{"$ref":"#/components/schemas/Type"},"searchClause":{"$ref":"#/components/schemas/SearchClause"},"rawValue":{"type":"string","readOnly":true}},"additionalProperties":false,"readOnly":true},"SelectExpandClause":{"required":["selectedItems","allSelected"],"type":"object","properties":{"selectedItems":{"type":"array","items":{"$ref":"#/components/schemas/SelectItem"},"readOnly":true},"allSelected":{"type":"boolean","readOnly":true}},"additionalProperties":false,"readOnly":true},"SelectExpandQueryOption":{"required":["context"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawSelect":{"type":"string","readOnly":true},"rawExpand":{"type":"string","readOnly":true},"compute":{"$ref":"#/components/schemas/ComputeQueryOption"},"validator":{"$ref":"#/components/schemas/ISelectExpandQueryValidator"},"selectExpandClause":{"$ref":"#/components/schemas/SelectExpandClause"},"levelsMaxLiteralExpansionDepth":{"type":"integer","format":"int32"}},"additionalProperties":false,"readOnly":true},"SelectItem":{"type":"object","additionalProperties":false},"ServiceModel":{"type":"object","properties":{"name":{"type":"string","description":"Name of the service model"},"icon":{"type":"string","description":"URL for the icon that represents the service model"},"features":{"description":"Service model features, which can be switched on/off.","$ref":"#/components/schemas/ServiceModelFeatures"},"calc":{"description":"Default calculation related settings.","$ref":"#/components/schemas/ServiceModelCalculation"},"accounting":{"description":"Default accounting settings.","$ref":"#/components/schemas/ServiceModelAccounting"},"costAccounting":{"description":"Default cost accounting settings.","$ref":"#/components/schemas/ServiceModelCostAccounting"},"holiday":{"description":"Default holiday settings.","$ref":"#/components/schemas/ServiceModelHoliday"},"pricing":{"description":"Default pricing settings.","$ref":"#/components/schemas/ServiceModelPricing"},"payments":{"description":"Default payment channels.","$ref":"#/components/schemas/ServiceModelPayments"},"branding":{"description":"Partner branding settings: site logo, css etc.","$ref":"#/components/schemas/ServiceModelBranding"},"reporting":{"description":"Reporting layout settings.","$ref":"#/components/schemas/ServiceModelReporting"},"site":{"description":"Default site for customers.","$ref":"#/components/schemas/ServiceModelSite"},"usecase":{"description":"Settings related to usecases.","$ref":"#/components/schemas/ServiceModelUsecase"},"messaging":{"description":"Settings related to messaging.","$ref":"#/components/schemas/ServiceModelMessaging"},"forms":{"description":"Settings related to the calculation data delivery by forms.","$ref":"#/components/schemas/ServiceModelForms"},"payStats":{"description":"Settings related to the pay statistics calculations.","$ref":"#/components/schemas/ServiceModelPayStats"},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false},"ServiceModelAccounting":{"type":"object","properties":{"defaultTargetId":{"type":"string","description":"Default accounting target."},"defaultPeriodDateKind":{"description":"Default period selection method:  PaidAt date (paid by employer), Salary date (paid to worker) or Work date (work done). The default is PaidAt date.","$ref":"#/components/schemas/PeriodDateKind"},"targets":{"type":"array","items":{"$ref":"#/components/schemas/AccountingTargetSettings"},"description":"Accounting target systems and the rulesets assigned to them."}},"additionalProperties":false,"description":"Settings related to Accounting"},"ServiceModelBranding":{"type":"object","properties":{"logo":{"type":"string","description":"Url to logo."},"skin":{"type":"string","description":"Css path."}},"additionalProperties":false,"description":"Service model branding settings: logo, css etc."},"ServiceModelCalculation":{"type":"object","properties":{"irDelivery":{"description":"IR report delivery settings.","$ref":"#/components/schemas/IrDelivery"}},"additionalProperties":false,"description":"Settings related to Calculation"},"ServiceModelCostAccounting":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/CostAccountingDimensionDefinition"},"description":"Cost accounting dimensions"}},"additionalProperties":false,"description":"Settings related to Cost Accounting"},"ServiceModelData":{"type":"object","properties":{"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"logo":{"type":"string","description":"Url to logo."},"skin":{"type":"string","description":"Css path."},"webAppName":{"type":"string","description":"Name for the web application."},"webAppUrl":{"type":"string","description":"Web application URL when the WebApp is Custom."},"icon":{"type":"string","description":"Square icon for the service model. Used in listings etc."}},"additionalProperties":false,"description":"Service model specific business data for index."},"ServiceModelFeatures":{"type":"object","properties":{"irDelivery":{"type":"boolean","description":"If true, IR reporting uses given certificate."},"messaging":{"type":"boolean","description":"If true, the messaging is switched on for this service model."},"forms":{"type":"boolean","description":"If true, the calculation data delivery by forms is switched on."},"accounting":{"type":"boolean","description":"If true, the service model accounting settings override company  settings."},"costAccounting":{"type":"boolean","description":"If true, the service model cost accounting settings override company  settings."},"holiday":{"type":"boolean","description":"If true, the service model holiday settings override company  settings."},"payments":{"type":"boolean","description":"If true, the service model payment settings override company  settings."},"reporting":{"type":"boolean","description":"If true, the service model reporting settings override company settings."},"usecase":{"type":"boolean","description":"If true, the service model usecase settings override company settings."},"payStats":{"type":"boolean","description":"If true, the service model pay statistics settings override company settings."}},"additionalProperties":false,"description":"Service model features, which can be swithced on/off."},"ServiceModelForms":{"type":"object","additionalProperties":false,"description":"Settings related to the calculation data delivery by forms."},"ServiceModelHoliday":{"type":"object","properties":{"holidayPaySettings":{"type":"array","items":{"$ref":"#/components/schemas/HolidayPaySettings"},"description":"Settings for holiday pay calculations.\r\nThe default is null and the default settings are used."},"holidayAccrualSettings":{"type":"array","items":{"$ref":"#/components/schemas/HolidayAccrualSettings"},"description":"Settings for the accrual calculations.\r\nThe default is null and the default settings are used."}},"additionalProperties":false,"description":"Settings related to Holiday"},"ServiceModelListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/ServiceModelData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a partner service model."},"ServiceModelMessaging":{"type":"object","properties":{"partnerMessages":{"type":"boolean","description":"Enable partner communication. Enabled by default."},"workerSalaryNotifications":{"type":"array","items":{"$ref":"#/components/schemas/WorkerSalaryNotification"},"description":"Options for the notification to be sent to the worker after the salary payment."},"workerSalarySlipDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/WorkerSalarySlipDeliveryMethod"},"description":"Options for the delivery of the payslip to the worker."}},"additionalProperties":false,"description":"Settings related to Messaging."},"ServiceModelPayments":{"type":"object","properties":{"defaultChannel":{"description":"The default channel when making payments.","$ref":"#/components/schemas/PaymentChannel"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/PaymentChannelSettings"},"description":"Channel specific settings."}},"additionalProperties":false,"description":"Default payment channels for customers."},"ServiceModelPayStats":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/components/schemas/PayStatsTypeDefinition"},"description":"Settings for different types of pay statistics."}},"additionalProperties":false,"description":"Settings related to pay statistics calculations."},"ServiceModelPricing":{"type":"object","properties":{"pricingModel":{"description":"Pricing model by the partner.","$ref":"#/components/schemas/PricingModel"},"fixedFee":{"type":"number","description":"Fee for one calculation, which is visible and paid by customer.\r\nThis is not relevant if the PricingModel is PalkkausFee","format":"double"}},"additionalProperties":false,"description":"Service model specific pricing settings for customers."},"ServiceModelReporting":{"type":"object","properties":{"layoutTemplateId":{"type":"string","description":"Identifier of the report layout template in id@partition or URI format."},"layoutTemplateVariables":{"type":"string","description":"Layouts may define some variables that may be overriden, e.g. colors, margins, font-sizes."},"logo":{"type":"string","description":"The company logo that is used by some Layouts"}},"additionalProperties":false,"description":"Defines the settings for producing reports: Mainly PDF's but also HTMl previews."},"ServiceModelSite":{"type":"object","properties":{"webApp":{"description":"Type of web app that the customer is using to interact in the service process.","$ref":"#/components/schemas/CustomerWebApp"},"webAppUrl":{"type":"string","description":"Web application URL when the WebApp is Custom."},"webAppName":{"type":"string","description":"Name for the web application."},"texts":{"type":"object","additionalProperties":{"type":"string"},"description":"Override the translated texts for a service model.\r\nKey in the dictionary is a full key starting from the language, e.g. \"fi.SALAXY.NG1_Sitemap.home\"."},"sitemap":{"type":"object","additionalProperties":false,"description":"Sitemap customizations based on product sitemap.\r\nKey is a full sitemap id (dot path) and data is a dataobject that is merged to SiteMap."}},"additionalProperties":false,"description":"Stores information about the web site that is used for customer (employer)\r\nto access the customer web site."},"ServiceModelUsecase":{"type":"object","properties":{"usecases":{"type":"array","items":{"$ref":"#/components/schemas/UsecaseInSettings"},"description":"Available usecases for the current account."}},"additionalProperties":false,"description":"Usecase related settings."},"SessionUserCredential":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"id":{"maxLength":128,"type":"string","description":"Unique identitier for the user ID coming from the Auth0 database: \r\n'[MethodText]|[ProviderId]', e.g. 'facebook|12345678901234567'\r\n(Number may contain more characters - not sure for the exact cahracters count)"},"avatar":{"description":"Avatar object that contains the visual reresentation of the User account.","$ref":"#/components/schemas/Avatar"},"email":{"maxLength":256,"type":"string","description":"E-mail address if provided by the authentication provider."},"authenticationMethod":{"description":"The ultimate authentication provider that authenticated the user, e.g. Facebook, Google.","$ref":"#/components/schemas/AuthenticationMethod"}},"additionalProperties":false,"description":"Represents a user credential in session:\r\nThis credential is typically based on Claims and is availble without going to database."},"SettingsStatus":{"enum":["undefined","checked","pending"],"type":"string","description":"Settings status"},"SharedTaxcardExistsResult":{"type":"object","properties":{"sharedExists":{"type":"boolean","description":"Returns true if a shared taxcard exists."},"ownedExists":{"type":"boolean","description":"Returns true if there is already an owned taxcard for the employer."},"uri":{"type":"string","description":"Uri for the Shared taxcard"},"ownedTaxcard":{"description":"If Owned taxcard exists, it is returned here.","$ref":"#/components/schemas/Taxcard"},"isError":{"type":"boolean","description":"If true there was an error fetching the information.\r\nTypically, this would be that there were too many attempts to fetch Personal ID's and request was classified as phishing.\r\nIn this case, you should currently create the employment relation and fetch the taxcard infor after that. \r\nWe may later introduce a \"Are you robot\" type of interface to go around this (if necessary)."},"kind":{"description":"Type of the taxcard. Undefined if none is found.","$ref":"#/components/schemas/TaxcardKind"},"validity":{"description":"Validity of the taxcard. Note that this property is null when Exists is false.","$ref":"#/components/schemas/DateRange"},"personalId":{"type":"string","description":"The personal ID that was used in fetching.\r\nIt may be validated and formatted, or just the original string if there were issues."}},"additionalProperties":false,"description":"Provides a a result to query of whether a taxcard exists for a personal ID (no personal information)."},"Shareholder":{"type":"object","properties":{"name":{"type":"string","description":"Name of the shareholder."}},"additionalProperties":false,"description":"Defines a shareholder. At the moment, this is only a name and it is used only if the person has more than 25% of the shares.\r\nExpect this object to be developed with, Ownership percent or number of shares, Id or other such link to the actual person etc."},"SharingUriType":{"enum":["undefined","url","employer"],"type":"string","description":"Types of sharing."},"SignatureData":{"type":"object","properties":{"personName":{"type":"string","description":"Name of the signing person.\r\nBy default, this is Onboarding Person, but it may be a completely different person."},"personalId":{"type":"string","description":"Personal ID of the person, who has the right to sign."},"email":{"type":"string","description":"Email that is sent to Signature provider, if any."},"telephone":{"type":"string","description":"Telephone that is sent to Signature provider, if any."},"isPep":{"type":"boolean","description":"If true, the person signing is PEP (Politically Exposed Person"},"vismaSignData":{"description":"TODO: To be removed after Signicat is in production.\r\nData related to VismaSign signature process (API v01).","$ref":"#/components/schemas/VismaSignV01ObData"},"signicatData":{"description":"Data related to Signicat signature process.","$ref":"#/components/schemas/SignicatData"},"isProcura":{"type":"boolean","description":"The account is authorized to sign on behalf of the actual account."}},"additionalProperties":false},"SignicatData":{"type":"object","properties":{"documentId":{"type":"string","description":"Identifier of the document that is signed.","format":"uuid"},"documentSummary":{"type":"object","additionalProperties":false,"description":"Document summary after the signature has been done."},"pdfBlobUri":{"type":"string","description":"URI to the signed PDF document: Full unique URI for the BlobFile."}},"additionalProperties":false,"description":"Data about the Signicat process."},"SingleValueNode":{"type":"object","properties":{"typeReference":{"$ref":"#/components/schemas/IEdmTypeReference"},"kind":{"$ref":"#/components/schemas/QueryNodeKind"}},"additionalProperties":false,"readOnly":true},"SkipQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValue":{"type":"string","readOnly":true},"value":{"type":"integer","format":"int32","readOnly":true},"validator":{"$ref":"#/components/schemas/ISkipQueryValidator"}},"additionalProperties":false,"readOnly":true},"SkipTokenHandler":{"type":"object","additionalProperties":false,"readOnly":true},"SkipTokenQueryOption":{"required":["rawValue","context"],"type":"object","properties":{"rawValue":{"type":"string","readOnly":true},"context":{"$ref":"#/components/schemas/ODataQueryContext"},"validator":{"$ref":"#/components/schemas/ISkipTokenQueryValidator"},"handler":{"$ref":"#/components/schemas/SkipTokenHandler"}},"additionalProperties":false,"readOnly":true},"Stream":{"type":"string","format":"binary"},"SubsidisedCommuteKind":{"enum":["undefined","noDeduction","singleDeduction","periodicalDeduction"],"type":"string"},"SubsidisedCommuteUsecase":{"type":"object","properties":{"deduction":{"type":["null","number"],"format":"double"},"taxable":{"type":["null","number"],"format":"double"},"periodDivider":{"type":["null","integer"]},"kind":{"enum":["undefined","noDeduction","singleDeduction","periodicalDeduction"],"type":"string"}},"additionalProperties":false},"SummaryCalculationRow":{"type":"object","properties":{"message":{"type":"string","description":"Description text of the row that is shown in reports."},"count":{"type":"number","description":"Count for the row.","format":"double"},"price":{"type":"number","description":"Price for the row.","format":"double"},"total":{"type":"number","description":"Total sum.","format":"double"},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data\r\nThis contains especially row label parameters: calculationRowType, kind and code"}},"additionalProperties":false,"description":"Row containing summary data for the summary report."},"SummaryCalculationRows":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/SummaryCalculationRow"},"description":"Summary rows."},"total":{"type":"number","description":"Total sum of rows.","format":"double"}},"additionalProperties":false,"description":"Rows and totals for a set of calculation rows."},"SummaryReportData":{"type":"object","properties":{"businessId":{"type":"string","description":"Finnish Business Identifier (Y-tunnus) for the company."},"employer":{"description":"Employer avatar","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the report. Typically the employer, but may be something else.","$ref":"#/components/schemas/Contact"},"startDate":{"type":"string","description":"Start date for the report","format":"date-time"},"endDate":{"type":"string","description":"End date for the report","format":"date-time"},"result":{"description":"The total sum information for the report - this is the main payload of the report","$ref":"#/components/schemas/CalculationResult"},"calculations":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"},"description":"Individual calculations based on which the report is made.\r\nDepending on the request, this may be filled in or null (as opposed to empty list)."}},"additionalProperties":false,"description":"A summary report for an employer for a specific period (typically month or year)."},"TableReportColumn":{"type":"object","properties":{"field":{"type":"string","description":"Row dictionary key with prefix, e.g. \"base.calculationId\" or \"incometype.201-hours-count\"."},"label":{"type":"string","description":"Translated column label."},"type":{"description":"Data type of the column.","$ref":"#/components/schemas/TableReportColumnType"}},"additionalProperties":false,"description":"Column metadata for a table report."},"TableReportColumnType":{"enum":["text","number","date","boolean"],"type":"string","description":"Data type of a table report column. Maps to AG Grid cell data types."},"TableReportData":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":false},"description":"Report rows. Keys are prefixed column fields (see List&lt;TableReportColumn&gt; TableReportData.Columns)."},"columns":{"type":"array","items":{"$ref":"#/components/schemas/TableReportColumn"},"description":"Column metadata: field, label and type."}},"additionalProperties":false,"description":"Tabular report data for AG Grid: rows and column metadata."},"TableReportQuery":{"type":"object","properties":{"calculationIds":{"type":["null","array"],"items":{"type":"string"},"description":"Calculation: calculations to include. If set, period parameters are ignored."},"refDate":{"type":["null","string"],"description":"Calculation: reference date for the period. Required if string[]? TableReportQuery.CalculationIds is not set.","format":"date-time"},"periodType":{"description":"Calculation: month, quarter, year or a custom period. The custom period requires DateTime? TableReportQuery.EndDate.","$ref":"#/components/schemas/PeriodType"},"endDate":{"type":["null","string"],"description":"Calculation: end date for the custom period.","format":"date-time"},"periodDateKind":{"oneOf":[{"type":"null"},{"description":"Calculation: date kind for the period. Default from account settings.","$ref":"#/components/schemas/PeriodDateKind"}]},"workers":{"type":["null","array"],"items":{"type":"string"},"description":"Calculation: workers (by official id) to include."},"splitIncomeTypesByDimensions":{"type":"boolean","description":"Calculation: the income types are also split by the cost accounting dimensions (e.g. cost centers) and by the wage types:\r\na column per dimension value and income type, and per dimension value, income type and wage type."}},"additionalProperties":false,"description":"Query parameters for table reports. Applicable parameters depend on the report type."},"TableReportType":{"enum":["undefined","calculation","employment"],"type":"string","description":"Report types available as tabular report data."},"TaskAction":{"type":"object","properties":{"name":{"type":"string","description":"Short name of the action."},"description":{"type":"string","description":"Longer description of the action."},"script":{"type":"string","description":"Script for the task."},"parameters":{"type":"object","additionalProperties":false,"description":"Parameters for the action."}},"additionalProperties":false,"description":"Represents a single action to be performed as part of a task."},"TaskDefinition":{"type":"object","properties":{"name":{"type":"string","description":"Short name of the task."},"description":{"type":"string","description":"Longer description of the task."},"schedule":{"type":"string","description":"Cron schedule or exact time for the task."},"isRecurring":{"type":"boolean","description":"Indicates whether the task run is recurring."},"actions":{"type":"array","items":{"$ref":"#/components/schemas/TaskAction"},"description":"Actions for the task."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a scheduled or adhoc task that can perform automated actions."},"TaskDefinitionData":{"type":"object","properties":{"description":{"type":"string","description":"Longer description of the task."}},"additionalProperties":false,"description":"Task specific business data for index."},"TaskDefinitionListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/TaskDefinitionData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of tasks in the user interface."},"TaskLogEntry":{"type":"object","properties":{"taskDefinitionId":{"type":"string"},"taskRunId":{"type":"string"},"actionName":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"message":{"type":"string"},"level":{"type":"string"}},"additionalProperties":false,"description":"Represents a single log entry for a task run."},"TaskRun":{"type":"object","properties":{"taskDefinitionId":{"type":"string","description":"Id of the task definition that this run is for."},"startAt":{"type":["null","string"],"description":"Start time of the task run.","format":"date-time"},"endAt":{"type":["null","string"],"description":"Ending time of the task run.","format":"date-time"},"status":{"description":"Status of the task run.","$ref":"#/components/schemas/TaskRunStatus"},"isRecurring":{"type":"boolean","description":"Indicates whether the task run is recurring.\r\nPlease note that if the task definition is recurring, this property may still be false for individual runs."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents one run of a task defined in the TaskDefinition"},"TaskRunData":{"type":"object","additionalProperties":false,"description":"Task run specific business data for index."},"TaskRunListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/TaskRunStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/TaskRunData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of task runs in the user interface."},"TaskRunStatus":{"enum":["undefined","scheduled","running","succeeded","failed","canceled"],"type":"string"},"TaxAtSource":{"type":"object","properties":{"percent":{"type":"number","description":"Tax percent. As of writing, this is 35% by default and 15% for athletes and performingg artists,\r\nbut the percentage may change and bust be checked from the taxcard (or legistlattion if there is no card available).","format":"double"},"deductionMonthly":{"type":["null","number"],"description":"Monthly deduction (e.g. 510 €/month) if one can be used for this card.","format":"double"},"deductionDaily":{"type":["null","number"],"description":"Daily deduction (e.g. 17 €/day) if one can be used for this card.","format":"double"}},"additionalProperties":false,"description":"The information about tax at source, typically from  non-resident taxcard (lähdeverokortti) for non-residents."},"TaxAtSourceKind":{"enum":["undefined","noDeduction","monthlyDeduction","dailyDeduction","fixedValues"],"type":"string","description":"Type of tax at source calcuation."},"TaxAtSourceUsecase":{"type":"object","properties":{"taxValue":{"type":["null","number"],"format":"double"},"deductionPrice":{"type":["null","number"],"format":"double"},"deductionCount":{"type":["null","number"],"format":"double"},"deduction":{"type":["null","number"],"format":"double"},"totalTaxable":{"type":["null","number"],"format":"double"},"employmentData":{"type":"object","properties":{"percent":{"type":"number","format":"double"},"deductionMonthly":{"type":["null","number"],"format":"double"},"deductionDaily":{"type":["null","number"],"format":"double"}},"additionalProperties":false},"allowedKinds":{"type":["null","string"]},"kind":{"enum":["undefined","noDeduction","monthlyDeduction","dailyDeduction","fixedValues"],"type":"string"}},"additionalProperties":false},"Taxcard":{"required":["card"],"type":"object","properties":{"worker":{"description":"The Worker, whose salaries are paid based on this tax card.","$ref":"#/components/schemas/Avatar"},"employmentId":{"type":"string","description":"Employment for which the tax card is created."},"card":{"description":"The input that is coming from the Worker / Tax authorities","$ref":"#/components/schemas/TaxcardInput"},"incomeLog":{"type":"array","items":{"$ref":"#/components/schemas/TaxCardIncome"},"description":"Calculations that have been paid to this tax card."},"result":{"description":"Read-only calculation results and other logic values on the Taxcard.","$ref":"#/components/schemas/TaxcardResults"},"copyOfUri":{"type":"string","description":"If the item is an employer instance of a shared taxcard, contains the original identifier\r\nas URI (\"[Server]/[PayloadType]/[Owner]/[Id]\", e.g. \"https://test-secure.salaxy.com/CalculationDTO/FI86POYL0009461858/16ea052e-f23f-4b72-83a9-b8f6590f0dc9\");\r\nThis item cannot be set in Save - only in Approve method."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Full tax card that is stored in database and that is used in tax card percentage calculations.\r\nAlso contains the salary history in the income log."},"TaxcardApiIncomeType":{"enum":["undefined","salary","dividendsForWorkAsSalary","personnelFundIncome","salaryOneOff","compensationForUseEarnedIncome","compensationForUseCapitalIncome","compensationVatResponsible","compensation","dividendsForWorkAsCompensation","athletePay","otherTaxableIncome","otherTaxableIncomeOneOff","employeeStockOption"],"type":"string","description":"Supported Income types from Widthholding tax GetWithholdingPercentageResponse API."},"TaxcardApprovalMethod":{"enum":["assureWaiting","approve","reject"],"type":"string","description":"Taxcard approval method"},"TaxcardCalcDiffCheck":{"enum":["getDiff","noCheck","commitDiff"],"type":"string","description":"Defines the behavior of how to check and handle existing paid calculations in relation to a Taxcard."},"TaxcardData":{"type":"object","properties":{"forYear":{"type":["null","integer"],"description":"Year that the tax card is valid for. Typically this means from February of this year to January of the following.","format":"int32"},"taxPercent":{"type":["null","number"],"description":"Tax percent as percent. I.e. for 50% set 50, not 0.5.","format":"double"},"incomeLimit":{"type":["null","number"],"description":"Income up to which the TaxPercent can be used.\r\nAny income above the limit is taxed with ExcessTaxPercent.","format":"double"},"totalIncome":{"type":["null","number"],"description":"Total income paid to the taxcard during the year (forYear).","format":"double"},"taxPercent2":{"type":["null","number"],"description":"Tax percentage that is used in calculating the widthholding tax for the part of income above the IncomeLimit.","format":"double"},"taxPercentMin":{"type":["null","number"],"description":"A Worker may request a minimum percent that is deducted even if the effective tax percent would be lower.\r\nThis can be used if Worker knows that he/she will be earning more in the year than what was estimated when the taxcard was created.","format":"double"},"incomeType":{"description":"The income type of the taxacard if fetched from the tax authorities taxcard API.","$ref":"#/components/schemas/TaxcardApiIncomeType"},"kind":{"description":"The type of the tax card.","$ref":"#/components/schemas/TaxcardKind"},"employmentId":{"type":"string","description":"Employment id."},"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"start":{"type":"string","description":"Start date of the taxcard validity","format":"date"},"end":{"type":["null","string"],"description":"End date of the taxcard validity. This may be null on NoTaxcard types.","format":"date"},"copyOfUri":{"type":"string","description":"If the item is an employer instance of a shared taxcard, contains the original identifier\r\nas URI (\"/[PayloadType]/[Owner]/[Id]\", e.g. \"/CalculationDTO/FI86POYL0009461858/16ea052e-f23f-4b72-83a9-b8f6590f0dc9\");\r\nThis item cannot be set in Save - only in Approve method."},"validity":{"oneOf":[{"type":"null"},{"description":"Validity resolved as enumeration in relation to payment date given in the query.\r\nThis is not available in direct database OData queries as it is relevant to current / given date.","$ref":"#/components/schemas/TaxcardValidity"}]},"fileUri":{"type":"string","description":"Uri to the file copy of the tax card."},"previewUri":{"type":"string","description":"Uri to the preview image of the tax card."}},"additionalProperties":false,"description":"Tax card specific business data for index."},"TaxCardIncome":{"type":"object","properties":{"type":{"description":"Type of income","$ref":"#/components/schemas/TaxCardIncomeType"},"id":{"type":"string","description":"Calculation id in the Salaxy database.\r\nIf the calculation is not in the Salaxy Database, leave this null."},"owner":{"type":"string","description":"Owner of the row, typically the employer that paid the salary.\r\nNull meaning that it is the owner of the original taxcard."},"description":{"type":"string","description":"A short description of the paid calculation.\r\nThis is a mandatory field if the Id is null."},"startDate":{"type":["null","string"],"description":"Beginning of the salary payment period from taxation point-of-view.\r\nThis is typically the same as CalcInfo.WorkStartDate, but may be different in edge cases.","format":"date-time"},"endDate":{"type":["null","string"],"description":"End of the salary payment period from taxation point-of-view.\r\nThis is typically the same as CalcInfo.WorkEndDate, but may be different in edge cases.","format":"date-time"},"paidAt":{"type":["null","string"],"description":"The paidAt date which tells mainly to which year the payment should be attributed.\r\nThis is reliable only if the salary is paid by Salaxy (TaxCardIncomeType.SalaxyCalculation).\r\nIn other cases it is just the reporting date.","format":"date-time"},"income":{"type":"number","description":"Taxable income from this calculation","format":"double"},"tax":{"type":"number","description":"Widthholding tax in euro","format":"double"},"diff":{"description":"When loading calculations from the database (in taxcard Save and FindBy with diff), \r\nthis property identifies the differences in the entry.","$ref":"#/components/schemas/IncomeLogDiff"}},"additionalProperties":false,"description":"Defines income that is recorded in a Taxcard:\r\nA paid salary calulation, income from previous employers or other salaries that affect the income calculation."},"TaxCardIncomeType":{"enum":["unknown","salaxyCalculation","previousEmployerSalaries","externalSalaries","sharedCardExtSum","diff"],"type":"string"},"TaxcardInput":{"required":["personalId","forYear"],"type":"object","properties":{"personalId":{"type":"string","description":"The personal ID as written in the tax card."},"state":{"description":"Tax card approval state","$ref":"#/components/schemas/TaxcardState"},"forYear":{"type":"integer","description":"Year that the tax card is valid for. Typically this means from February of this year to January of the following.","format":"int32"},"validity":{"description":"Validity for the taxcard as expressed in the card.\r\nNote that the end date may not be reliable if new taxcard has replaced this one.","$ref":"#/components/schemas/DateRange"},"taxPercent":{"type":["null","number"],"description":"Tax percent as percent. I.e. for 50% set 50, not 0.5.","format":"double"},"incomeLimit":{"type":["null","number"],"description":"Income up to which the TaxPercent can be used.\r\nAny income above the limit is taxed with ExcessTaxPercent.","format":"double"},"taxPercent2":{"type":["null","number"],"description":"Tax percentage that is used in calculating the widthholding tax for the part of income above the IncomeLimit.","format":"double"},"taxPercentMin":{"type":["null","number"],"description":"A Worker may request a minimum percent that is deducted even if the effective tax percent would be lower.\r\nThis can be used if Worker knows that he/she will be earning more in the year than what was estimated when the taxcard was created.","format":"double"},"taxPercentMinOwned":{"type":["null","number"],"description":"TaxPercentMin set by owner of the card.\r\nThis overrides the tax percent min set by the taxcard sharer.","format":"double"},"lastChecked":{"type":"string","description":"Explicit value of when the item was last checked. At the moment, updated in API fetches only, but may be used later for other checks.\r\nUndefined value is 1.1.2000","format":"date-time"},"incomeType":{"description":"The income type of the taxacard if fetched from the tax authorities taxcard API.","$ref":"#/components/schemas/TaxcardApiIncomeType"},"includesStockOptionsAndGrants":{"type":"boolean","description":"Withholding Percentage may include Stock Options and Grants (information from the taxcard API).\r\nThis property is not currently in use."},"kind":{"description":"Type of the taxcard as of 2019, when the taxcards logic was simplified by the Finnish tazx authorities.","$ref":"#/components/schemas/TaxcardKind"},"fileUri":{"type":"string","description":"Uri to the file copy of the tax card. \r\nSet by the system as part of the upload process, do not change in the API though it may be technically possible. This may have unintended results."},"previewUri":{"type":"string","description":"Uri to the preview image of the tax card. \r\nSet by the system as part of the upload process, do not change in the API though it may be technically possible. This may have unintended results."}},"additionalProperties":false,"description":"Input from user for a tax card: What is written in the card plus the state infomration that is directly editable by the user."},"TaxcardKind":{"enum":["undefined","noTaxCard","auto","defaultYearly","replacement","noWithholdingHousehold","others","historical"],"type":"string","description":"Kind of taxcard: How the taxcard behaves and is shown in user interfaces."},"TaxcardListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/TaxcardState"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/TaxcardData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"List item of taxcard searches."},"TaxcardResult":{"type":"object","properties":{"yearlyPreviousIncome":{"type":"number","description":"Sum of income for this year based on the items marked on the tax card.","format":"double"},"tax":{"type":["null","number"],"description":"Provides a decimal number for a recommended widthholding tax IF it is possible to calculate that based on given information.\r\nNull, if the information is not sufficient to give a recommendation.","format":"double"},"taxPercent":{"type":"number","description":"Applied tax base percent","format":"double"},"taxPercent2":{"type":"number","description":"Applied tax additional percent","format":"double"},"taxPercentBase":{"type":"number","description":"Base amount taxed using base tax percent","format":"double"},"taxPercent2Base":{"type":"number","description":"Base amount taxed using additional tax percent","format":"double"},"taxPercentTax":{"type":"number","description":"Tax from base tax percent.","format":"double"},"taxPercent2Tax":{"type":"number","description":"Tax from additional tax percent.","format":"double"}},"additionalProperties":false,"description":"Provides the results of the tax card calculation and business logic."},"TaxcardResults":{"type":"object","properties":{"totalIncome":{"type":"number","description":"Total income for the actual year, which is used for income limit.\r\nNote that this does not include January income that may be paid for previous year taxcard.","format":"double","readOnly":true},"totalIncomeJanuary":{"type":"number","description":"Total income for January of the following year that is paid for previous year taxcard (this taxcard) if there is no new taxcard for January.","format":"double","readOnly":true},"payment":{"type":"number","description":"Payments of the salary calculations that were made using Palkkaus.fi system (as opposed to external salaries etc) \r\nand that were marked to this card. These are for the actual year, which is used for income limit.\r\nFor Shared card, all employers are considered, for Owner copies of shared card, only salaries paid by owner is considered.","format":"double","readOnly":true},"paymentJanuary":{"type":"number","description":"Payments of the salary calculations that were made using Palkkaus.fi system (as opposed to external salaries etc) \r\nand that were marked to this card. These are for January of the following year that is paid for previous year taxcard (this taxcard) if there is no new taxcard for January.\r\nFor Shared card, all employers are considered, for Owner copies of shared card, only salaries paid by owner is considered.","format":"double","readOnly":true},"validityToday":{"description":"Gets the validity of the taxcard today. This value reflects purely the date value - it does not take into account approval or replacement.","$ref":"#/components/schemas/TaxcardValidity"}},"additionalProperties":false,"description":"Read-only calculations and other logic methods on a Taxcard.","readOnly":true},"TaxcardSnapshot":{"required":["forYear"],"type":"object","properties":{"forYear":{"type":["null","integer"],"description":"Year that the tax card is valid for. Typically this means from February of this year to January of the following.","format":"int32"},"validity":{"description":"Validity for the taxcard as expressed in the card.\r\nNote that the end date may not be reliable if new taxcard has replaced this one.","$ref":"#/components/schemas/DateRange"},"taxPercent":{"type":["null","number"],"description":"Tax percent as percent. I.e. for 50% set 50, not 0.5.","format":"double"},"incomeLimit":{"type":["null","number"],"description":"Income up to which the TaxPercent can be used.\r\nAny income above the limit is taxed with ExcessTaxPercent.","format":"double"},"cumulativeIncome":{"type":["null","number"],"description":"Cumulative income on the taxcard - including this calculation.\r\nNote that with shared taxcards, this may include income from other employers.","format":"double"},"taxPercent2":{"type":["null","number"],"description":"Tax percentage that is used in calculating the widthholding tax for the part of income above the IncomeLimit.\r\nThis is percent. I.e. for 50% set 50, not 0.5.","format":"double"},"taxPercentMin":{"type":["null","number"],"description":"A Worker may request a minimum percent that is deducted even if the effective tax percent would be lower.\r\nThis can be used if Worker knows that he/she will be earning more in the year than what was estimated when the taxcard was created.","format":"double"},"taxPercentMinOwned":{"type":["null","number"],"description":"TaxPercentMin set by owner of the card.\r\nThis overrides the tax percent min set by the taxcard sharer.","format":"double"},"incomeType":{"description":"The income type of the taxacard if fetched from the tax authorities taxcard API.","$ref":"#/components/schemas/TaxcardApiIncomeType"},"kind":{"description":"Type of the taxcard as of 2019, when the taxcards logic was simplified by the Finnish tazx authorities.","$ref":"#/components/schemas/TaxcardKind"},"fileUri":{"type":"string","description":"Uri to the file copy of the tax card. \r\nSet by the system as part of the upload process, do not change in the API though it may be technically possible. This may have unintended results."},"previewUri":{"type":"string","description":"Uri to the preview image of the tax card. \r\nSet by the system as part of the upload process, do not change in the API though it may be technically possible. This may have unintended results."},"lastChecked":{"type":"string","description":"Explicit value of when the item was last checked. At the moment, updated in API fetches only, but may be used later for other checks.\r\nUndefined value is 1.1.2000","format":"date-time"}},"additionalProperties":false,"description":"Basic information about the taxcard: This object has the information printed in SalarySlip etc. \r\nbut not the full salaries paid to the taxcard etc."},"TaxcardState":{"enum":["new","approved","employerAdded","verifiedVero","sharedWaiting","sharedApproved","sharedRejected","sharedRejectedWithoutOpen","shared"],"type":"string","description":"Tax card approval state"},"TaxcardValidity":{"enum":["undefined","valid","validJanuary","future","expired"],"type":"string","description":"Validity of a taxcard at the given point of time.","readOnly":true},"TaxcardWaitingApproval":{"type":"object","properties":{"uri":{"type":"string","description":"URI for the shared card: This is the taxcard owned by the Worker and to view it \r\nyou need to request your own copy (would be in FullCard)."},"kind":{"description":"Type of the taxcard.","$ref":"#/components/schemas/TaxcardKind"},"state":{"description":"Status of the taxcard","$ref":"#/components/schemas/TaxcardState"},"createdAt":{"type":"string","description":"Time when the taxcard was added.","format":"date-time"},"owner":{"description":"Owner account that added the taxcard.","$ref":"#/components/schemas/Avatar"},"isRelationUnconfirmed":{"type":"boolean","description":"If true, the relation has not yet been confirmed:\r\nI.e. the employer has just input the Finnish Personal Id (HETU) of the Worker.\r\nThe employment relation is confirmed when salaries are paid or salary request is received from Worker."},"fullCard":{"description":"If there is an owner instance of taxcard for the employer, the copy is added here.\r\nInstance exists only if there is a confirmed employment relation or if employer explicitly requests the taxcard.","$ref":"#/components/schemas/Taxcard"}},"additionalProperties":false,"description":"Informs the employer that there is a Worker taxcard waiting for approval\r\npotentially without revealing personal information."},"TaxDeductionWorkCategories":{"enum":["none","householdwork","carework","homeImprovement","ownPropety","relativesProperty","oilHeatingReplacementWork"],"type":"string"},"TaxProduct":{"type":"object","properties":{"paymentReferenceNumber":{"type":"string","description":"The reference number for the tax authorities"},"irReporting":{"description":"Defines how the reporting is done for Incomes registry (Tulorekisteri).","$ref":"#/components/schemas/TaxReportHandling"},"isTaxAndSocialSecuritySelfHandling":{"type":"boolean","description":"If true, tax and social security payments are paid directly by the employer."},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"status":{"maxLength":56,"type":"string","description":"The status text that should give the user.\r\nRestrict the length to 56 characters.","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"enabled":{"type":"boolean","description":"If true, the product is enabled for the current user"},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"Service related to integration, reporting and payments to tax authorities."},"TaxReportHandling":{"enum":["default","noZeroSalaryReport","noMonthlyReport","always"],"type":"string"},"TaxWithholdingKind":{"enum":["undefined","percentage","fixedValue"],"type":"string","description":"Enumerates the tax witholding types for which automatic calculation is implemented."},"TaxWithholdingUsecase":{"type":"object","properties":{"taxValue":{"type":["null","number"],"format":"double"},"kind":{"enum":["undefined","percentage","fixedValue"],"type":"string"}},"additionalProperties":false},"Template":{"type":"object","properties":{"name":{"type":"string","description":"Short name of the template."},"description":{"type":"string","description":"Longer description of the template."},"packages":{"type":"array","items":{"$ref":"#/components/schemas/ContentPackage"},"description":"Contents of the template."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a template that can be used to create new business objects or parts of them."},"TemplateData":{"type":"object","properties":{"description":{"type":"string","description":"Longer description of the template."},"propertyPath":{"type":"string","description":"The property path of the first content package."},"type":{"oneOf":[{"type":"null"},{"description":"The entity type of the first content package.","$ref":"#/components/schemas/ApiItemType"}]}},"additionalProperties":false,"description":"Template specific business data for index."},"TemplateListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"type":"string","description":"The main status depending on the type of the object."},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/TemplateData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of templates in the user interface."},"TesParameters":{"type":"object","properties":{"type":{"description":"Type of the work framework","$ref":"#/components/schemas/FrameworkAgreement"},"subType":{"description":"Subtype when one framework has several options","$ref":"#/components/schemas/TesSubtype"},"isTesIncludedInSalary":{"type":"boolean","description":"Marker that the payments defined by framework agreement are included in the salary (will not be added by the calculation)."},"unionPayment":{"description":"Type of the union payment","$ref":"#/components/schemas/UnionPaymentType"},"unionPaymentPercent":{"type":"number","description":"Percent of the union payment","format":"double"},"numberOfDays":{"type":"integer","description":"Number of days may affect calculation of different payments calculated based on a Framework agreement","format":"int32"},"dailyTravelExpenses":{"type":["null","number"],"description":"Travel expences per day","format":"double"},"dailyTravelExpensesKm":{"type":["null","number"],"description":"The amount of kilometers travelled by day - used to define the amount of travel expenses in aomse framework agreements.","format":"double"},"dailyExpenses":{"type":["null","number"],"description":"Daily expenses amount","format":"double"},"isYksityisenHoidonTuki":{"type":"boolean","description":"If true will calculate the Finnish child care subsidy"},"yksityisenHoidonTukiAmount":{"type":["null","number"],"description":"Amount of Finnish child care subsidy","format":"double"},"isEntrepreneurPensionContract":{"type":"boolean","description":"If true, the Worker has his own entrepreneur contract.","readOnly":true},"isEntrepreneurPensionContractForFarmer":{"type":"boolean","description":"If true, the Worker has his own Pension farmer contract.","readOnly":true},"isEntrepreneurPensionContractForAthlete":{"type":"boolean","description":"If true, the Worker has his own Pension farmer contract.","readOnly":true}},"additionalProperties":false,"description":"Captures the collection of parameters that different Framework agreements (TES) have."},"TesSubtype":{"enum":["notSelected","constructionCarpenter","constructionFloor","constructionOther","constructionFreeContract"],"type":"string"},"TestAccountInfo":{"type":"object","properties":{"token":{"type":"string","description":"Bearer token for authentication."},"userCredential":{"description":"The current user credentials.","$ref":"#/components/schemas/SessionUserCredential"}},"additionalProperties":false,"description":"Object containing essential details of the test account"},"TestEnum":{"enum":["valueZero","valueOne","valueTwo","valueThree","valueFour","valueFive","valueSix","valueSeven","valueEight","valueNine","valueTen"],"type":"string"},"TestValues":{"type":"object","properties":{"intValue":{"type":["null","integer"],"description":"Test integer.","format":"int32"},"doubleValue":{"type":["null","number"],"description":"Test double.","format":"double"},"decimalValue":{"type":["null","number"],"description":"Test decimal.","format":"double"},"stringValue":{"type":"string","description":"Test string."},"dateTimeValue":{"type":["null","string"],"description":"Test DateTime.","format":"date-time"},"dateValue":{"type":["null","string"],"description":"Test Date.","format":"date"},"boolValue":{"type":["null","boolean"],"description":"Test bool."},"objectValue":{"type":"object","additionalProperties":false,"description":"Test object."},"arrayValue":{"type":"array","items":{"type":"string"},"description":"Test array"},"enumValue":{"oneOf":[{"type":"null"},{"description":"Test enum","$ref":"#/components/schemas/TestEnum"}]},"dictValue":{"type":"object","additionalProperties":false,"description":"Free values dictionary."}},"additionalProperties":false,"description":"Test object with value properties."},"ThreadedMessageType":{"enum":["text","blobFile","calculation","payroll","workerAccount","email","salaxyEmail","sms","salaxySms","timer","timerEdited","hourlyReport","timeReport","absence","annualLeave","calcRow","travel","expense"],"type":"string","description":"Type of the message"},"TimeRatePayKind":{"enum":["undefined","default","paidSickLeave","training","military","travel"],"type":"string"},"TopQueryOption":{"required":["context","rawValue"],"type":"object","properties":{"context":{"$ref":"#/components/schemas/ODataQueryContext"},"rawValue":{"type":"string","readOnly":true},"value":{"type":"integer","format":"int32","readOnly":true},"validator":{"$ref":"#/components/schemas/ITopQueryValidator"}},"additionalProperties":false,"readOnly":true},"TotalCalculationDTO":{"type":"object","properties":{"pension":{"type":"number","description":"The total pension payment for this calculation","format":"double"},"unemployment":{"type":"number","description":"The total unemployment payment sum.","format":"double"},"total":{"type":"number","description":"The total of all calculation rows","format":"double"},"totalBaseSalary":{"type":"number","description":"The base salary without overtime and other such additions that are part of gross salary.","format":"double"},"totalGrossSalary":{"type":"number","description":"Gross salary is the salary including additions like overtime, but not benefits or expenses","format":"double"},"totalTaxable":{"type":"number","description":"Taxable salary is the salary from the taxation point of view - includes some benefits.","format":"double"},"taxAtSourceDeduction":{"type":"number","description":"Deduction from TotalTaxable to tax at source calculation.","format":"double"},"totalSocialSecurityBase":{"type":"number","description":"DEPRICATED: This is now the same as TotalPensionInsuranceBase. For other social insurances, you may want to use \r\nTotalUnemploymentInsuranceBase, TotalHealthInsuranceBase or TotalAccidentInsuranceBase,","format":"double"},"totalPensionInsuranceBase":{"type":"number","description":"Base income for calculating the Pension insurance contributions.","format":"double"},"totalUnemploymentInsuranceBase":{"type":"number","description":"Base income for calculating the Unemployment insurance contributions.","format":"double"},"totalHealthInsuranceBase":{"type":"number","description":"Base income for calculating the Health insurance contributions.","format":"double"},"totalAccidentInsuranceBase":{"type":"number","description":"Base income for calculating the Accident insurance contributions.","format":"double"},"totalExpenses":{"type":"number","description":"Tax free expenses.","format":"double"},"totalPayable":{"type":"number","description":"Total sum of rows that are paid through Salaxy Customer Funds account.\r\nThis is the Gross sum before side costs, deductions etc., but it is not Gross salary as it includes expenses etc.","format":"double"}},"additionalProperties":false,"description":"Calculates the total numbers - the ones that are common to Employer and worker."},"TotalWorkerPaymentKind":{"enum":["undefined","totalWorkerPayment","totalWorkerWorkerPaymentExcludingExpenses","totalWorkerPaymentAndTax","totalWorkerWorkerPaymentAndTaxExcludingExpenses"],"type":"string","description":"Enumerates all the scopes for the given worker payment target amount."},"TotalWorkerPaymentUsecase":{"type":"object","properties":{"rowType":{"enum":["unknown","salary","hourlySalary","monthlySalary","totalWorkerPayment","totalEmployerPayment","timeRatePay","compensation","overtime","tesWorktimeShortening","eveningAddition","nightimeAddition","saturdayAddition","sundayWork","otherAdditions","paidSickLeaveSalary","paidSickLeaveHourlySalary","paidSickLeaveMonthlySalary","trainingSalary","trainingHourlySalary","trainingMonthlySalary","accomodationBenefit","mealBenefit","phoneBenefit","carBenefit","bicycleBenefit","otherBenefit","holidayCompensation","holidayBonus","holidaySalary","dailyAllowance","dailyAllowanceHalf","mealCompensation","milageOwnCar","toolCompensation","expenses","milageDaily","milageOther","unionPayment","foreclosure","advance","foreclosureByPalkkaus","prepaidExpenses","otherDeductions","deductibleOfExerciseAndCultureBenefit","childCareSubsidy","chainsawReduction","nonProfitOrg","subsidisedCommute","irIncomeType","board","remuneration","otherCompensation","workingTimeCompensation","employmentTermination","hourlySalaryWithWorkingTimeCompensation","paidSickLeave","training","payStats","taxAtSource","taxWithholding","absencePeriod","serviceCharge","service","info","totals"],"type":["null","string"]},"message":{"type":["null","string"]},"kind":{"enum":["undefined","totalWorkerPayment","totalWorkerWorkerPaymentExcludingExpenses","totalWorkerPaymentAndTax","totalWorkerWorkerPaymentAndTaxExcludingExpenses"],"type":"string"}},"additionalProperties":false},"TrainingKind":{"enum":["undefined","trainingSalary","trainingHourlySalary","trainingMonthlySalary"],"type":"string","description":"Kind for Training."},"TrainingUsecase":{"type":"object","properties":{"unit":{"enum":["undefined","hours","days","weeks","period","one","count","percent","kilometers","euro"],"type":"string"},"kind":{"enum":["undefined","trainingSalary","trainingHourlySalary","trainingMonthlySalary"],"type":"string"}},"additionalProperties":false},"TransactionCode":{"enum":["unknown","ignored","timeRatePay","initiativeFee","bonusPay","complementaryWagePaidDuringBenefitPeriod","emergencyWorkCompensation","eveningWorkCompensation","eveningShiftAllowance","noticePeriodCompensation","kilometreAllowanceTaxable","meetingFee","saturdayPay","extraWorkPremium","holidayBonus","lectureFee","compensationForTrustPosition","otherCompensation","waitingTimeCompensation","workingConditionCompensation","partialPayDuringSickLeave","commission","sundayWorkCompensation","benefitArisingFromSyntheticOption","performanceBonus","monetaryCompensationFromWorkingTimeBank","compensationForAccruedTimeOff","shareIssueForEmployees","contractPay","damagesInConjunctionWithTermination","standByCompensation","voluntaryCompensationInConjunctionWithTermination","weeklyRestCompensation","profitSharingBonus","annualHolidayCompensation","overtimeCompensation","nightWorkAllowance","nightShiftCompensation","otherRegularCompensation","compensationForUnusedCompensatoryLeave","accommodationBenefit","interestBenefitForHousingLoan","mealAllowance","carBenefit","compensationForGoverningBodyMembership","shareOfReserveDrawnFromPersonnelFund","monetaryGiftForEmployees","kilometreAllowanceTaxExempt","treatmentFeeForMunicipalVeterinarian","compensationForUseEarnedIncome","compensationForUseCapitalIncome","otherTaxableBenefitForEmployees","otherTaxableIncomeDeemedEarnedIncome","otherFringeBenefit","kinshipCarersFee","stockOptions","wagesPaidBySubstitutePayerIncludingSocialInsurance","wagesPaidBySubstitutePayerIncludingEarningsRelatedPensionInsurance","wagesPaidBySubstitutePayerIncludingUnemploymentInsurance","wagesPaidBySubstitutePayerIncludingAccidentAndOccupationalDiseaseInsurance","wagesPaidBySubstitutePayerIncludingHealthInsurance","compensationForEmployeeInvention","reimbursementOfPrivateCaretakersExpenses","privateCaretakersFee","reimbursementOfFamilyDayCareProvidersExpenses","telephoneBenefit","dailyAllowance","capitalIncomePayment","mealBenefit","reimbursementOfCostsPaidToConciliator","nonWageCompensationForWork","supplementaryDailyAllowancePaidByEmployerSpecificHealthInsuranceFund","pensionPaidByEmployer","dividendsBasedOnWages","dividendsBasedOnNonWage","employerSubsidisedCommuterTicketTaxExempt","employerSubsidisedCommuterTicketTaxable","employeeStockOption","wagesTransferredToAthletesSpecialFund","wagesPaidFromAthletesSpecialFund","wagesForInsurancePurposes","taxableReimbursementOfExpenses","privateDayCareAllowanceMunicipalSupplement","privateDayCareAllowanceWages","privateDayCareAllowanceNonWage","kilometreAllowancePaidByNonProfitOrganisation","dailyAllowancePaidByNonProfitOrganisation","unjustEnrichment","employeeStockOptionLowerMarketPrice","royaltyPaidToNonResidentTaxpayer","bicycleBenefitTaxExempt","bicycleBenefitTaxable","conditionalStockOptions","copyrightRoyaltiesEarnedIncome","stockGrantPaidInMoney","employeeStockOptionPaidInMoney","earningsFromJuELEmployerToLightEntrepreneur","compensationCollectedForCarBenefit","withholdingTax","electedOfficialFee","taxAtSource","taxAtSourceDeduction","wagesPaid","reimbursementCollectedForOtherFringeBenefits","otherItemDeductibleFromNetWage","netWage","employerPaidPremiumForCollectiveAdditionalPensionInsurance","employerPaidPremiumForCollectiveAdditionalPensionInsuranceEmployeesContribution","employeesHealthInsuranceContribution","employeesPensionInsuranceContribution","employeesUnemploymentInsuranceContribution","reimbursementForEmployerSubsidisedCommuterTicket","taxPaidAbroad","distraint","voluntaryIndividualPensionInsurancePremium","deductionBeforeWithholding","reimbursementCollectedForBicycleBenefit"],"type":"string"},"TransformationNode":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/TransformationNodeKind"}},"additionalProperties":false},"TransformationNodeKind":{"enum":["aggregate","groupBy","filter","compute","expand"],"type":"string","readOnly":true},"Type":{"type":"object","additionalProperties":false},"UnemploymentInsuranceSettings":{"type":"object","properties":{"payrollLimitStatus":{"description":"Status for indicating whether the total amount of paid salaries exceeds the thresold for higher unemployment insurance percent.","$ref":"#/components/schemas/UnemploymentPayrollLimitStatus"}},"additionalProperties":false,"description":"Settings related to unemployment insurance."},"UnemploymentPayrollLimitStatus":{"enum":["default","higher"],"type":"string","description":"The employer percentage of the unemployment contribution depends on the total amount of yearly salary payments.\r\nThe higher employment percentage should be set for large employers.","readOnly":true},"UnemploymentProduct":{"type":"object","properties":{"isSalariesPaidThisYear":{"type":"boolean","description":"If true, the account has paid salaries this year outside Palkkaus.fi.\r\nThis affects the yearly reporting - Palkkaus needs to contact the account.\r\nNote that this is a shared option with the taxation product."},"isPrepayments":{"type":"boolean","description":"If true, the account has made prepayments or is registered to make prepayments.\r\nPalkkaus needs to contact the account."},"isNotificationsSelfHandling":{"type":"boolean","description":"If true, the account himself handles the unemployment insurance notifications."},"id":{"type":"string","description":"Identifier for the product","readOnly":true},"title":{"type":"string","description":"The main short title for the product / service","readOnly":true},"status":{"maxLength":56,"type":"string","description":"The status text that should give the user.\r\nRestrict the length to 56 characters.","readOnly":true},"description":{"type":"string","description":"One paragraph description text","readOnly":true},"img":{"type":"string","description":"The logo image for the product.","readOnly":true},"articleId":{"type":"string","description":"Identifier for the main product desription article in the Palkkaus.fi CMS","readOnly":true},"enabled":{"type":"boolean","description":"If true, the product is enabled for the current user"},"visible":{"type":"boolean","description":"If false, it is not bossible to enable this product for the current account / environment. \r\nTypically, this means that the UI should not show this product."},"visited":{"type":"boolean","description":"Indicates (true-value) if the end user has confirmed the product options.\r\nIf false, the end user has not confirmed the option."}},"additionalProperties":false,"description":"Product that helps employer to handle the mandatory unemployment insurance reports and payments."},"UnionPaymentKind":{"enum":["undefined","fixed","percentage","percentageAndLimits","raksaNormal","raksaUnemploymentOnly","other"],"type":"string","description":"Enumerates the Union payment types for which automatic calculation is implemented"},"UnionPaymentType":{"enum":["notSelected","raksaNormal","raksaUnemploymentOnly","other"],"type":"string","description":"Enumerates the Union payment types for which automatic calculation is implemented"},"UnionPaymentUsecase":{"type":"object","properties":{"referenceNumber":{"type":["null","string"]},"recipientFullName":{"type":["null","string"]},"iban":{"type":["null","string"]},"paymentPercentage":{"type":["null","number"],"format":"double"},"maximumPayment":{"type":["null","number"],"format":"double"},"minimumPayment":{"type":["null","number"],"format":"double"},"kind":{"enum":["undefined","fixed","percentage","percentageAndLimits","raksaNormal","raksaUnemploymentOnly","other"],"type":"string"}},"additionalProperties":false},"Unit":{"enum":["undefined","hours","days","weeks","period","one","count","percent","kilometers","euro"],"type":"string","description":"Generic concept of Unit.\r\nValues Hours, Days, Weeks and Period are compatible with Income Register."},"Usecase":{"type":"object","properties":{"uri":{"type":"string","description":"Uri with owner information."},"label":{"type":"string","description":"Short title for the usecase."},"description":{"type":"string","description":"Longer description for what the usecase is used for."},"icon":{"type":"string","description":"URL for the icon that represents the service model. \r\nSupports font-awesome icons v4: https://fontawesome.com/v4.7/ (e.g. \"fa-wrench\") and images with absolute URL (https)."},"itemType":{"description":"Item type of the usecase","$ref":"#/components/schemas/ApiItemType"},"status":{"description":"The default status of the usecase in the settings.\r\nThe status affects the visibilty of the usecase.","$ref":"#/components/schemas/UsecaseStatus"},"order":{"type":"integer","description":"Order setting for the usecases.\r\nThis is needed e.g. ad hoc reports.","format":"int32"},"schema":{"type":"object","additionalProperties":false,"description":"JSON schema defines the data model and the automatically generated default user interface for the usecase."},"actions":{"type":"array","items":{"$ref":"#/components/schemas/UsecaseAction"},"description":"The actions related to this usecase."},"views":{"type":"array","items":{"$ref":"#/components/schemas/UsecaseView"},"description":"Customized userinterface definitions (views) for the usecase."},"workflowData":{"description":"Readonly workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Usecase definition"},"UsecaseAction":{"type":"object","properties":{"actionType":{"description":"Type of the automation action","$ref":"#/components/schemas/UsecaseActionType"},"label":{"type":"string","description":"Title of the action"},"uiShowButton":{"type":"boolean","description":"If true, the button is shown in the user interfaces.\r\nTODO: This property may be removed before final production version =&gt; Set on/off depending on the view."},"uiText":{"type":"string","description":"Text for the UI button."},"uiColor":{"description":"Defines the color of the UI button","$ref":"#/components/schemas/BootstrapStyle"},"description":{"type":"string","description":"Description of the action"},"content":{"type":"string","description":"The content: The script or other definition."}},"additionalProperties":false},"UsecaseActionType":{"enum":["clientScript","clientScriptAsync","serverScript","serverScriptAsync","webServiceCall","powerAutomateFlow"],"type":"string","description":"Usecase action types."},"UsecaseData":{"type":"object","properties":{"uri":{"type":"string","description":"Key for the usecase based on which it is resolved. \r\nLater, this may resolve to a user interface, microservice or a to manifest registering one.\r\nFor now, just use a unique string starting with a domain you own."},"label":{"type":"string","description":"A short label of that can be shown to the end user."},"description":{"type":"string","description":"Optional description of the use case for the end user.\r\nShown in detail views when explaining the logic of the usecase."},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data"}},"additionalProperties":false,"description":"A usecase for creating and editing salary calculations and other .\r\nIn practice, a usecase is either a user interface or a microservice that provides the bases for the object.\r\nProvides the possibility to store useacase specific data as part of object.\r\nNOTE: For Calculations, this functionality will replace TesParameters in the 3.0 version."},"UsecaseInSettings":{"type":"object","properties":{"uri":{"type":"string","description":"Uri of the usecase"},"itemType":{"description":"Item type of the usecase","$ref":"#/components/schemas/ApiItemType"},"label":{"type":"string","description":"Short title for the usecase"},"isDefault":{"type":"boolean","description":"If true, the usecase is the default usecase for this type (for the current account)."},"status":{"description":"Status of the usecase in the settings.\r\nThe status affects the visibilty of the usecase.","$ref":"#/components/schemas/UsecaseStatus"},"order":{"type":"integer","description":"Order setting for the usecases.\r\nThis is needed e.g. ad hoc reports.","format":"int32"}},"additionalProperties":false,"description":"Usecase definition."},"UsecaseListItem":{"type":"object","properties":{"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"timestamp":{"type":["null","string"],"description":"Last date of modification of the object. The modification can be produced by the end user or by the system.","format":"date-time"},"ownerId":{"type":"string","description":"Person GUID for the owner of the object."},"ownerInfo":{"description":"Metadata for the owner","$ref":"#/components/schemas/AccountInIndex"},"status":{"description":"The main status depending on the type of the object.","$ref":"#/components/schemas/UsecaseStatus"},"backOfficeStatus":{"type":"string","description":"The back office status depending on the type of the object."},"startAt":{"type":["null","string"],"description":"When the event started. Typically, this is the CreatedAt date, but it may be something else.","format":"date"},"endAt":{"type":["null","string"],"description":"This is the end date of the event.\r\nTypically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation.","format":"date"},"grossSalary":{"type":["null","number"],"description":"Gross salary if that is relevant to the transaction.","format":"double"},"payment":{"type":["null","number"],"description":"This is the payment from the Owner point-of-view:\r\nTotal payment for the Employer and Net salary for the Worker in the case of a calculation.\r\nOnly add here the payment, if the payment is really made.","format":"double"},"fee":{"type":["null","number"],"description":"Estimated fee of the transaction to Palkkaus.fi.","format":"double"},"otherId":{"type":"string","description":"The GUID for the other party. Currently, this is always the PersonID."},"otherPartyInfo":{"description":"The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer).","$ref":"#/components/schemas/AccountInIndex"},"shortText":{"type":"string","description":"A very short description describing the object as an event. E.g. \"Paid salary\""},"businessObjects":{"type":"array","items":{"type":"string"},"description":"Business object ids related to this object. E.g. calculations and payrolls in the payment."},"salaryDate":{"type":["null","string"],"description":"This is valid for calculations only. The estimated date of salary in worker.","format":"date"},"data":{"description":"Business data to include further information of the object.","$ref":"#/components/schemas/UsecaseListItemData"},"versionNumber":{"type":["null","integer"],"description":"Version number. May be used in conflicts","format":"int32"},"uri":{"type":"string","description":"Salaxy uri of the resource."},"flags":{"type":"array","items":{"type":"string"},"description":"Workflow flags for the object.\r\nOnly workflow events with API supported message types are listed."},"messages":{"type":"array","items":{"type":"string"},"description":"Workflow messages for the object.\r\nOnly workflow events with API supported message types are listed.\r\nShown in format \"[MessageType]:[Message] ([User] at [UTC-time])\""},"entityType":{"type":"string","description":"Sub category for the payload. E.g. Payment Category, MoneyTransfer Source."},"logicalDate":{"type":["null","string"],"description":"The date for the actual period for which this object is done.","format":"date-time"},"reference":{"type":"string","description":"Reference information. E.g. Payment or MoneyTransfer reference number."},"externalId":{"type":"string","description":"External id for the object in 3rd party system."},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Represents a single item in a list of usecases."},"UsecaseListItemData":{"type":"object","properties":{"partnerMessageAssignedTo":{"type":"string","description":"Contains the email or id of the responsible for the partner workflow event."},"description":{"type":"string","description":"Longer description for what the usecase is used for."},"icon":{"type":"string","description":"URL for the icon that represents the service model. \r\nSupports font-awesome icons v4: https://fontawesome.com/v4.7/ (e.g. \"fa-wrench\") and images with absolute URL (https)."},"order":{"type":"integer","description":"Order setting for the usecases.\r\nThis is needed e.g. ad hoc reports.","format":"int32"}},"additionalProperties":false,"description":"Usecase specific business data for index."},"UsecaseSettings":{"type":"object","properties":{"denyServiceModel":{"type":"boolean","description":"If true, the service model is not applied to this feature."},"usecases":{"type":"array","items":{"$ref":"#/components/schemas/UsecaseInSettings"},"description":"Available usecases for the current account."},"serverUrl":{"type":"string","description":"URL to custom staging / integration server.\r\nUsed in running custom usecases and other custom integrations (currently imports)."}},"additionalProperties":false,"description":"Usecase related settings."},"UsecaseStatus":{"enum":["undefined","active","default","inactive"],"type":"string","description":"Status enumeration for usecases in settings.\r\nThe status affects the visibility of usecases."},"UsecaseView":{"type":"object","properties":{"label":{"type":"string","description":"Title of the action"},"description":{"type":"string","description":"Description of the action"},"content":{"type":"string","description":"The content: The HTML for the view."}},"additionalProperties":false,"description":"Customized user interface view."},"UserDefinedRow":{"type":"object","properties":{"rowIndex":{"type":"integer","description":"Zero based row index that can be used to match the row to result rows or when deleting.\r\nNOTE: The Row ID is given values on the fly so setting this will not have any effect at the moment.\r\nIt may reorder the entries in later implementations.","format":"int32"},"type":{"type":"string","description":"Wage type. Either a built in wage type in Salaxy or a custom wage type created by the user.\r\nPlease note that this type fully determines the CalculationRowType and the kind."},"rowType":{"description":"Logical type of the row","$ref":"#/components/schemas/CalculationRowType"},"message":{"type":"string","description":"Description text of the row that is shown in reports. If null, will be set according to type."},"count":{"type":["null","number"],"description":"Count for the row - default is one","format":"double"},"price":{"type":"number","description":"Price for the row","format":"double"},"unit":{"description":"Unit for the row. Guessed based on the RowType and count, but you are better off setting it to be sure.","$ref":"#/components/schemas/CalculationRowUnit"},"source":{"description":"Source of the calculation row - affects how the row is handled in editing / recalculation scenarios.","$ref":"#/components/schemas/CalculationRowSource"},"sourceId":{"type":"string","description":"Identifier in the source system is a key defined by a source system / partner system.\r\nThis is a pass-through string that is passed to the result calculations."},"accounting":{"description":"Accounting related data for the row.","$ref":"#/components/schemas/RowAccounting"},"period":{"description":"Period if different than the Period of calculation.\r\nWill be reported to the National Incomes registry, but also affect some other calculations.\r\nNote that this property may be (and by default is) null.","$ref":"#/components/schemas/DateRange"},"data":{"type":"object","additionalProperties":false,"description":"Usecase specific data"}},"additionalProperties":false,"description":"This is a user defined calculation row as opposed to CalculationRow that may \r\nbe either based on a user defined row or generated by the system based on e.g. TES parameters."},"UserInfoAccountRoles":{"enum":["unknown","noAccess","readOnly","readWrite","owner"],"type":"string","description":"Account rolse in the Open ID COnnect UserInfo message (Salaxy extension)"},"UserInfoApplication":{"type":"object","properties":{"return_link":{"type":"string","description":"Return link back to the calling application. Token is added to this string"},"cancel_link":{"type":"string","description":"Return link in case of error or user cancel."},"role":{"description":"Application role that the user has in relation to the account in this session.\r\nCurrently supported values are: \"noAccess\" and \"owner\"\r\nAlso \"unknown\" (the default if null) is technically supported, but that value is an error in federation process by design.","$ref":"#/components/schemas/UserInfoAccountRoles"},"state":{"type":"object","additionalProperties":{"type":"string"},"description":"Application specific state data that is sent from the federation provider to the end-application.\r\nThis data is guaranteed to survive the onboarding process."},"custom":{"type":"object","additionalProperties":{"type":"string"},"description":"TEMPORARY"}},"additionalProperties":false,"description":"Salaxy extension to Open ID Connect UserInfo claims for Application data."},"UserInfoCompanyAccount":{"required":["business_id","type"],"type":"object","properties":{"as_company":{"type":"boolean","description":"If true, the authorization is made for a company account. \r\nThe root user claims are just for a current user acting in behalf of the company.\r\nIf false, the entire CompanyClaims object will be ignored."},"business_id":{"type":"string","description":"The Business ID (Y-tunnus / Business Identity Code) is a code given to businesses and organizations by the PRH or the Tax Administration. \r\nIt consists of seven digits, a dash and a control mark, for example 1234567-8.\r\nAlternative accepted formats incule international VAT number \"FI12345678\" or number without the dash: \"12345678\"."},"type":{"description":"One of the Salaxy Finnish company type shortcuts: fiOy, fiTm, fiRy, fiYy (Other)","$ref":"#/components/schemas/CompanyType"},"name":{"type":"string","description":"Company name - the owner of the Salaxy account and shown in salary calculations, reports and invoices.\r\nTypically this is the official full name of the company as in Business registry."},"picture":{"type":"string","description":"URL of the Company profile picture.\r\nThis URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. \r\nThe URL SHOULD specifically reference a company logo picture (PNG preferred) and it should be a square. If not, it may be converted, cropped and/or extended."},"email":{"type":"string","description":"The company's preferred e-mail address in relation to salary payments.\r\nIts value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax."},"email_verified":{"type":["null","boolean"],"description":"True if the Company's e-mail address has been verified; otherwise false.\r\nIMPORTANT: In Salaxy federation context, avoid sending non-confirmed e-mails. This may later become an error without being considered a breaking change.\r\nWhen this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. \r\nThe means by which an e-mail address is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating."},"phone_number":{"type":"string","description":"Company's preferred telephone number for salary payment purposes. \r\nE.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400.\r\nIf the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678."},"phone_number_verified":{"type":["null","boolean"],"description":"True if the Company's phone number has been verified; otherwise false.\r\nWhen this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed.\r\nThe means by which a phone number is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.\r\nWhen true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format."},"address":{"description":"Company's preferred postal address in relation to salary payments.\r\nThe value of the address member is a JSON [RFC4627] structure containing some or all of the members defined in Section 2.5.1.","$ref":"#/components/schemas/OpenIdUserInfoAddress"},"proxy_partner":{"type":"string","description":"The primary partner account for the new company to create.\r\nIf the company already exists and has given authorization to the primary partner, and does not have any primary partner, the primary partner will be set.\r\nPlease note, that the calling account must have the authorization to the primary partner account, or\r\nbe the primary partner itself."},"partner_account_id":{"type":"string","description":"The account identifier at the partner site. \r\nIf present, this ID is used to restrict the authorization to one account at partner site only."}},"additionalProperties":false,"description":"Salaxy extension to Open ID claims for company federation."},"UserInfoPersonAccount":{"type":"object","properties":{"can_sign_company":{"type":["null","boolean"],"description":"If true, the user issuer indicates that the current user has the right to sign in behalf of the company / association.\r\nIn this case the provider must also provide a valid Finnish personal ID in personal_id field."},"personal_id":{"type":"string","description":"A Finnish Personal ID (Henkilötunnus / HETU) for digital signature.\r\nIf can_sign_company is set to true, the issuer should provide a valid personal id here."}},"additionalProperties":false,"description":"Salaxy extension to Open ID Connect UserInfo claims for Personal account federation."},"UserSession":{"type":"object","properties":{"isAuthorized":{"type":"boolean","description":"If false, the current user needs to be authenticated or authenticated user does not have acces to the system."},"hasCredential":{"type":"boolean","description":"If false, the current user does not have a credential in the system =&gt; need to redirect to login"},"hasCurrentAccount":{"type":"boolean","description":"If false, the current user does not have a current account. \r\nIf HasCredential is true, this means that the user should be redirected to Account creation wizard."},"status":{"description":"Authorization status","$ref":"#/components/schemas/AuthorizationStatus"},"avatar":{"description":"Avatar that should be shown for the current session.\r\nTypically CurrentAccount.Avatar, but could theoretically be something different.","$ref":"#/components/schemas/Avatar"},"currentCredential":{"description":"The current user credentials.","$ref":"#/components/schemas/SessionUserCredential"},"currentAccount":{"description":"The current Palkkaus.fi-account that the user acting as","$ref":"#/components/schemas/IVerifiedAccount"},"systemAlertHtml":{"type":"string","description":"Contains html for system alert."},"settings":{"description":"Often needed settings directly in session object.\r\nNOTE: For editing settings, request the full settings object separately.","$ref":"#/components/schemas/AccountSettingsInSession"},"tenant":{"type":"string","description":"Optional Tenant ID."}},"additionalProperties":false,"description":"Passes the data about the authorization that is the bases for callin the \r\nservices that require user authorization."},"VarmaPensionOrder":{"type":"object","properties":{"orderer":{"description":"Orderer information.","$ref":"#/components/schemas/InvoiceParty"},"action":{"description":"Action for the order.","$ref":"#/components/schemas/VarmaPensionOrderAction"},"validation":{"description":"Validation information.","$ref":"#/components/schemas/ApiValidation"},"yel":{"description":"YEL data for the order","$ref":"#/components/schemas/VarmaPensionOrderYel"},"tyel":{"description":"TyEL data for the order","$ref":"#/components/schemas/VarmaPensionOrderTyel"}},"additionalProperties":false,"description":"Contains order data for Varma pensions (TyEL, YEL) and required operations."},"VarmaPensionOrderAction":{"enum":["undefined","newYel","newTyel","move"],"type":"string","description":"Varma pension order action."},"VarmaPensionOrderTyel":{"type":"object","properties":{"personalId":{"type":"string","description":"Personal id number."},"isMove":{"type":"boolean","description":"If true, indicates that existing contract will be moved to Varma."},"yearlyIncome":{"type":["null","number"],"description":"Estimated yerly income.","format":"double"},"startYear":{"type":"string","description":"Start year for the new order."},"startMonth":{"type":"string","description":"Start month for the new order."},"moveMoment":{"type":"string","description":"Movement timing. (Q1,Q2,Q3 or Q4, or as soon as possible)"}},"additionalProperties":false,"description":"Varma pension order TyEL details."},"VarmaPensionOrderYel":{"type":"object","properties":{"personalId":{"type":"string","description":"Personal id number."},"payer":{"oneOf":[{"type":"null"},{"description":"Payer definition.","$ref":"#/components/schemas/VarmaPensionOrderYelPayer"}]},"isMove":{"type":"boolean","description":"If true, indicates that existing contract will be moved to Varma."},"yearlyIncome":{"type":["null","number"],"description":"Estimated yearly income.","format":"double"},"startDate":{"type":["null","string"],"description":"Start date for the new pension.","format":"date-time"},"moveMoment":{"type":"string","description":"Movement timing. (Q1,Q2,Q3 or Q4, or as soon as possible)"},"isYearlyIncomeChange":{"type":"boolean","description":"Indicates if the existing yearly income estimate will be changed."}},"additionalProperties":false,"description":"Varma pension order YEL details."},"VarmaPensionOrderYelPayer":{"enum":["undefined","entrepreneur","company"],"type":"string"},"VatEntry":{"type":"object","properties":{"tax":{"type":["null","number"],"description":"Tax amount of specific VAT rate in euro.\r\nThis value is mandatory, if the collection of VatEntries contains more than one item.","format":"double"},"vatRate":{"description":"Applied VAT rate. This is always mandatory.","$ref":"#/components/schemas/VatRate"},"taxPercent":{"type":["null","number"],"description":"Tax as percent of Net sales (0-1). Currently just informative, but may later be used for Custom non-standard VAT rates.","format":"double"},"gross":{"type":["null","number"],"description":"Gross sales for specific VAT rate including the tax (VAT).\r\nThis value is mandatory, if the collection of VatEntries contains more than one item.","format":"double"},"net":{"type":["null","number"],"description":"Net sales for specific VAT rate excluding the tax (VAT).\r\nThis value is mandatory, if the collection of VatEntries contains more than one item.","format":"double"}},"additionalProperties":false,"description":"For VAT breakdown of a receipt (ALV-erittely) represents a single VAT rate and the revenue and tax with that rate."},"VatRate":{"enum":["undefined","none","vat0000","vat1000","vat1350","vat1400","vat2400","vat2550","other"],"type":"string","description":"VAT rates determine what percentages of value-added tax must be paid on various goods and services. \r\nhttps://www.vero.fi/en/businesses-and-corporations/taxes-and-charges/vat/rates-of-vat/"},"VersionInfo":{"type":"object","properties":{"versionId":{"type":"string","description":"Identifier for the version."},"operation":{"type":"string","description":"Operation which created the version."},"date":{"type":"string","description":"Date and time when the version was created.","format":"date-time"},"userAccount":{"description":"User account  who created the version.","$ref":"#/components/schemas/Avatar"}},"additionalProperties":false,"description":"Version information for the API object."},"VismaSignV01ObData":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID identifies the document (one or several files) that are to be signed in Visma Sign storage."},"invitationId":{"type":"string","description":"Invitation ID that is used in the signature process"},"category":{"type":"string","description":"Category / folder where the item is stored."},"fileName":{"type":"string","description":"File name in Visma Sign."},"authService":{"type":"string","description":"Logs the authentication service (e.g. 'tupas-osuuspankki', 'tupas-nordea') for later analyses.\r\nAll methods are available in https://sign.visma.net/api/v1/auth/methods (test: https://vismasign.frakt.io/api/v1/auth/methods)"}},"additionalProperties":false,"description":"For Visma Sign V01, data that is stored within the onboarding object."},"WageBasis":{"enum":["undefined","monthly","hourly","performanceBased","other"],"type":"string","description":"Default bases for wage."},"WaitHandle":{"type":"object","properties":{"handle":{},"safeWaitHandle":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/SafeWaitHandle"}]}},"additionalProperties":false,"readOnly":true},"WebSiteUserRole":{"enum":["none","household","worker","company"],"type":"string","description":"Type of the user on the site. \r\nNOTE: Depending on the situation this may be used as Flags or not."},"WebSocketManager":{"type":"object","properties":{"isWebSocketRequest":{"type":"boolean","readOnly":true},"webSocketRequestedProtocols":{"type":"array","items":{"type":"string"},"readOnly":true}},"additionalProperties":false,"readOnly":true},"WorkDescription":{"type":"object","properties":{"description":{"type":"string","description":"Free text description of the work that is being performed."},"occupationCode":{"type":"string","description":"Occupation classification, used at least for Accident insurance purposes, but may be used for other reporting. \r\nFor Finnish Salaries use the Statistics Finland \r\n\"Classification of Occupations 2010\" (TK10): https://www.stat.fi/meta/luokitukset/ammatti/017-2018-05-15/index_en.html"},"occupationCode2":{"type":"string","description":"Secondary occupation classification. Some earnings payment reports may require two occupation codes."},"salaryDefaults":{"type":"array","items":{"$ref":"#/components/schemas/UserDefinedRow"},"description":"Contains default calculation rows for the worker.\r\nTypically used for setting for example monthly salary or hourly salary price for workers."},"wageBasis":{"description":"Default bases for wage.","$ref":"#/components/schemas/WageBasis"},"monthlyHours":{"type":["null","number"],"description":"Number of hours per month defined in the employment contract.","format":"double"},"weeklyHours":{"type":["null","number"],"description":"Number of hours per week defined in the employment contract.","format":"double"},"dailyHours":{"type":["null","number"],"description":"Number of hours per day defined in the employment contract.","format":"double"},"accounting":{"description":"Contains calculation specific data for accounting (both cost and financial accounting).","$ref":"#/components/schemas/CalculationAccounting"}},"additionalProperties":false,"description":"Describes the work that is being performed - mainly for Employment relation purposes."},"WorkerAbsencePeriod":{"type":"object","properties":{"absencesId":{"type":"string","description":"WorkerAbsences storage object that contains the period"},"worker":{"description":"The Worker that owns the Absence period","$ref":"#/components/schemas/Avatar"},"id":{"type":"string","description":"Identifies a single leave."},"period":{"description":"Period for the absance.","$ref":"#/components/schemas/DateRange"},"causeCode":{"description":"Cause / type of the absence","$ref":"#/components/schemas/AbsenceCauseCode"},"isPaid":{"type":["null","boolean"],"description":"If true, the absence is paid by the employer."},"isHolidayAccrual":{"type":["null","boolean"],"description":"If true, annual leaves are accrued from the absence. If false, these days are deducted from the accrual.\r\nBy default, you may leave this null and it always follows the IsPaid."},"amount":{"type":"number","description":"Amount of salary that is paid for the absense.\r\nCurrently not in use: Would be used in Incomes Register integration.","format":"double"},"notes":{"type":"string","description":"Additional information as recorded by the Employer."},"sourceId":{"type":"string","description":"Identifier in the source system is a key defined by a source system / partner system.\r\nThis is a pass-through string that is passed to the result calculations."},"bonusDaysCount":{"type":["null","number"],"description":"Number of Bonus days to be paid. This is applicable only for AbsenceCauseCode.AnnualLeaveAnnualLeave.","format":"double"},"holidayYear":{"type":["null","integer"],"description":"Holiday year to consume, if the period is outside the normal holiday pay period for the holiday year.","format":"int32"}},"additionalProperties":false,"description":"Absence Period with Worker information."},"WorkerAbsences":{"required":["employmentId"],"type":"object","properties":{"workerId":{"type":"string","description":"Account ID for the worker whose absences are recorded."},"employmentId":{"type":"string","description":"The employment relation id for the worker whose absences are recorded."},"periods":{"type":"array","items":{"$ref":"#/components/schemas/AbsencePeriod"},"description":"Collection of absence periods."},"workerSnapshot":{"description":"Basic information for the Worker. \r\nAutomatically updated upon save based on WorkerId.\r\nMainly for the listings etc.","$ref":"#/components/schemas/Avatar"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Absences for a single Worker."},"WorkerAccount":{"type":"object","properties":{"ibanNumber":{"type":"string","description":"Tha bank account number of the Worker - in Iban format."},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"employerId":{"type":"string","description":"If created (and still owned) by an employer, this is the AccountOwnerId of the employer who created this account."},"officialPersonId":{"type":"string","description":"The Person ID of the worker if known."},"ageRange":{"description":"Age range that is relevant to workers salary calculation and/or employment.\r\nSet this especially if OfficialPersonId is not set. \r\nIf OfficialPersonId is valid, this property is always set based on it.","$ref":"#/components/schemas/AgeRange"},"employment":{"description":"Current Employment Relation: The data that is owned by the Employer about the Worker \r\neven if the Worker has registered and created an account.\r\nIf employer has several Employment Relations, this is the one that is marked as Primary.","$ref":"#/components/schemas/WorkerAccountEmployment"},"validation":{"description":"Provides validation errors currently only in Save operations,\r\nbut potentially in the future also in detail/list views.","$ref":"#/components/schemas/ApiValidation"},"employmentId":{"type":"string","description":"The unique id for the employment. This does not change within one employment."},"entityType":{"description":"Entity type of the account.\r\nType PersonCreatedByEmployer means that the Worker has not yet signed into the system and there may be multiple instances of the same logical person (Official ID) - one for each employer.","$ref":"#/components/schemas/LegalEntityType"},"isEmployer":{"type":"boolean","description":"If true the object Account is and Employer account - it has the EmployerInfo object"},"isWorker":{"type":"boolean","description":"If true the object Account is and Worker account - it has the WorkerInfo object"},"isVerified":{"type":"boolean","description":"If true, the account has been verified. Typically this means a digitally signed contract.\r\nThis means that the account also has an Identity object.\r\nHowever, as the Identity object contains confidential information, it is not necessarily present in all method calls."},"avatar":{"description":"Avatar is the visual representation of the Account.","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the Account.","$ref":"#/components/schemas/Contact"},"language":{"description":"Language of the person/company.","$ref":"#/components/schemas/Language"},"serviceModelId":{"type":"string","description":"Service model for the account."},"workflowData":{"description":"Workflow data, which is exposed to API.","$ref":"#/components/schemas/WorkflowData"},"id":{"maxLength":64,"type":"string","description":"Identifier of the object."},"createdAt":{"type":["null","string"],"description":"The date when the object was created.","format":"date-time"},"updatedAt":{"type":["null","string"],"description":"The time when the object was last updated. \r\nTypically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates.","format":"date-time"},"owner":{"maxLength":64,"type":"string","description":"Owner ID for this data"},"isReadOnly":{"type":"boolean","description":"Indication that for the currently logged-in account, the data is generally read-only."},"partner":{"type":"string","description":"Primary partner information. Automatically updated from the storage container Partner."}},"additionalProperties":false,"description":"Account data that is relevant for a Worker."},"WorkerAccountEmployment":{"type":"object","properties":{"type":{"description":"Type of the employment relation","$ref":"#/components/schemas/EmploymentRelationType"},"irIncomeEarnerTypes":{"type":"array","items":{"$ref":"#/components/schemas/IncomeEarnerType"},"description":"Type of additional income earner data by National Incomer Register classification . If several types apply, all of them should be selected."},"cbaCode":{"type":["null","integer"],"description":"Applicable collective agreement","format":"int32"},"employeeGroup":{"type":"string","description":"Employee group."},"work":{"description":"Describes the work that is being performed in this Employment Relation.","$ref":"#/components/schemas/WorkDescription"},"holidays":{"description":"Defines how the holidays are specified to this Worker.","$ref":"#/components/schemas/HolidaySpecification"},"usecase":{"description":"Usecase is data related to the source and processing of the Employment data outside the Salaxy backend service / system.\r\nTypically, Usecase data would be processed by an external system that has originally created the \r\nEmployment Relation (Worker / Employee in many systems). E.g. expenses system, hourly reporting system.","$ref":"#/components/schemas/UsecaseData"},"isYel":{"type":["null","boolean"],"description":"If true the worker's pension contract is for entrepreneurs (yel)."},"pensionCalculation":{"description":"Type for the pension insurance.","$ref":"#/components/schemas/PensionCalculation"},"pensionRule":{"description":"Rules (e.g. effect of monthly lower limit) for pension calculation.","$ref":"#/components/schemas/PensionRule"},"pensionCompany":{"oneOf":[{"type":"null"},{"description":"The id of the pension company.","$ref":"#/components/schemas/PensionCompany"}]},"pensionContractNumber":{"type":"string","description":"The pension contract number.","format":"pension-contract-number"},"insuranceCompany":{"oneOf":[{"type":"null"},{"description":"The id of the insurance company.","$ref":"#/components/schemas/InsuranceCompany"}]},"insuranceContractNumber":{"type":"string","description":"The accident insurance contract number.","format":"insurance-contract-number"},"taxcard":{"description":"Taxcard type from the employment point of view.","$ref":"#/components/schemas/EmploymentRelationTaxcard"},"salaryPaymentMethod":{"description":"Worker's salary payment method, bank account, external etc.","$ref":"#/components/schemas/EmploymentRelationSalaryPaymentMethod"},"startDate":{"type":["null","string"],"description":"Start date of the Employment Relation.","format":"date"},"endDate":{"type":["null","string"],"description":"End date of the Employment Relation.","format":"date"},"isFixedTerm":{"type":"boolean","description":"Duration of the employment. If true, the employment relation is for a fixed term.\r\nOtherwise (which is the default) the employment relation continues until further notice."},"isTerminated":{"type":"boolean","description":"Indicates that the employment relation has been terminated.\r\nSaving with this status also makes the employment relation Archived."},"employmentEndingCode":{"oneOf":[{"type":"null"},{"description":"Termination of employment\r\nMandatory data group, if \"Time of employment\" with an \"End date\" has been specified in the report, and the \"Pension provider code\" is 20, 30, 25, 24, 29 or 29.","$ref":"#/components/schemas/EmploymentEndingCode"}]},"isAccountOwner":{"type":"boolean","description":"If true, the worker is the same person as the actual signed owner of the account."},"sourceId":{"type":"string","description":"Identifier in a source system. Used in imports etc."},"employmentRegCode":{"type":"string","description":"Employment registration code for Incomes Registry."}},"additionalProperties":false,"description":"Employment Relation as it is shown as part of WorkerAccount."},"WorkerCalculationDTO":{"type":"object","properties":{"benefits":{"type":"number","description":"The benefits as valued by the tax authority.","format":"double"},"deductions":{"type":"number","description":"All the items that are deducted from the salary (this is also the order if there is not enough payable money):\r\nSalaryAdvance + Tax + Pension + UnemploymentInsurance + UnionPayment + OtherDeductions","format":"double"},"salaryPayment":{"type":"number","description":"The payment that is made to the Worker based on salary after all deductions.\r\nDoes not include expenses.","format":"double"},"salaryAdvance":{"type":"number","description":"The salary advance that was paid to the Worker","format":"double"},"foreclosure":{"type":"number","description":"The foreclosure that been deducted from the salary by the employer.","format":"double"},"tax":{"type":"number","description":"Ennakonpidätys: The taxes that were deducted from the worker salary.","format":"double"},"taxAtSource":{"type":"number","description":"Lähdevero: The tax at source that were deducted from the worker salary.","format":"double"},"salaryAfterTax":{"type":"number","description":"Net salary after tax - before worker foreclosure or deductions of the side costs","format":"double"},"salaryAfterTaxAndForeclosure":{"type":"number","description":"Net salary after tax and foreclosure.","format":"double"},"pension":{"type":"number","description":"Part of the Pension that is taken from the Worker side of the salary.","format":"double"},"unemploymentInsurance":{"type":"number","description":"Workers part of the unemployment insurance.","format":"double"},"socialSecurity":{"type":"number","description":"The social security payment. NOT paid as a part of tax withhold .","format":"double"},"unionPayment":{"type":"number","description":"The union payment that is deducted from the Worker salarya s per workers request.","format":"double"},"fullTax":{"type":"number","description":"Widthholding tax: The original calulated version - there might not be enough money to finally pay this.","format":"double"},"fullTaxAtSource":{"type":"number","description":"Tax at source: The original calulated version - there might not be enough money to finally pay this.","format":"double"},"fullSalaryAdvance":{"type":"number","description":"The salary advance that was paid to the Worker\r\nThe original calulated version - there might not be enough money to finally pay this.","format":"double"},"fullPension":{"type":"number","description":"Part of the Pension that is taken from the Worker side of the salary.\r\nThe original calulated version - there might not be anough money to finally pay this.","format":"double"},"fullUnemploymentInsurance":{"type":"number","description":"Workers part of the unemployment insurance.\r\nThe original calulated version - there might not be anough money to finally pay this.","format":"double"},"fullSocialSecurity":{"type":"number","description":"The social security payment. NOT paid as a part of tax withhold .\r\nThe original calculted version.","format":"double"},"fullUnionPayment":{"type":"number","description":"The union payment that is deducted from the Worker salarya s per workers request.","format":"double"},"totalWorkerPayment":{"type":"number","description":"The sum that is at the end paid to the Worker:\r\nSalary payment + expenses","format":"double"},"totalWorkerPaymentLegacy":{"type":"number","description":"Total payment using pre Insiders register calculation logic.\r\nDEPRICATED: This is provided for special scenarios and may be removed without warning","format":"double"},"workerSideCosts":{"type":"number","description":"The side costs that are deducted from the Worker salary according to law:\r\nPension, Unemployment and Union payment. Tax is not included in this number.\r\nThis is not an official number, really used in the charts etc.","format":"double"},"fullOtherDeductions":{"type":"number","description":"Other deductions that are deducted from the net salary.\r\nThe original calulated version - there might not be enough money to finally deduct this.","format":"double"},"otherDeductions":{"type":"number","description":"Part of the other deductions that are deducted from the net salary.","format":"double"},"fullPrepaidExpenses":{"type":"number","description":"Prepaid expenses that are deducted from the expenses to be paid to the worker.\r\nThe original calulated version - there might not be enough money to finally deduct this.","format":"double"},"prepaidExpenses":{"type":"number","description":"Part of the prepaid expenses that are deducted from the expenses.","format":"double"}},"additionalProperties":false,"description":"The Worker side of the calculation.\r\nSalarySlip is largely written based on this calculation."},"WorkerCheck":{"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678\r\nThis field is optional and defaults to the company number of the current account."},"id":{"type":"string","description":"Item id to check.\r\nThis can be external ID, official ID or Salaxy ID."},"validation":{"description":"Validation for the import","$ref":"#/components/schemas/ApiValidation"},"result":{"description":"Result object of the import.","$ref":"#/components/schemas/ApiCheckResultOfWorkerAccountArray"}},"additionalProperties":false,"description":"API worker check object.\r\nThe API uses this object for checking the existence of a worker with employment."},"WorkerCurrentTaxcards":{"type":"object","properties":{"active":{"description":"The currently active taxcard if one exists. This property is null by default.","$ref":"#/components/schemas/Taxcard"},"list":{"type":"array","items":{"$ref":"#/components/schemas/TaxcardListItem"},"description":"All the relevant taxcards as list items.\r\nFor Workes own taxcards search (MyTaxcards) this is ownerd cards only"},"employers":{"type":"array","items":{"$ref":"#/components/schemas/TaxcardListItem"},"description":"Employer taxcards from all Employers for the Worker account.\r\nAll available within the searched timestring. This list is only available for the Worker, not for the Employer."},"personalId":{"type":"string","description":"Personal ID that is used for taxcard binding. This always exists as opposed to Employment."},"employment":{"description":"Employment relation if the search is done based on employment relation ID and not Current worker account.","$ref":"#/components/schemas/AccountInIndex"},"waitingApproval":{"description":"A shared taxcard waiting for approval if one exists. This property is null by default.","$ref":"#/components/schemas/TaxcardWaitingApproval"},"employmentTaxcard":{"description":"Employment preference for the taxcard.","$ref":"#/components/schemas/EmploymentRelationTaxcard"}},"additionalProperties":false,"description":"Contains the status and necessary data with Workers current taxcards."},"WorkerImport":{"type":"object","properties":{"officialId":{"type":"string","description":"Company number in the the trade register (Y-tunnus). \r\nFormat is \"1234567-8\" - 7 numbers, one control character, with or without the dash.\r\nAlso, the international VAT format is allowed: FI12345678\r\nThis field is optional and defaults to the company number of the current account."},"parameters":{"type":"object","additionalProperties":false,"description":"Additional parameters for import. Defaults to string."},"item":{"$ref":"#/components/schemas/WorkerAccount"},"validation":{"description":"Validation for the import","$ref":"#/components/schemas/ApiValidation"},"result":{"description":"Result object of the import.","$ref":"#/components/schemas/ApiImportResultOfstring"}},"additionalProperties":false,"description":"API worker import object.\r\nThe API uses this object for mass operations for creating or assuring the worker employment relations in the system."},"WorkerSalaryNotification":{"enum":["always","silent"],"type":"string","description":"Options for the notification to be sent to the worker after the salary payment."},"WorkerSalarySlipDeliveryMethod":{"enum":["default","payslip","omapalkka"],"type":"string","description":"Options for the delivery of the payslip to the worker."},"WorkerSummaryReportData":{"type":"object","properties":{"worker":{"description":"Worker avatar","$ref":"#/components/schemas/Avatar"},"workerSocialSecurityNumber":{"type":"string","description":"Worker's socials security number"},"workerIbanNumber":{"type":"string","description":"Worker's bank account number"},"workerBic":{"type":"string","description":"Bank Identifier Code (BIC)."},"workerContact":{"description":"Contact information for the report. Typically the employer, but may be something else.","$ref":"#/components/schemas/Contact"},"workerResult":{"description":"Additional result data for the worker summary report.","$ref":"#/components/schemas/WorkerSummaryResult"},"businessId":{"type":"string","description":"Finnish Business Identifier (Y-tunnus) for the company."},"employer":{"description":"Employer avatar","$ref":"#/components/schemas/Avatar"},"contact":{"description":"Contact information for the report. Typically the employer, but may be something else.","$ref":"#/components/schemas/Contact"},"startDate":{"type":"string","description":"Start date for the report","format":"date-time"},"endDate":{"type":"string","description":"End date for the report","format":"date-time"},"result":{"description":"The total sum information for the report - this is the main payload of the report","$ref":"#/components/schemas/CalculationResult"},"calculations":{"type":"array","items":{"$ref":"#/components/schemas/Calculation"},"description":"Individual calculations based on which the report is made.\r\nDepending on the request, this may be filled in or null (as opposed to empty list)."}},"additionalProperties":false,"description":"A summary report for a worker for a specific period (typically month or year) and selected employer."},"WorkerSummaryResult":{"type":"object","properties":{"cashSalary":{"description":"Cash salary row details.","$ref":"#/components/schemas/SummaryCalculationRows"},"benefitsInKind":{"description":"Benefits details.","$ref":"#/components/schemas/SummaryCalculationRows"},"expenses":{"description":"Expense details.","$ref":"#/components/schemas/SummaryCalculationRows"}},"additionalProperties":false,"description":"Additional result data for the worker summary report."},"WorkflowData":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowEvent"},"description":"Workflow events for the item."}},"additionalProperties":false,"description":"Defines the data that IWorkflowItem must provide."},"WorkflowEvent":{"type":"object","properties":{"id":{"type":"string","description":"Event-provider specific identifier for the event.\r\nFor deletable events, this should identify , but do NOT trust this to be 100% unique."},"type":{"type":"string","description":"Type of the event. This typically maps to parent-object specific enumeration."},"message":{"type":"string","description":"Message for backoffice purposes from the User or system that created the event."},"ui":{"description":"User Interface styling of the event: Indicates the severity for the end-user.","$ref":"#/components/schemas/BootstrapStyle"},"features":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowEventFeatures"},"description":"Features for this event."},"time":{"type":"string","description":"UTC time for when the event occured.","format":"date-time"},"user":{"type":"string","description":"User or system that created the event."},"assignedTo":{"type":"string","description":"Credential of the user which is responsible of the event."},"record":{"type":"string","description":"Record attached to this event."}},"additionalProperties":false,"description":"Event in the workflow"},"WorkflowEventFeatures":{"enum":["none","isActive","isEditable","isRemovable","isOnHold"],"type":"string","description":"Defines the properties"},"WorkingTimeCompensationKind":{"enum":["undefined","emergencyWorkCompensation","eveningWorkCompensation","eveningShiftAllowance","saturdayPay","extraWorkPremium","otherCompensation","waitingTimeCompensation","sundayWorkCompensation","standByCompensation","weeklyRestCompensation","overtimeCompensation","nightWorkAllowance","nightShiftCompensation"],"type":"string","description":"Kind for WorkingTimeCompensationUsecase."},"WorkingTimeCompensationPricing":{"enum":["undefined","percent","fixed"],"type":"string","description":"Hourly compensation type: percentage of the base hourly price or fixed hourly price."},"WorkingTimeCompensationRow":{"type":"object","properties":{"count":{"type":["null","number"],"description":"Count for compensation row.","format":"double"},"percent":{"type":["null","number"],"description":"Percent for price calculation.","format":"double"},"price":{"type":["null","number"],"description":"Compensation price, fixed price or calculated using percent.","format":"double"},"message":{"type":"string","description":"Message for compensation row"},"unit":{"oneOf":[{"type":"null"},{"description":"Unit for compensation row.","$ref":"#/components/schemas/CalculationRowUnit"}]},"accounting":{"description":"Accounting related data for the row.","$ref":"#/components/schemas/RowAccounting"}},"additionalProperties":false,"description":"Working time compensation row."},"WorkingTimeCompensationUsecase":{"type":"object","properties":{"kind":{"enum":["undefined","emergencyWorkCompensation","eveningWorkCompensation","eveningShiftAllowance","saturdayPay","extraWorkPremium","otherCompensation","waitingTimeCompensation","sundayWorkCompensation","standByCompensation","weeklyRestCompensation","overtimeCompensation","nightWorkAllowance","nightShiftCompensation"],"type":"string"}},"additionalProperties":false},"X500DistinguishedName":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"oid":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Oid"}]},"rawData":{"type":"string","format":"byte"}},"additionalProperties":false,"readOnly":true},"X509Certificate2":{"type":"object","properties":{"archived":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/X509Extension"},"readOnly":true},"friendlyName":{"type":"string"},"hasPrivateKey":{"type":"boolean","readOnly":true},"privateKey":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/AsymmetricAlgorithm"}]},"issuerName":{"$ref":"#/components/schemas/X500DistinguishedName"},"notAfter":{"type":"string","format":"date-time","readOnly":true},"notBefore":{"type":"string","format":"date-time","readOnly":true},"publicKey":{"$ref":"#/components/schemas/PublicKey"},"rawData":{"type":"string","format":"byte","readOnly":true},"rawDataMemory":{"$ref":"#/components/schemas/ReadOnlyMemoryOfbyte"},"serialNumber":{"type":"string","readOnly":true},"signatureAlgorithm":{"$ref":"#/components/schemas/Oid"},"subjectName":{"$ref":"#/components/schemas/X500DistinguishedName"},"thumbprint":{"type":"string","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true},"handle":{"readOnly":true},"issuer":{"type":"string","readOnly":true},"subject":{"type":"string","readOnly":true},"serialNumberBytes":{"$ref":"#/components/schemas/ReadOnlyMemoryOfbyte"}},"additionalProperties":false},"X509Extension":{"type":"object","properties":{"critical":{"type":"boolean"},"oid":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Oid"}]},"rawData":{"type":"string","format":"byte"}},"additionalProperties":false},"YearlyChangingNumbers":{"type":"object","properties":{"year":{"type":"integer","description":"Year for numbers.","format":"int32","readOnly":true},"sideCosts":{"description":"Returns yearly sidecosts.","$ref":"#/components/schemas/YearlySideCosts"},"taxFreeNumbers":{"description":"Returns yearly tax free numbers.","$ref":"#/components/schemas/YearlyTaxFreeNumbers"},"holidays":{"type":"object","properties":{"newYearsDay":{"$ref":"#/components/schemas/HolidayDate"},"epiphany":{"$ref":"#/components/schemas/HolidayDate"},"goodFriday":{"$ref":"#/components/schemas/HolidayDate"},"easterSunday":{"$ref":"#/components/schemas/HolidayDate"},"easterSaturday":{"$ref":"#/components/schemas/HolidayDate"},"easterMonday":{"$ref":"#/components/schemas/HolidayDate"},"mayDay":{"$ref":"#/components/schemas/HolidayDate"},"ascensionDay":{"$ref":"#/components/schemas/HolidayDate"},"pentecost":{"$ref":"#/components/schemas/HolidayDate"},"midsummerEve":{"$ref":"#/components/schemas/HolidayDate"},"midsummerDay":{"$ref":"#/components/schemas/HolidayDate"},"allSaintsDay":{"$ref":"#/components/schemas/HolidayDate"},"independenceDay":{"$ref":"#/components/schemas/HolidayDate"},"christmasEve":{"$ref":"#/components/schemas/HolidayDate"},"christmasDay":{"$ref":"#/components/schemas/HolidayDate"},"stStephensDay":{"$ref":"#/components/schemas/HolidayDate"}},"additionalProperties":false,"description":"Returns holidays for the year."}},"additionalProperties":false,"description":"Parameters that are changing yearly. \r\nThis class is made for the change of the year and it is typically updated in December.\r\nIt is not for recording longer history of numbers."},"YearlyHolidays":{"required":["year"],"type":"object","properties":{"year":{"type":"integer","description":"Year for the holidays.","format":"int32","readOnly":true},"holidays":{"type":"object","properties":{"newYearsDay":{"$ref":"#/components/schemas/HolidayDate"},"epiphany":{"$ref":"#/components/schemas/HolidayDate"},"goodFriday":{"$ref":"#/components/schemas/HolidayDate"},"easterSunday":{"$ref":"#/components/schemas/HolidayDate"},"easterSaturday":{"$ref":"#/components/schemas/HolidayDate"},"easterMonday":{"$ref":"#/components/schemas/HolidayDate"},"mayDay":{"$ref":"#/components/schemas/HolidayDate"},"ascensionDay":{"$ref":"#/components/schemas/HolidayDate"},"pentecost":{"$ref":"#/components/schemas/HolidayDate"},"midsummerEve":{"$ref":"#/components/schemas/HolidayDate"},"midsummerDay":{"$ref":"#/components/schemas/HolidayDate"},"allSaintsDay":{"$ref":"#/components/schemas/HolidayDate"},"independenceDay":{"$ref":"#/components/schemas/HolidayDate"},"christmasEve":{"$ref":"#/components/schemas/HolidayDate"},"christmasDay":{"$ref":"#/components/schemas/HolidayDate"},"stStephensDay":{"$ref":"#/components/schemas/HolidayDate"}},"additionalProperties":false,"description":"Holidays for the year.","readOnly":true}},"additionalProperties":false,"description":"Holidays for the entire year."},"YearlySideCosts":{"type":"object","properties":{"unemploymentEmployerPercent":{"type":"number","description":"Unemployment insurance payment percent - Employer","format":"double","readOnly":true},"unemploymentHigherEmployerPercent":{"type":"number","description":"Unemployment insurance payment percent - Large Employer","format":"double","readOnly":true},"unemploymentWorkerPercent":{"type":"number","description":"Unemployment insurance payment percent - deducted from Worker","format":"double","readOnly":true},"unemploymentPartialOwnerWorkerPercent":{"type":"number","description":"Unemployment insurance payment percent for partial owner worker - deducted from Worker","format":"double","readOnly":true},"tyelIncomeLimit":{"type":"number","description":"Pension payment income limit per month","format":"double","readOnly":true},"tyelBasePercent":{"type":"number","description":"Pension payment base percentage","format":"double","readOnly":true},"tyelWorkerPercent":{"type":"number","description":"Pension payment base percentage - deducted from Worker salary","format":"double","readOnly":true},"tyel53Percent":{"type":"number","description":"Pension payment base percentage - deducted from 53-62 year old Worker","format":"double","readOnly":true},"tyelContractEmployerLimit":{"type":"number","description":"Pension contract employer six month limit","format":"double","readOnly":true},"socSecPercent":{"type":"number","description":"Social Security payment for employer (SAVA-maksu)","format":"double","readOnly":true},"illnessInsurancePercent":{"type":"number","description":"Illness Insurance care percent that is withhold from the Worker. (vakuutetun sairausvakuutusmaksu: päivärahamaksu + sairaanhoitomaksu","format":"double","readOnly":true},"healthInsuranceMedicalCareContribution":{"type":"number","description":"Medical care contribution of the employee's health insurance contribution.","format":"double","readOnly":true},"healthInsuranceDailyAllowanceContribution":{"type":"number","description":"Daily allowance contribution of the employee's health insurance contribution.","format":"double","readOnly":true},"taxFreeDailyAllowance":{"type":"number","description":"Tax free daily allowance for full day approved by tax authorities.","format":"double","readOnly":true},"taxFreeDailyHalfAllowance":{"type":"number","description":"Tax free daily allowance for half day approved by tax authorities.","format":"double","readOnly":true},"taxFreeMealAllowance":{"type":"number","description":"Tax free meal allowance approved by tax authorities.","format":"double","readOnly":true},"taxFreeBicycleBenefit":{"type":"number","description":"Tax free bicycle benefit approved by tax authorities.","format":"double","readOnly":true},"taxFreeSubsidisedCommute":{"type":"number","description":"Tax free subsidised sommute benefit approved by tax authorities.","format":"double","readOnly":true},"taxFreeKmAllowance":{"type":"number","description":"Tax free milage allowance approved by tax authorities.","format":"double","readOnly":true},"unionPaymentRaksaA":{"type":"number","description":"Union payment: Rakennusliitto, A (typical)","format":"double","readOnly":true},"unionPaymentRaksaAoTa":{"type":"number","description":"Union payment: Rakennusliitto, AO and TA","format":"double","readOnly":true},"palkkausVatPercent":{"type":"number","description":"ALV-% for the fee.","format":"double","readOnly":true},"palkkausVatRate":{"description":"ALV-% for the fee.","$ref":"#/components/schemas/VatRate"},"householdDeduction":{"type":"number","description":"Household deduction","format":"double","readOnly":true},"householdDeductionExtended":{"type":"number","description":"Household deduction","format":"double","readOnly":true},"householdDeductionMaxAmount":{"type":"number","description":"Household deduction max amount","format":"double","readOnly":true},"householdDeductionMaxAmountExtended":{"type":"number","description":"Household deduction max amount","format":"double","readOnly":true},"householdDeductionCategoriesExtended":{"type":"array","items":{"$ref":"#/components/schemas/TaxDeductionWorkCategories"},"description":"Tax deduction categories, which extend the deduction.","readOnly":true},"householdDeductionDeductible":{"type":"number","description":"Household deduction deductible","format":"double","readOnly":true},"mealBenefitCateringContract":{"type":"number","description":"Meal benefit for catering contract","format":"double","readOnly":true},"mealBenefitInstitute":{"type":"number","description":"Meal benefit for institute","format":"double","readOnly":true},"mealBenefitRestaurantWorker":{"type":"number","description":"Meal benefit for restaurant worker","format":"double","readOnly":true},"mealBenefitTeacher":{"type":"number","description":"Meal benefit for teacher","format":"double","readOnly":true},"mealTicketLowerLimit":{"type":"number","description":"Meal ticket lower limit","format":"double","readOnly":true},"mealTicketUpperLimit":{"type":"number","description":"Meal ticket upper limit","format":"double","readOnly":true},"mealTicketTaxable":{"type":"number","description":"Taxable-% of meal ticket","format":"double","readOnly":true},"protectedPortionBase":{"type":"number","description":"Foreclosure: protected portion.","format":"double","readOnly":true},"protectedPortionDependant":{"type":"number","description":"Foreclosure: protected portion for each dependant.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Encapsulates yearly side costs into one class.","readOnly":true},"YearlyTaxFreeMileage":{"type":"object","properties":{"car":{"type":"number","description":"Regular car, euros per kilometer.","format":"double","readOnly":true},"carAdditions":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Additions to car per kilometer, euros per kilometer.","readOnly":true},"carLimitedBenefit":{"type":"number","description":"For a limited car benefit car (käyttöetu), the mileage if Worker pays gasoline / electricity etc.\r\nEuros per kilometer.","format":"double","readOnly":true},"passenger":{"type":"number","description":"Additional euros per kilometer paid for each extra passenger in the vehicle.","format":"double","readOnly":true},"other":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Other vehicles (motorcycle, snowmobile etc.), euros per kilometer.","readOnly":true}},"additionalProperties":false,"description":"Tax free mileage / kilometer allowances for vehicles, defined yearly by the Finnish tax authorities.","readOnly":true},"YearlyTaxFreeNumbers":{"type":"object","properties":{"mileage":{"description":"Mileage / kilometer allowance for vehicles.","$ref":"#/components/schemas/YearlyTaxFreeMileage"},"countries":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Countries or regions for international daily allowance.\r\nKey is the country / region as stored on calculation rows (e.g. \"Afghanistan\"),\r\nvalue is the tax free daily allowance in euros.","readOnly":true}},"additionalProperties":false,"description":"Tax free numbers defined yearly by the Finnish tax authorities.","readOnly":true},"YtjCompany":{"type":"object","properties":{"businessId":{"type":"string","description":"The Business ID (Y-tunnus / Business Identity Code) is a code given to businesses and organizations by the PRH or the Tax Administration. \r\nIt consists of seven digits, a dash and a control mark, for example 1234567-8.\r\nAlternative accepted formats incule international VAT number \"FI12345678\" or number without the dash: \"12345678\"."},"name":{"type":"string","description":"Official name of the company. \r\nSource: Tiedostonimi.Tiedostonimi"},"companyType":{"description":"The legal type of the company, as categorized by Palkkaus / used in generating IBAN numbers.","$ref":"#/components/schemas/CompanyType"},"companyTypeText":{"type":"string","description":"YTJ's legal type of the company as a string. This is only to be used for display purposes.\r\nSource: YritysHaku.YritysMuoto"},"ytjCompanyType":{"description":"The internal YTJ code number for the company's legal type.","$ref":"#/components/schemas/YtjCompanyType"},"ytjCompanyTypeCode":{"type":"integer","description":"Original YTJ company type code.","format":"int32"},"contact":{"description":"Contact information for the","$ref":"#/components/schemas/Contact"},"contactPersonPersonalId":{"type":"string","description":"Social security number of the contact person in the company, if available."},"contactPerson":{"type":"string","description":"Names are not necessarily avaiable. If they are, they may not be reliable."},"contactPhone":{"type":"string","description":"Mobile for or other company phone.\r\nDifference between Contact.Phone and ContactPhone is that \r\nthis (ContactPhone) is first mobile number, then company general phone if the former was null.\r\nContact.Phone is fisrt general phone number and mobile number only if not available."},"www":{"type":"string","description":"Web site address"},"sectorOfBusinessCode":{"type":"integer","description":"The sector where the company is active. (Toimialatieto.Koodi)","format":"int32"},"sectorOfBusinessText":{"type":"string","description":"Text of the sector where company operates."}},"additionalProperties":false,"description":"The details of company data as provided by the Finnish Business Infromation System (YTJ/BIS)"},"YtjCompanyType":{"enum":["noCompanyType","housingCooperative","condominium","asoAssociation","openCompany","association","hypoAssociation","mutualRealEstateCompany","ky","osuuskunta","cooperativeBank","oy","publicLimitedCompany","foundation","branch","savingsBank","financialAssociation","stateEstablishment","insuranceAssociation","privateEntrepreneur","otherAssociation","specialPurposeAssociation","forestCareAssociation","otherFinancialAssociation","otherFoundation","religiousCommunity","jointInterestGroups","taxableGrouping","deathEstate","businessPartnership","mutualInsuranceAssociation","foreignOrganisation","municipalEstablishment","federationOfMunicipalitiesEstablishment","alandFederation","europeanCooperative","europeanCooperativeBank","reindeerHerdingCooperative","unknown"],"type":"string","description":"Company types in the Finnish Business Inofrmation System (BIS / YTJ)"},"YtjSearchResult":{"type":"object","properties":{"rawInput":{"type":"string","description":"The original search string - without trimming etc. that are done in the actual search."},"isSuccess":{"type":"boolean","description":"If true, search is a success. This may mean that no results were found though."},"isTooGeneric":{"type":"boolean","description":"If true, the searh is too generic. \r\nTypically either there was more than 200 results or less than 3 characters in the search string. \r\nBoth of these return an error in the API."},"status":{"type":"string","description":"Technical status - for developers / admin."},"userMessage":{"type":"string","description":"A message that can be shown to the end user."},"counter":{"type":"integer","description":"API quota counter","format":"int32"},"result":{"type":"array","items":{"$ref":"#/components/schemas/YtjSearchResultCompany"},"description":"Result of the search."}},"additionalProperties":false,"description":"Search result for free text search from the Finnish Business Infromation System (YTJ/BIS).\r\nReturns a list of companies without details."},"YtjSearchResultCompany":{"type":"object","properties":{"businessId":{"type":"string","description":"The Business ID (Y-tunnus / Business Identity Code) is a code given to businesses and organizations by the PRH or the Tax Administration. \r\nIt consists of seven digits, a dash and a control mark, for example 1234567-8.\r\nAlternative accepted formats incule international VAT number \"FI12345678\" or number without the dash: \"12345678\"."},"name":{"type":"string","description":"Official name of the company."},"id":{"type":"integer","description":"Numeric ID (\"Yritysavain\")","format":"int32"},"type":{"type":"string","description":"Type of the company. This is a free text type. Not necessary parseable to company type enumeration in details."}},"additionalProperties":false,"description":"Search result list level of detail of companies coming from YTJ."}}},"tags":[{"name":"Calculator","description":"Anonymous methods for calculating salary previews and testing without committing data to database."},{"name":"Test","description":"Test methods for various purposes."},{"name":"Account","description":"Read and update access to Palkkaus-account: Person or Company accounts that are currently in use as well as Worker Accounts that are created under this account."},{"name":"AccountReset","description":"Controller for resetting account data for testing purposes."},{"name":"InsuranceServices","description":"API connecting to insurance partner services."},{"name":"OnboardingApi","description":"Functionality for Onboarding: The process where the user becomes a user of Salaxy service and an account is created for him / her / the company."},{"name":"Partner","description":"Methods restricted to Authroized partners. NOTE: With production data, these methods require Approved Partner status!"},{"name":"Reports","description":"Methods for Reporting: Initiating custom report creation, listing created reports (including preview, pdf and HTML) as well as creating demo reports with test data."},{"name":"Session","description":"Login, logoff and information about the current session."},{"name":"Absences","description":"Absences Controller provides CRUD functionality as well as additional methods for Absences objects"},{"name":"File","description":"User-specific files and other files related functionality: Image processing, preview etc."},{"name":"HolidayYears","description":"Holiday Years Controller provides CRUD functionality as well as additional methods for Holiday Year objects"},{"name":"Invoice","description":"Invoices in Salaxy contect are the payments that should be made to pay the net salary and side costs. The service is for querying invoices and notifying them as unread/paid/read/canceled from 3rd party system."},{"name":"MessageThread","description":"CRUD functionality as well as additional methods for Message threads. Messages thread groups together a set of related messages and/or attachments."},{"name":"PaymentChannel","description":"Payment channels are methods that hanlde salary payments: Paytrail / Palkkaus.fi Customer funds account handling, Finvoice, Accounting software, Banks Web Services etc. This controller is for those channels to fetch Invoices and other data as well as to update payment feedback back to Palkkaus.fi. The services can only be used by registered payment channels: Ask us if you wish to register."},{"name":"PaymentMessage","description":"Payment messages (maksuaineisto) of the current company: create from invoices, list, download, mark sent, resend, mark paid and cancel. Every call is scoped to the account of the token. The channel's settings decide the actions: GET settings/{channel} returns them. Payment channels use the payment-channel endpoints instead."},{"name":"Payroll","description":"Payroll Controller provides CRUD functionality as well as additional methods for Payroll objects"},{"name":"TestData","description":"Methods for modifying test data. Only available in test environment."},{"name":"AccountingTarget","description":"Views and updates accounting targets: integrated systems, CoA and rulesets that map the calculations to the CoA (Chart of Accounts)."},{"name":"BeneficialOwners","description":"Views and updates beneficial owners and other beneficiaries of the company."},{"name":"Calculations","description":"Salary Calculations CRUD functionality as well as additional helper methods."},{"name":"Dataset","description":"Lists and edits datasets: Dataset models some arbitrary data that is stored in storage."},{"name":"Employment","description":"Employment relations between employers and workers. This is the primary method for Employers to manage their workers."},{"name":"HouseholdYear","description":"Views and updates household yearly deduction data."},{"name":"Import","description":"Controller for mass imports."},{"name":"Record","description":"Views and updates account and employment records."},{"name":"ReferenceObject","description":"Reference object controller. For testing and development purposes only. This controller is a typical CRUD controller for business objects. The implementation is based on the current development conventions. The reference objects have no meaning or use outside development or testing environments, and they should not be used in production for any business purpose."},{"name":"ServiceModel","description":"Views and updates partner service models. Service models customize the user interface, workflows, texts and other functionality for customer groups of partners."},{"name":"Settings","description":"View and update settings for the service."},{"name":"TaskDefinition","description":"Views and updates the definitions of the scheduled or adhoc tasks that can perform automated actions."},{"name":"TaskRun","description":"Views and updates the runs of the scheduled or adhoc tasks that can perform automated actions."},{"name":"Taxcards","description":"Year 2019 version for taxcards. This API will be replaced by the new 2020 version in January 2020. The new version is labeled as V03 (3.0-rc in before release) and old V02."},{"name":"Template","description":"Views and updates templates for business object creation."},{"name":"Usecases","description":"Views and updates usecases. Usecases are a way to define custom functionality and data for partner pusposes."},{"name":"Version","description":"Functionality to list and get versions from version history for api objects."},{"name":"ApiCrudUtility","description":"Various utility endpoints for all API CRUD objects."},{"name":"Workflow","description":"Functionality to add and change workflow events for all the API objects that support workflows."},{"name":"RowUsecases","description":"Strongly typed and stand-alone test methods for the calculation rows usecases."}]}