Get employees
Resource: getemployees.nv
Returns a list of employees and their id's.
Querystring parameters:
| Parameter | Occurs | Example | Description |
| includeendedemployments | 0...1 | 1 | Include ended employments, 1 = yes, 0 = no |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | employees | Aggr. | 1 | ||
| 2 | employee | Aggr. | 1 | ||
| 3 | employeenumber | String | 1 | Employee number | 100 |
| 3 | netvisorkey | String | 1 | Employee's netvisor id | 10 |
| 3 | personalid | String | 1 | Employee's pin | 010277-xxxp |
| Attr. | type | String | 1 | Type of personalID | finnishidentifier |
| 3 | firstname | String | 1 | Employee's first name | Anna |
| 3 | lastname | String | 1 | Employee's last name | Ammattilainen |
| 3 | employmentstatus | String | 1 | Employment status | 1 |
| 3 | payrollservice | String | 1 | Payroll operations service. 1 = enabled or 0 = disabled | 1 |
| 3 | resourcemanagement | String | 1 | Travel expense resources 1 = enabled or 0 = disabled | 1 |
Get employee
Resource: getemployee.nv
Returns the information of a single employee.
Querystring parameters:
| Parameter | Occurs | Example | Description |
| netvisorkey | 0...1 | 1 | Employees Netvisorkey |
| employeenumber | 0...1 | 100 | |
| employmentperiods | 0...1 | 1 | Include employment periods 1 = yes 0 = no |
| employeepayrollinformation | 0...1 | 1 | Include payroll information 1 = yes 0 = no |
| educationalinformation | 0...1 | 1 | Include educational information 1 = yes 0 = no |
| additionalinformationfields | 0...1 | 1 | Include additional information fields 1 = yes 0 = no |
| employeesettlementpoints | 0...1 | 1 | Include settlement points 1 = yes 0 = no |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | employee | Aggr. | 1 | ||
| 2 | employeebaseinformation | Aggr. | 1...n | ||
| 3 | netvisorkey | Numeric | 1 | Employee's netvisorkey | 8 |
| 3 | employeenumber | Numeric | 1 | Employee's number | 123 |
| 3 | employeeidentifier | String | 1 | Employee identifier type: finnishidentifier, foreignidentifier, companyidentifier | foreignidentifiertype |
| Attr. | foreignidentifiertype | String | 1 | Foreign person's identifier type: taxidentificationnumber, foreignpersonalidentifier, other. Use only if person is foreign | taxidentificationnumber |
| 3 | issuingcountry | String, max 2 | 1 | Employee's home country | fi |
| Attr. | type | String | 1 | Always ISO-3166 | ISO-3166 |
| 3 | firstname | String, max 50 | 1 | Employee's first name | Anna |
| 3 | lastname | String, max 50 | 1 | Employee's last name | Ammattilainen |
| 3 | fullname | String | 1 | Employee's full name | Ammattilainen Anna |
| 3 | payrollservice | Numeric | 1 | Payroll service | 1 = yes 0 = no |
| 3 | resourcemanagement | Numeric | 1 | Travel expense service | 1 = yes 0 = no |
| 3 | nationality | String, maks. 2 | 1 | Employee's nationality | se |
| Attr. | type | String | 1 | Always ISO-3166 | ISO-3166 |
| 3 | language | String, maks. 2 | 1 | Employee's language, default is 'fi' | fi |
| Attr. | type | String | Language format | ISO-3166 | |
| 3 | municipality | String, maks. 255 | 1 | Employee's home city | Lappeenranta |
| 3 | gender | String | 1 | Gender: male, female | male |
| 3 | dateofbirth | Date | 1 | Date of birth | 1970-10-20 |
| 3 | streetaddress | String, maks. 255 | 1 | Employee's address | Keisarinnankatu 1 |
| 3 | postnumber | String, maks. 50 | 1 | Employee's post number | 56120 |
| 3 | city | String, maks. 255 | 1 | Employee's post office | Lappeenranta |
| 3 | country | String, maks. 2 | 1 | Employee's home country | fi |
| Attr. | type | String | 1 | Always ISO-3166 | ISO-3166 |
| 3 | phonenumber | String, maks. 50 | 1 | Employee's phone number | 050 123 456 |
| 3 | String, maks. 100 | 1 | Employee's e-mail address | anna.ammattilainen@yritys.fi | |
| 3 | bankaccountnumber | String, maks. 34 | 1 | Employee's bank account number, IBAN | FI71 7997 9580 0073 35 |
| 3 | bankidentificationcode | String, maks. 20 | 1 | BIC | NDEAFIHH |
| 3 | activity | Numeric | Employee's activity. Does not indicate whether empoyee has an active employment | 1 = yes 0 = no | |
| 2 | employmentperiods | Aggr. | 0...1 | Employment periods | |
| 3 | employmentperiod | Aggr. | 0...n | Employment period | |
| 4 | netvisorkey | Numeric | 1 | Employment period's netvisorkey | 3 |
| 4 | companystartdate | Date | 1 | Start date of continuous employment | 2017-01-01 |
| Attr. | format | String | 1 | Date format, always ansi | ansi |
| startdate | Date | 1 | Start date | 2017-01-01 | |
| Attr. | format | String | 1 | Date format, always ansi | ansi |
| 4 | probationenddate | Date | 1 | End date of probation | 2017-04-01 |
| Attr. | format | String | 1 | Date format, always ansi | ansi |
| 4 | employmentmode | Numeric | 1 | Mode of employment | 1 = employed 2 = leased employee 3 = self-employed person or similar 4 = trainee 5 = voluntary work |
| 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 | 1 | Comment | Knows what she is doing |
| 4 | enddate | Date | 1 | End date | 2017-12-31 |
| Attr. | format | String | 1 | Date format, always ansi | ansi |
| 4 | endreason | Numeric | 1 | End 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. | type | String | 1 | Linking type of endreason | Attribute type is always netvisor, which is Netvisor ID |
| 4 | occupationclassification | String | 1 | Occupation class | TK10-code of occupation class |
| Attr. | type | String | 1 | Linking type of occupation classification | always isco |
| 4 | employmentcontract | Numeric | 1 | Duration of employment | >1 = Permanent 2 = Temporary |
| Attr. | type | String | 1 | Linking type of employment contract | always netvisor |
| 4 | employmentform | Numeric | 1 | Form of employment | 1 = Full-time2 = Part-time |
| Attr. | type | String | 1 | Linking type of employment form | always netvisor |
| 4 | parttimepercent | Decimal | 1 | Part-time percent | Decimal number from 0 to 100 |
| 4 | regularworkinghours | Numeric | 1 | Regular working hours | Decimal number from 0 to 168 |
| 4 | groundsforemployment | Numeric | 1 | Grounds for employment | 0=Other grounds 1=Working or employment relationship |
| 4 | kevaprofessionalclasscode | Numeric | 1 | Keva professional class code, max 20 characters | Professional class codes |
| 4 | kevaemploymentregistration | Numeric | 1 | Keva employment registration, max 2 characters | Keva employment registration codes |
| Attr. | type | String | 1 | always keva | keva |
| Attr. | pensionprovidercode | Numeric | 1 | Pension provider code | Keva: Incomes register codes |
| 4 | ispaymenttypemonthlywage | Numeric | 1 | Form of payment: Monthly wages | 1=yes 0=no |
| 4 | ispaymenttypehourlywage | Numeric | 1 | Form of payment: Hourly wages | 1=yes 0=no |
| 4 | ispaymenttypepiecewage | Numeric | 1 | Form of payment: Contract pay | 1=yes 0=no |
| 4 | collectiveagreement | Numeric | 1 | Collective agreement | Income register: Codes |
| Attr. | pensionprovidercode | String | 1 | always cbacode | cbacode |
| 4 | stateemploymentfund | Numeric | 1 | Employed with assistance from the State employment fund | 1=yes 0=no |
| 4 | carbenefityear | Numeric | 1 | Year of commissioning of the company car, max 4 characters | 2012 |
| 4 | isabroadcarbenefit | Numeric | 1 | Company car benefit received in another country. | 1=yes 0=no |
| 4 | caremissionvalue | Numeric | 1 | Car emission value, an integer between 0-100 | 85 |
| 2 | employeepayrollinformation | Aggr. | 0...1 | Payroll information | |
| 3 | payrollrulegroup | Aggr. | 1 | Payroll group name | |
| 4 | netvisorkey | Numeric | 1 | Payroll groups netvisorkey | 2 |
| 4 | name | String | 1 | Employees payroll group | Monthly salary |
| 3 | taxnumber | Numeric | 1 | Tax number | 123456789101 |
| 3 | foreclosure | Numeric | 1 | Foreclosure | 1=yes 0=no |
| 3 | foreclosuremaintenancepersons | Numeric | 1 | Foreclosure maintenance persons | 3 |
| 3 | nosocialsecuritypayment | Numeric | 1 | Not subject to employer's sickness insurance payment | 1=yes 0=no |
| 3 | accountingaccount | Aggr. | 1 | Advance debt account | |
| 4 | netvisorkey | Numeric | 1 | Advance debt account's netvisorkey | |
| 4 | name | String | 1 | Advance debt account's name | Receivables from employees |
| 4 | number | Numeric | 1 | Advance debt account's number | 1751 |
| 3 | hierarchy | Aggr. | 1 | Hierarchy level | |
| 4 | netvisorkey | Numeric | 1 | Hierarchy level's netvisorkey | 4 |
| 4 | name | String | 1 | Hierarchy level's name | Oy Yritys Ab |
| 3 | placeofbusiness | String | 1 | Place of business for income register | Pääkonttori |
| 3 | defaultdimensions | Aggr. | 0...1 | Default dimensions | |
| 4 | defaultdimension | Aggr. | 0...n | Default dimension | |
| 5 | dimensionname | String | 1 | Dimension name. | Kustannuspaikat |
| 5 | dimensionitem | String | 1 | Dimension item name. | DevOps |
| 3 | payslipdeliverymethod | String | 1 | Payslip delivery method | 1 = local printing 2 = printing service 3 = e-salary |
| 3 | type | String | 1 | Attribute type is always netvisor, which is Netvisor ID | netvisor |
| 3 | isjointowner | Numeric | 1 | In a shareholder relationship with payer | 1=yes 0=no |
| 3 | isathlete | Numeric | 1 | Athlete | 1=yes 0=no |
| 3 | isperformingartist | Numeric | 1 | Performing atrist | 1=yes 0=no |
| 3 | employeeinsurancetype | Numeric | 1 | Työeläkevakuutuksen tyyppi | 1=Tyel 2=MYEL 3=YEL 4=No pension insurance |
| 3 | ispersonworkingonaroadferryonalandislands | Numeric | 1 | Person working on a road ferry on Åland Islands | 1=yes 0=no |
| 3 | isentrepreneurwithoptionalyelormyel | Numeric | 1 | Entrepreneur, no YEL or MYEL insurance obligation | 1=yes 0=no |
| 2 | employeeeducationalinformation | Aggr. | 0...1 | Degrees | |
| 3 | degree | Aggr. | 0...n | Degree | |
| 4 | name | String | 1 | Name of the degree | Merkonomi |
| 4 | school | Numeric | 1 | Name of the school | Kauppaoppilaitos |
| 4 | graduationyear | Numeric | 1 | Graduation year | 2021 |
| 4 | isprimarydegree | Numeric | 1 | Is this the primary degree | 1=yes 0=no |
| 2 | employeeadditionalinformationfields | Aggr. | 0...1 | Additional information fields | |
| 3 | additionalinformationfield | Aggr. | 0...n | Additional information field | |
| 4 | netvisorkey | Numeric | 1 | netvisorkey | 1 |
| 4 | name | String | 1 | Additional information field's name | Food allergies |
| 4 | value | String | 1 | Additional information field's value | fish |
| Attr. | type | String | 1 | text, datetime | text |
| 4 | group | String | 1 | 1=Basic information 2=Contact information 3=Educational information | 1 |
| Attr. | type | String | 1 | Attribute type is always netvisor, which is Netvisor ID | netvisor |
| 2 | employeesettlementpoints | Aggr. | 0...1 | Settlement points | |
| 3 | employeeunemploymentinsurance | Aggr. | 0...n | Unemployment insurance | |
| 4 | netvisorkey | Numeric | 1 | Settlement's netvisorkey | 1 |
| 4 | type | String | 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 | 1 | Insurance specific settlement point definition | Unemployment insurance |
| 3 | employeeaccidentinsurance | Aggr. | 0...n | Accident insurance | |
| 4 | netvisorkey | Numeric | 1 | Settlement point netvisorkey | 2 |
| 4 | type | String | 1 | Settlement point handling | attachedtosettlementpoint |
| 4 | name | String | 1 | Insurance specific settlement point definition | Accident insurance |
| 3 | employeegrouplifeinsurance | Aggr. | 0...n | Group life insurance | |
| 4 | netvisorkey | Numeric | 1 | Settlement point netvisorkey | 3 |
| 4 | type | String | 1 | Settlement point handling | attachedtosettlementpoint |
| 4 | name | String | 1 | Insurance specific settlement point definition | Group life insurance |
| 3 | employeeunionmembershipfee | Aggr. | 0...n | Union membership fee | |
| 4 | netvisorkey | Numeric | 1 | Settlement point netvisorkey | 4 |
| 4 | type | String | 1 | Settlement point handling | attachedtosettlementpoint |
| 4 | name | String | 1 | Insurance specific settlement point definition | Union membership fee |
| 3 | employeeotherinsurance | Aggr. | 0...n | Other insurance | |
| 4 | netvisorkey | Numeric | 1 | Settlement point netvisorkey | 5 |
| 4 | type | String | 1 | Settlement point handling | attachedtosettlementpoint |
| 4 | name | String | 1 | Insurance specific settlement point definition | Other insurance |
| 3 | employeeworkpensioninsurance | Aggr. | 0...n | Work pension insurance | |
| 4 | netvisorkey | Numeric | 1 | Settlement point netvisorkey | |
| 4 | type | String | 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 | 1 | Insurance specific settlement point definition | TyEL |
| 3 | employeeforeclosure | Aggr. | 0...n | Foreclosure | |
| 4 | netvisorkey | Numeric | 1 | netvisorkey | 6 |
| 4 | type | String | 1 | Settlement point handling | attachedtosettlementpoint |
| 4 | name | String | 1 | Insurance specific settlement point definition | Foreclosure |
Import an employee
Resource: employee.nv
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: taxidentificationnumber foreignpersonalidentifier other | foreignpersonalidentifier |
| 4 | issuingcountry | String | 1 | Country | AF |
| Attr. | type | String | 1 | Country type | ISO-3316 |
| 4 | gender | String | 1 | Gender, male female | 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), when company is added as an employee | 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 | carl.customer@company.fi | |
| 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 or customer - If identified by name, name has to be unique Read about company hierarchy |
| 3 | dimension | Aggr. | 0...n | Default dimensions | |
| 4 | dimensionname | String | 1 | Dimension header name. Created if needed | 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 2 = printing service 3 = e-salary |
| 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 0=no |
| 3 | isathlete | Numeric | 0...1 | Athlete | 1=yes 0=no |
| 3 | isperformingartist | Numeric | 0...1 | Performing atrist | 1=yes 0=no |
| 3 | employeeincurancetype | 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 employeeincurancetype=4 |
| 3 | nosocialsecuritypayment | Numeric | 0...1 | Not subject to employer's sickness insurance payment | 1=yes 0=no |
| 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 2 = leased employee 3 = self-employed person or similar 4 = trainee 5 = voluntary work |
| 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 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 | Linking type of endreason | 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 of occupation classification | always isco |
| 4 | employmentcontract | Numeric | 0...1 | Duration of employment | 1 = Permanent 2 = Temporary Note: For temporary contract must be given end date |
| Attr. | type | String | 1 | Linking type of employment contract | always netvisor |
| 4 | employmentform | Numeric | 0...1 | 1 = Full-time 2 = Part-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 Note: employmentform must be 2 so that the setting is taken into account. Rounding to the nearest two decimal places |
| 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 is company has selected "Company pension insurer is Keva" | Keva's professional class codes: Professional class codes |
| 4 | kevaemploymentregistration | Numeric | 0...1 | Keva employment registration code, max 2 characters. | Keva employment registration codes: 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 0=no |
| 4 | ispaymenttypehourlywage | Numeric | 0...1 | Form of payment: Hourly wages | 1=yes 0=no |
| 4 | ispaymenttypepiecewage | Numeric | 0...1 | Form of payment: Contract pay | 1=yes 0=no |
| 4 | collectiveagreement | Numeric | 0...1 | Collective agreement | Incomes registers 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 in another country. | 1=yes 0=no |
| 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 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 (* | |
| 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 (* | |
| 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 graduate |
| 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 0 = no |
| 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
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 name | Occurs | Description | Example |
| identifiertype | 1 | Employee identifier type: netvisorkey, number or personalidentificationnumber | netvisorkey |
| identifier | 1 | Employee's identifier | 1 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | Root | Aggr. | 1 | ||
| 1 | patchemployee | Aggr. | 1 | ||
| 2 | employeebaseinformation | Aggr. | 1 | ||
| 3 | companyname | String | 0..1 | Yrityksen nimi | Test Company Oy |
| 3 | firstname | String, max 50 | 0..1 | Employee's first name | Anna |
| 3 | lastname | String, max 50 | 0..1 | Employee's last name | Ammattilainen |
| 3 | phonenumber | String, max 50 | 0..1 | Employee's phone number | 0501234567 |
| 3 | String, max 100 | 0..1 | Employee's e-mail address | anna.ammattilainen@test-company.fi | |
| 2 | employeepayrollinformation | Aggregaatti | 0..1 | ||
| 3 | streetaddress | String, max 255 | 0..1 | Employee's street address | Keisarinnankatu 1 |
| 3 | postnumber | String, max 50 | 0..1 | Employee's post number | 56120 |
| 3 | city | String, max 255 | 0..1 | Employee's post office | Lappeenranta |
| 3 | municipality | String, max 255 | 0..1 | Employee's municipality | Lappeenranta |
| 3 | country | String, max 2 | 0..1 | Employee's 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 | Numerical | 0..1 | Employee's number | 12 |
| 3 | payrollrulegroupname | String, max 50 | 0..1 | Employee's payroll group name | Kuukausipalkka, perusmalli |
| 3 | bankaccountnumber | String, max 34 | 0..1 | Employee's bank account number, IBAN-account number. If given, BIC-code is also mandatory (bankidentificationcode). | FI7179979580007335 |
| 3 | bankidentificationcode | String, max 20 | 0..1 | Bank BIC-code | NDEAFIHH |
| 3 | accountingaccountnumber | Numerical | 0..1 | Employee's accounting account number | 1751 |
| 3 | hierarchy | String | 0..1 | Hierarchy level | Test Company Oy |
| Attr. | type | String | 0..1 | Hierarkian linkitystyyppi | netvisor - Netvisorin tunniste (netvisorkey) tai customer - Jos yksilöidään nimellä, täytyy olla uniikki. Lue yrityshierarkiasta |
| 3 | payslipdeliverymethod | String | 0..1 | Palkkalaskelman toimitustapa | 1 = paikallinen tulostus 2 = tulostuspalvelu 3 = verkkopalkka |
| Attr. | type | String | 0..1 | Toimitustavan linkitystyyppi | Attribuutti type on aina netvisor, eli Netvisorin tunniste (netvisorkey) |
| 3 | isjointowner | Numerical | 0..1 | Osakasasemassa maksajaan | 1=kyllä 0=ei |
| 3 | isathlete | Numerical | 0..1 | Urheilija | 1=kyllä 0=ei |
| 3 | isperformingartist | Numerical | 0..1 | Esiintyvä taiteilija | 1=kyllä 0=ei |
| 3 | employeeinsurancetype | Numerical | 0..1 | Työeläkevakuutuksen tyyppi | 1=Tyel 2=MYEL 3=YEL 4=Ei eläkevakuutettu |
| 3 | ispersonworkingonaroadferryonalandislands | Numerical | 0..1 | Ahvenanmaan maantielautalla työskentelevä henkilö | 1=kyllä 0=ei |
| 3 | isentrepreneurwithoptionalyelormyel | Numerical | 0..1 | Yrittäjä, ei YEL- tai MYEL-vakuuttamisvelvollisuutta | 1=kyllä 0=ei 1 voidaan antaa vain, mikäli employeeinsurancetype=4 |
| 3 | ispersonreceivingeppoinsurancesalary | Numerical | 0..1 | EPPO-lain mukaista vakuutuspalkkaa saaja henkilö | 1=kyllä 0=ei |
| 3 | nosocialsecuritypayment | Numerical | 0..1 | Ei työnantajan sairausvakuutusmaksun alainen | 1=kyllä 0=ei |
| 3 | receivessalaryfromdiplomaticembassy | Numerical | 0..1 | Diplomaattisen edustuston maksamaa palkkaa saava henkilö | 1=kyllä 0=ei |
| 3 | activity | Numerical | 0..1 | Aktiivisuus | 1=kyllä 0=ei |
| 3 | foreclosure | Numerical | 0..1 | Ulosotto | 1=kyllä 0=ei |
| 3 | foreclosuremaintenancepersons | Numerical | 0..1 | Ulosotossa elatuksen varassa olevat henkilöt | Annettava jos tieto ulosotta annetaan arvolla 1 |
| 3 | taxnumber | String | 0..1 | Employee's veronumero | 12345678912 |
| 3 | placeofbusiness | String | 0..1 | Toimipaikka tulorekisteriin (nimi) | Pääkonttori |
| 2 | employeesettings | Aggregaatti | 0..1 | Employee's asetukset | |
| 3 | payrollservice | String | 0..1 | Palkanlaskentapalvelu | enabled tai disabled |
| 3 | resourcemanagement | String | 0..1 | Resurssinhallinta | enabled 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):
| Parameter | Occurs | Description |
| identifiertype | 1 | Value: pin = employee personal identity code or number = employee number |
| identifier | 1 | Identifier defined by the type: employee personal identity code or employee number |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| root | root | Aggr. | 1 | ||
| 1 | employeesalaryparameters | Aggr. | 1 | ||
| 2 | parameters | Aggr. | 1 | ||
| 3 | parameter | Aggr. | 0...n | ||
| 4 | rationumber | Numeric | 1 | Number of the salary parameter | 123 |
| 4 | value | Decimal | 1 | Value of the salary parameter | 12,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.
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | employeesalaryparameters | Aggr. | 1 | ||
| 2 | employeeidentification | String | 1 | Identification of the employee | 123456-123A |
| Attr. | type | String | 1 | Type of the employee identificationi: pin or number | pin |
| 2 | salaryparameters | Aggr. | 1 | ||
| 3 | salaryparameter | Aggr. | 1...24 | ||
| 4 | rationumber | Numeric | 1 | Number of salary parameter's salary type (company-spesific salary types) | 123 |
| 4 | value | Decimal | 0...1 | Value of salary parameter | 12,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.
| Parameter | Occurs | Description | Example |
| source | 1...n | The 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:
| Level | Element | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | PayrollRatios | Aggr. | 1 | ||
| 2 | PayrollRatio | Aggr. | 0...n | ||
| 3 | Names | Aggr. | 0...n | ||
| 4 | Name | String | 1-3 | Name of salary type | Ulkomaan päiväraha |
| Attr. | ISO639-1Code | String | 1 | Language information of salary type's name: fi,se, en | fi |
| 3 | Identifier | Numeric | 1 | ID of salary type | 1 |
| 3 | Source | String | 1 | Type of salary type | Matkalasku, kulurivit |
| 3 | RatioNumber | Numeric | 1 | Number of salary type | 123 |
| 3 | DefaultDebitAccountNumber | Numeric | 1 | Debit account for bookkeeping | 7890 |
| 3 | DefaultCreditAccountNumber | Numeric | 1 | Credit account for bookkeeping | 2961 |
Import a payroll paycheck batch
Resource: payrollpaycheckbatch.nv
Import a payslip into Netvisor.
Request:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | payrollpaycheckbatch | Aggr. | 1 | ||
| 2 | employeeidentifier | String | 1 | Employee has to exist in Netvisor and the employee must be determined for correct wage model in Netvisor before transferring the data | 10 |
| Attr. | type | String | 1 | Type of identifier, either employeenumber or finnishpersonalidentifier | employeenumber |
| 2 | rulegroupperiodstart | Date | 1 | Pay 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. | format | String | 1 | Date format, always ansi | ansi |
| 2 | rulegroupperiodend | Date | 1 | Pay 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. | format | String | 1 | Date format, always ansi | ansi |
| 2 | freetextbeforelines | String | 0...1 | Free text before payroll lines | |
| 2 | freetextafterlines | String | 0...1 | Free text after payroll lines | |
| 2 | duedate | Date | 1 | Due date | 2022-02-17 |
| Attr. | format | String | 1 | Date format, always ansi | ansi |
| 2 | valuedate | Date | 1 | Value date | 2022-02-17 |
| Attr. | format | String | 1 | Date format, always ansi | ansi |
| 2 | payrollpaycheckbatchline | Aggr. | 1...n | ||
| 3 | payrollratioidentifier | String | 1 | Salary type as number, has to exist in Netvisor. Can be foud from Salaries > Salary model management > Company-specific salary types. | 1 |
| Attr. | type | String | 1 | Always rationumber | rationumber |
| 3 | units | Numeric | 1 | Number of units | 2 |
| 3 | unitamount | Numeric | 1 | price of a single unit | 39 |
| 3 | linesum | Numeric | 1 | Sum of the line, will not be calculated automatically, has to be given in XML. Recomended max 2 decimals. | 78,00 |
| 3 | linedescription | String | 0...1 | Description of the line | |
| 3 | earningperiodstartdate | Date | 0...1 | Start date of the earning period | 2022-01-01 |
| Attr. | type | String | 1 | Date format, always ansi | ansi |
| 3 | earningperiodenddate | Date | 0...1 | End date of the earning period | 2022-31-01 |
| Attr. | type | String | 1 | Date format, always ansi | ansi |
| 3 | dimension | Aggr. | 0...n | ||
| 4 | dimensionname | String | 1 | Title of the dimension. If not found, it will be created | |
| 4 | dimensionitem | String | 1 | Dimension name. If not found it will be created |
Import record line for pay period
Resource: payrollperiodcollector.nv
| Level | Element | Type and length | Occurs | Description | Example |
| Root | Root | Aggr. | 1 | ||
| 1 | payrollperiodcollector | Aggr. | 1 | ||
| 2 | date | Date | 1 | Date | |
| Attr. | format | String | 1 | Always ansi | |
| 2 | employeeidentifier | String | 1 | Employee number in Netvisor | |
| Attr. | type | String | 1 | number or personalidentificationnumber | |
| 2 | payrollratioline | Aggr. | 1...n | ||
| 3 | amount | Number | 1 | The amount of the record line | |
| 3 | payrollratio | Number | 1 | Number of record type in Netvisor | |
| Attr. | type | String | 0...1 | Always number | |
| 3 | dimension | Aggr. | 0...n | ||
| 4 | dimensionname | String | 1 | Title of dimension. If not found, it will be created | |
| 4 | dimensionitem | String | 1 | Name of the dimension. If not found, it will be created | |
| Attr. | fatherid | Numeric | 0...1 | Parent id of the dimension |
Import pay advance
Resource: payrolladvance.nv
Import payment for pay advance
| Level | Element | Type and lenghth | Occurs | Description | Example |
| Root | Root | Aggr. | 1 | ||
| 1 | payrolladvance | Aggr. | 1 | ||
| 2 | description | String | 0...1 | Open description of the event | |
| 2 | employeeidentifier | String | 1 | Employee number | |
| Attr. | type | String | 0...1 | number or finnishpersonalidentifier | |
| 2 | paymentdate | Date | 1 | Date of pay advance's payment. Can't be earlier than today | |
| Attr. | format | String | 0 | Always ansi (Notify that in the DTD there is a miskatake in this, if this attribute is given an error will occur) | |
| 2 | advancesum | Number | 1 | Amount of pay advance | |
| Attr. | paymentstatus | String | 0...1 | ispaid or notpaid | |
| 2 | paymenttype | String | 1 | payroll 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.
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | Root | Aggr. | 1 | ||
| 1 | payrollexternalsalarypayment | Aggr. | 1 | ||
| 2 | description | String | 1 | Description of the event. Informal definition | External payment |
| 2 | paymentdate | Date | 1 | Payment date = Payday, salary will be on employees account on this date | 2017-01-01 |
| Attr. | format | String | ansi | ansi | |
| 2 | duedate | Date | 1 | Due date, salary will be charged from company's account | 2017-01-01 |
| Attr. | format | String | ansi | ansi | |
| 2 | externalpaymentsum | Decimal | 1 | Amount of payment (0.01 < sum < 10000000.0) | 100,0 |
| 2 | iban | String | 1 | Employee's bank account number | FI21 1234 xxxx xxxx xx |
| 2 | bic | String | 1 | Bank's identification code | NDEAFIHH |
| 2 | hetu | String | 1 | Employee's Personal identity code: | 140785-xxyy |
| 2 | realname | String | 1 | Employee's name | Erkki 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
| Parameter | Occurs | Description | Example |
| startdate | 1 | Mandatory, start date | 2023-01-01 |
| enddate | 0..1 | Voluntary, end date. If not given, payslips are retrieved from start date only | 2023-01-31 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | PayrollPaycheckBatches | Aggr. | 1 | ||
| 2 | PayrollPaycheckBatch | Aggr. | 0..n | ||
| 3 | Netvisorkey | Numerical | 1 | Payslip's identifier | 1 |
| 3 | PaymentDate | Date | 1 | Payslip's payment date | 2023-01-31 |
| 3 | PayrollRuleGroupPeriod | Aggr. | 1 | Payroll period's information | |
| 4 | Netvisorkey | Numerical | 1 | Payroll period's netvisorkey | 3 |
| 4 | StartDate | Date | 1 | Payroll period's start date | 2023-01-01 |
| 4 | EndDate | Date | 1 | Payroll period's end date | 2023-01-31 |
| 3 | PayrollRuleGroup | Aggr. | 1 | Payroll Rulegroup's information | |
| 4 | Netvisorkey | Numerical | 1 | Payroll Rulegroup's netvisorkey | 15 |
| 4 | Name | Text | 1 | Payroll Rulegroup's name | Monthly salary |
| 3 | Employee | Aggr. | 1 | Employee's information | |
| 4 | Name | Text | 1 | Employee's name | Matti Meikäläinen |
| 4 | EmployeeNumber | Numerical | 1 | Employee's number | 111 / empty |
| 4 | Netvisorkey | Numerical | 1 | Employee's identifier | 12 |
| 3 | Status | Numerical | 1 | Paycheck's status | 1=Open, 2=Confirmed/Accepted, 3= Paid |
| 3 | StatusDescription | Text | 1 | Paycheck's status in text format | Paid |
Get payroll paycheckbatch
Resource: getpayrollpaycheckbatch.nv
Returns a single payslip's information. Payslip's netvisorkey's can be retrieved with getpayrollpaycheckbatchlist.nv.
| Parameter | Occurs | Description | Example |
| netvisorkey | 1 | Mandatory, payslip's netvisorkey | 23 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | payrollpaycheckbatch | Aggr. | 1 | ||
| 2 | paymentdate | Date | 1 | Payment date | 2023-03-31 |
| 2 | payrollrulegroupperiod | Aggr. | 1 | Payroll period | |
| 3 | netvisorkey | Numerical | 1 | Payroll period's identifier | 123 |
| 3 | startdate | Date | 1 | Payroll period's starting date | 2023-03-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 3 | enddate | Date | 1 | Payroll period's end date | 2023-03-31 |
| Attr. | format | String | 1 | Date format | ansi |
| 2 | payrollrulegroup | Aggr. | 1 | Payroll rulegroup | |
| 3 | netvisorkey | Numerical | 1 | Payroll rulegroup's identifier | 123 |
| 3 | name | String | 1 | Payroll group's name | Monthly salary |
| 2 | employee | Aggr. | 1 | Employee | |
| 3 | netvisorkey | Numerical | 1 | Employee's identifier | 123 |
| 3 | name | String | 1 | Employee's name | Malli Maisa |
| 3 | employeenumber | Numerical | 1 | Employee number | 123 / empty |
| 2 | status | Numerical | 1 | Paycheck's status | 1=Open 2=Confirmed/Accepted 3= Paid |
| 2 | voucher | Aggr. | 0..1 | Voucher | |
| 3 | netvisorkey | Numerical | 1 | Voucher's identifier | 123 |
| 3 | class | String | 1 | Voucher class | PA Palkka |
| 3 | number | Numerical | 1 | Voucher number | 123 |
| 3 | date | Date | 1 | Voucher date | 2023-03-31 |
| Attr. | format | String | 1 | Date format | ansi |
| 2 | allocationcurves | Aggr. | 0..1 | Paycheck allocation curve | |
| 3 | allocationcurve | Aggr. | 1..n | Allocation curve | |
| Attr. | percent | Numerical | 1 | Distribution percent | 61 |
| 4 | dimensions | Aggr. | 1 | Dimensions | |
| 5 | dimension | Aggr. | 1..n | Dimension | |
| 6 | dimensionname | String | 1 | Dimension name | Toimipiste |
| Attr. | netvisorkey | Numerical | 1 | Tunniste | 123 |
| 6 | dimensionitem | String | 1 | Dimension iten name | Lappeenranta |
| 2 | freetextbeforelines | String | 1 | Free text before lines | Remember to deliver your tax card! / empty |
| 2 | freetextafterlines | String | 1 | Free text after lines | Happy Easter! / tyhjä |
| 2 | holidayrecords | Aggr. | 1 | Holidays records | |
| 3 | availableholidays | Numerical | 1 | Number of available vacation days | 25 |
| 3 | newaccrualofholidays | Decimal | 1 | Number of newly accrued vacation days | 7,5 |
| 2 | payrollpaycheckbatchlines | Aggr. | 1 | Paycheck lines | |
| 3 | payrollpaycheckbatchline | Aggr. | 1..n | Paycheck line | |
| 4 | payrollratio | Aggr. | 1 | Payroll ratio | |
| 5 | netvisorkey | Numerical | 1 | Identifier | 123 |
| 5 | number | Numerical | 0..1 | Payroll ratio number | 123 |
| 5 | name | String | 1 | Payroll ratio name | Monthly salary |
| 5 | isvisible | Numerical | 1 | Payroll ratios visibility on paycheck | 1=yes, 0=no |
| 5 | costobjectsource | String | 1 | Payroll check's dimension's source | DimensionCurve PaycheckBatchLine EmployeeDimensions None SelectedDimensions |
| 4 | units | Numerical | 1 | Number of units | 2 / empty |
| 4 | unitamount | Numerical | 1 | Unit amount | 200 / tyhjä |
| 4 | linesum | Numerical | 1 | Line sum | 400 |
| 4 | earningsperiods | Aggr. | 1 | Earning periods | |
| 5 | earningperiods | Aggr. | 1...n | Earning period | |
| 6 | startdate | Date | 1 | Earning period's start date | 2023-03-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 6 | enddate | Date | 1 | Earning period's end date | 2023-03-31 |
| Attr. | format | String | 1 | Date format | ansi |
| 4 | incometype | Aggr. | 0...1 | Income type | |
| 5 | netvisorkey | Numerical | 1 | Identifier | 123 |
| 5 | name | String | 1 | Income type name | Time rate |
| 4 | accountingdata | Aggr. | 1 | Accounting | |
| 5 | debetaccountnetvisorkey | Numerical | 1 | Identifier | 123 / empty |
| 5 | debetaccountnumber | Numerical | 1 | Debet-account's number | 5000 / empty |
| 5 | debetaccountname | String | 1 | Debet-account's name | Employee salaries / empty |
| 5 | kreditaccountnetvisorkey | Numerical | 1 | Identifier | 123 / empty |
| 5 | kreditaccountnumber | Numerical | 1 | Credit-account's number | 2961 / empty |
| 5 | kreditaccountname | String | 1 | Credit-account's name | Salary expenses (accruals) / empty |
| 4 | dimensions | Aggr. | 0..1 | Dimensions | |
| 5 | dimension | Aggr. | 1..n | Dimension | |
| Attr. | percent | Numerical | 1 | Percent | 25 |
| 6 | dimensionname | String | 1 | Dimension name | Toimipiste |
| Attr. | netvisorkey | Numerical | 1 | Identifier | 123 |
| 6 | dimensionitem | String | 1 | Dimension item name | Lappeenranta |
| Attr. | netvisorkey | Numerical | 1 | Identifier | 123 |
| 4 | linedescription | String | 1 | Line description |
Add employment period
Resource: addjobperiod.nv
With this resource it is possible to add new job periods to an employee.
| Parameter | Occurs | Description | Example |
| employeeidentifier | 1 | Employee's netvisorkey | 12 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | employmentperiods | Aggr. | 1 | Employment periods | |
| 2 | employmentperiod | Aggr. | 1..n | Employmen period | |
| 3 | companystartdate | Date | 0..1 | Company start date | 2022-01-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 3 | startdate | Date | 1 | Start date | 2022-01-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 3 | probationenddate | Date | 0..1 | End date of probation | 2022-04-01 |
| Attr. | format | String | 1 | Date format | ansi |
| 3 | employmentmode | Numerical | 0..1 | Mode of employment | 1 = employed 2 = leased employee 3 = self-employed person or similar 4 = trainee 5 = voluntary work |
| Attr. | type | String | 1 | Linking type of employment | always netvisor |
| 3 | profession | String, max 250 | 1 | Professional title | Specialist |
| 3 | comment | String, max 500 | 0..1 | Comment | Knows what she's doing |
| 3 | enddate | Date | 0..1 | End date | 2022-12-31 |
| Attr. | format | String | 1 | Date format | ansi |
| 3 | endreason | Numerical | 0..1 | End 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 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. | type | String | 1 | Linking type | always netvisor |
| 3 | occupationclassification | String | 0..1 | Occupation class | Occupation class TK10-code |
| Attr. | type | String | 1 | Linking type | always isco |
| 3 | employmentcontract | Numerical | 0..1 | Duration of employment | 1 = Permanent 2 = Temporary Note: a temporary job period must be given an end date |
| Attr. | type | String | 1 | Linking type | always netvisor |
| 3 | employmentform | Numerical | 0..1 | Form of employment | 1 = Full-time 2 = Part-time |
| Attr. | type | String | 1 | Linking type | always netvisor |
| 3 | parttimepercent | Numerical | 0..1 | Part-time percent | Decimal number from 0 to 100 Note: employmentform must be 2, in order for this to be recognized Rounded to the nearest two decimals |
| 3 | regularworkinghours | Numerical | 0..1 | Regular working hours | Decimal number from 0 to 168 Rounded to the nearest two decimals |
| 3 | groundsforemployment | Numerical | 0..1 | Grounds for employment | 0=Other grounds 1=Working or employment relationship |
| 3 | kevaprofessionalclasscode | Numerical | 0..1 | Keva 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 |
| 3 | kevaemploymentregistration | Numerical | 0..1 | Keva employment registration, max length 2 | Keva: Income register's codes |
| Attr. | type | String | 1 | Always keva | keva |
| Attr. | pensionprovidercode | Numerical | 0..1 | Pension provider code. If not given, default value "20" will be used Defines what values are accepted in the element kevaemploymentregistration | Keva: Incomes register codes |
| 3 | ispaymenttypemonthlywage | Numerical | 0..1 | Form of payment: Monthly salary | 1=yes 0=no |
| 3 | ispaymenttypehourlywage | Numerical | 0..1 | Form of payment: Hourly wages | 1=yes 0=no |
| 3 | ispaymenttypepiecewage | Numerical | 0..1 | Form of payment: Contract pay | 1=yes 0=no |
| 3 | collectiveagreement | Numerical | 0..1 | Collective agreement | Income register: Codes |
| Attr. | type | String | 1 | always cbacode | cbacode |
| 3 | stateemploymentfund | Numerical | 0..1 | Employed with assistance from the State employment fund | 1=yes 0=no |
| 3 | carbenefityear | Numerical | 0..1 | Year of commissioning of the company car, max 4 characters | 2022 |
| 3 | isabroadcarbenefit | Numerical | 0..1 | Company car benefit received in another country | 1=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.
| Parameter | Occurs | Description | Example |
| netvisorkey | 1 | Employment period's netvisorkey | 2 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | employmentperiods | Aggr. | 1 | Employment periods | |
| 2 | employmentperiod | Aggr. | 1 | Employment period | |
| 3 | companystartdate | Date | 0..1 | Company start date | 2022-01-01 |
| Attr. | format | String | 1 | Date format | |
| 3 | startdate | Date | 0..1 | Start date | 2022-01-01 |
| Attr. | format | String | 1 | Date format | |
| 3 | probationenddate | Date | 0..1 | End date of probation | 2022-04-01 |
| Attr. | format | String | 1 | Date format | |
| 3 | employmentmode | Numerical | 0..1 | Mode of employment | 1 = employed 2 = leased employee 3 = self-employed person or similar 4 = trainee 5 = voluntary work |
| Attr. | type | String | 1 | Linking type of employment | always netvisor |
| 3 | profession | String, max 250 | 0..1 | Professional title | Specialist |
| 3 | comment | String, max 500 | 0..1 | Comment | Knows what she's doing |
| 3 | enddate | Date | 0..1 | End date | 2022-12-31 |
| Attr. | format | String | 1 | Date format | ansi |
| 3 | endreason | Numerical | 0..1 | End 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 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. | type | String | 1 | Linking type | always netvisor |
| 3 | occupationclassification | String | 0..1 | Occupation class | Occupation class TK10-code |
| Attr. | type | String | 1 | Linking type | always isco |
| 3 | employmentcontract | Numerical | 0..1 | Duration of employment | 1 = Permanent 2 = Temporary Note: a temporary job period must be given an end date |
| Attr. | type | String | 1 | Linking type | always netvisor |
| 3 | employmentform | Numerical | 0..1 | Form of employment | 1 = Full-time 2 = Part-time |
| Attr. | type | String | 1 | Linking type | always netvisor |
| 3 | parttimepercent | Numerical | 0..1 | Part-time percent | Decimal number from 0 to 100 Note: employmentform must be 2, in order for this to be recognized Rounded to the nearest two decimals |
| 3 | regularworkinghours | Numerical | 0..1 | Regular working hours | Decimal number from 0 to 168 Rounded to the nearest two decimals |
| 3 | groundsforemployment | Numerical | 0..1 | Grounds for employment | 0=Other grounds 1=Working or employment relationship |
| 3 | kevaprofessionalclasscode | Numerical | 0..1 | Keva 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 |
| 3 | kevaemploymentregistration | Numerical | 0..1 | Keva employment registration, max length 2 | Keva: Income register's codes |
| Attr. | type | String | 1 | Always keva | keva |
| Attr. | pensionprovidercode | Numerical | 0..1 | Pension 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 |
| 3 | ispaymenttypemonthlywage | Numerical | 0..1 | Form of payment: Monthly salary | 1=yes 0=no |
| 3 | ispaymenttypehourlywage | Numerical | 0..1 | Form of payment: Hourly wages | 1=yes 0=no |
| 3 | ispaymenttypepiecewage | Numerical | 0..1 | Form of payment: Contract pay | 1=yes 0=no |
| 3 | collectiveagreement | Numerical | 0..1 | Collective agreement | Income register: codes |
| Attr. | type | String | 1 | always cbacode | cbacode |
| 3 | stateemploymentfund | Numerical | 0..1 | Employed with assistance from the State employment fund | 1=yes 0=no |
| 3 | carbenefityear | Numerical | 0..1 | Year of commissioning of the company car, max 4 characters | 2022 |
| 3 | isabroadcarbenefit | Numerical | 0..1 | Company car benefit received in another country | 1=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.
| Parameter | Occurs | Example | Description |
| netvisorkey | 1 | Mandatory, employment period's netvisorkey | 12 |
Get settlement points
Resurssi: getpayrollparties.nv
Retrieves the company's settlement points
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | payrollparties | Aggr. | 1 | ||
| 2 | party | Aggr. | 0..n | ||
| 3 | netvisorkey | Numerical | 1 | Settlement point's netvisorkey | 8 |
| 3 | name | String | 1 | Settlement point's name | TyEL |
| 3 | partyinternaltype | String | 1 | Settlement point's internal type employeeworkpensioninsurance employeeunemploymentinsurance employeeaccidentinsurance employeegrouplifeinsurance employeeunionmembershipfee employeeforeclosure employeeotherinsurance | employeeworkpensioninsurance |
| 3 | useonlyinreporting | Numerical | 1 | Settlement point is only used in reporting | 1 |
Attach employee to settlement point
Resource: attachemployeetosettlementpoint.nv
This resource allows to attach employees to settlements points.
| Parameter | Occurs | Description | Example |
| identifiertype | 1 | Use either netvisorkey, number or personalidentificationnumber | netvisorkey |
| identifier | 1 | Employee's identifier | 3 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | attachemployeetosettlementpoint | Aggr. | 1 | ||
| 2 | employeeinsurancetype | Numerical | 0..1 | Employee insurance type (Tyel, MYEL,YEL, Not insured) | 1 = TyEL 2 = MYEL 3 = YEL 4 = Not insured |
| 2 | employeesettlementpoints | Aggr. | 1 | ||
| 3 | employeeworkpensioninsurance | Aggr. | 0..1 | Work pension insurance | |
| 4 | type | String | 1 | Settlement point handling | nohandling automatichandling under17yearsold 17to52yearsold 53to62yearsold 63to67yearsold over68yearsold |
| 4 | name | String | 0..1 | Settlement point name (name and/or netvisorkey must be given) | TyEL |
| 4 | netvisorkey | Numerical | 0..1 | Settlement point netvisorkey (name and/or netvisorkey must be given) | 8 |
| 4 | reporttoincomeregister | Numerical | 0..1 | Settlement 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 |
| 3 | employeeunemploymentinsurance | Aggr. | 0..n | Unemployment insurance | |
| 4 | type | String | 1 | Settlement point handling | nohandling automatichandling under17yearsold 17to64yearsold over65yearsold partowner |
| 4 | name | String | 0..1 | Settlement point name (name and/or netvisorkey must be given) | Unemployment insurance |
| 4 | netvisorkey | Numerical | 0..1 | Settlement point netvisorkey (name and/or netvisorkey must be given) | 9 |
| 3 | employeeaccidentinsurance | Aggr. | 0..n | Accident insurance | |
| 4 | type | String | 1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0..1 | Settlement point name (name and/or netvisorkey must be given) | Accident insurance |
| 4 | netvisorkey | Numerical | 0..1 | >Settlement point netvisorkey (name and/or netvisorkey must be given) | 10 |
| 4 | reporttoincomeregister | Numerical | 0..1 | Settlement 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) | |
| 3 | employeegrouplifeinsurance | Aggr. | 0..n | Group life insurance | |
| 4 | type | String | 1 | ||
| 4 | name | String | 0..1 | ||
| 4 | netvisorkey | Numerical | 0..1 | Settlement point netvisorkey (name and/or netvisorkey must be given) | 11 |
| 3 | employeeotherinsurance | Aggr. | 0..n | Other insurance | |
| 4 | type | String | 1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0..1 | Settlement point name (name and/or netvisorkey must be given) | Other insurance |
| 4 | netvisorkey | Numerical | 0..1 | Settlement point netvisorkey (name and/or netvisorkey must be given) | 12 |
| 3 | employeeunionmembershipfee | Aggr. | 0..n | Union membership fee | |
| 4 | type | String | 1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0..1 | Settlement point name (name and/or netvisorkey must be given) | Union membership fee |
| 4 | netvisorkey | Numerical | 0..1 | Settlement point netvisorkey (name and/or netvisorkey must be given) | 13 |
| 3 | employeeforeclosure | Aggr. | 0..n | Foreclosure | |
| 4 | type | String | 1 | Settlement point handling | nohandling or attachedtosettlementpoint |
| 4 | name | String | 0..1 | Settlement point name (name and/or netvisorkey must be given) | Foreclosure |
| 4 | netvisorkey | Numerical | 0..1 | Settlement point netvisorkey (name and/or netvisorkey must be given) | 14 |
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.