Navigation: Catalog: VismaNet > Schemas > Schema: Project > Tables

ProjectById: Visma.net Financials Project by ID

Get a specific ProjectData for a single projectThe response headers include an ETag after a successful GET operation.

Catalog: VismaNet

Schema: Project

Label: Project by ID

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL 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 ProjectById. 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	Default Value	Documentation
projectID		☑		Identifies the Project

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
allocationRule_active	char	Allocation Rule Active	☐
allocationRule_description	varchar2	Allocation Rule Description	☐	Click on the magnifier. > The description.
allocationRule_id	varchar2	Allocation Rule ID	☐	Click on the magnifier. > The identifier.
assets	double	Assets	☐	The top part > Assest > The actual assets for the project.
autoAllocate	char	Auto Allocate	☐	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	char	Automatic Release AR	☐	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.
billingPeriod	varchar2	Billing Period	☐	Summary tab > Invoicing and allocation settings section > Invoicing period > The frequency of invoicing, which can be one of the following options: Week, Month, Quarter, Year, On demand.
billingRule_active	char	Billing Rule Active	☐
billingRule_description	varchar2	Billing Rule Description	☐	Click on the magnifier. > The description.
billingRule_id	varchar2	Billing Rule ID	☐	Click on the magnifier. > The identifier.
branch_name	varchar2	Branch Name	☐	Click the magnifier. > The name.
branch_number	varchar2	Branch Number	☐	Click the magnifier. > The identifier.
COMPANY_CODE	varchar2(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	varchar2(240)	Company Name	☑	Name of the partition.
customer_name	varchar2	Customer Name	☐	Click the magnifier. > The name.
customer_number	varchar2	Customer Number	☐
customerLocation_id	int32	Customer Location ID	☐	Click the magnifier > The identifier
customerLocation_name	varchar2	Customer Location Name	☐	Click the magnifier > The displayed name
defAccount_description	varchar2	Default Account Description	☐	Name of item/description
defAccount_number	varchar2	Default Account Number	☐	Number of item
defAccount_type	varchar2	Default Account Type	☐
defAccrualAccount_description	varchar2	Default Accrual Account Description	☐	Name of item/description
defAccrualAccount_number	varchar2	Default Accrual Account Number	☐	Number of item
defAccrualAccount_type	varchar2	Default Accrual Account Type	☐
defAccrualSub_active	char	Default Accrual Account Sub Active	☐
defAccrualSub_description	varchar2	Default Accrual Account Sub Description	☐	Click on the magnifier. > The description.
defAccrualSub_id	varchar2	Default Accrual Account Sub ID	☐	Click on the magnifier. > The identifier.
defSub_active	char	Default Sub Active	☐
defSub_description	varchar2	Default Sub Description	☐	Click on the magnifier. > The description.
defSub_id	varchar2	Default Sub ID	☐	Click on the magnifier. > The identifier.
description	varchar2	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	varchar2	Error Message	☐
expenses	double	Expenses	☐	The top part > Expenses > The total of the current expenses incurred by the project.
hold	char	Hold	☐	The top part > Hold > A check box that you select to indicate that the project should have the In planning status.
income	double	Income	☐	The top part > Income > The income expected from the project.
internalID	int32	Internal ID	☐
lastBillingDate	datetime	Last Billing Date	☐	Summary tab > Invoicing and allocation settings section > Last invoicing date > The date when the latest invoicing was performed for the project.
lastModifiedDateTime	datetime	Last Modified	☐	System generated information
liability	double	Liability	☐	The top part > Liabilities > The actual liabilities for the project.
metadata_maxPageSize	int64	Metadata Max Pagesize	☐
metadata_totalCount	int64	Total Count	☐
nextBillingDate	datetime	Next Billing Date	☐	Summary tab > Invoicing and allocation settings section > Next invoicing date > The date for which the next invoicing is scheduled for the project.
note	varchar2	Note	☐	The note on the project.
projectID	varchar2	Project ID	☐	Mandatory field: The top part > Project ID* > The unique ID for the project.
projectManager_address_addressId	int32		☐
projectManager_address_addressLine1	varchar2		☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
projectManager_address_addressLine2	varchar2		☐	Address 2 > The second line of the address.
projectManager_address_addressLine3	varchar2		☐	Address 3 > The third line of the address.
projectManager_address_city	varchar2		☐	City > The city.
projectManager_address_country_errorInfo	varchar2		☐
projectManager_address_country_id	varchar2		☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
projectManager_address_country_metadata_maxPageSize	int64		☐
projectManager_address_country_metadata_totalCount	int64		☐
projectManager_address_country_name	varchar2		☐	Mandatory field: Country name* > The complete name of the country.
projectManager_address_county_id	varchar2		☐	Click the magnifier > The identifier
projectManager_address_county_name	varchar2		☐	Click the magnifier > The displayed name
projectManager_address_postalCode	varchar2		☐	Postcode > The postcode.
projectManager_branch_name	varchar2		☐	Click the magnifier. > The name.
projectManager_branch_number	varchar2		☐	Click the magnifier. > The identifier.
projectManager_calendarID	varchar2		☐
projectManager_contact_attention	varchar2		☐	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.
projectManager_contact_contactId	int32		☐
projectManager_contact_email	varchar2		☐	Email > The email address of the customer/supplier/company as a business entity.
projectManager_contact_employeeContact	varchar2		☐	Employee contact > The link to the contact record associated with the employee.
projectManager_contact_fax	varchar2		☐	Fax > The fax number.
projectManager_contact_firstName	varchar2		☐	First name > The first name of the employee.
projectManager_contact_lastName	varchar2		☐	Mandatory field: Last name* > The last name of the employee.
projectManager_contact_midName	varchar2		☐	Middle name > The middle name of the employee.
projectManager_contact_name	varchar2		☐	Name > The legal name of to appear on the documents.
projectManager_contact_phone1	varchar2		☐	Phone 1 > The default phone number.
projectManager_contact_phone2	varchar2		☐	Phone 2 > An additional phone number.
projectManager_contact_phone3	varchar2		☐	Phone 3 > An additional phone number of the employee.
projectManager_contact_title	varchar2		☐	Title > The courtesy title to be used for the employee.
projectManager_contact_web	varchar2		☐	Web > The website of the company, if one exists.
projectManager_department	varchar2	Project Manager Department	☐	Mandatory field: General information tab > Employee section > Department* > The department the employee works for.
projectManager_employeeClass_description	varchar2		☐	Click on the magnifier. > The description.
projectManager_employeeClass_id	varchar2		☐	Click on the magnifier. > The identifier.
projectManager_employeeId	int32	Project Manager 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.
projectManager_employeeLogin	varchar2		☐
projectManager_employeeName	varchar2	Project Manager Employee Name	☐	The top part > Employee name > The name of this employee.
projectManager_employeeNumber	varchar2	Project Manager Employee Number	☐	General information tab > Employee settings section > Employee ref. no. > A reference number for the employee.
projectManager_employeeUserId	guid		☐	Employee internal user ID. This is the ID of the user linked to the employee
projectManager_errorInfo	varchar2		☐
projectManager_lastModifiedDateTime	datetime		☐
projectManager_metadata_maxPageSize	int64		☐
projectManager_metadata_totalCount	int64		☐
projectManager_status	varchar2	Project Manager 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.
projectManager_timeStamp	blob		☐	Identifier that represents a specific version of the resource.It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)
publicId	guid	Public ID	☐
rateTable_description	varchar2	Rate Table Description	☐	Click on the magnifier. > The description.
rateTable_id	varchar2	Rate Table ID	☐	Click on the magnifier. > The identifier.
restrictEmployees	char	Restrict Employees	☐	Summary tab > Project properties section > Restrict employees > A check box that indicates (if selected) that only the employees listed on the Employees tab of this window can create activities and documents associated with the current project.
restrictEquipment	char	Restrict Equipment	☐
startDate	datetime	Start Date	☐	Mandatory field: Summary tab > Project properties section > Start date* > The date when the project starts.
status	varchar2	Status	☐	The top part > Status > The status of the project, which can be one of the following options: In planning, Active, Completed, Suspended, Cancelled.
systemTemplate	char	System Template	☐
template_description	varchar2	Template Description	☐	Name of item/description
template_number	varchar2	Template Number	☐	Number of item
template_status	varchar2	Template Status	☐
timeStamp	blob	Timestamp	☐	Identifier that represents a specific version of the resource.It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)
visibility_visibleInAp	char		☐	Supplier ledger
visibility_visibleInAr	char		☐	Customer ledger
visibility_visibleInCa	char		☐	Cash management
visibility_visibleInCr	char		☐
visibility_visibleInEa	char		☐	Expenses
visibility_visibleInGl	char		☐	General ledger
visibility_visibleInIn	char		☐	Inventory
visibility_visibleInPo	char		☐	Purchases
visibility_visibleInSo	char		☐	Sales
visibility_visibleInTa	char		☐	Time entries

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

ProjectById: Visma.net Financials Project by ID

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information