Resource: employee.nv
HTTP-method: POST
Import an employee's information.
Querystring parameters:
Parameter name | Occurs | Example | Description |
Method | 1 | Add | Add or Edit |
Request:
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: | foreignpersonalidentifier |
4 | issuingcountry | String | 1 | Country | AF |
Attr. | type | String | 1 | Country type | ISO-3166 |
4 | gender | String | 1 | Gender, | male |
4 | dateofbirth | Date | 1 | Date of birth | 1970-10-20 |
Attr. | format | String | 1 | Date format, always ansi | ansi |
3 | employeeidentifier | String | 1 | Finnish employee social security number | 010277-xxxp |
3 | companyidentifier | String | 0...1 | Company indentifier (y-tunnus), | 0174564-5 |
3 | companyname | String | 0...1 | Name of the company | Test Company |
3 | firstname | String, max 50 | 1 | Employee's first name | Carl |
3 | lastname | String, max 50 | 1 | Employee's last name | Customer |
3 | phonenumber | String, max 50 | 1 | Employee's phone number | 0501234567 |
3 | String, max 100 | 1 | Employees E-mail | ||
2 | employeepayrollinformation | Aggr. | 1 |
|
|
3 | streetaddress | String, max 255 | 1 | Employee's address | Examplestreet 1 |
3 | postnumber | Text, max 50 | 1 | Employee's post number | 56123 |
3 | city | String, max 255 | 1 | Employee's post office | Lappeenranta |
3 | municipality | String, max 255 | 0...1 | Employees's home city | Lappeenranta |
3 | country | String, max 2 | 0...1 | Employee's home country. Default is 'fi' | fi |
3 | nationality | String, max 2 | 0...1 | Employee's nationality | se |
3 | language | String, max 2 | 0...1 | Employee's language | fi |
3 | employeenumber | Numeric, max 10 | 0...1 | Employee's unique identification number | 12 |
3 | profession | String, max 255 | 0...1 | Employee's profession | Seller |
3 | jobbegindate | String, max 10 | 0...1 | Employee's job begin date, yyyy-mm-dd | 2014-08-10 |
Attr. | format | String | 1 | Date format, always ansi | ansi |
3 | payrollrulegroupname | String, max 50 | 1 | Payroll group name | Monthly salary |
3 | bankaccountnumber | String, max 34 | 0...1 | Employee's bank account number | FI21 1234 xxxx xxxx xx |
3 | bankidentificationcode | String, max. 20 | 0...1 | Bank's identification code |
|
3 | accountingaccountnumber | Numeric | 0...1 | You can access company's accounting information in Netvisor from ACCOUNTING > Administration > Accounting basic information > Account list | 1751 |
3 | hierarchy | String | 0...1 | Hierarchy level | Oy Yritys Ab |
Attr. | type | String | 1 | Linking type of hierarchy | netvisor - Netvisor ID |
3 | dimension | Aggr. | 0...n |
| Default dimensions |
4 | dimensionname | String | 1 | Dimension header name. | Cost centers |
4 | dimensionitem | String | 1 | Dimension name. Created if needed | DevOps |
Attr. | fatherid | Numeric | 0...1 | Dimensions parent ID tunnus. IDs can be retrieved with this resource. | 1 |
3 | payslipdeliverymethod | String | 0...1 | Payslip delivery method | 1 = local printing |
Attr. | type | String | 1 | Linking type of delivery method | Attribute type is always netvisor, which is Netvisor ID |
3 | isjointowner | Numeric | 0...1 | In a shareholder relationship with payer | 1=yes |
3 | isathlete | Numeric | 0...1 | Athlete | 1=yes |
3 | isperformingartist | Numeric | 0...1 | Performing atrist | 1=yes |
3 | employeeincurancetype | Numeric | 0...1 | Employee pension insurance type | 1=Tyel |
3 | ispersonworkingonaroadferryonalandislands | Numeric | 0...1 | Person working on a road ferry on Åland Islands | 1=yes |
3 | isentrepreneurwithoptionalyelormyel | Numeric | 0...1 | Entrepreneur, no YEL or MYEL insurance obligation | 1=yes |
3 | ispersonreceivingeppoinsurancesalary | Numeric | 0...1 | EPPO-lain mukaista vakuutuspalkkaa saaja henkilö | 1=yes |
3 | isinvoicingserviceuserwithoutbusinessid | Numeric | 0...1 | A self-employed light entrepreneur, a client of an invoicing service, no Business ID | 1=yes |
3 | nosocialsecuritypayment | Numeric | 0...1 | Not subject to employer's sickness insurance payment | 1=yes |
3 | receivessalaryfromdiplomaticembassy | Numeric | 0...1 | Person receiving a salary paid by a diplomatic mission | 1=yes |
3 | activity | Numeric | 0...1 | Activity | 1=yes |
3 | foreclosure | Numeric | 0...1 | Foreclosure | 1=tes |
3 | foreclosuremaitenancepersons | Numeric | 0...1 | Persons facing recovery proceedings living under maintenance allowance | Must be given, if foreclosure=1 |
3 | taxnumber | String | 0...1 | Tax number | 123456798912 |
3 | placeofbusiness | String | 0...1 | Place of business (tulorekisteriin) | Pääkonttori |
2 | employmentperiods | Aggr. | 0...1 | Employments |
|
3 | employmentperiod | Aggr. | 1...n | Employment |
|
4 | companystartdate | Date | 0...1 | Start date of continuous employment | 2017-01-01 |
Attr. | format | String | 1 | Date format, always ansi | ansi |
4 | startdate | Date | 1 | Start date | 2017-01-01 |
Attr. | format | String | 1 | Date format, always ansi | ansi |
4 | probationenddate | Date | 0...1 | End date of probation | 2017-04-01 |
Attr. | format | String | 1 | Date format, always ansi | ansi |
4 | employmentmode | Numeric | 0...1 | Form of employment | 1 = employed |
Attr. | type | String | 1 | Linking type of employment | Attribute type is always netvisor, which is Netvisor ID |
4 | profession | String, max 250 | 1 | Professional title | Tester |
4 | comment | String, max 500 | 0...1 | Comment | Knows what she is doing |
4 | enddate | Date | 0...1 | End date | 2017-12-31 |
Attr. | format | String | 1 | Date format, always ansi | ansi |
4 | endreason | Numeric | 0...1 | End reason | 2=Retirement |
Attr. | type | String | 1 | Linking type of endreason | Attribute type is always netvisor, which is Netvisor ID |
4 | occupationclassification | String | 0...1 | Occupation class | |
Attr. | type | String | 1 | Linking type of occupation classification | always isco |
4 | employmentcontract | Numeric | 0...1 | Duration of employment | 1 = Permanent |
Attr. | type | String | 1 | Linking type of employment contract | always netvisor |
4 | employmentform | Numeric | 0...1 |
| 1 = Full-time |
Attr. | type | String | 1 | Linking type of employment form | always netvisor |
4 | parttimepercent | Numeric | 0...1 | Part-time percentage | Permissible value: decimal number from 0 to 100 |
4 | regularworkinghours | Numeric | 0...1 | Regular working hours | Permissible value: decimal number from 0 to 168 |
4 | groundsforemployment | Numeric | 0...1 | Grounds for employment | 0=Other grounds |
4 | kevaprofessionalclasscode | Numeric | 0...1 | Keva professional class code, max 20 characters | Keva's professional class codes: |
4 | kevaemploymentregistration | Numeric | 0...1 | Keva employment registration code, max 2 characters. | Keva employment registration codes: |
Attr. | type | String | 1 | always keva | keva |
Attr. | pensionprovidercode | String | 0...1 | Pension company ID code. If not given, default (20) will be used. This defines which values can be given in kevaemploymentregistration | Codes can be found here: Pension company ID codes |
4 | ispaymenttypemonthlywage | Numeric | 0...1 | Form of payment: Monthly wages | 1=yes |
4 | ispaymenttypehourlywage | Numeric | 0...1 | Form of payment: Hourly wages | 1=yes |
4 | ispaymenttypepiecewage | Numeric | 0...1 | Form of payment: Contract pay | 1=yes |
4 | collectiveagreement | Numeric | 0...1 | Collective agreement | Incomes registers 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 |
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 in another country. | 1=yes |
4 | caremissionsvalue | Numeric | 0...1 | Car emission value, an integer between 0-100 | 85 |
2 | employeesettings | Aggr. | 0...1 | Settings for the employee |
|
3 | payrollservice | String | 0...1 | Payroll operations service. enabled or disabled | enabled |
3 | resourcemanagement | String | 0...1 | Resource management |
|
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 |
4 | name | String | 0...1 | Insurance specific settlement point definition (* |
|
3 | employeeunemploymentinsurance | Aggr. | 0...1 | Unemployment insurance |
|
4 | type | String | 0...1 | Settlement point handling | nohandling=no handling |
4 | name | String | 0...1 | Insurance specific settlement point definition (* |
|
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 (* |
|
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 (* |
|
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 (* |
|
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 (* |
|
3 | employeeforeclosure | Aggr. | 0...1 | fore closure |
|
4 | type | String | 0...1 | Settlement point handling | nohandling or attachedtosettlementpoint |
4 | name | String | 0...1 | Insurance specific settlement point definition (* |
|
2 | EmployeeEducationalInformation | Aggr. | 0...1 | Employee's educational information |
|
3 | degree | Aggr. | 0...n | Degree |
|
3 | name | String | 1 | Name of the degree | secondary school |
3 | school | String | 1 | Name of the School | Lyseon lukio |
3 | graduationyear | Numeric | 1 | Year of graduation | 2022 |
3 | primarydegree | Numeric | 1 | Primary degree | 1 = yes |
2 | employeeadditionalinformation | Aggr. | 0...n | Employee's additional information fields |
|
3 | additionalinformationfield | Aggr. | 0...n | Employee additional information field |
|
4 | name | String | 1 | Additional information field's name | Allergies |
4 | value | String | 1 | Additional information field's value |
|
*) Settlement points: Salary > Payroll > Obligations > Settlements
Note when using this resource:
Editing employee is also possible when the employee's employment emplyment is not valid
If you are updating existing employee and you are not changing Employee number do not give tag
With this resource you cannot set holiday accural. This has to be done in Netvisor UI.
For a single employee, the information can be set on the employees's information page
For multiple employees, information can be set as mass in the management of holiday rights (Salaries > Holiday calculation settings): Select wanted employees, press "Handle select" and "Set holiday accumulation rule", and then select the wanted 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 not been defined, employees employment will be set as it was before (employeepayrollinformation > profession and jobbegindate)
If employmentperiods-element has been defined, employment information will override employeepayrollinformation-definitions
If employments will be imported through API already existing (if any) employments will be deleted
If company is added as employee, do not give basic employee information, like:
employeeidentifier
firstname
lastname
foreignemployeeidentification -element
