itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of Projects - ScreenId=PM301000Request 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 size
Catalog: VismaNet
Schema: ProjectBasic
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/projectbasic
Insert Visma.net Financials API URL: /controller/api/v1/projectbasic
Update Visma.net Financials API URL: /controller/api/v1/projectbasic
Delete Visma.net Financials API URL: /controller/api/v1/projectbasic
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/projectbasic
Table Function Parameters
The following parameters can be used to control the behaviour of the table function ProjectBasic. 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. |
createdDateTime |
string |
☐ |
|
Creation date and time. |
createdDateTimeCondition |
string |
☐ |
|
System-retrieved information for state/condition |
description |
string |
☐ |
|
Project name/description |
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. |
nonProject |
boolean |
☐ |
|
Set to true to return the non-project. |
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. |
pageNumber |
int32 |
☐ |
|
Pagination parameter. Page number. |
pageSize |
int32 |
☐ |
|
Pagination parameter. Number of items to be collected. |
projectId |
string |
☐ |
|
Identifies the Project |
projectIdDesc |
string |
☐ |
|
Identifies the Project by ID and description |
publicId |
string |
☐ |
|
Identifies the Project by its publicId |
restrictedEmployee |
string |
☐ |
|
Id of the employee where access restrictions apply |
restrictedUser |
int64 |
☐ |
|
Id of the odp user where access restrictions apply |
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. |
startDate |
datetime |
☐ |
|
Project's start date |
status |
string |
☐ |
|
Select project status. (Values: Planned, Active, Completed, Cancelled, OnHold, PendingApproval) |
visibleInAp |
boolean |
☐ |
|
If the project is visible in the Supplier ledger |
visibleInAr |
boolean |
☐ |
|
If the project is visible in the Customer ledger |
visibleInCa |
boolean |
☐ |
|
If the project is visible in the Cash management workspace |
visibleInCr |
boolean |
☐ |
|
If the project is visible in the CRM workspace |
visibleInEa |
boolean |
☐ |
|
If the project is visible in the Expense workspace |
visibleInGl |
boolean |
☐ |
|
If the project is visible in the General ledger workspace |
visibleInIn |
boolean |
☐ |
|
If the project is visible in the Inventory workspace |
visibleInPo |
boolean |
☐ |
|
If the project is visible in the Purchases workspace |
visibleInSo |
boolean |
☐ |
|
If the project is visible in the Sales workspace |
visibleInTa |
boolean |
☐ |
|
If the project is visible in the Time entities workspace |
Table Function Columns
The columns of the table function ProjectBasic are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
autoAllocate |
boolean |
|
☐ |
Summary tab > Invoicing and allocation settings section > Run allocation when you release project transactions > A check box that indicates (if selected) that allocation is run automatically during the release of the documents associated with this project. |
automaticReleaseAr |
boolean |
|
☐ |
Summary tab > Invoicing and allocation settings section > Automatically release customer documents > A check box that indicates (if selected) that invoice documents are released automatically after the project invoicing is completed. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
customer_name |
string |
Customer Name |
☐ |
Click the magnifier. > The name. |
customer_number |
string |
Customer Number |
☐ |
|
description |
string |
Description |
☐ |
Mandatory field: The top part > Description* > The description of the project. |
endDate |
datetime |
End Date |
☐ |
Summary tab > Project properties section > End date > The date when the project is expected to end. |
errorInfo |
string |
Error Message |
☐ |
|
hold |
boolean |
Hold |
☐ |
The top part > Hold > A check box that you select to indicate that the project should have the In planning status. |
internalID |
int32 |
Internal ID |
☐ |
|
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
Systemgenerated information. |
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
projectID |
string |
Project ID |
☐ |
Mandatory field: The top part > Project ID* > The unique ID for the project. |
publicId |
string |
Public ID |
☐ |
|
startDate |
datetime |
Start Date |
☐ |
Mandatory field: Summary tab > Project properties section > Start date* > The date when the project starts. |
status |
string |
Status |
☐ |
The top part > Status > The status of the project, which can be one of the following options: In planning, Active, Completed, Suspended, Cancelled. |
visibility_visibleInAp |
boolean |
|
☐ |
Supplier ledger |
visibility_visibleInAr |
boolean |
|
☐ |
Customer ledger |
visibility_visibleInCa |
boolean |
|
☐ |
Cash management |
visibility_visibleInCr |
boolean |
|
☐ |
|
visibility_visibleInEa |
boolean |
|
☐ |
Expenses |
visibility_visibleInGl |
boolean |
|
☐ |
General ledger |
visibility_visibleInIn |
boolean |
|
☐ |
Inventory |
visibility_visibleInPo |
boolean |
|
☐ |
Purchases |
visibility_visibleInSo |
boolean |
|
☐ |
Sales |
visibility_visibleInTa |
boolean |
|
☐ |
Time entries |
06-04-2021 14:55 Version 20.1.393-BETA+3152
