VatCategoryLines: Visma.net Financials VAT Category Lines |
Get a range of VatCategories - ScreenId=TX205500
Catalog: VismaNet
Schema: VatCategory
Label: VAT Category Lines
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.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function VatCategoryLines. 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 evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `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 |
☐ |
|
Creation date and time. |
createdDateTimeCondition |
string |
☐ |
|
System-retrieved information for state/condition |
erp-api-background |
string |
☐ |
|
If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation. |
greaterThanValue |
string |
☐ |
|
Greater than value. The item which is the object for this, varies from API to API. |
lastModifiedDateTime |
string |
☐ |
|
System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present. |
lastModifiedDateTimeCondition |
string |
☐ |
|
System retrieved information for state/condition. |
numberToRead |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. |
skipRecords |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. |
Columns of Table Function
The columns of the table function VatCategoryLines 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 means (if selected) that this VAT category is active. |
calculateOn |
string |
|
☐ |
Calculate on > The way the VAT amount is calculated, which can be one of the following options: Extract from item amount, Document amount, Document and VAT amount. |
cashDiscount |
string |
Cash Discount |
☐ |
Cash discount > The method of calculating the taxable amount if a discount is applied (based on the credit terms). It can be one of the following options: Reduce VAT amount, Does not affect VAT amount. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
description_1 |
string |
|
☐ |
The top part > Description > A detailed description of the category. |
description |
string |
Description |
☐ |
Description > The detailed description of the VAT item. |
excludeListedTaxes |
boolean |
|
☐ |
The top part > Exclude listed taxes > A check box that indicates (if selected) this VAT category should exclude the listed taxes from VAT zones. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
Systemgenerated information. |
type |
string |
Type |
☐ |
VAT type > The type of VAT, which defines how it is processed. |
vatCategoryId |
string |
VAT Category ID |
☐ |
Mandatory field: The top part > VAT category ID* > The unique ID of the VAT category. An alphanumeric string of up to six characters can be used. |
vatId |
string |
VAT ID |
☐ |
Mandatory field: VAT ID* > The ID of the VAT included in the category. |
22-12-2022 21:03 Version 22.1.101-BETA+3681