Please enable JavaScript to view this site.

itgendoc001X

xMsg javascript has not been loaded.

Visma.net Financials API Data Model

Navigation: Schema: CustomerSalesPrice > Tables

CustomerSalesPrices: Visma.net Financials Customer Sales Prices

Contents Previous Home Next More

Get a range of Customer Sales Prices - ScreenId=AR202000Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page size

Catalog: VismaNet

Schema: CustomerSalesPrice

Label: Customer Sales Prices

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

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

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

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

Field Selection Method: NotRequired

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

Table Function Parameters

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

effectiveAsOf

datetime

 

 

greaterThanValue

string

 

 

inventoryId

string

 

 

lastModifiedDateTime

string

 

 

lastModifiedDateTimeCondition

string

 

 

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.

priceCode

string

 

 

priceType

string

 

Values: All, Base, Customer, CustomerPriceClass.

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.

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

breakQty

double

 

The Sales price table > Break quantity > The quantity to define a lower bound for a quantity tier with the specific price.

COMPANY_CODE

string(30)

Company Code

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

Name of the partition.

currency

string

Currency

Mandatory field: The Sales price table > Currency* > The currency in which this price is specified.

description

string

Description

The Sales price table > Description > The description of the stock item.

effectiveDate

datetime

Effective Date

The Sales price table > Effective date > The date when the price became effective.

errorInfo

string

Error Message

 

expirationDate

datetime

Expiration Date

The Sales price table > Ecpiration date > The date when the price expires.

inventoryId

string

Inventory ID

The Sales price table or the top part > Warehouse > The warehouse in which the price applies.

lastModifiedDateTime

datetime

Last Modified

 

metadata_maxPageSize

int64

 

 

metadata_totalCount

int64

Total Count

 

price

double

Price

The Sales Price table > Price > The price for the item.

priceCode

string

Price Code

The Sales price table or the top part > Price code > The customer or a customer price class for which you want to create or edit a price list.

priceType

string

Price Type

The Sales price table or the top part > Price type > The type of prices you want to view: All prices, Base, Customer, Customer price class.

promotion

boolean

Promotion

The Sales price table > Promotion > A check box that indicates (if selected) that the price for this item is promotional.

recordId

int32

Record ID

Mandatory field: The Sales price table > Item ID* > The ID of the stock or non-stock stock item for which price information is listed.

uoM

string

Unit of Measure

Mandatory field: The Sales price table > UoM* > The unit of measure (UoM) used for the item.

vat

string

VAT

The Sales price table > VAT > The VAT amount that is included in the sales price.

 

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