Please enable JavaScript to view this site.

itgendoc001X

xMsg javascript has not been loaded.

Visma.net Financials API Data Model

Navigation: Schema: NumberSequence > Tables

NumberSequenceById

Contents Previous Home Next More

Get a specific Numbering

Catalog: VismaNet

Schema: NumberSequence

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/numberSequence/{numberingId}

Insert Visma.net Financials API URL: /controller/api/v1/numberSequence/{numberingId}

Update Visma.net Financials API URL: /controller/api/v1/numberSequence/{numberingId}

Delete Visma.net Financials API URL: /controller/api/v1/numberSequence/{numberingId}

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: get /controller/api/v1/numberSequence/{numberingId}

Table Function Parameters

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

numberingId

string

 

Identifies the Numbering

 

Table Function Columns

The columns of the table function NumberSequenceById 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

Mandatory field: The top part > Description* > The description of the numbering series.

manualNumbering

boolean

Manual Numbering

The top part > Manual numbering > A check box that indicates (if selected) that the system will not generate numbers for the series and users will need to specify document numbers manually.

newNumberSymbol

string

New Number Symbol

Mandatory field: The top part > New number symbol* > An alphanumeric string used to indicate that a new number for an object will be assigned.

numberingId

string

Number Sequence ID

Mandatory field: The top part > Numbering ID > The unique ID of the numbering series, which is an alphanumeric string of up to 10 characters.

 

06-04-2021 14:55 Version 20.1.393-BETA+3152