Please enable JavaScript to view this site.

itgendoc001X

xMsg javascript has not been loaded.

Visma.net Financials API Data Model

Navigation: Schema: ProjectTransaction > Tables

ProjectTransactionByReferenceNumber

Contents Previous Home Next More

Get a specific Project transaction document

Catalog: VismaNet

Schema: ProjectTransaction

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/projecttransaction/{refNbr}

Insert Visma.net Financials API URL: /controller/api/v1/projecttransaction/{refNbr}

Update Visma.net Financials API URL: /controller/api/v1/projecttransaction/{refNbr}

Delete Visma.net Financials API URL: /controller/api/v1/projecttransaction/{refNbr}

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: get /controller/api/v1/projecttransaction/{refNbr}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ProjectTransactionByReferenceNumber. 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.

refNbr

string

 

Identifies the project transaction document

 

Table Function Columns

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

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