itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of Project transaction documents - ScreenId=PM304000
Catalog: VismaNet
Schema: ProjectTransaction
Label: Project Transactions
The data in this table is partitioned per value of the COMPANY_CODE column.
Retrieve: true
Insert: true
Update: true
Delete: false
Select Visma.net Financials API URL: /controller/api/v1/projecttransaction
Insert Visma.net Financials API URL: /controller/api/v1/projecttransaction
Update Visma.net Financials API URL: /controller/api/v1/projecttransaction
Delete Visma.net Financials API URL: /controller/api/v1/projecttransaction
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/projecttransaction
Insert Visma.net Financials API Operation: post /controller/api/v1/projecttransaction
Update Visma.net Financials API Operation: put /controller/api/v1/projecttransaction/{refNbr}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function ProjectTransactions. 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 |
|---|---|---|---|---|
billable |
boolean |
☐ |
|
Filter invoiceable project tasks. |
branch |
string |
☐ |
|
Filter on branch for the project transation. |
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
createdDateTime |
string |
☐ |
|
Creation date and time. |
createdDateTimeCondition |
string |
☐ |
|
System-retrieved information for state/condition |
date |
datetime |
☐ |
|
Filter on the registration date for the project transaction. |
expandNote |
boolean |
☐ |
|
Expands project transaction notes |
fromPeriod |
string |
☐ |
|
Mandatory. Start date for the task. |
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. |
module |
string |
☐ |
|
Select to filter on module; e.g. AR, AP, IN etc. (Values: ModuleGL, ModuleAP, ModuleAR, ModuleCA, ModuleCM, ModuleIN, ModuleSO, ModulePO, ModuleDR, ModuleFA, ModuleEP, ModulePM, ModuleTX, ModuleCR) |
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. |
project |
string |
☐ |
|
Filter on project ID. |
projectTask |
string |
☐ |
|
Filter on Task ID. |
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. |
status |
string |
☐ |
|
The status of the document. (Values: Hold, Balanced, Released) |
toPeriod |
string |
☐ |
|
Mandatory. End date for the task. |
Table Function Columns
The columns of the table function ProjectTransactions are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert or update.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
description |
string |
Description |
☐ |
The top part > Description > The description provided for the transaction. |
errorInfo |
string |
Error Message |
☐ |
|
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
module |
string |
Module |
☐ |
The top part > Module > The module you create the transactions in. |
note |
string |
Note |
☐ |
|
origDocNbr |
string |
Original Document Number |
☐ |
The top part > Orig. doc. no. > The reference number of the underlying document for the transaction. |
origDocType |
string |
Original Document Type |
☐ |
The top part > Orig. doc. no. > The type of the document the transaction is based on. It has one of the following values: Allocation, Time card, Case, Expense claim, Allocation reversal, Reversal, Credit note. |
refNbr |
string |
Reference Number |
☐ |
The top part > Ref. no. > The reference number of the transaction. |
status |
string |
Status |
☐ |
The top part > Status > The status of the transaction. The following statuses are possible: Balanced, Released. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
