Integration | HTTP-method | Resource | DTD | Example |
Import travel expense | POST | tripexpense.nv | tripexpense.dtd | Download |
Import working hours | POST | workday.nv | workday.dtd | Download |
Get working hours | GET | getworkday.nv | Download | |
Get working hours from time period | GET | getworkdays.nv | Download | |
Get record type list | GET | getrecordtypelist.nv | ||
Delete workdayhour | GET | deleteworkdayhour.nv |
Import travel expense
Resource: tripexpense.nv
Request:
Level | Element name | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | tripexpense | Aggr | 1 | ||
2 | header | String | 1 | Header of the invoice | Trip expense |
2 | description | String | 0...1 | Free description for invoice | |
2 | customlines | Aggr. | 0...1 | ||
3 | customline | Aggr. | 1...n | ||
4 | employeeidentifier | String | 1 | Identifier of the employee, either number, finnish personal identifier or netvisorkey | 140785-xxxx |
Attr. | type | String | 0...1 | Type of identifier number or finnishpersonalidentifier | finnishpersonalidentifier |
4 | ratio | String | 1 | Type of Expense HTTP-header X-Netvisor-Interface-Language=FI affects to the name of ratio | Majoituskulut |
Attr. | type | String | 1 | Type of identifier name | name |
4 | amount | Numeric | 1 | Amount of expense | 1,00 |
4 | customlineunitprice | Numeric | 1 | Unit price of the expense | 150,00 |
Attr. | iso4217currencycode | String | 0...1 | Currency used | EUR |
Attr. | currencyrate | Numeric | 0...1 | Currency exchange rate | |
4 | vatpercentage | Numeric | 0...1 | VAT percentage | 24 |
4 | linedescription | String | 1 | Description of the line | Hotel bill |
4 | begindate | Date | 1 | Begin date | 2018-10-05 |
4 | enddate | Date | 1 | End date | 2018-10-05 |
4 | crmprocessidentifier | String | 0...1 | Identifier of a related CRM process | |
4 | customeridentifier | String | 0...1 | Netvisor ID or customer code | NV#123456 |
Attr. | type | String | 0...1 | Type of identifier, netvisor or customer | customer |
4 | expenseaccountnumber | Numeric | 0...1 | Expense account number | 1701 |
4 | linestatus | String | 0...1 | Travel line status. Different statuses are open (unfinished), confirmed (acknowledged), contentsupervisiored (travel expense rows with factual verification performed), accepted (approved) and paid. | Paid |
4 | dimension | Aggr. | 0...n | ||
5 | dimensionname | String | 1 | Dimension header. If the header can't be found in system, Netvisor will create it | Project |
5 | dimensionitem | String | 1 | Dimension item. If the item can't be found in system, Netvisor will create it | Payroll |
Attr. | fatherid | Numeric | 0...1 | ||
4 | tripexpenseattachments | Aggr. | 0...1 | ||
5 | tripexpenseattachment | Aggr. | 1...n | ||
6 | mimetype | String | 1 | MIME-Type of the attachment | Application/Pdf |
6 | attachmentdescription | String | 1 | Description | Description |
6 | filename | String | 1 | File name | Description.pdf |
6 | documentdata | String | 1 | Attachment data as Base64 encoded string | BwgHBgoICAgLCgoLDhg... |
2 | travellines | Aggr. | 0...1 | ||
3 | travelline | Aggr. | 1...n | ||
4 | employeeidentifier | String | 1 | Identifier of the employee, either number or personal identification number | 140785-xxyy |
Attr. | type | String | 0...1 | type of identifier used, number or finnishpersonalidentifier | finnishpersonalidentifier |
4 | traveltype | String | 1 | Type of travel, allowed values: car, car_with_trailer, car_with_caravan, car_with_heavy_cargo, car_with_big_machinery, car_with_dog, car_travel_in_rough_terrain, motorboat_max_50hp, motorboat_over_50hp, snowmobile, atv, motorbike, moped, other, carbenefit | car |
4 | passengeramount | Numeric | 1 | Amount of passenger | 1 |
4 | kilometeramount | Numeric | 1 | Kilometers travelled | 252,00 |
4 | unitprice | Numeric | 0...1 | Price of a single unit, if not given will be retrieved from Netvisor based on mileage type | 5,50 |
4 | linedescription | String | 1 | Description of the line | |
4 | traveldate | Date | 1 | Date of travel | 2014-10-03 |
4 | routedescription | String | 1 | Description of the route | |
4 | crmprocessidentifier | String | 0...1 | Identifier of related CRM process | |
4 | customeridentifier | String | 0...1 | Identifier of customer, either id or number | |
Attr. | type | String | 0...1 | Type of identifier, netvisor or customer | |
4 | linestatus | String | 0...1 | Travel line status. Different statuses are open (unfinished), confirmed (acknowledged), contentsupervisiored (travel expense rows with factual verification performed), accepted (approved) and paid. | Paid |
4 | dimension | Aggr. | 0...n | ||
5 | dimensionname | String | 1 | Dimension header. If the header can't be found in system, Netvisor will create it | Project |
5 | dimensionitem | String | 1 | Dimension item. If the item can't be found in system, Netvisor will create it | Payroll |
Attr. | fatherid | Numeric | 0...1 | ||
4 | tripexpenseattachments | Aggr. | 0...1 | ||
5 | tripexpenseattachment | Aggr. | 1...n | ||
6 | mimetype | String | 1 | MIME type of the attachment | Application/pdf |
6 | attachmentdescription | String | 1 | Description | |
6 | filename | String | 1 | File name | |
6 | documentdata | String | 1 | Attachment as base64-encoded string | |
2 | dailycompensationlines | Aggr. | 0...1 | ||
3 | dailycompensationline | Aggr. | 1...n | ||
4 | employeeidentifier | String | 1 | Identifier of the employee, either number or personal identifier | 140785-xxxx |
Attr. | type | String | 0...1 | type of identifier, number tai finnishpersonalidentifier | finnishpersonalidentifier |
4 | compensationtype | String | 1 | Type of compensation, DomesticFull, DomesticHalf tai Foreign | domesticfull |
4 | amount | Numeric | 1 | Amount of compensation | 1 |
4 | unitprice | Numeric | 0...1 | Price of compensation, if not given, will be retrieved from Netvisor based on compensations's type | 500,00 |
4 | linedescription | String | 1 | Day in Helsinki | |
4 | timeofdeparture | Date and time | 1 | Date of departure, must include time | 2012-04-04 08:00:00.000 |
4 | returntime | Date and time | 1 | Date of departure, must include time | 2012-04-04 16:00:00.000 |
4 | crmprocessidentifier | String | 0...1 | NV#123456 | |
4 | customeridentifier | String | 0...1 | Identifier of customer, either id or number | |
Attr. | type | String | 0...1 | Type if identifeir used, either netvisor tai customer | netvisor |
4 | linestatus | String | 0...1 | Travel line status. Different statuses are open (unfinished), confirmed (acknowledged), contentsupervisiored (travel expense rows with factual verification performed), accepted (approved) and paid. | Paid |
4 | dimension | Aggr. | 0...n | ||
5 | dimensionname | String | 1 | Dimension header. If the header can't be found in system, Netvisor will create it | Project |
5 | dimensionitem | String | 1 | Dimension item. If thitem can't be found in system, Netvisor will create it | Payroll |
Attr. | fatherid | Numeric | 0...1 | ||
4 | tripexpenseattachments | Aggr. | 0...1 | ||
5 | tripexpenseattachment | Aggr. | 1...n | ||
6 | mimetype | String | 1 | MIME type of the attachment | |
6 | attachmentdescription | String | 1 | Description | |
6 | filename | String | 1 | File name | |
6 | documentdata | String | 1 | Attachment as base64-encoded string |
|
Import work time
Resource: workday.nv
Import work hours for day.
Request:
Level | Element name | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | workday | Aggr. | 1 | ||
2 | date | Date | 1 | Day which for work time entries are | 2013-10-30 |
Attr. | format | String | 1 | Always ansi | ansi |
Attr. | method | String | 0...1 | replace or increment. Default is replace. | replace |
2 | employeeidentifier | String | 1 | Data that is used to link entry to employee, social security number or employee number in Netvisor | 1407 |
Attr. | type | String | 0...1 | Type of EmployeeIdentifier; personalidentificationnumber, number or netvisorkey | number |
Attr. | defaultdimensionhandlingtype | String | 0...1 | none or usedefault | usedefault |
2 | workdayhour | Aggr. | 0...n | ||
3 | hours | Numeric | 1 | Amount of hours *), Netvisor will round to two decimals | 7,5 |
3 | collectorratio | String | 1 | Record type, must exist in Netvisor | 11 |
Attr. | type | String | 0...1 | Linking type of record type, always number | number |
3 | acceptancestatus | String | 1 | Status of the work time entry, confirmed or accepted | accepted |
3 | description | String | 1 | Description of the work record | Normal work |
3 | crmprocessidentifier | String | 0...1 | CRM process' linking information | |
Attr. | billingtype | String | 1 | unbillable or billable | billable |
3 | invoicingproductidentifier | String | 0...1 | Invoicing product | |
3 | customeridentifier | String | 0...1 | Invoicing customer | Test customer |
Attr. | type | String | 1 | netvisor or customer | netvisor |
3 | dimension | Aggr. | 0...n | ||
4 | dimensionname | String | 1 | Title of the dimension | Project |
4 | dimensionitem | String | 1 | Name of the dimension. If dimension does not exists, Netvisor creates new one | Payroll |
Attr. | fatherid | Numeric | 0...1 | Id of the dimension's parent | 33 |
2 | workdaytime | Aggr. | 0...n | ||
3 | starttimeofday | Numeric | 1 | Start time of working time recording | 8:00 |
3 | endtimeofday | Numeric | 1 | End time of working time recording | 16:00 |
3 | breaktime | Numeric | 1 | Break time in minutes | 30 |
Attr. | type | String | always minutes | minute | |
3 | collectorratio | String | 1 | Record type, must exist in Netvisor | 11 |
Attr. | type | String | 0...1 | Linking type of record type, always number | number |
3 | acceptancestatus | String | 1 | Status of the work time entry, confirmed or accepted | accepted |
3 | description | String | 1 | Description of the work record | Normal work |
3 | invoicingproductidentifier | String | 0...1 | Invoicing product | |
3 | dimension | Aggr. | 0...n | ||
4 | dimensionname | String | 1 | Title of the dimension | project |
4 | dimensionitem | String | 1 | Name of the dimension. If dimension does not exists, Netvisor creates new one | Payroll |
*) You can also import working time entries with record types that have days as units, such as annual leaves. In these cases you have to save the number of days for element "hours" (for example 1, when one day is saved as working time entry). To be able to use Netvisor's holiday calculation, annual leaves should always be imported with value 1.
Get working hours
Resource: getworkday.nv
Returns single employee's working hours for one day.
Parameter | Occurs | Description | Example |
netvisorkey | Employee's netvisorkey Note! Use either parameter netvisorkey or employeenumber, not both | 123 | |
employeenumber | 1 | Employee number in Netvisor Note! Use either parameter netvisorkey or employeenumber, not both | 1407 |
workhourdate | 1 | Date | 2018-06-20 |
Response:
Level | Element | Type and length | Occurs | Description | Example |
root | Root | Aggr. | 1 | ||
1 | Workday | Aggr. | 1 | ||
2 | Date | Date | 1 | Date | 2018-06-20 |
2 | WorkdayHour | Aggr. | 0...n | ||
3 | Hours | Decimal | 1 | Number of working hours | 7,5 |
3 | CollectorRatio | String | 1 | Record type | Normal working hours |
Attr. | Number | Numeric | 1 | Number of record type | 1 |
3 | AcceptanceStatus | String | 1 | Status of the work time entry, confirmed or accepted | accepted |
3 | Description | String | 1 | Description | Accepted hours |
3 | CrmProcessName | String | 1 | CRM process' linking information | |
3 | Dimension | Aggr. | 0...n | ||
4 | DimensionName | String | 1 | Title of dimension | Project |
4 | Dimensionitem | String | 1 | Name of dimension | Project 1 |
Get working hours from time period
Resource: getworkdays.nv
Returns single employee's working hours from selected time period. The maximum length of the time period is one calendar year.
Parameter | Occurs | Description | Example |
netvisorkey | 0...1 | Employee's netvisorkey Note! Use either parameter netvisorkey or employeenumber, not both | 1 |
employeenumber | 0...1 | Employee number in Netvisor Note! Use either parameter netvisorkey or employeenumber, not both | 1407 |
workhourstartdate | 1 | Start date of the time period | 2022-01-01 |
workhourenddate | 1 | End date of the time period | 2022-12-31 |
Response:
Level | Element | Type and length | Occurs | Description | Example |
root | Root | Aggr. | 1 | ||
1 | Workdays | Aggr. | 1 | ||
2 | Workday | Aggr. | 0...n | ||
3 | Date | Date | 1 | Date | 2022-01-01 |
3 | WorkDayHour | Aggr. | 0...n | ||
Attr | Netvisorkey | String | 1 | Worktime recording's Netvisorkey | |
4 | Hours | Decimal | 1 | Number of hours | 7,5 |
4 | CollectorRatio | Text | 1 | Record type | Normal working hours |
Attr. | Number | Numeric | 1 | Number of record type | 1 |
Attr. | Netvisorkey | String | 1 | Record type netvisorkey | |
4 | AcceptanceStatus | Text | 1 | Status of the work time entry, confirmed or accepted | Accepted |
4 | Description | Text | 1 | Description | |
4 | CrmProcessName | Text | 1 | CRM process' linking information | |
4 | Dimension | Aggr. | 0...n | ||
5 | DimensionName | Text | 1 | Title of the dimension | Project |
5 | DimensionItem | Text | 1 | Name of dimension | Project 1 |
Get record type list
Resource: getrecordtypelist.nv
Retrieves company's record type information
Response:
Level | Element name | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | RecordTypes | Aggr. | 1 | ||
2 | RecordType | Aggr. | 0...n | ||
3 | Names | Aggr. | 1 | ||
4 | Name | Text | 3 | Name of the record type | 01. Normal working hours |
Attr. | ISO-319-1 Code | Text | Record type's name's language: fi, se, en | fi | |
3 | Netvisorkey | Numerical | 1 | Record Type's netvisorkey | 1 |
3 | Rationumber | Numerical | 1 | Record type's number, which is used in workday.nv to direct to record type's | 10 |
3 | Charactertype | Numerical | 1 | Record type's character | 1=working hours, 2=holiday, 5=other absence |
3 | UnitType | Numerical | 1 | Record Type's unit | 1=hour, 2=day |
Delete workdayhour
Resource: deleteworkdayhour.nv
This resource allows to delete a working hour line, if it has not been paid or linked to a paycheck. Working hour line's netvisorkey can be retrieved with getworkdays.nv.
Parameter | Occurs | Description | Example |
netvisorkey | 1 | Working hours netvisorkey | 12 |
Did you find it helpful? Yes No
Send feedback