VATCategoriesById: Visma.net Financials VAT Categories by ID
read only REST
- Catalog:
VismaNet - Schema:
Vat - Label: VAT Categories by ID
Get a specific Vat - TX205000
Can only retrieve data.
API Source
- Endpoint:
/v1/vat/{vatId} - Operation:
get /v1/vat/{vatId}
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 155 |
| Full scan rows per minute | 29,100 |
| Point query rows per minute | 387 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
include |
`` | Optional. If true, each VAT category in the response also includes its category lines (vatCategoryLines). Loading these requires extra queries, so it is off by default. Default is false. | ||
vatId |
`` | Mandatory. Value for VatID to be looked for. |
Table Columns
The columns of the table VATCategoriesById are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
COMPANY_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
active |
char |
Active | writable, active |
The top part > Active > A check box that means (if selected) that this VAT category is active. | |
calculate |
varchar2 |
itgen_vnet_calculateon | filters on the platform, writable, ::ancestor. |
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. | |
cash |
varchar2 |
Cash Discount | filters on the platform, writable, ::ancestor. |
VAT settings tab > Cash discount > The method of calculating the tax base amount if a cash discount is applied. | |
deductible |
char |
Deductible VAT | filters on the platform, writable, ::ancestor. |
VAT settings tab > Partially deductible VAT > A check box that indicates (if selected) that this is a deductible value-added VAT. | |
default |
varchar2 |
itgen_vnet_defaultnonstockitem_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
default |
varchar2 |
itgen_vnet_defaultnonstockitem_number | filters on the platform, writable, ::ancestor. |
Number of item | |
description |
varchar2 |
Description | writable, description |
The top part > Description > A detailed description of the category. | |
description_ |
varchar2 |
Description 2 | filters on the platform, writable, ::ancestor. |
VAT settings tab > Description > A detailed description of the VAT. | |
document |
varchar2 |
Document Text | filters on the platform, writable, ::ancestor. |
VAT Settings tab > Document text tab > Document text > The text to be printed to the VAT document. | |
enter |
char |
itgen_vnet_enterfromvatinvoice | filters on the platform, writable, ::ancestor. |
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. | |
eu |
varchar2 |
EU Report Code | filters on the platform, writable, ::ancestor. |
VAT settings tab > EU report code > The EU reporting code for the VAT. | |
exclude |
char |
itgen_vnet_excludelistedtaxes | writable, exclude |
The top part > Exclude listed taxes > A check box that indicates (if selected) this VAT category should exclude the listed taxes from VAT zones. | |
gl |
char |
itgen_vnet_glaccounts_vatclaimableaccount_active | filters on the platform, writable, ::ancestor. |
||
gl |
varchar2 |
itgen_vnet_glaccounts_vatclaimableaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatclaimableaccount_externalcode1 | filters on the platform, writable, ::ancestor. |
Account class > The identifier of the account class. | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatclaimableaccount_externalcode2 | filters on the platform, writable, ::ancestor. |
Account class > The name of the account class. | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatclaimableaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatclaimableaccount_type | filters on the platform, writable, ::ancestor. |
Account > The account number. | |
gl |
char |
itgen_vnet_glaccounts_vatclaimablesubccount_active | filters on the platform, writable, ::ancestor. |
||
gl |
varchar2 |
itgen_vnet_glaccounts_vatclaimablesubccount_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatclaimablesubccount_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
gl |
char |
itgen_vnet_glaccounts_vatpayableaccount_active | filters on the platform, writable, ::ancestor. |
||
gl |
varchar2 |
itgen_vnet_glaccounts_vatpayableaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatpayableaccount_externalcode1 | filters on the platform, writable, ::ancestor. |
Account class > The identifier of the account class. | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatpayableaccount_externalcode2 | filters on the platform, writable, ::ancestor. |
Account class > The name of the account class. | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatpayableaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatpayableaccount_type | filters on the platform, writable, ::ancestor. |
Account > The account number. | |
gl |
char |
itgen_vnet_glaccounts_vatpayablesubaccount_active | filters on the platform, writable, ::ancestor. |
||
gl |
varchar2 |
itgen_vnet_glaccounts_vatpayablesubaccount_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
gl |
varchar2 |
itgen_vnet_glaccounts_vatpayablesubaccount_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
includein |
char |
itgen_vnet_includeinvatexempttotal | filters on the platform, writable, ::ancestor. |
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. | |
includein |
char |
itgen_vnet_includeinvattotal | filters on the platform, writable, ::ancestor. |
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). | |
last |
datetime |
Last Modified | writable, last |
Systemgenerated information. | |
last |
datetime |
Last Modified Date/Time 2 | filters on the platform, writable, ::ancestor. |
System generated information. | |
not |
datetime |
Not Valid After | filters on the platform, writable, ::ancestor. |
VAT settings tab > Not valid after > The date after which the VAT is not effective. | |
pending |
char |
itgen_vnet_pendingvat | filters on the platform, writable, ::ancestor. |
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. | |
reverse |
char |
Reverse VAT | filters on the platform, writable, ::ancestor. |
VAT settings tab > Reverse VAT > A check box that indicates (if selected) that this is a reverse VAT. | |
statistical |
char |
Statistical VAT | filters on the platform, writable, ::ancestor. |
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 |
varchar2 |
Type | filters on the platform, writable, ::ancestor. |
VAT settings tab > VAT type > The type of VAT. | |
vat |
int64 |
itgen_vnet_vatagencyid_internalid | filters on the platform, writable, ::ancestor. |
The internal id of the supplier | |
vat |
varchar2 |
itgen_vnet_vatagencyid_name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
vat |
varchar2 |
itgen_vnet_vatagencyid_number | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The identifier. | |
vat |
varchar2 |
VAT Category ID | writable, vat |
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. | |
vat |
varchar2 |
itgen_vnet_vatcategoryid_2 | filters on the platform, writable, ::ancestor. |
VatCategoryId is deprecated, please use Vat Id instead | |
vatId |
varchar2 |
VAT ID | filters on the platform, writable, ::ancestor. |
Mandatory field: VAT settings tab > VAT ID* > The unique ID of the VAT. | |
visma |
varchar2 |
itgen_vnet_vismaxmlvattype | filters on the platform, writable, ::ancestor. |
VAT settings tab > Visma XML VAT type > The VAT type to be used in Visma XML files. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: