Navigation: Schema: Employee > Tables

Employees: Visma.net Financials Employees

Get a range of employees - ScreenId=EP203000Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page sizeChange log:2021-October:Added forced pagination

Catalog: VismaNet

Schema: Employee

Label: Employees

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Employees. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
COMPANY_CODE	string	☐	Partition to retrieve data from.
erp-api-background	string	☐	If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.
greaterThanValue	string	☐	Greater-than value. The item which is the object for this, varies from API to API.
lastModifiedDateTime	string	☐	System-generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.
lastModifiedDateTimeCondition	string	☐	System-retrieved information for state/condition.
linkedToUser	boolean	☐	If the employee is linked to a user.
numberToRead	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
orderBy	string	☐	This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.
pageNumber	int32	☐	Pagination parameter. Page number.
pageSize	int32	☐	Pagination parameter. Number of items to be collected.Please use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page size.
skipRecords	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.

Columns of Table Function

The columns of the table function Employees are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
address_addressId	int32	Address ID	☐
address_addressLine1	string	Address Line 1	☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
address_addressLine2	string	Address Line 2	☐	Address 2 > The second line of the address.
address_addressLine3	string	Address Line 3	☐	Address 3 > The third line of the address.
address_city	string	City	☐	City > The city.
address_country_errorInfo	string		☐
address_country_id	string	Country ID	☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
address_country_metadata_maxPageSize	int64		☐
address_country_metadata_totalCount	int64		☐
address_country_name	string	Country Name	☐	Mandatory field: Country name* > The complete name of the country.
address_county_id	string	County ID	☐	Click the magnifier > The identifier
address_county_name	string	County Name	☐	Click the magnifier > The displayed name
address_postalCode	string	Postal Code	☐	Postcode > The postcode.
branch_name	string	Branch Name	☐	Click the magnifier. > The name.
branch_number	string	Branch Number	☐	Click the magnifier. > The identifier.
calendarID	string		☐
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
contact_attention	string		☐	Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person.
contact_contactId	int32	Contact ID	☐
contact_email	string	Contact Email	☐	Email > The email address of the customer/supplier/company as a business entity.
contact_employeeContact	string		☐	Employee contact > The link to the contact record associated with the employee.
contact_fax	string	Contact Fax	☐	Fax > The fax number.
contact_firstName	string	Contact First Name	☐	First name > The first name of the employee.
contact_lastName	string	Contact Last Name	☐	Mandatory field: Last name* > The last name of the employee.
contact_midName	string	Contact Middle Name	☐	Middle name > The middle name of the employee.
contact_name	string	Contact Name	☐	Name > The legal name of to appear on the documents.
contact_phone1	string	Contact Phone 1	☐	Phone 1 > The default phone number.
contact_phone2	string	Contact Phone 2	☐	Phone 2 > An additional phone number.
contact_phone3	string	Contact Phone 3	☐	Phone 3 > An additional phone number of the employee.
contact_title	string	Contact Title	☐	Title > The courtesy title to be used for the employee.
contact_web	string	Contact Website	☐	Web > The website of the company, if one exists.
department	string	Department	☐	Mandatory field: General information tab > Employee section > Department* > The department the employee works for.
employeeClass_description	string		☐	Click on the magnifier. > The description.
employeeClass_id	string		☐	Click on the magnifier. > The identifier.
employeeId	int32	Employee ID	☐	Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.
employeeLogin	string		☐
employeeName	string	Employee Name	☐	The top part > Employee name > The name of this employee.
employeeNumber	string	Employee Number	☐	General information tab > Employee settings section > Employee ref. no. > A reference number for the employee.
employeeUserId	guid		☐	Employee internal user ID. This is the ID of the user linked to the employee
errorInfo	string	Error Message	☐
lastModifiedDateTime	datetime	Last Modified	☐
metadata_maxPageSize	int64		☐
metadata_totalCount	int64	Total Count	☐
status	string	Status	☐	Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time.

22-12-2022 21:03 Version 22.1.101-BETA+3681

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

Employees: Visma.net Financials Employees

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information