Please enable JavaScript to view this site.

itgendoc001X

xMsg javascript has not been loaded.

Visma.net Financials API Data Model

Navigation: Schema: Customer > Tables

CustomerSpecificCustomerClassByCustomerClassId

Contents Previous Home Next More

Get a specific customer class - ScreenId=AR201000

Catalog: VismaNet

Schema: Customer

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/customer/customerClass/{customerClassId}

Insert Visma.net Financials API URL: /controller/api/v1/customer/customerClass/{customerClassId}

Update Visma.net Financials API URL: /controller/api/v1/customer/customerClass/{customerClassId}

Delete Visma.net Financials API URL: /controller/api/v1/customer/customerClass/{customerClassId}

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: get /controller/api/v1/customer/customerClass/{customerClassId}

Table Function Parameters

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

customerClassId

string

 

Identifies the customer class

 

Table Function Columns

The columns of the table function CustomerSpecificCustomerClassByCustomerClassId 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 > A detailed description of the customer class.

id

string

ID

The top part > Class ID> The unique identifier of the class. You can use an alphanumeric string of up to 10 characters.

paymentMethodId

string

Payment Method ID

The General information tab > Payment method > The payment method used by default in relations with these customers.

requiredTaxzoneId

boolean

Required Tax Zone ID

The General information tab > Require VAT zone > A check box that means (if selected) that the VAT zone value is required for customers of the class.

taxZoneId

string

Tax Zone ID

The General information tab > VAT zone ID >The default VAT zone for customers of the class.

 

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