IntegrationHTTP-methodResourceDTDExample
Get employeesGETgetemployees.nv

Get employeeGETgetemployee.nv

Import an employeePOSTemployee.nvemployee.dtdDownload
Patch an employee's informationPOSTpatchemployee.nv

Get employee salary parametersGETgetemployeesalaryparameters.nv Download
Import employee salary parametersPOSTemployeesalaryparameters.nvemployeesalaryparameters.xsdDownload
Get salary typesGETpayrollratiolist.nv Download
Import a payroll paycheck batchPOSTpayrollpaycheckbatch.nvpayrollpaycheckbatch.dtdDownload
Import record line for pay periodPOSTpayrollperiodcollector.nvpayrollperiodcollector.dtdDownload
Import pay advancePOSTpayrolladvance.nvpayrolladvance.dtdDownload
Import external salary payment dataPOSTpayrollexternalsalarypayment.nvpayrollexternalsalarypayment.dtdDownload
Get payroll paycheckbatch listGETgetpayrollpaycheckbatchlist.nv

Get payroll paycheckbatchGETgetpayrollpaycheckbatch.nv

Add employment periodPOST
addjobperiod.nv
Download
Edit employment periodPOST
editjobperiod.nv
Download
Delete employment periodGETdeletejobperiod.nv

Get settlement pointsGETgetpayrollparties.nv

Attach employee to settlement pointPOSTattachemployeetosettlementpoint.nv


Get employees

Resource: getemployees.nv

Returns a list of employees and their id's.

Querystring parameters:

ParameterOccursExampleDescription
includeendedemployments0...11Include ended employments, 1 = yes, 0 = no

Response:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1

1employeesAggr.1

2employeeAggr.1

3employeenumberString1Employee number100
3netvisorkeyString1Employee's netvisor id10
3personalidString1Employee's pin010277-xxxp
Attr.typeString1Type of personalIDfinnishidentifier
3firstnameString1Employee's first nameAnna
3lastnameString1Employee's last nameAmmattilainen
3employmentstatusString1Employment status1
3payrollserviceString1Payroll operations service. 1 = enabled or 0 =  disabled1
3resourcemanagementString1Travel expense resources 1 = enabled or 0 =  disabled1

Get employee

Resource: getemployee.nv

Returns the information of a single employee.

Querystring parameters:

ParameterOccursExampleDescription
netvisorkey0...11Employees Netvisorkey
employeenumber0...1100
employmentperiods0...11Include employment periods
1 = yes
0 = no
employeepayrollinformation0...11Include payroll information
1 = yes
0 = no
educationalinformation0...11Include educational information
1 = yes
0 = no
additionalinformationfields0...11Include additional information fields
1 = yes
0 = no
employeesettlementpoints0...11Include settlement points
1 = yes
0 = no

Response:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1

1employeeAggr.1

2employeebaseinformation Aggr.1...n

3netvisorkey Numeric1Employee's netvisorkey 8
3employeenumber Numeric1Employee's number123
3employeeidentifier String1Employee identifier type: finnishidentifier, foreignidentifier, companyidentifier foreignidentifiertype
Attr.foreignidentifiertypeString1Foreign person's identifier type: taxidentificationnumber, foreignpersonalidentifier, other. Use only if person is foreigntaxidentificationnumber 
3issuingcountry String,
max 2
1Employee's home countryfi
Attr.typeString1Always ISO-3166ISO-3166
3firstnameString, max 501Employee's first nameAnna
3lastname String, max 501Employee's last nameAmmattilainen
3fullnameString1Employee's full nameAmmattilainen Anna
3payrollserviceNumeric1Payroll service1 = yes 0 = no
3resourcemanagement Numeric1Travel expense service1 = yes 0 = no
3nationalityString, maks. 21Employee's nationalityse
Attr.typeString1Always ISO-3166ISO-3166
3languageString, maks. 21Employee's language, default is 'fi'fi
Attr.typeString
Language formatISO-3166
3municipalityString, maks. 2551Employee's home cityLappeenranta
3genderString1Gender: male, femalemale
3dateofbirthDate1Date of birth1970-10-20
3streetaddressString, maks. 2551Employee's addressKeisarinnankatu 1
3postnumberString, maks. 501Employee's post number56120
3cityString, maks. 2551Employee's post officeLappeenranta
3countryString, maks. 21Employee's home countryfi
Attr.typeString1Always ISO-3166ISO-3166
3phonenumberString, maks. 501Employee's phone number050 123 456
3emailString, maks. 1001Employee's e-mail addressanna.ammattilainen@yritys.fi
3bankaccountnumberString, maks. 341Employee's bank account number, IBANFI71 7997 9580 0073 35
3bankidentificationcodeString, maks. 201BICNDEAFIHH
3activityNumeric
Employee's activity. Does not indicate whether empoyee has an active employment1 = yes
0 = no
2employmentperiodsAggr.0...1Employment periods
3employmentperiodAggr.0...nEmployment period
4netvisorkeyNumeric1Employment period's netvisorkey3
4companystartdateDate1Start date of continuous employment2017-01-01
Attr.formatString1Date format, always ansiansi

startdateDate1Start date2017-01-01
Attr.formatString1Date format, always ansiansi
4probationenddateDate1End date of probation2017-04-01
Attr.formatString1Date format, always ansiansi
4employmentmodeNumeric1Mode of employment1 = employed
2 = leased employee
3 = self-employed person or similar
4 = trainee
5 = voluntary work
Attr.typeString1Linking type of employmentAttribute type is always netvisor, which is Netvisor ID
4professionString, max. 2501Professional titleTester
4commentString, max. 5001CommentKnows what she is doing
4enddateDate1End date2017-12-31
Attr.formatString1Date format, always ansiansi
4endreasonNumeric1End reason    2=Retirement
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.typeString1Linking type of endreasonAttribute type is always netvisor, which is Netvisor ID
4occupationclassificationString1Occupation class  TK10-code of occupation class
Attr.typeString1Linking type of occupation classificationalways isco
4employmentcontractNumeric1Duration of employment>1 = Permanent
2 = Temporary
Attr.typeString1Linking type of employment contractalways netvisor
4employmentformNumeric1Form of employment1 = Full-time2 = Part-time
Attr.typeString1Linking type of employment form    always netvisor
4parttimepercentDecimal1Part-time percentDecimal number from 0 to 100
4regularworkinghoursNumeric1Regular working hoursDecimal number from 0 to 168
4groundsforemploymentNumeric1Grounds for employment0=Other grounds
1=Working or employment relationship
4kevaprofessionalclasscodeNumeric1Keva professional class code, max 20 charactersProfessional class codes
4kevaemploymentregistrationNumeric1Keva employment registration, max 2 charactersKeva employment registration codes
Attr.typeString1always kevakeva
Attr.pensionprovidercodeNumeric1Pension provider codeKeva: Incomes register codes
4ispaymenttypemonthlywageNumeric1Form of payment: Monthly wages1=yes
0=no
4ispaymenttypehourlywageNumeric1Form of payment: Hourly wages1=yes
0=no
4ispaymenttypepiecewageNumeric1Form of payment: Contract pay1=yes
0=no
4collectiveagreementNumeric1Collective agreementIncome register: Codes
Attr.pensionprovidercodeString1always cbacodecbacode
4stateemploymentfundNumeric1Employed with assistance from the State employment fund1=yes
0=no
4carbenefityearNumeric1Year of commissioning of the company car, max 4 characters2012
4isabroadcarbenefitNumeric1Company car benefit received in another country.1=yes
0=no
4caremissionvalueNumeric1Car emission value, an integer between 0-10085
2employeepayrollinformationAggr.0...1Payroll information
3payrollrulegroupAggr.1Payroll group name
4netvisorkeyNumeric1Payroll groups netvisorkey2
4nameString1Employees payroll groupMonthly salary
3taxnumberNumeric1Tax number123456789101
3foreclosureNumeric1Foreclosure1=yes
0=no
3foreclosuremaintenancepersonsNumeric1Foreclosure maintenance persons3
3nosocialsecuritypaymentNumeric1Not subject to employer's sickness insurance payment1=yes
0=no
3accountingaccountAggr.1Advance debt account
4netvisorkeyNumeric1Advance debt account's netvisorkey
4nameString1Advance debt account's nameReceivables from employees
4numberNumeric1Advance debt account's number1751
3hierarchyAggr.1Hierarchy level
4netvisorkeyNumeric1Hierarchy level's netvisorkey4
4nameString1Hierarchy level's nameOy Yritys Ab
3placeofbusinessString1Place of business for income registerPääkonttori
3defaultdimensionsAggr.0...1Default dimensions
4defaultdimensionAggr.0...nDefault dimension
5dimensionnameString1Dimension name.Kustannuspaikat
5dimensionitemString1Dimension item name.DevOps
3payslipdeliverymethodString1Payslip delivery method1 = local printing
2 = printing service
3 = e-salary
3typeString1Attribute type is always netvisor, which is Netvisor IDnetvisor
3isjointownerNumeric1In a shareholder relationship with payer1=yes
0=no
3isathleteNumeric1Athlete1=yes
0=no
3isperformingartistNumeric1Performing atrist1=yes
0=no
3employeeinsurancetypeNumeric1Työeläkevakuutuksen tyyppi1=Tyel
2=MYEL
3=YEL
4=No pension insurance
3ispersonworkingonaroadferryonalandislandsNumeric1Person working on a road ferry on Åland Islands1=yes
0=no
3isentrepreneurwithoptionalyelormyelNumeric1Entrepreneur, no YEL or MYEL insurance obligation1=yes
0=no
2employeeeducationalinformationAggr.0...1Degrees
3degreeAggr.0...nDegree
4nameString1Name of the degreeMerkonomi
4schoolNumeric1Name of the schoolKauppaoppilaitos
4graduationyearNumeric1Graduation year2021
4isprimarydegreeNumeric1Is this the primary degree1=yes
0=no
2employeeadditionalinformationfieldsAggr.0...1Additional information fields
3additionalinformationfieldAggr.0...nAdditional information field
4netvisorkeyNumeric1netvisorkey1
4nameString1Additional information field's nameFood allergies
4valueString1Additional information field's valuefish
Attr.typeString1text, datetimetext
4groupString11=Basic information
2=Contact information
3=Educational information
1
Attr.typeString1Attribute type is always netvisor, which is Netvisor IDnetvisor
2employeesettlementpointsAggr.0...1Settlement points
3employeeunemploymentinsuranceAggr.0...nUnemployment insurance
4netvisorkeyNumeric1Settlement's netvisorkey1
4typeString1Settlement point handlingnohandling = no handling automatichandling = Automatic handling under17yearsold = under 17 years old
17to64yearsold = 17 to 64 years old
over65yearsold = over 65 years old
partowner = part owner
4nameString1Insurance specific settlement point definitionUnemployment insurance
3employeeaccidentinsuranceAggr.0...nAccident insurance
4netvisorkeyNumeric1Settlement point netvisorkey2
4typeString1Settlement point handlingattachedtosettlementpoint
4nameString1Insurance specific settlement point definitionAccident insurance
3employeegrouplifeinsuranceAggr.0...nGroup life insurance
4netvisorkeyNumeric1Settlement point netvisorkey3
4typeString1Settlement point handlingattachedtosettlementpoint
4nameString1Insurance specific settlement point definitionGroup life insurance
3employeeunionmembershipfeeAggr.0...nUnion membership fee
4netvisorkeyNumeric1Settlement point netvisorkey4
4typeString1Settlement point handlingattachedtosettlementpoint
4nameString1Insurance specific settlement point definitionUnion membership fee
3employeeotherinsuranceAggr.0...nOther insurance    
4netvisorkeyNumeric1Settlement point netvisorkey5
4typeString1Settlement point handlingattachedtosettlementpoint
4nameString1Insurance specific settlement point definitionOther insurance
3employeeworkpensioninsuranceAggr.0...nWork pension insurance
4netvisorkeyNumeric1Settlement point netvisorkey
4typeString1Settlement point handlingnohandling = no handling automatichandling = Automatic handling under17yearsold = under 17 years old 17to64yearsold = 17 to 64 years old over65yearsold = over 65 years old
partowner = part owner 
4nameString1Insurance specific settlement point definitionTyEL
3employeeforeclosureAggr.0...nForeclosure
4netvisorkeyNumeric1netvisorkey6
4typeString1Settlement point handlingattachedtosettlementpoint
4nameString1Insurance specific settlement point definitionForeclosure

Import an employee

Resource: employee.nv

Import an employee's information.
Querystring parameters:

Parameter nameOccursExampleDescription
Method1AddAdd or Edit

Request:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1  
1employeeAggr.1  
2employeebaseinformationAggr.1  
3foreignemployeeidentificationAggr.0...1Foreign employeeIf given, do not give employeeidentifier value
4identifierText1Identifier23011970
Attr.typeString1Identifier type, allowed values:
taxidentificationnumber
foreignpersonalidentifier
other
foreignpersonalidentifier
4issuingcountryString1CountryAF
Attr.typeString1Country typeISO-3316
4genderString1Gender,
male
female
male
4dateofbirthDate1Date of birth
1970-10-20
Attr.formatString1Date format, always ansiansi
3employeeidentifierString1Finnish employee social security number010277-xxxp 
3companyidentifierString0...1Company indentifier (y-tunnus),
when company is added as an employee
0174564-5
3companynameString0...1Name of the companyTest Company
3firstnameString, max 50 1Employee's first name Carl
3lastnameString, max 50 1Employee's last name Customer
3phonenumberString, max 50 1Employee's phone number 0501234567
3emailString, max 100 1Employees E-mail carl.customer@company.fi
2employeepayrollinformationAggr.1  
3streetaddressString, max 2551Employee's address Examplestreet 1
3postnumberText, max 501Employee's post number 56123
3cityString, max 2551Employee's post officeLappeenranta
3municipalityString, max 2550...1Employees's home cityLappeenranta
3countryString, max 20...1Employee's home country. Default is 'fi'fi
3nationalityString, max 2 0...1Employee's nationalityse
3languageString, max 2 0...1Employee's language fi
3employeenumberNumeric, max 100...1Employee's unique identification number 12
3professionString, max 2550...1Employee's profession Seller
3jobbegindateString, max 100...1Employee's job begin date, yyyy-mm-dd2014-08-10
Attr.formatString1Date format, always ansiansi
3payrollrulegroupnameString, max 501Payroll group nameMonthly salary
3bankaccountnumberString, max 340...1Employee's bank account numberFI21 1234 xxxx xxxx xx
3bankidentificationcodeString, max. 200...1Bank's identification code  
3accountingaccountnumberNumeric 0...1You can access company's accounting information in Netvisor from ACCOUNTING > Administration > Accounting basic information > Account list1751
3hierarchyString0...1Hierarchy levelOy Yritys Ab 
Attr.typeString1Linking type of hierarchynetvisor - Netvisor ID
or
customer - If identified by name, name has to be unique
Read about company hierarchy
3dimensionAggr.0...n Default dimensions
4dimensionnameString1Dimension header name.
Created if needed
Cost centers
4dimensionitemString1Dimension name. Created if neededDevOps
Attr.fatheridNumeric0...1Dimensions parent ID tunnus. IDs can be retrieved with this resource.1
3payslipdeliverymethodString0...1Payslip delivery method1 = local printing
2 = printing service
3 = e-salary
Attr.typeString1Linking type of delivery methodAttribute type is always netvisor, which is Netvisor ID
3isjointownerNumeric0...1In a shareholder relationship with payer1=yes
0=no
3isathleteNumeric0...1Athlete1=yes
0=no
3isperformingartistNumeric0...1Performing atrist1=yes
0=no
3employeeincurancetypeNumeric0...1Employee pension insurance type1=Tyel
2=MYEL
3=YEL
4=No pension insurance
3ispersonworkingonaroadferryonalandislandsNumeric0...1Person working on a road ferry on Åland Islands1=yes
0=no
3isentrepreneurwithoptionalyelormyelNumeric0...1Entrepreneur, no YEL or MYEL insurance obligation1=yes
0=no

1 can be given only when employeeincurancetype=4
3nosocialsecuritypaymentNumeric0...1Not subject to employer's sickness insurance payment1=yes
0=no
2employmentperiodsAggr.0...1Employments 
3employmentperiodAggr.1...nEmployment 
4companystartdateDate0...1Start date of continuous employment2017-01-01
Attr.formatString1Date format, always ansiansi
4startdateDate1Start date2017-01-01
Attr.formatString1Date format, always ansiansi
4probationenddateDate0...1End date of probation2017-04-01
Attr.formatString1Date format, always ansiansi
4employmentmodeNumeric0...1Form of employment1 = employed
2 = leased employee
3 = self-employed person or
 similar
4 = trainee
5 = voluntary work
Attr.typeString1Linking type of employmentAttribute type is always netvisor, which is Netvisor ID
4professionString, max 250
1Professional titleTester
4commentString, max 5000...1CommentKnows what she is doing
4enddateDate0...1End date2017-12-31
Attr.formatString1Date format, always ansiansi
4endreasonNumeric0...1End reason2=Retirement
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.typeString1Linking type of endreasonAttribute type is always netvisor, which is Netvisor ID
4occupationclassificationString0...1Occupation classTK10-code of occupation class 
Attr.typeString1 Linking type of occupation classification always isco
4employmentcontractNumeric0...1Duration of employment1 = Permanent
2 = Temporary
Note: For temporary contract must be given end date 
Attr.typeString1Linking type of employment contractalways netvisor
4employmentformNumeric0...1 1 = Full-time
2 = Part-time
Attr.typeString1Linking type of employment formalways netvisor
4parttimepercentNumeric0...1Part-time percentagePermissible value: decimal number from 0 to 100
Note: employmentform must be 2 so that the setting is taken into account.
Rounding to the nearest two decimal places
4regularworkinghoursNumeric0...1Regular working hoursPermissible value: decimal number from 0 to 168
Rounding to the nearest two decimal places
4groundsforemploymentNumeric0...1Grounds for employment0=Other grounds
1=Working or employment relationship
4kevaprofessionalclasscodeNumeric0...1Keva professional class code, max 20 characters
KEVA information can only be given is company has selected "Company pension insurer is Keva"
Keva's professional class codes:
Professional class codes
4kevaemploymentregistrationNumeric0...1Keva employment registration code, max 2 characters.
Keva employment registration codes:
Keva employment registration codes
Attr.typeString1always kevakeva
Attr.pensionprovidercodeString0...1Pension company ID code. If not given, default (20) will be used. This defines which values can be given in kevaemploymentregistrationCodes can be found here: Pension company ID codes
ispaymenttypemonthlywageNumeric0...1Form of payment: Monthly wages1=yes
0=no
4ispaymenttypehourlywageNumeric0...1Form of payment: Hourly wages1=yes
0=no
4ispaymenttypepiecewageNumeric0...1Form of payment: Contract pay1=yes
0=no
4collectiveagreementNumeric0...1Collective agreementIncomes registers collective agreement codes:
Collective agreement codes
Attr.typeString1always cbacodecbacode
4stateemploymentfundNumeric0...1Employed with assistance from the State employment fund1=yes
0=no
4carbenefityearNumeric0...1Year of commissioning of the company car, max 4 characters2012
4isabroadcarbenefitNumeric0...1Company car benefit received in another country. 1=yes
0=no
4caremissionsvalueNumeric0...1Car emission value, an integer between 0-10085
2employeesettingsAggr.0...1Settings for the employee 
3payrollserviceString0...1Payroll operations service. enabled or disabledenabled
3resourcemanagementString0...1Resource management 
2employeesettlementpointsAggr.0...1Settlement points 
3employeeworkpensioninsuranceAggr.0...1Work pension insurance 
4typeString0...1Settlement point handlingnohandling=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
4nameString0...1Insurance specific settlement point definition (* 
3employeeunemploymentinsuranceAggr.0...1Unemployment insurance 
4typeString0...1Settlement point handlingnohandling=no handling
automatichandling =Automatic handling 
under17yearsold=under 17 years old
17to64yearsold=17 to 64 years old
over65yearsold=over 65 years old
partowner=part owner
4nameString0...1Insurance specific settlement point definition (* 
3employeeaccidentinsuranceAggr.0...1Accident insurance 
4typeString0...1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0...1Insurance specific settlement point definition (* 
3employeegrouplifeinsuranceAggr.0...1Group life insurance 
4typeString0...1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0...1Insurance specific settlement point definition (* 
3employeeotherinsuranceAggr.0...1Other insurance 
4typeString0...1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0...1Insurance specific settlement point definition (* 
3employeeunionmembershipfeeAggr.0...1Union membership fee 
4typeString0...1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0...1Insurance specific settlement point definition (* 
3employeeforeclosureAggr.0...1fore closure 
4typeString0...1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0...1Insurance specific settlement point definition (* 
2EmployeeEducationalInformationAggr.0...1Employee's educational information
3degreeAggr.0...nDegree
3nameString1Name of the degreesecondary school
graduate
3schoolString1Name of the SchoolLyseon lukio
3graduationyearNumeric1Year of graduation2022
3primarydegreeNumeric1Primary degree1 = yes
0 = no
2employeeadditionalinformationAggr.0...nEmployee's additional information fields
3additionalinformationfieldAggr.0...nEmployee additional information field
4nameString1Additional information field's nameAllergies
4valueString1Additional 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

Patch an employee's information

Resource: patchemployee.nv

This resource allows to edit an employee's information. Use only those elements which information you want to edit.

Parameter nameOccursDescriptionExample
identifiertype1Employee identifier type: netvisorkey, number or personalidentificationnumbernetvisorkey
identifier1Employee's identifier1

Response:

LevelElement nameType and lengthOccursDescriptionExample
RootRootAggr.1

1patchemployeeAggr.1

2employeebaseinformationAggr.1

3companynameString0..1Yrityksen nimiTest Company Oy
3firstnameString, max 500..1Employee's first nameAnna
3lastnameString, max 500..1Employee's last nameAmmattilainen
3phonenumberString, max 500..1Employee's phone number0501234567
3emailString, max 1000..1Employee's e-mail addressanna.ammattilainen@test-company.fi
2employeepayrollinformationAggregaatti0..1

3streetaddressString, max 2550..1Employee's street addressKeisarinnankatu 1
3postnumberString, max 500..1Employee's post number56120
3cityString, max 2550..1Employee's post officeLappeenranta
3municipalityString, max 2550..1Employee's municipalityLappeenranta
3countryString, max 20..1Employee's country code, default fifi
3nationalityString, max 20..1Employee's nationality, default fise
3languageString, max 20..1Employee's language, default fifi
3employeenumberNumerical0..1Employee's number12
3payrollrulegroupnameString, max 500..1Employee's payroll group nameKuukausipalkka, perusmalli
3bankaccountnumberString, max 340..1Employee's bank account number, IBAN-account number. If given, BIC-code is also mandatory (bankidentificationcode).FI7179979580007335
3bankidentificationcodeString, max 200..1Bank BIC-codeNDEAFIHH
3accountingaccountnumberNumerical0..1Employee's accounting account number1751
3hierarchyString0..1Hierarchy levelTest Company Oy
Attr.typeString0..1Hierarkian linkitystyyppinetvisor - Netvisorin tunniste (netvisorkey) tai customer - Jos yksilöidään nimellä, täytyy olla uniikki. Lue yrityshierarkiasta
3payslipdeliverymethodString0..1Palkkalaskelman toimitustapa1 = paikallinen tulostus
2 = tulostuspalvelu
3 = verkkopalkka
Attr.typeString0..1Toimitustavan linkitystyyppiAttribuutti type on aina netvisor,
eli Netvisorin tunniste (netvisorkey)
3isjointownerNumerical0..1Osakasasemassa maksajaan1=kyllä
0=ei
3isathleteNumerical0..1Urheilija1=kyllä
0=ei
3isperformingartistNumerical0..1Esiintyvä taiteilija1=kyllä
0=ei
3employeeinsurancetypeNumerical0..1Työeläkevakuutuksen tyyppi1=Tyel
2=MYEL
3=YEL
4=Ei eläkevakuutettu
3ispersonworkingonaroadferryonalandislandsNumerical0..1Ahvenanmaan maantielautalla työskentelevä henkilö1=kyllä
0=ei
3isentrepreneurwithoptionalyelormyelNumerical0..1Yrittäjä, ei YEL- tai MYEL-vakuuttamisvelvollisuutta1=kyllä
0=ei
1 voidaan antaa vain, mikäli employeeinsurancetype=4
3ispersonreceivingeppoinsurancesalaryNumerical0..1EPPO-lain mukaista vakuutuspalkkaa saaja henkilö1=kyllä
0=ei
3nosocialsecuritypaymentNumerical0..1Ei työnantajan sairausvakuutusmaksun alainen1=kyllä
0=ei
3receivessalaryfromdiplomaticembassyNumerical0..1Diplomaattisen edustuston maksamaa palkkaa saava henkilö1=kyllä
0=ei
3activityNumerical0..1Aktiivisuus1=kyllä
0=ei
3foreclosureNumerical0..1Ulosotto1=kyllä
0=ei
3foreclosuremaintenancepersonsNumerical0..1Ulosotossa elatuksen varassa olevat henkilötAnnettava jos tieto ulosotta annetaan arvolla 1
3taxnumberString0..1Employee's veronumero12345678912
3placeofbusinessString0..1Toimipaikka tulorekisteriin (nimi)Pääkonttori
2employeesettingsAggregaatti0..1Employee's asetukset
3payrollserviceString0..1Palkanlaskentapalveluenabled tai disabled
3resourcemanagementString0..1Resurssinhallintaenabled tai disabled

Get employee salary parameters

Resource: getemployeesalaryparameters.nv

If the paycheck does not have a value, the value element returns as an empty element (), whereas the zero value returns as a normal value ( 0,0 ).

With this resource it is possible to get employee salary parameters. Parameters used in the request (GET):

ParameterOccursDescription
identifiertype1Value: pin employee personal identity code or number employee number
identifier1 Identifier defined by the type: employee personal identity code or employee number

Response:

LevelElement nameType and lengthOccursDescriptionExample
rootrootAggr.1  
1employeesalaryparametersAggr.1  
2parametersAggr.1  
3parameterAggr.0...n  
4rationumberNumeric1Number of the salary parameter123
4valueDecimal1Value of the salary parameter12,34

Import employee salary parameters

Resource: employeesalaryparameters.nv

It is possible to import part of the salary parameters (1-24 pcs at a time) in one request and the other part with another request. No changes are made in the salary parameters existing in Netvisor if they are not specified in the request.

If you want to set salary parameter to zero or update its value, a new value is given in the value element.  If the value of an existing salary parameter is to be completely eliminated, the value element is not given at all in the request.

This resource requires payroll accountant role (P role) from API user. 

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1  
1employeesalaryparametersAggr.1  
2employeeidentificationString1Identification of the employee123456-123A
Attr.typeString1Type of the employee identificationi:
pin or number 
pin
2salaryparametersAggr.1  
3salaryparameterAggr.1...24  
4rationumberNumeric1Number of salary parameter's salary type (company-spesific salary types)123
4valueDecimal0...1Value of salary parameter12,30

Get salary types

Resource: payrollratiolist.nv

With this resource it is possible to get company-specific salary types. Salary types are used for importing trip expenses and payslips to Netvisor.

ParameterOccursDescriptionExample
source1...nThe request is limited by the salary type, which has to be one of the following:
- tripexpensecustomlines
- taxingrules
- collectorratiolines
- userparameters
- companyparameters
- userformula
- tabledata
- foreclosure
- lowsalarysupport
collectorratiolines

Vastaus:

LevelElementType and lengthOccursDescriptionExample
RootrootAggr.1  
1PayrollRatiosAggr.1  
2PayrollRatioAggr.0...n  
3NamesAggr.0...n

4NameString1-3Name of salary typeUlkomaan päiväraha
Attr.ISO639-1CodeString1Language information of salary type's name: fi,se, enfi
3IdentifierNumeric1ID of salary type1
3SourceString1Type of salary typeMatkalasku, kulurivit
3RatioNumberNumeric1Number of salary type123
3DefaultDebitAccountNumberNumeric1Debit account for bookkeeping7890
3DefaultCreditAccountNumberNumeric1Credit account for bookkeeping2961

Import a payroll paycheck batch

Resource: payrollpaycheckbatch.nv

Import a payslip into Netvisor.

Request:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1  
1payrollpaycheckbatchAggr.1  
2employeeidentifierString1Employee has to exist in Netvisor and the employee must be determined for correct wage model in Netvisor before transferring the data10
Attr.typeString1Type of identifier, either employeenumber or finnishpersonalidentifieremployeenumber
2rulegroupperiodstartDate1Pay period start date. Note! The period or the previous or next period has to exist in Netvisor. If period is not defined in Netvisor it will be added only if it is the first pay period of wage model or it begins right after the last pay period
2022-02-01
Attr.formatString1Date format, always ansiansi
2rulegroupperiodendDate1Pay period end date. Note! The period or the previous or next period has to exist in Netvisor. If period is not defined in Netvisor it will be added only if it is the first pay period of wage model or it begins right after the last pay period
2022-02-28
Attr.formatString1Date format, always ansi ansi
2freetextbeforelinesString0...1Free text before payroll lines 
2freetextafterlinesString0...1Free text after payroll lines  
2duedateDate1Due date 2022-02-17
Attr.formatString1Date format, always ansiansi
2valuedateDate1Value date2022-02-17
Attr.formatString1Date format, always ansiansi
2payrollpaycheckbatchlineAggr.1...n  
3payrollratioidentifierString1Salary type as number, has to exist in Netvisor. Can be foud from Salaries > Salary model management > Company-specific salary types.1
Attr.typeString1Always rationumberrationumber
3unitsNumeric1Number of units 2
3unitamountNumeric1price of a single unit 39
3linesumNumeric1Sum of the line, will not be calculated automatically, has to be given in XML. Recomended max 2 decimals.78,00
3linedescriptionString 0...1Description of the line 
3earningperiodstartdateDate0...1Start date of the earning period2022-01-01
Attr.typeString1Date format, always ansiansi
3earningperiodenddateDate0...1End date of the earning period2022-31-01
Attr.typeString1Date format, always ansiansi
3dimensionAggr.0...n  
4dimensionnameString1Title of the dimension. If not found, it will be created  
4dimensionitemString1Dimension name. If not found it will be created  

Import record line for pay period

Resource: payrollperiodcollector.nv

LevelElementType and lengthOccursDescriptionExample
RootRootAggr.1  
1payrollperiodcollectorAggr.1  
2dateDate1Date 
Attr.formatString1Always ansi 
2employeeidentifierString1Employee number in Netvisor 
Attr.typeString1number or personalidentificationnumber 
2payrollratiolineAggr.1...n  
3amountNumber1The amount of the record line 
3payrollratioNumber1Number of record type in Netvisor 
Attr.typeString0...1Always number 
3dimensionAggr.0...n  
4dimensionnameString1Title of dimension. If not found, it will be created 
4dimensionitemString1Name of the dimension. If not found, it will be created 
Attr.fatheridNumeric0...1Parent id of the dimension 

Import pay advance

Resource: payrolladvance.nv

Import payment for pay advance

LevelElementType and lenghthOccursDescriptionExample
RootRootAggr.1  
1payrolladvanceAggr.1  
2descriptionString0...1Open description of the event 
2employeeidentifierString1Employee number 
Attr.typeString0...1number or finnishpersonalidentifier 
2paymentdateDate1Date of pay advance's payment. Can't be earlier than today 
Attr.formatString0Always ansi (Notify that in the DTD there is a miskatake in this, if this attribute is given an error will occur) 
2advancesumNumber1Amount of pay advance 
Attr.paymentstatusString0...1ispaid or notpaid 
2paymenttypeString1payroll or tripexpence 

Importing external salary payment data

Resource: payrollexternalsalarypayment.nv

Is used to import external salary payment data. It is not necessary to import the whole
payslip, only the payment data. The data doesn't need to be linked to an employee in
Netvisor. Payment takes place in Netvisor, resource is quite similar to importing bank transfer.

LevelElement nameType and lengthOccursDescriptionExample
RootRootAggr.1  
1payrollexternalsalarypaymentAggr.1  
2descriptionString1Description of the event. Informal definition
External payment
2paymentdateDate1Payment date = Payday, salary will be on employees account on this date2017-01-01
Attr.formatString ansiansi
2duedateDate1Due date, salary will be charged from company's account2017-01-01
Attr.formatString ansiansi
2externalpaymentsumDecimal1Amount of payment (0.01 < sum < 10000000.0)100,0
2ibanString1Employee's bank account numberFI21 1234 xxxx xxxx xx
2bicString1Bank's identification codeNDEAFIHH
2hetuString1Employee's Personal identity code:140785-xxyy
2realnameString1Employee's nameErkki Esimerkki

Either paymentdate or duedate will be set

Elements (paymentdate, duedate) terminology is according to SEPA-bank transfer standard:
SEPA Palkat Tiedote Tammikuu 2009

The date when payers account is charged is given in payment order instead of payment date; On this basis banks take care of that salaries and retirement payments are on recipients accounts at the payday in all banks that operate in Finland. This due date has to be banking day and it has must be a banking day before payday.

On the due date (duedate) salary is charged from company's account.
One banking day is added to the due date so that payment date = payday. If due date is eg. Friday, 3 days will be added so that due date is Monday.

Payment date (paymentdate) = payday, payroll is in employees account.
Banking day interpretation is not done at this moment, it will be interpreted in payment.

 

Get payroll paycheckbatchlist

Resource: getpayrollpaycheckbatchlist.nv

Retrieves company's payslips from given time period, maximum 30 days

ParameterOccursDescriptionExample
startdate1Mandatory, start date2023-01-01
enddate0..1Voluntary, end date. If not given, payslips are retrieved from start date only2023-01-31

Response:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1

1PayrollPaycheckBatchesAggr.1

2PayrollPaycheckBatchAggr.0..n

3NetvisorkeyNumerical1Payslip's identifier1
3PaymentDateDate1Payslip's payment date2023-01-31
3PayrollRuleGroupPeriodAggr.1Payroll period's information
4NetvisorkeyNumerical1Payroll period's  netvisorkey3
4StartDateDate1Payroll period's  start date2023-01-01
4EndDateDate1Payroll period's end date2023-01-31
3PayrollRuleGroupAggr.1Payroll Rulegroup's information
4NetvisorkeyNumerical1Payroll Rulegroup's  netvisorkey15
4NameText1Payroll Rulegroup's  nameMonthly salary
3EmployeeAggr.1Employee's information
4NameText1Employee's nameMatti Meikäläinen
4EmployeeNumberNumerical1Employee's number111 / empty
4NetvisorkeyNumerical1Employee's  identifier12
3StatusNumerical1Paycheck's status1=Open, 2=Confirmed/Accepted, 3= Paid
3StatusDescriptionText1Paycheck's status in text formatPaid


Get payroll paycheckbatch

Resource: getpayrollpaycheckbatch.nv

Returns a single payslip's information. Payslip's netvisorkey's can be retrieved with getpayrollpaycheckbatchlist.nv.

ParameterOccursDescriptionExample
netvisorkey1Mandatory, payslip's netvisorkey23

Response:

LevelElement nameType and lengthOccurs
DescriptionExample
RootrootAggr.1

1payrollpaycheckbatchAggr.1

2paymentdateDate1Payment date2023-03-31
2payrollrulegroupperiodAggr.1Payroll period
3netvisorkeyNumerical1Payroll period's identifier123
3startdateDate1Payroll period's starting date2023-03-01
Attr.formatString1Date formatansi
3enddateDate1Payroll period's end date2023-03-31
Attr.formatString1Date formatansi
2payrollrulegroupAggr.1Payroll rulegroup
3netvisorkeyNumerical1Payroll rulegroup's identifier123
3nameString1Payroll group's nameMonthly salary
2employeeAggr.1Employee
3netvisorkeyNumerical1Employee's identifier123
3nameString1Employee's nameMalli Maisa
3employeenumberNumerical1Employee number123 / empty
2statusNumerical1Paycheck's status1=Open
2=Confirmed/Accepted
3= Paid
2voucherAggr.0..1Voucher
3netvisorkeyNumerical1Voucher's identifier123
3classString1Voucher classPA Palkka
3numberNumerical1Voucher number123
3dateDate1Voucher date2023-03-31
Attr.formatString1Date formatansi
2allocationcurvesAggr.0..1Paycheck allocation curve
3allocationcurveAggr.1..nAllocation curve
Attr.percentNumerical1Distribution percent61
4dimensionsAggr.1Dimensions
5dimensionAggr.1..nDimension
6dimensionnameString1Dimension nameToimipiste
Attr.netvisorkeyNumerical1Tunniste123
6dimensionitemString1Dimension iten nameLappeenranta
2freetextbeforelinesString1Free text before linesRemember to deliver your tax card! / empty
2freetextafterlinesString1Free text after linesHappy Easter! / tyhjä
2holidayrecordsAggr.1Holidays records
3availableholidaysNumerical1Number of available vacation days25
3newaccrualofholidaysDecimal1Number of newly accrued vacation days7,5
2payrollpaycheckbatchlinesAggr.1Paycheck lines
3payrollpaycheckbatchlineAggr.1..nPaycheck line
4payrollratioAggr.1Payroll ratio
5netvisorkeyNumerical1Identifier123
5numberNumerical0..1Payroll ratio number123
5nameString1Payroll ratio nameMonthly salary
5isvisibleNumerical1Payroll ratios visibility on paycheck1=yes, 0=no
5costobjectsourceString1Payroll check's dimension's sourceDimensionCurve
PaycheckBatchLine
EmployeeDimensions
None
SelectedDimensions
4unitsNumerical1Number of units2 / empty
4unitamountNumerical1Unit amount200 / tyhjä
4linesumNumerical1Line sum400
4earningsperiodsAggr.1Earning periods
5earningperiodsAggr.1...nEarning period
6startdate
Date1Earning period's start date2023-03-01
Attr.formatString1Date formatansi
6enddateDate1Earning period's end date2023-03-31
Attr.formatString1Date formatansi
4incometypeAggr.0...1Income type
5netvisorkeyNumerical1Identifier
123
5nameString1Income type nameTime rate
4accountingdataAggr.1Accounting
5debetaccountnetvisorkeyNumerical1Identifier123 / empty
5debetaccountnumberNumerical1Debet-account's number5000 / empty
5debetaccountnameString1Debet-account's nameEmployee salaries / empty
5kreditaccountnetvisorkeyNumerical1Identifier123 / empty
5kreditaccountnumberNumerical1Credit-account's number2961 / empty
5kreditaccountnameString1Credit-account's nameSalary expenses (accruals) / empty
4dimensionsAggr.0..1Dimensions
5dimensionAggr.1..nDimension
Attr.percentNumerical1Percent25
6dimensionnameString1Dimension nameToimipiste
Attr.netvisorkeyNumerical1Identifier123
6dimensionitemString1Dimension item nameLappeenranta
Attr.netvisorkeyNumerical1Identifier123
4linedescriptionString1Line description


Add employment period

Resource: addjobperiod.nv

With this resource it is possible to add new job periods to an employee.

ParameterOccursDescriptionExample
employeeidentifier1Employee's netvisorkey12

Response:

LevelElement name
Type and lengthOccursDescriptionExample
RootrootAggr.1

1employmentperiods
Aggr.1Employment periods
2employmentperiodAggr.1..nEmploymen period
3companystartdateDate0..1Company start date2022-01-01
Attr.formatString1Date formatansi
3startdateDate1Start date2022-01-01
Attr.formatString1Date formatansi
3probationenddateDate0..1End date of probation2022-04-01
Attr.formatString1Date formatansi
3employmentmodeNumerical0..1Mode of employment1 = employed
2 = leased employee
3 = self-employed person or similar
4 = trainee
5 = voluntary work
Attr.typeString1Linking type of employmentalways netvisor
3professionString, max 2501Professional titleSpecialist
3commentString, max 5000..1CommentKnows what she's doing
3enddateDate0..1End date2022-12-31
Attr.formatString1Date formatansi
3endreasonNumerical0..1End reason2=retirement
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
The following are not in use anymore:
1 = Normal ending of employment
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.typeString1Linking typealways netvisor
3occupationclassificationString0..1Occupation classOccupation class TK10-code
Attr.typeString1Linking typealways isco
3employmentcontractNumerical0..1Duration of employment1 = Permanent
2 = Temporary
Note: a temporary job period must be given an end date
Attr.typeString1Linking typealways netvisor
3employmentformNumerical0..1Form of employment1 = Full-time
2 = Part-time
Attr.typeString1Linking typealways netvisor
3parttimepercentNumerical0..1Part-time percentDecimal number from 0 to 100
Note: employmentform must be 2, in order for this to be recognized
Rounded to the nearest two decimals
3regularworkinghoursNumerical0..1Regular working hoursDecimal number from 0 to 168
Rounded to the nearest two decimals
3groundsforemploymentNumerical0..1Grounds for employment0=Other grounds
1=Working or employment relationship
3kevaprofessionalclasscodeNumerical0..1Keva professional class code, max 20 characters
This code can only be given, if KEVA is chosen as the company's work pension provider in Netvisor
Professional class codes
3kevaemploymentregistrationNumerical0..1Keva employment registration, max length 2
Keva: Income register's codes
Attr.typeString1Always kevakeva
Attr.pensionprovidercodeNumerical0..1Pension provider code. If not given, default value "20" will be used
Defines what values are accepted in the element kevaemploymentregistration

Keva: Incomes register codes
3ispaymenttypemonthlywageNumerical0..1Form of payment: Monthly salary1=yes
0=no
3ispaymenttypehourlywageNumerical0..1Form of payment: Hourly wages1=yes
0=no
3ispaymenttypepiecewageNumerical0..1Form of payment: Contract pay1=yes
0=no
3collectiveagreementNumerical0..1Collective agreementIncome register: Codes
Attr.typeString1always cbacodecbacode
3stateemploymentfundNumerical0..1Employed with assistance from the State employment fund1=yes
0=no
3carbenefityearNumerical0..1Year of commissioning of the company car, max 4 characters2022
3isabroadcarbenefitNumerical0..1Company car benefit received in another country1=yes
0=no


Edit employment period

Resource: editjobperiod.nv

The resource can be used to edit an employee's single employment period. Use only those elements which information you want to edit. 

ParameterOccursDescriptionExample
netvisorkey1Employment period's netvisorkey2

Response:

LevelElement name
Type and lengthOccursDescriptionExample
RootrootAggr.1

1employmentperiodsAggr.1Employment periods
2employmentperiodAggr.1Employment period
3companystartdateDate0..1Company start date2022-01-01
Attr.formatString1Date format
3startdateDate0..1Start date2022-01-01
Attr.formatString1Date format
3probationenddateDate0..1End date of probation2022-04-01
Attr.formatString1Date format
3employmentmodeNumerical0..1Mode of employment1 = employed
2 = leased employee
3 = self-employed person or similar
4 = trainee
5 = voluntary work
Attr.typeString1Linking type of employmentalways netvisor
3professionString, max 2500..1Professional titleSpecialist
3commentString, max 5000..1CommentKnows what she's doing
3enddateDate0..1End date2022-12-31
Attr.formatString1Date formatansi
3endreasonNumerical0..1End reason2=retirement
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
The following are not in use anymore:
1 = Normal ending of employment
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.typeString1Linking typealways netvisor
3occupationclassificationString0..1Occupation classOccupation class TK10-code
Attr.typeString1Linking typealways isco
3employmentcontractNumerical0..1Duration of employment1 = Permanent
2 = Temporary
Note: a temporary job period must be given an end date
Attr.typeString1Linking typealways netvisor
3employmentformNumerical0..1Form of employment1 = Full-time
2 = Part-time
Attr.typeString1Linking typealways netvisor
3parttimepercentNumerical0..1Part-time percentDecimal number from 0 to 100
Note: employmentform must be 2, in order for this to be recognized
Rounded to the nearest two decimals
3regularworkinghoursNumerical0..1Regular working hoursDecimal number from 0 to 168
Rounded to the nearest two decimals
3groundsforemploymentNumerical0..1Grounds for employment0=Other grounds
1=Working or employment relationship
3kevaprofessionalclasscodeNumerical0..1Keva professional class code, max 20 characters
This code can only be given, if KEVA is chosen as the company's work pension provider in Netvisor
Professional class codes
3kevaemploymentregistrationNumerical0..1Keva employment registration, max length 2Keva: Income register's codes
Attr.typeString1Always kevakeva
Attr.pensionprovidercodeNumerical0..1Pension company ID-code. If not given, default value "20" will be used
Defines what values are accepted in the element kevaemploymentregistration
Keva: Incomes register code
3ispaymenttypemonthlywageNumerical0..1Form of payment: Monthly salary1=yes
0=no
3ispaymenttypehourlywageNumerical0..1Form of payment: Hourly wages1=yes
0=no
3ispaymenttypepiecewageNumerical0..1Form of payment: Contract pay1=yes
0=no
3collectiveagreementNumerical0..1Collective agreementIncome register: codes
Attr.typeString1always cbacodecbacode
3stateemploymentfundNumerical0..1Employed with assistance from the State employment fund1=yes
0=no
3carbenefityearNumerical0..1Year of commissioning of the company car, max 4 characters2022
3isabroadcarbenefitNumerical0..1Company car benefit received in another country1=yes
0=no

Delete employment period

Resource: deletejobperiod.nv

The resource allows to delete an employee's single employment period. Employee's employment period's netvisorkeys can be retrieved with getemployee.nv.

ParameterOccursExampleDescription
netvisorkey1Mandatory, employment period's netvisorkey12

Get settlement points

Resurssi: getpayrollparties.nv

Retrieves the company's settlement points

Response:

LevelElement name
Type and lengthOccursDescriptionExample
RootrootAggr.1

1payrollpartiesAggr.1

2partyAggr.0..n

3netvisorkeyNumerical1Settlement point's netvisorkey8
3nameString1Settlement point's nameTyEL
3partyinternaltypeString1Settlement point's internal type

employeeworkpensioninsurance
employeeunemploymentinsurance employeeaccidentinsurance
employeegrouplifeinsurance
employeeunionmembershipfee
employeeforeclosure
employeeotherinsurance
employeeworkpensioninsurance
3useonlyinreportingNumerical1Settlement point is only used in reporting1


Attach employee to settlement point

Resource: attachemployeetosettlementpoint.nv

This resource allows to attach employees to settlements points.

ParameterOccursDescriptionExample
identifiertype1Use either netvisorkey, number or personalidentificationnumbernetvisorkey
identifier1Employee's identifier3

Response:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1

1attachemployeetosettlementpointAggr.1

2employeeinsurancetypeNumerical0..1Employee insurance type (Tyel, MYEL,YEL, Not insured)1 = TyEL
2 = MYEL
3 = YEL
4 = Not insured
2employeesettlementpointsAggr.1

3employeeworkpensioninsuranceAggr.

0..1Work pension insurance

4typeString1Settlement point handlingnohandling
automatichandling
under17yearsold
17to52yearsold
53to62yearsold
63to67yearsold
over68yearsold
4nameString0..1Settlement point name (name and/or netvisorkey must be given)TyEL
4netvisorkeyNumerical0..1Settlement point  netvisorkey (name and/or netvisorkey must be given)8
4reporttoincomeregisterNumerical0..1Settlement point which is reported to Income register (if employee is connected to multiple TyEL-insurance settlement points, then it must be specified which one is registered to Income register)1
3employeeunemploymentinsuranceAggr.0..nUnemployment insurance
4typeString1Settlement point handlingnohandling
automatichandling
under17yearsold
17to64yearsold
over65yearsold
partowner
4nameString0..1Settlement point name (name and/or netvisorkey must be given)Unemployment insurance
4netvisorkeyNumerical0..1Settlement point  netvisorkey (name and/or netvisorkey must be given)9
3employeeaccidentinsuranceAggr.0..nAccident insurance
4typeString1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0..1Settlement point name (name and/or netvisorkey must be given)Accident insurance
4netvisorkeyNumerical0..1>Settlement point  netvisorkey (name and/or netvisorkey must be given)10
4reporttoincomeregisterNumerical0..1Settlement point which is reported to Income register (if employee is connected to multiple settlement points, then it must be specified which one is registered to Income register)
3employeegrouplifeinsuranceAggr.0..nGroup life insurance
4typeString1

4nameString0..1

4netvisorkeyNumerical0..1Settlement point  netvisorkey (name and/or netvisorkey must be given)11
3employeeotherinsuranceAggr.0..nOther insurance
4typeString1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0..1Settlement point name (name and/or netvisorkey must be given)Other insurance
4netvisorkeyNumerical0..1Settlement point  netvisorkey (name and/or netvisorkey must be given)12
3employeeunionmembershipfeeAggr.0..nUnion membership fee

4typeString1Settlement point handlingnohandling or
attachedtosettlementpoint
4nameString0..1Settlement point name (name and/or netvisorkey must be given)Union membership fee
4netvisorkeyNumerical0..1Settlement point  netvisorkey (name and/or netvisorkey must be given)13
3employeeforeclosureAggr.0..nForeclosure
4typeString1Settlement point handlingnohandling or attachedtosettlementpoint
4nameString0..1Settlement point name (name and/or netvisorkey must be given)Foreclosure
4netvisorkeyNumerical0..1Settlement point  netvisorkey (name and/or netvisorkey must be given)14

xml
(412 Bytes)
xml
(948 Bytes)
xml
(325 Bytes)
xml
(415 Bytes)
xml
xml
(299 Bytes)
xml
(2.95 KB)
xml
(513 Bytes)
xml
(4.56 KB)

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.