Resource: employee.nv
HTTP method: POST
Import or edit an employee's information. See instructions for using the resource at the end of the table.
Parameters used in the request:
Parameter name | Occurs | Example | Description |
Method | 1 | Add | Import type, Add or Edit |
useonlyexistingdimensions | 0...1 | 1 | Prevents automatic creation of new cost object headers and Cost objects. Returns an error if the given Cost object does not exist. 1=prevention enabled |
When editing employee information, use Method=Edit and XML element employeeidentifier (Finnish employee) or identifier (foreign employee) as the allocating information.
The imported information is sent as XML (POST data) as described below:
| Level | Element name | Type and length | Occurs | Description | Example |
| --- | --- | --- | --- | --- | --- |
| Root | root | Aggr. | 1 | | |
| 1 | employee | Aggr. | 1 | | |
| 2 | employeebaseinformation | Aggr. | 1 | | |
| 3 | foreignemployeeidentification | Aggr. | 0...1 | Foreign employee | If given, do not give employeeidentifier value |
| 4 | identifier | Text | 1 | Identifier | 23011970 |
| Attr. | type | String | 1 | Identifier type, allowed values:
taxidentificationnumber
foreignpersonalidentifier
other | foreignpersonalidentifier |
| 4 | issuingcountry | String | 1 | Country | AF |
| Attr. | type | String | 1 | Country type | ISO-3166 |
| 4 | gender | String | 1 | Gender,
male
female | male |
| 4 | dateofbirth | Date | 1 | Date of birth | 1970-10-20 |
| Attr. | format | String | 1 | Date format | ansi |
| 3 | employeeidentifier | String | 1 | Employee's Finnish personal identity code | 010277-xxxp |
| 3 | companyidentifier | String | 0...1 | Company's Business ID, when company is added as an employee | 0174564-5 |
| 3 | companyname | String | 0...1 | Company name | Test Company |
| 3 | firstname | String, max 50 | 1 | Employee's first name | Anna |
| 3 | lastname | String, max 50 | 1 | Employee's last name | Ammattilainen |
| 3 | phonenumber | String, max 50 | 1 | Employee's phone number | 050 123 456 |
| 3 | email | String, max 100 | 1 | Employee's email address | [email protected] |
| 2 | employeepayrollinformation | Aggr. | 1 | | |
| 3 | streetaddress | String, max 255 | 1 | Employee's street address | Keisarinnankatu 1 |
| 3 | postnumber | Text, max 50 | 1 | Employee's post number | 56120 |
| 3 | city | String, max 255 | 1 | Employee's postal address | Lappeenranta |
| 3 | municipality | String, max 255 | 0...1 | Employee's municipality of residence | Lappeenranta |
| 3 | country | String, max 2 | 0...1 | Employee's home country code, default fi | fi |
| 3 | nationality | String, max 2 | 0...1 | Employee's nationality, default fi | se |
| 3 | language | String, max 2 | 0...1 | Employee's language, default fi | fi |
| 3 | employeenumber | Numeric, max 10 | 0...1 | Employee's unique identification number | 13 |
| 3 | profession | String, max 255 | 0...1 | Employee's occupational title | Tester |
| 3 | jobbegindate | String, max 10 | 0...1 | Employee's employment start date | 2017-11-09 |
| Attr. | format | String | | Date format, always ansi | ansi |
| 3 | payrollrulegroupname | String, max 50 | 1 | Salary model name | Monthly salary employees |
| 3 | bankaccountnumber | String, max 34 | 0...1 | Employee's bank account number, IBAN account number. If only the bank account number is imported, BIC is calculated based on the account number | FI71 7997 9580 0073 35 |
| 3 | bankidentificationcode | String, max. 20 | 0...1 | Bank BIC code | NDEAFIHH |
| 3 | accountingaccountnumber | Numeric | 0...1 | Employee's debt account number | 1751 |
| 3 | hierarchy | String | 0...1 | Hierarchy level | Oy Yritys Ab |
| Attr. | type | String | 1 | Hierarchy linking type | netvisor - Netvisor ID
or
customer - If identified by name,
name has to be unique
Read about corporate hierarchy |
| 3 | dimension | Aggr. | 0...n | | Default Cost objects |
| 4 | dimensionname | String | 1 | Cost object header name. Created if needed | Cost centers |
| 4 | dimensionitem | String | 1 | Cost object name. Created if needed | DevOps |
| 4 | code | String | 0...1 | Cost object identifier | P001 |
| 4 | displayname | String | 0...1 | Cost object name | Website renewal |
| Attr. | fatherid | Numeric | 0...1 | Parent Cost object ID. IDs can be retrieved with this resource | 1 |
| 3 | payslipdeliverymethod | String | 0...1 | Payslip delivery method | 1 = local printing
2 = printing service
3 = e-salary |
| Attr. | type | String | 1 | Delivery method linking type | Attribute type is always netvisor, which is Netvisor ID |
| 3 | isjointowner | Numeric | 0...1 | Part-owner in relation to the payer | 1=yes
0=no |
| 3 | isathlete | Numeric | 0...1 | Athlete | 1=yes
0=no |
| 3 | isperformingartist | Numeric | 0...1 | Performing artist | 1=yes
0=no |
| 3 | employeeinsurancetype | Numeric | 0...1 | Employee pension insurance type | 1=Tyel
2=MYEL
3=YEL
4=No pension insurance |
| 3 | ispersonworkingonaroadferryonalandislands | Numeric | 0...1 | Person working on a road ferry on Åland Islands | 1=yes
0=no |
| 3 | isentrepreneurwithoptionalyelormyel | Numeric | 0...1 | Entrepreneur, no YEL or MYEL insurance obligation | 1=yes
0=no
1 can be given only when employeeinsurancetype=4 |
| 3 | ispersonreceivingeppoinsurancesalary | Numeric | 0...1 | Person receiving wages for insurance purposes under the EPPO Act | 1=yes
0=no |
| 3 | isinvoicingserviceuserwithoutbusinessid | Numeric | 0...1 | Person using an invoicing service who does not have a Business ID | 1=yes
0=no |
| 3 | nosocialsecuritypayment | Numeric | 0...1 | Not subject to employer's health insurance contribution | 1=yes
0=no
Default 0 |
| 3 | receivessalaryfromdiplomaticembassy | Numeric | 0...1 | Person receiving wages paid by a diplomatic mission | 1=yes |
| 3 | activity | Numeric | 0...1 | Activity | 1=yes
0=no
Default 1 |
| 3 | foreclosure | Numeric | 0...1 | Foreclosure | 1=yes
0=no
Default 0 |
| 3 | foreclosuremaitenancepersons | Numeric | 0...1 | Persons under maintenance allowance in foreclosure | Must be given, if foreclosure = 1 |
| 3 | taxnumber | String | 0...1 | Employee's tax number | 123456798912 |
| 3 | placeofbusiness | String | 0...1 | Office for the Incomes Register (name) | Pääkonttori |
| 2 | employmentperiods | Aggr. | 0...1 | Employments | |
| 3 | employmentperiod | Aggr. | 1...n | Employment | |
| 4 | companystartdate | Date | 0...1 | Date of entry into the partnership | 2017-01-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 4 | startdate | Date | 1 | Start date | 2017-01-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 4 | probationenddate | Date | 0...1 | End date of probation | 2017-04-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 4 | employmentmode | Numeric | 0...1 | Form of employment | 1 = employed
2 = leased employee
3 = self-employed person or similar
4 = trainee
5 = voluntary work |
| Attr. | type | String | 1 | Employment linking type | Attribute type is always netvisor, which is Netvisor ID |
| 4 | profession | String, max 250 | 1 | Occupational title | Tester |
| 4 | comment | String, max 500 | 0...1 | Comment | New skilled person |
| 4 | enddate | Date | 0...1 | End date | 2017-12-31 |
| Attr. | format | String | 1 | Date format | ansi |
| 4 | endreason | Numeric | 0...1 | End reason | 2=Employee's old-age pension
4=Employee's own request
5=Reason attributable to the employee
6=Fixed-term employment
11=Financial and production-related grounds for termination
12=End of employment by mutual agreement
13=Other reason
(Not in use anymore:
1 = Normal employment ending
3 = Employee's death
7 = Probation period
8 = Cancellation of the employment
9 = Bankruptcy of the company
10 = Change of ownership of the company) |
| Attr. | type | String | 1 | End reason linking type | Attribute type is always netvisor, which is Netvisor ID |
| 4 | occupationclassification | String | 0...1 | Occupation class | TK10-code of occupation class |
| Attr. | type | String | 1 | Linking type | Attribute type is always isco |
| 4 | employmentcontract | Numeric | 0...1 | Duration of employment | 1 = Permanent
2 = Temporary
Note: For a temporary employment, an end date must be given |
| Attr. | type | String | 1 | Linking type | Attribute type is always netvisor, which is Netvisor ID |
| 4 | employmentform | Numeric | 0...1 | Type of employment | 1 = Full-time
2 = Part-time
3 = information not available |
| Attr. | type | String | 1 | Linking type | Attribute type is always netvisor, which is Netvisor ID |
| 4 | parttimepercent | Numeric | 0...1 | Part-time percent | Permissible value: decimal number from 0 to 100
Rounding to the nearest two decimal places
Note: The element cannot be given if the employment type is other than part-time. employmentform must be 2 |
| 4 | regularworkinghours | Numeric | 0...1 | Regular working hours | Permissible value: decimal number from 0 to 168
Rounding to the nearest two decimal places |
| 4 | groundsforemployment | Numeric | 0...1 | Grounds for employment | 0=Other grounds
1=Working or employment relationship |
| 4 | kevaprofessionalclasscode | Numeric | 0...1 | Keva professional class code, max 20 characters. KEVA information can only be given if company has selected "Company pension insurer is Keva" from Payroll settings. | Keva professional class codes:
Keva: Search for professional titles |
| 4 | kevaemploymentregistration | Numeric | 0...1 | Keva employment registration code, max 2 characters. | Keva employment registration codes:
Keva: Codes for the Incomes Register |
| Attr. | type | String | 1 | always keva | keva |
| Attr. | pensionprovidercode | String | 0...1 | Pension insurance company ID code. If not given, the default value “20” is used. This defines which values are accepted in kevaemploymentregistration. With an incorrect value, the allowed values are listed. | The value can be found in KEVA's code list:
Keva: Codes for the Incomes Register |
| 4 | ispaymenttypemonthlywage | Numeric | 0...1 | Form of payment: Monthly salary | 1=yes
0=no |
| 4 | ispaymenttypehourlywage | Numeric | 0...1 | Form of payment: Hourly pay | 1=yes
0=no |
| 4 | ispaymenttypepiecewage | Numeric | 0...1 | Form of payment: Piecework pay | 1=yes
0=no |
| 4 | workercategory | Aggr. | 0...n | Employee group for pay transparency reporting. The employee group is related to pay transparency reporting. Instructions can be found here. | Employee group management Salaries > Settings > Payroll settings > Pay transparency reporting settings > Employee group management |
| 4 | name | String | 1 | Employee group must be added in Netvisor | Esimerkkiryhmä |
| 4 | additionalinformationfield | Aggr. | 0...n | Job requirement group. The job requirement group is related to pay transparency reporting. Instructions can be found here. | |
| 4 | name | String | 1 | Job requirement group | Vaativuusryhmä 1 |
| 4 | collectiveagreement | Numeric | 0...1 | Collective agreement | Incomes Register collective agreement codes:
Collective agreement codes |
| Attr. | type | String | 1 | always cbacode | cbacode |
| 4 | stateemploymentfund | Numeric | 0...1 | Employed with assistance from the state employment fund | 1=yes
0=no |
| 4 | carbenefityear | Numeric | 0...1 | Year of commissioning of the company car, max 4 characters | 2012 |
| 4 | isabroadcarbenefit | Numeric | 0...1 | Company car benefit received abroad | 1=yes
0=no |
| 4 | caremissionsvalue | Numeric | 0...1 | Car emission value, integer between 0-100 | 85 |
| 2 | employeesettings | Aggr. | 0...1 | Employee's settings | |
| 3 | payrollservice | String | 0...1 | Payroll service | enabled or disabled |
| 3 | resourcemanagement | String | 0...1 | Resource management | enabled or disabled |
| 2 | employeesettlementpoints | Aggr. | 0...1 | Settlement points | |
| 3 | employeeworkpensioninsurance | Aggr. | 0...1 | Work pension insurance | |
| 4 | type | String | 0...1 | Settlement point handling | nohandling=no handling
automatichandling=
automatic handling
under17yearsold=under 17 years old
17to52yearsold=17 to 52 years old
53to62yearsold=53 to 62 years old
63to67yearsold=63 to 67 years old
over68yearsold=over 68 years old |
| 4 | name | String | 0...1 | Insurance specific settlement point definition () | TyEL |
| 3 | employeeunemploymentinsurance | Aggr. | 0...1 | Unemployment insurance | |
| 4 | type | String | 0...1 | Settlement point handling | nohandling=no handling
automatichandling=
automatic handling
under17yearsold=under 17 years old
17to64yearsold=17 to 64 years old
over65yearsold=over 65 years old
partowner=part-owner |
| 4 | name | String | 0...1 | Insurance specific settlement point definition () | Työttömyysvakuutus |
| 3 | employeeaccidentinsurance | Aggr. | 0...1 | Accident insurance | |
| 4 | type | String | 0...1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0...1 | Insurance specific settlement point definition () | Tapaturmavakuutus |
| 3 | employeegrouplifeinsurance | Aggr. | 0...1 | Group life insurance | |
| 4 | type | String | 0...1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0...1 | Insurance specific settlement point definition () | Ryhmähenkivakuutus |
| 3 | employeeotherinsurance | Aggr. | 0...1 | Other insurance | |
| 4 | type | String | 0...1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0...1 | Insurance specific settlement point definition () | Muu vakuutus |
| 3 | employeeunionmembershipfee | Aggr. | 0...1 | Union membership fee | |
| 4 | type | String | 0...1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0...1 | Insurance specific settlement point definition () | Ammattiliiton jäsenmaksu |
| 3 | employeeforeclosure | Aggr. | 0...1 | Foreclosure | |
| 4 | type | String | 0...1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0...1 | Insurance specific settlement point definition (*) | Ulosotto |
| 2 | employeeeducationalinformation | Aggr. | 0...1 | Employee's educational information | |
| 3 | degree | Aggr. | 0...n | Degree | |
| 4 | name | String | 1 | Name of the degree | Ylioppilas |
| 4 | school | String | 1 | Name of the school | Lyseon lukio |
| 4 | graduationyear | Numeric | 1 | Year of graduation | 2022 |
| 4 | primarydegree | Numeric | 1 | Main degree | 1=yes
0=no |
| 2 | employeeadditionalinformation | Aggr. | 0...1 | Employee's additional information fields | |
| 3 | additionalinformationfield | Aggr. | 0...n | Employee additional information field | |
| 4 | name | String | 1 | Additional information field name | Allergies |
| 4 | value | String | 1 | Additional information field value | Fish |
(*) Settlement points: Salaries > Payroll > Obligations > Settlements
Note when using this resource:
Editing employee is also possible when the employee's employment is not valid
This resource does not set holiday day accruals for the employee. This is set in the user interface.
For a single employee, the information can be updated on the employee's information page
For multiple employees, the information can be set in mass in the holiday rights management, Salaries - Holiday calculation settings, where you select the employees to be processed and from the "Handle selected" menu select "Set holiday accumulation rule" and the desired accumulation rule
If employmentperiods element has been defined, at least one employment has to be imported
startdate and profession elements are always mandatory
If enddate has been defined, then endreason is also mandatory
If employmentperiods element has been defined, employment information overrides employeepayrollinformation definitions
If employmentperiods element has not been defined, the employee's employment is defined using employeepayrollinformation > profession and jobbegindate
If employments are imported through the API, any existing employments of the employee are deleted
If a company is added as employee, do not give individual employee information, such as:
employeeidentifier
firstname
lastname
foreignemployeeidentification element
*This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.
*