VATSchedulesById: Visma.net Financials VAT Schedules by ID |
Get a specific Vat - TX205000
Catalog: VismaNet
Schema: Vat
Label: VAT Schedules by ID
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 VATSchedulesById. 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. |
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. |
vatId |
string |
☑ |
|
Mandatory. Value for VatID to be looked for. |
Columns of Table Function
The columns of the table function VATSchedulesById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
calculateOn |
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. |
cashDiscount |
string |
Cash Discount |
☐ |
VAT settings tab > Cash discount > The method of calculating the tax base amount if a cash discount is applied. |
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. |
deductibleVatRate |
double |
|
☐ |
Deductible VAT rate > The VAT rate (%) that is used to calculate the amount deductible from the output VAT. |
defaultNonStockItem_description |
string |
|
☐ |
Name of item/description |
defaultNonStockItem_number |
string |
|
☐ |
Number of item |
description |
string |
Description |
☐ |
VAT settings tab > Description > A detailed description of the VAT. |
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. |
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. |
groupType |
string |
Group Type |
☐ |
Group type > The type of the reporting group. |
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 |
datetime |
Last Modified |
☐ |
System generated information. |
maxTaxableAmt |
double |
|
☐ |
Max. taxable amount > The maximum taxable amount for which this rate applies. |
minTaxableAmt |
double |
|
☐ |
Min. taxable amount > The minimum taxable amount for which this rate is applicable. |
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. |
reportingGroup |
string |
|
☐ |
Reporting group > The reporting group for the VAT. |
reverseVat |
boolean |
Reverse VAT |
☐ |
VAT settings tab > Reverse VAT > A check box that indicates (if selected) that this is a reverse VAT. |
startDate |
datetime |
Start Date |
☐ |
Mandatory field: Start date > The date when the VAT at the rate in the current row becomes 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 |
string |
Type |
☐ |
VAT settings tab > VAT type > The type of VAT. |
vatAgencyId_name |
string |
|
☐ |
Click the magnifier. > The name. |
vatAgencyId_number |
string |
|
☐ |
Click the magnifier. > The identifier. |
vatCategoryId |
string |
VAT Category ID |
☐ |
VatCategoryId is deprecated, please use Vat Id instead |
vatId |
string |
VAT ID |
☐ |
Mandatory field: VAT settings tab > VAT ID* > The unique ID of the VAT. |
vatRate |
double |
|
☐ |
VAT rate > The VAT rate (%) that is used to calculate the VAT amount. |
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