invantive documentation
Invantive Support ForumsLog In / Sign Up

DiscountBreakpointsV2: Visma.net Financials Discount Breakpoints (V2)

read only REST

  • Catalog: VismaNet
  • Schema: DiscountV2
  • Label: Discount Breakpoints (V2)

Get a range of discounts - ScreenId=AR209500

Can only retrieve data.

API Source

  • Endpoint: /v2/discount
  • Operation: get /v2/discount

Performance Characteristics

Characteristic Value
Average access latency (ms) 155
Full scan rows per minute 29,100
Point query rows per minute 387

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
createdDateTime `` This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present. Accepted format: * yyyy-MM-dd * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd HH:mm:ss.FFF * yyyy-MM-ddTHH:mm:ss * yyyy-MM-ddTHH:mm:ss.FFF Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive.
createdDateTimeCondition `` This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive.
discountCode ``
lastModifiedDateTime ``
lastModifiedDateTimeCondition `` System retrieved information for state/condition.
series ``

Table Columns

The columns of the table DiscountBreakpointsV2 are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
COMPANY_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) Company Name writable Name of the partition.
active char Active writable, active The top part > Active > A check box that indicates (if selected) that the series is active.
active_2 char itgen_vnet_active_2 filters on the platform, writable, ::ancestor.active The top part > Active > A check box that indicates (if selected) that the series is active.
amountTo double itgen_vnet_amountto writable, amountTo
breakAmount double itgen_vnet_breakamount writable, breakAmount Discount breakpoints tab > Break amount > The line amount (break point) that starts the new range for the currently effective series.
breakBy varchar2 itgen_vnet_breakby filters on the platform, writable, ::ancestor.breakBy The top part > Break by > The way the breakpoints for this discount series are specified. Quantity, Amount.
breakQuantity double itgen_vnet_breakquantity writable, breakQuantity 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.
createdDateTime datetime Created filters on the platform, writable, ::ancestor.createdDateTime
description varchar2 Description filters on the platform, writable, ::ancestor.description The top part > Description > A brief description of the series.
discountAmount double itgen_vnet_discountamount writable, discountAmount 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 varchar2 itgen_vnet_discountby filters on the platform, writable, ::ancestor.discountBy The top part > Discount by > The way the discount for the series is specified. Percent, Amount, Free item.
discountCode varchar2 Discount Code filters on the platform, writable, ::ancestor.discountCode 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 writable, discountPercent 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 datetime Effective Date writable, effectiveDate
effectiveDate_2 datetime itgen_vnet_effectivedate_2 filters on the platform, writable, ::ancestor.effectiveDate The top part > Effective date > The date when the series becomes effective; this field appears for promotional discount series only.
errorInfo varchar2 Error Message filters on the platform, writable, ::ancestor.errorInfo
expirationDate datetime Expiration Date filters on the platform, writable, ::ancestor.expirationDate 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 filters on the platform, writable, ::ancestor.freeItem 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 itgen_vnet_freeitemqty writable, freeItemQty 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 itgen_vnet_lastamountto writable, lastAmountTo
lastBreakAmount double itgen_vnet_lastbreakamount writable, lastBreakAmount 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 itgen_vnet_lastbreakquantity writable, lastBreakQuantity 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 itgen_vnet_lastdiscount writable, lastDiscount 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 itgen_vnet_lastdiscountamount writable, lastDiscountAmount 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 itgen_vnet_lastdiscountpercent writable, lastDiscountPercent Discount breakpoints tab > Last discount percent > The percentage used for the break point in the previously effective series.
lastFreeItem int32 itgen_vnet_lastfreeitem filters on the platform, writable, ::ancestor.lastFreeItem 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 itgen_vnet_lastfreeitemqty writable, lastFreeItemQty 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 filters on the platform, writable, ::ancestor.lastModifiedDateTime Free item tab > Last update date > A read-only field that shows the date when this discount series has been updated last.
lastQuantityTo double itgen_vnet_lastquantityto writable, lastQuantityTo
lastUpdateDate datetime itgen_vnet_lastupdatedate filters on the platform, writable, ::ancestor.lastUpdateDate The top part > Last update date > A read-only field that shows the date when the discount series was last updated.
lineCntr int32 itgen_vnet_linecntr filters on the platform, writable, ::ancestor.lineCntr Free item tab > A line counter for the table.
lineNbr int32 itgen_vnet_linenbr writable, lineNbr
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, ::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, ::ancestor.metadata.totalCount
pendingBreakAmount double itgen_vnet_pendingbreakamount writable, pendingBreakAmount 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 itgen_vnet_pendingbreakquantity writable, pendingBreakQuantity 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 itgen_vnet_pendingdate writable, pendingDate
pendingDiscountAmount double itgen_vnet_pendingdiscountamount writable, pendingDiscountAmount 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 itgen_vnet_pendingdiscountpercent writable, pendingDiscountPercent Discount breakpoints tab > Pending discount percent > The discount percent to be used for the break point in the pending series.
pendingFreeItem int32 itgen_vnet_pendingfreeitem filters on the platform, writable, ::ancestor.pendingFreeItem 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 itgen_vnet_pendingfreeitemqty writable, pendingFreeItemQty 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 char itgen_vnet_promotional filters on the platform, writable, ::ancestor.promotional The top part > Promotional > A check box that indicates (if selected) that the series is a promotional discount.
prorateDiscount char itgen_vnet_proratediscount filters on the platform, writable, ::ancestor.prorateDiscount The top part > Prorate discount > A check box that indicates (if selected) that the discount can be prorated.
quantityTo double itgen_vnet_quantityto writable, quantityTo
series varchar2 itgen_vnet_series filters on the platform, writable, ::ancestor.series Mandatory field: The top part > Series > The ID of the series defined for the discount.
timeStamp blob Timestamp filters on the platform, writable, ::ancestor.timeStamp Identifier that represents a specific version of the resource. It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: