itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet 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[*].branches[*]
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 DiscountRecordBranches. 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. |
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 DiscountRecordBranches are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
active |
boolean |
Active |
☐ |
The top part > Active > A check box that indicates (if selected) that the series is active. |
branch |
string |
Branch |
☐ |
|
breakBy |
string |
|
☐ |
The top part > Break by > The way the breakpoints for this discount series are specified. Quantity, Amount. |
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. |
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. |
effectiveDate |
datetime |
Effective Date |
☐ |
The top part > Effective date > The date when the series becomes effective; this field appears for promotional discount series only. |
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. |
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. |
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. |
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. |
pageNumber |
int32 |
|
☐ |
|
pageSize |
int32 |
|
☐ |
|
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. |
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. |
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
