itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of discount codes - ScreenId=AR209000
Catalog: VismaNet
Schema: DiscountCode
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/discountCode
Insert Visma.net Financials API URL: /controller/api/v1/discountCode
Update Visma.net Financials API URL: /controller/api/v1/discountCode
Delete Visma.net Financials API URL: /controller/api/v1/discountCode
Field Selection Method: NotRequired
Base Path: records[*]
Select Visma.net Financials API Operation: get /controller/api/v1/discountCode
Table Function Parameters
The following parameters can be used to control the behaviour of the table function DiscountCodeRecords. 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. |
Table Function Columns
The columns of the table function DiscountCodeRecords are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
applicableTo |
string |
|
☐ |
Mandatory field: Discount codes table > Applicable to > The entity to which the discount may be applied.Applicable To values: CU - Customer,CI - Customer and Item,CP - Customer and Item Price Class,CE - Customer Price Class,PI - Customer Price Class and Item,PP - Customer Price Class and Item Price Class,CB - Customer and Branch,PB - Customer Price Class and Branch,WH - Warehouse,WI - Warehouse and Item,WC - Warehouse and Customer,WP - Warehouse and Item Price Class,WE - Warehouse and Customer Price Class,BR - Branch,IN - Item,IE - Item Price Class,UN - Unconditional |
applyToDeferredRevenue |
boolean |
|
☐ |
Discount codes table > Apply to deferred revenue > A check box that (if selected) indicates that a discount should be applied to a component price while computing a deferred revenue for the component. |
autoNumbering |
boolean |
|
☐ |
Discount codes table > Auto numbering > A check box that you select to use auto-numbering for generating IDs for series based on this discount code. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
createdDateTime |
datetime |
Created |
☐ |
System generated value. |
description |
string |
Description |
☐ |
|
discountCode |
string |
Discount Code |
☐ |
|
discountType |
string |
|
☐ |
DiscountType: L - Line, G - Group, D - Document |
excludeFromDiscountableAmount |
boolean |
|
☐ |
Discount codes table > Exclude from discountable amount > A check box that (if selected) indicates that the line amount is excluded from the amount that is the base for any applicable Group or Document discount. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated value. |
lastNumber |
string |
|
☐ |
Discount codes table > Last number > The last ID used for the series if series IDs are auto-numbered. |
manual |
boolean |
|
☐ |
Discount codes table > Manual > A check box that (if selected) indicates that this discount is excluded from automatic searches for the best available discount. |
pageNumber |
int32 |
|
☐ |
|
pageSize |
int32 |
|
☐ |
|
skipDocumentDiscounts |
boolean |
|
☐ |
Discount codes table > Skip document discounts > A check box that indicates (if selected) that after this discount has been applied, no other applicable discounts should be applied. |
totalCount |
int64 |
|
☐ |
|
06-04-2021 14:55 Version 20.1.393-BETA+3152
