invantive documentation
Invantive Support ForumsLog In / Sign Up

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
includeVatCategoryLines `` 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_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) 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.
calculateOn varchar2 itgen_vnet_calculateon filters on the platform, writable, ::ancestor.calculateOn 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 varchar2 Cash Discount filters on the platform, writable, ::ancestor.cashDiscount VAT settings tab > Cash discount > The method of calculating the tax base amount if a cash discount is applied.
deductibleVat char Deductible VAT filters on the platform, writable, ::ancestor.deductibleVat VAT settings tab > Partially deductible VAT > A check box that indicates (if selected) that this is a deductible value-added VAT.
defaultNonStockItem_description varchar2 itgen_vnet_defaultnonstockitem_description filters on the platform, writable, ::ancestor.defaultNonStockItem.description Name of item/description
defaultNonStockItem_number varchar2 itgen_vnet_defaultnonstockitem_number filters on the platform, writable, ::ancestor.defaultNonStockItem.number Number of item
description varchar2 Description writable, description The top part > Description > A detailed description of the category.
description_2 varchar2 Description 2 filters on the platform, writable, ::ancestor.description VAT settings tab > Description > A detailed description of the VAT.
documentText varchar2 Document Text filters on the platform, writable, ::ancestor.documentText VAT Settings tab > Document text tab > Document text > The text to be printed to the VAT document.
enterFromVatInvoice char itgen_vnet_enterfromvatinvoice filters on the platform, writable, ::ancestor.enterFromVatInvoice 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 varchar2 EU Report Code filters on the platform, writable, ::ancestor.euReportCode VAT settings tab > EU report code > The EU reporting code for the VAT.
excludeListedTaxes char itgen_vnet_excludelistedtaxes writable, excludeListedTaxes 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_active char itgen_vnet_glaccounts_vatclaimableaccount_active filters on the platform, writable, ::ancestor.glAccounts.vatClaimableAccount.active
glAccounts_vatClaimableAccount_description varchar2 itgen_vnet_glaccounts_vatclaimableaccount_description filters on the platform, writable, ::ancestor.glAccounts.vatClaimableAccount.description Name of item/description
glAccounts_vatClaimableAccount_externalCode1 varchar2 itgen_vnet_glaccounts_vatclaimableaccount_externalcode1 filters on the platform, writable, ::ancestor.glAccounts.vatClaimableAccount.externalCode1 Account class > The identifier of the account class.
glAccounts_vatClaimableAccount_externalCode2 varchar2 itgen_vnet_glaccounts_vatclaimableaccount_externalcode2 filters on the platform, writable, ::ancestor.glAccounts.vatClaimableAccount.externalCode2 Account class > The name of the account class.
glAccounts_vatClaimableAccount_number varchar2 itgen_vnet_glaccounts_vatclaimableaccount_number filters on the platform, writable, ::ancestor.glAccounts.vatClaimableAccount.number Number of item
glAccounts_vatClaimableAccount_type varchar2 itgen_vnet_glaccounts_vatclaimableaccount_type filters on the platform, writable, ::ancestor.glAccounts.vatClaimableAccount.type Account > The account number.
glAccounts_vatClaimableSubccount_active char itgen_vnet_glaccounts_vatclaimablesubccount_active filters on the platform, writable, ::ancestor.glAccounts.vatClaimableSubccount.active
glAccounts_vatClaimableSubccount_description varchar2 itgen_vnet_glaccounts_vatclaimablesubccount_description filters on the platform, writable, ::ancestor.glAccounts.vatClaimableSubccount.description Click on the magnifier. > The description.
glAccounts_vatClaimableSubccount_id varchar2 itgen_vnet_glaccounts_vatclaimablesubccount_id filters on the platform, writable, ::ancestor.glAccounts.vatClaimableSubccount.id Click on the magnifier. > The identifier.
glAccounts_vatPayableAccount_active char itgen_vnet_glaccounts_vatpayableaccount_active filters on the platform, writable, ::ancestor.glAccounts.vatPayableAccount.active
glAccounts_vatPayableAccount_description varchar2 itgen_vnet_glaccounts_vatpayableaccount_description filters on the platform, writable, ::ancestor.glAccounts.vatPayableAccount.description Name of item/description
glAccounts_vatPayableAccount_externalCode1 varchar2 itgen_vnet_glaccounts_vatpayableaccount_externalcode1 filters on the platform, writable, ::ancestor.glAccounts.vatPayableAccount.externalCode1 Account class > The identifier of the account class.
glAccounts_vatPayableAccount_externalCode2 varchar2 itgen_vnet_glaccounts_vatpayableaccount_externalcode2 filters on the platform, writable, ::ancestor.glAccounts.vatPayableAccount.externalCode2 Account class > The name of the account class.
glAccounts_vatPayableAccount_number varchar2 itgen_vnet_glaccounts_vatpayableaccount_number filters on the platform, writable, ::ancestor.glAccounts.vatPayableAccount.number Number of item
glAccounts_vatPayableAccount_type varchar2 itgen_vnet_glaccounts_vatpayableaccount_type filters on the platform, writable, ::ancestor.glAccounts.vatPayableAccount.type Account > The account number.
glAccounts_vatPayableSubaccount_active char itgen_vnet_glaccounts_vatpayablesubaccount_active filters on the platform, writable, ::ancestor.glAccounts.vatPayableSubaccount.active
glAccounts_vatPayableSubaccount_description varchar2 itgen_vnet_glaccounts_vatpayablesubaccount_description filters on the platform, writable, ::ancestor.glAccounts.vatPayableSubaccount.description Click on the magnifier. > The description.
glAccounts_vatPayableSubaccount_id varchar2 itgen_vnet_glaccounts_vatpayablesubaccount_id filters on the platform, writable, ::ancestor.glAccounts.vatPayableSubaccount.id Click on the magnifier. > The identifier.
includeinVatExemptTotal char itgen_vnet_includeinvatexempttotal filters on the platform, writable, ::ancestor.includeinVatExemptTotal 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 char itgen_vnet_includeinvattotal filters on the platform, writable, ::ancestor.includeinVatTotal 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 writable, lastModifiedDateTime Systemgenerated information.
lastModifiedDateTime_2 datetime Last Modified Date/Time 2 filters on the platform, writable, ::ancestor.lastModifiedDateTime System generated information.
notValidAfter datetime Not Valid After filters on the platform, writable, ::ancestor.notValidAfter VAT settings tab > Not valid after > The date after which the VAT is not effective.
pendingVat char itgen_vnet_pendingvat filters on the platform, writable, ::ancestor.pendingVat 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 char Reverse VAT filters on the platform, writable, ::ancestor.reverseVat VAT settings tab > Reverse VAT > A check box that indicates (if selected) that this is a reverse VAT.
statisticalVat char Statistical VAT filters on the platform, writable, ::ancestor.statisticalVat 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.type VAT settings tab > VAT type > The type of VAT.
vatAgencyId_internalId int64 itgen_vnet_vatagencyid_internalid filters on the platform, writable, ::ancestor.vatAgencyId.internalId The internal id of the supplier
vatAgencyId_name varchar2 itgen_vnet_vatagencyid_name filters on the platform, writable, ::ancestor.vatAgencyId.name Click the magnifier. > The name.
vatAgencyId_number varchar2 itgen_vnet_vatagencyid_number filters on the platform, writable, ::ancestor.vatAgencyId.number Click the magnifier. > The identifier.
vatCategoryId varchar2 VAT Category ID writable, vatCategoryId 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.
vatCategoryId_2 varchar2 itgen_vnet_vatcategoryid_2 filters on the platform, writable, ::ancestor.vatCategoryId VatCategoryId is deprecated, please use Vat Id instead
vatId varchar2 VAT ID filters on the platform, writable, ::ancestor.vatId Mandatory field: VAT settings tab > VAT ID* > The unique ID of the VAT.
vismaXmlVatType varchar2 itgen_vnet_vismaxmlvattype filters on the platform, writable, ::ancestor.vismaXmlVatType 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: