Visma.net Financials API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: Discount > Tables

DiscountRecordDiscountBreakpoints

Contents Previous Home Next More

Get a range of discounts - ScreenId=AR209500

Catalog: VismaNet

Schema: Discount

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

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

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

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

Field Selection Method: NotRequired

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

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

Table Function Parameters

The following parameters can be used to control the behaviour of the table function DiscountRecordDiscountBreakpoints. 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	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.
discountCode	string	☐
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.
series	string	☐

Table Function Columns

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

Name	Data Type	Label	Required	Documentation
active_1	boolean		☐	The top part > Active > A check box that indicates (if selected) that the series is active.
active	boolean	Active	☐	The top part > Active > A check box that indicates (if selected) that the series is active.
amountTo	double		☐
breakAmount	double		☐	Discount breakpoints tab > Break amount > The line amount (break point) that starts the new range for the currently effective series.
breakBy	string		☐	The top part > Break by > The way the breakpoints for this discount series are specified. Quantity, Amount.
breakQuantity	double		☐	Discount breakpoints tab > Break quantity > The quantity of items (break quantity) that starts the new range for a discount level for the currently effective series. Any break quantity should be specified in the base units.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
createdDateTime	datetime	Created	☐
description	string	Description	☐	The top part > Description > A brief description of the series.
discountAmount	double		☐	Discount breakpoints tab > Discount amount > The discount amount to be used for the quantities that exceed this break quantity if the Amount option is selected as Discount by.
discountBy	string		☐	The top part > Discount by > The way the discount for the series is specified. Percent, Amount, Free item.
discountCode	string	Discount Code	☐	Mandatory field: The top part > Discount code > The code of the discount for which you want to create a new series or view an existing one.
discountPercent	double	Discount Percent	☐	Discount breakpoints tab > Discount percent > The discount percent to be currently used for the quantities that exceed this break quantity if the Percent option is selected as Discount by.
effectiveDate_1	datetime		☐	The top part > Effective date > The date when the series becomes effective; this field appears for promotional discount series only.
effectiveDate	datetime	Effective Date	☐
expirationDate	datetime	Expiration Date	☐	The top part > Expiration date > The date when the promotional discount expires. This field appears for the series if the Promotional check box is selected.
freeItem	int32		☐	Free item tab > Free item > The free item (by its item ID) that is added to orders as the discount for this series.
freeItemQty	double		☐	Discount breakpoints tab > Free item qty. > The quantity of the free item to be added as the discount to orders for this discount series.
lastAmountTo	double		☐
lastBreakAmount	double		☐	Discount breakpoints tab > Last break amount > The amount (break point) that started the new range for the previously effective series (the one that was used before the effective date).
lastBreakQuantity	double		☐	Discount breakpoints tab > Last break quantity > The quantity of item (break point) that started the range for the discount series used before the effective date.
lastDiscount	double		☐	Discount breakpoints tab > Last discount amount > The amount used as the discount for the discount series that was in effect before the effective date.
lastDiscountAmount	double		☐	Discount breakpoints tab > Last discount amount > The amount used as the discount for the discount series that was in effect before the effective date.
lastDiscountPercent	double		☐	Discount breakpoints tab > Last discount percent > The percentage used for the break point in the previously effective series.
lastFreeItem	int32		☐	Free item tab > Last free item > The free item (by its item ID) that had been added to orders as the discount for this series before the date shown in the Last date column on the Discount breakpoints tab.
lastFreeItemQty	double		☐	Discount breakpoints tab > Last free item qty. > The quantity of the free item that was used as the discount for the previously effective series.
lastModifiedDateTime	datetime	Last Modified	☐	Free item tab > Last update date > A read-only field that shows the date when this discount series has been updated last.
lastQuantityTo	double		☐
lastUpdateDate	datetime		☐	The top part > Last update date > A read-only field that shows the date when the discount series was last updated.
lineCntr	int32		☐	Free item tab > A line counter for the table.
lineNbr	int32		☐
pageNumber	int32		☐
pageSize	int32		☐
pendingBreakAmount	double		☐	Discount breakpoints tab > Pending break amount > The amount (break point) that starts the new range for the pending series (one that is not yet in effect).
pendingBreakQuantity	double		☐	Discount breakpoints tab > Pending break quantity > The quantity of items (break point) that starts the new range for the pending (not yet effective) series.
pendingDate	datetime		☐
pendingDiscountAmount	double		☐	Discount breakpoints tab > Pending discount amount > The amount to be used as the discount for the pending series if the Amount option is selected as Discount by.
pendingDiscountPercent	double		☐	Discount breakpoints tab > Pending discount percent > The discount percent to be used for the break point in the pending series.
pendingFreeItem	int32		☐	Free item tab > Pending free item > The free item (by its item ID) that will be added to orders as the discount for this series, starting on the date specified in the Pending date column on the Discount breakpoints tab.
pendingFreeItemQty	double		☐	Discount breakpoints tab > Pending free item qty. > The quantity of the free item to be added as the discount to orders for the pending discount series.
promotional	boolean		☐	The top part > Promotional > A check box that indicates (if selected) that the series is a promotional discount.
prorateDiscount	boolean		☐	The top part > Prorate discount > A check box that indicates (if selected) that the discount can be prorated.
quantityTo	double		☐
series	string		☐	Mandatory field: The top part > Series > The ID of the series defined for the discount.
totalCount	int64		☐

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

Please enable JavaScript to view this site.

itgendoc001X

Visma.net Financials API Data Model

Table Function Parameters

Table Function Columns