Please enable JavaScript to view this site.

itgendoc001X

xMsg javascript has not been loaded.

Visma.net Financials API Data Model

Navigation: Schema: CreditTerm > Tables

CreditTermRecordInstalmentsSchedule

Contents Previous Home Next More

Get a range of credit terms - ScreenId=CS206500

Catalog: VismaNet

Schema: CreditTerm

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/creditTerm

Insert Visma.net Financials API URL: /controller/api/v1/creditTerm

Update Visma.net Financials API URL: /controller/api/v1/creditTerm

Delete Visma.net Financials API URL: /controller/api/v1/creditTerm

Field Selection Method: NotRequired

Base Path: records[*].instalmentsSchedule[*]

Select Visma.net Financials API Operation: get /controller/api/v1/creditTerm

Table Function Parameters

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

 

System retrieved information for created date and time.

createdDateTimeCondition

string

 

System retrieved information for state/condition.

lastModifiedDateTime

string

 

 

lastModifiedDateTimeCondition

string

 

System retrieved information for state/condition.

pageNumber

int32

 

Pagination parameter. Page number.

pageSize

int32

 

Pagination parameter. Number of items to be collected.

termsId

string

 

 

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

calculationType

string

 

Calculation Type: G - Gross amount, N - Net amount

COMPANY_CODE

string(30)

Company Code

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

Name of the partition.

createdDateTime

datetime

Created

 

days

int32

 

 

delayDays

int32

 

 

description

string

Description

 

discountDay

int32

 

 

discountPercent

double

Discount Percent

 

discountType

string

 

Discount Type , values:N - Fixed Number of Days, D - Day of Next Month, E - End of the Month, M - End of Next Month, T - Day of the Month, P - Fixed Number of Days starting Next Month.

dueDateType

string

 

Due Date Type , values:N - Fixed Number of Days, D - Day of Next Month, E - End of the Month, M - End of Next Month, T - Day of the Month, P - Fixed Number of Days starting Next Month, C - Custom.

dueDay1

int32

 

 

dueDay1DayFrom1

int32

 

 

dueDay1DayTo1

int32

 

 

dueDay2

int32

 

 

dueDay2DayFrom1

int32

 

 

dueDay2DayTo1

int32

 

 

instalmentFrequency

string

 

Instalment Frequency, values:W - Weekly,M - Monthly,B - Semi-monthly (the second installment comes a half a month after the first one, and so on).

instalmentMethod

string

 

Instalment Method, values:E - Equal Parts,A - All Tax in First Installment (the total amount before tax is split equally between installments and the entire amount of tax is added to the first installment),S - Split by Percents in Table (the days and amounts of installments are defined by the related Instalments Schedule records).

instalmentType

string

 

Instalment Type: S - Simple, M - Multiple

lastModifiedDateTime

datetime

Last Modified

 

moveDueDateIfOnTheWeekend

string

 

Move Due Date If On The Weekend, values:1 - Keep the exact date, 2 - Day before (Friday), 3 - Day after (Monday).

numberOfInstalments

int32

 

 

pageNumber

int32

 

 

pageSize

int32

 

 

percent

double

 

 

termsId

string

 

 

totalCount

int64

 

 

visibleTo

string

 

VisibleTo: AL - All, VE - Suppliers, CU - Customers, DS - Disabled

 

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