invantive documentation
Invantive Support ForumsLog In / Sign Up

DiscountRecordBranches: Visma.net Financials Discount Record Branches

read only REST

  • Catalog: VismaNet
  • Schema: Discount
  • Label: Discount Record Branches

Get a range of discounts - ScreenId=AR209500

Can only retrieve data.

API Source

  • Endpoint: /v1/discount
  • Operation: get /v1/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 DiscountRecordBranches 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, ::ancestor.active The top part > Active > A check box that indicates (if selected) that the series is active.
branch varchar2 Branch writable, branch
breakBy varchar2 itgen_vnet_breakby writable, ::ancestor.breakBy The top part > Break by > The way the breakpoints for this discount series are specified. Quantity, Amount.
createdDateTime datetime Created writable, ::ancestor.createdDateTime
description varchar2 Description writable, ::ancestor.description The top part > Description > A brief description of the series.
discountBy varchar2 itgen_vnet_discountby 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 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.
effectiveDate datetime Effective Date 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 writable, ::ancestor.errorInfo
expirationDate datetime Expiration Date 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 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.
lastFreeItem int32 itgen_vnet_lastfreeitem 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.
lastModifiedDateTime datetime Last Modified 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.
lastUpdateDate datetime itgen_vnet_lastupdatedate 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 writable, ::ancestor.lineCntr Free item tab > A line counter for the table.
metadata_maxPageSize int64 Metadata Max Pagesize writable, ::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count writable, ::ancestor.metadata.totalCount
pageNumber int32 Page Number filters on the platform, writable, ::ancestor.::ancestor.pageNumber
pageSize int32 Pagesize filters on the platform, writable, ::ancestor.::ancestor.pageSize
pendingFreeItem int32 itgen_vnet_pendingfreeitem 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.
promotional char itgen_vnet_promotional 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 writable, ::ancestor.prorateDiscount The top part > Prorate discount > A check box that indicates (if selected) that the discount can be prorated.
series varchar2 itgen_vnet_series writable, ::ancestor.series Mandatory field: The top part > Series > The ID of the series defined for the discount.
timeStamp blob Timestamp 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)
totalCount int64 Total Count filters on the platform, writable, ::ancestor.::ancestor.totalCount

Release Notes

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