Navigation: Schema: Vat > Tables

VatVats_CategoriesVatCategoryLinesVatRates

Get a range of Vats - ScreenId=TX205000

Catalog: VismaNet

Schema: Vat

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 VatVats_CategoriesVatCategoryLinesVatRates. 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	Documentation
COMPANY_CODE	string	☐	Partition to retrieve data from.
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.
lastModifiedDateTime	string	☐	System retrieved information for state/condition. Valid date/time format is yyyy-MM-dd, yyyy-MM-dd HH:mm:ss or yyyy-MM-dd HH:mm:ss.FFF. FFF stands for milliseconds
lastModifiedDateTimeCondition	string	☐	Value to be used for filtering lastModifiedDateTime value.
numberToRead	int32	☐	This field has been deprecated and will be removed in future versions.
skipRecords	int32	☐	This field has been deprecated and will be removed in future versions.

Columns of Table Function

The columns of the table function VatVats_CategoriesVatCategoryLinesVatRates 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_1	string		☐	VAT settings tab > Calculate on > The method of calculating the tax amount, which is one of the following options: Extract from item amount, Item amount, Item and VAT amount, Document amount, Document and VAT amount.
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_1	string		☐	VAT settings tab > Cash discount > The method of calculating the tax base amount if a cash discount is applied.
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.
deductibleVat	boolean	Deductible VAT	☐	VAT settings tab > Partially deductible VAT > A check box that indicates (if selected) that this is a deductible value-added VAT.
defaultNonStockItem_description	string		☐	Name of item/description
defaultNonStockItem_number	string		☐	Number of item
description_1	string		☐	The top part > Description > A detailed description of the category.
description_2	string		☐	VAT settings tab > Description > A detailed description of the VAT.
description	string	Description	☐	Description > The detailed description of the VAT item.
documentText	string	Document Text	☐	VAT Settings tab > Document text tab > Document text > The text to be printed to the VAT document.
enterFromVatInvoice	boolean		☐	VAT settings tab > Enter from VAT invoice > A check box that indicates (if selected) that this VAT should be calculated for documents only if the documents are added to a VAT invoice or VAT adjustment.
euReportCode	string	EU Report Code	☐	VAT settings tab > EU report code > The EU reporting code for the VAT.
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.
glAccounts_vatClaimableAccount_description	string		☐	Name of item/description
glAccounts_vatClaimableAccount_externalCode1	string		☐	Account class > The identifier of the account class.
glAccounts_vatClaimableAccount_externalCode2	string		☐	Account class > The name of the account class.
glAccounts_vatClaimableAccount_number	string		☐	Number of item
glAccounts_vatClaimableAccount_type	string		☐	Account > The account number.
glAccounts_vatClaimableSubccount_description	string		☐	Click on the magnifier. > The description.
glAccounts_vatClaimableSubccount_id	string		☐	Click on the magnifier. > The identifier.
glAccounts_vatPayableAccount_description	string		☐	Name of item/description
glAccounts_vatPayableAccount_externalCode1	string		☐	Account class > The identifier of the account class.
glAccounts_vatPayableAccount_externalCode2	string		☐	Account class > The name of the account class.
glAccounts_vatPayableAccount_number	string		☐	Number of item
glAccounts_vatPayableAccount_type	string		☐	Account > The account number.
glAccounts_vatPayableSubaccount_description	string		☐	Click on the magnifier. > The description.
glAccounts_vatPayableSubaccount_id	string		☐	Click on the magnifier. > The identifier.
includeinVatExemptTotal	boolean		☐	VAT settings tab > Include in VAT exempt total > A check box that indicates (if selected) that this value-added VAT has a zero rate and is used to calculate a document subtotal that is actually exempt from VAT.
includeinVatTotal	boolean		☐	VAT settings tab > Include in VAT taxable total > A check box that indicates (if selected) that the VAT taxable amount should appear in the VAT taxable total field in the documents (such as invoices).
lastModifiedDateTime_1	datetime		☐	System generated information.
lastModifiedDateTime	datetime	Last Modified	☐	Systemgenerated information.
notValidAfter	datetime	Not Valid After	☐	VAT settings tab > Not valid after > The date after which the VAT is not effective.
pendingVat	boolean		☐	VAT settings tab > Pendig VAT > A check box that indicates (if selected) that the VAT that should be calculated in documents, but should not be recorded to the VAT report until the VAT invoice is received.
reverseVat	boolean	Reverse VAT	☐	VAT settings tab > Reverse VAT > A check box that indicates (if selected) that this is a reverse VAT.
revisionID	string		☐	The revision ID of the VAT rate.
startDate	datetime	Start Date	☐	The date and time from which the VAT rate is effective.
statisticalVat	boolean	Statistical VAT	☐	VAT settings tab > Statistical VAT > A check box that indicates (if selected) that the VAT on documents will be calculated only for statistical purposes or will be reported only but not actually paid.
type_1	string		☐	VAT settings tab > VAT type > The type of VAT.
type	string	Type	☐	VAT type > The type of VAT, which defines how it is processed.
vatAgencyId_name	string		☐	Click the magnifier. > The name.
vatAgencyId_number	string		☐	Click the magnifier. > The identifier.
vatCategoryId_1	string		☐	VatCategoryId is deprecated, please use Vat Id instead
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_1	string		☐	Mandatory field: VAT settings tab > VAT ID* > The unique ID of the VAT.
vatId	string	VAT ID	☐	Mandatory field: VAT ID* > The ID of the VAT included in the category.
vatRate	double		☐	The VAT rate of the line.
vismaXmlVatType	string		☐	VAT settings tab > Visma XML VAT type > The VAT type to be used in Visma XML files.

22-12-2022 21:03 Version 22.1.101-BETA+3681

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

VatVats_CategoriesVatCategoryLinesVatRates

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information