itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of earningtypes - ScreenId=EP102000
Catalog: VismaNet
Schema: EarningType
Label: Earning Types
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.
Select Visma.net Financials API URL: /controller/api/v1/earningtype
Insert Visma.net Financials API URL: /controller/api/v1/earningtype
Update Visma.net Financials API URL: /controller/api/v1/earningtype
Delete Visma.net Financials API URL: /controller/api/v1/earningtype
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/earningtype
Table Function Parameters
The following parameters can be used to control the behaviour of the table function EarningTypes. 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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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 |
Default Value |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
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. |
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. |
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. |
Table Function Columns
The columns of the table function EarningTypes are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
code |
string |
Code |
☐ |
Mandatory field: Code* > The unique ID of the type of hour. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
description |
string |
Description |
☐ |
Mandatory field: Description > The brief description of the type of hour. |
isActive |
boolean |
Is Active |
☐ |
Active > A check box that indicates (if selected) that the type of hour is active and can be used. |
isBillable |
boolean |
Is Billable |
☐ |
Invoicable > A check box that indicates (if selected) that the type is treated as invoiceable by default. |
isOvertime |
boolean |
Is Overtime |
☐ |
Overtime > A check box that indicates (if selected) that the type of hour is treated as overtime. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
overtimeMultiplier |
double |
Overtime Multiplier |
☐ |
Multiplier > The value by which the employee cost for this type of hour is multiplied when the time activity is released. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
