invantive documentation
Invantive Support ForumsLog In / Sign Up

AccountByCode: Visma.net Financials General Ledger Account by Code

read only REST

  • Catalog: VismaNet
  • Schema: Account
  • Label: General Ledger Account by Code

Get a specific Account - ScreenId=GL202500 Data for Account The response headers include an ETag after a successful GET operation.

Can only retrieve data.

Summary

Data for Account

The response headers include an ETag after a successful GET operation.

API Source

  • Endpoint: /v1/account/{accountCd}
  • Operation: get /v1/account/{accountCd}

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
accountCd `` Return the Information from Chart of account for the specified AccountCD
includeSubaccount `` Optional. If set to true, each account in the response includes its subaccount (subaccount). Default false.
includeSubaccountSegments `` Optional. Default false. If set to true, the response includes each account's subaccount together with its segments (segments), even if includeSubaccount is not set. Loading segments requires additional queries, so this option is disabled by default.

Table Columns

The columns of the table AccountByCode 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.
accountCD varchar2 Account Code filters on the platform, writable, accountCD Mandatory field: The table > Account* > The unique identifier of the general ledger account in the system.
accountClass varchar2 Account Class filters on the platform, writable, accountClass The table > Account class > Optional. The account class to which the account is assigned.
accountClassDescription varchar2 itgen_vnet_accountclassdescription filters on the platform, writable, accountClassDescription The table > Desc > An alphanumeric string of up to 30 characters that describes the AccountClass.
accountGroupCD varchar2 Account Group Code filters on the platform, writable, accountGroupCD The table > Account group > The account group (used in project management if the Projects module has been activated) that includes this account.
accountID int32 Account ID filters on the platform, writable, accountID The table > AccountID > The Account ID is the actual ID that the account have in the database and are used in other tables as the relation between the Chart of accounts table and other tables.
active char Active filters on the platform, writable, active The table > Active > A check box that indicates that the account is active.
allowManualEntry char itgen_vnet_allowmanualentry filters on the platform, writable, allowManualEntry
analisysCodeInfo_description varchar2 itgen_vnet_analisyscodeinfo_description filters on the platform, writable, analisysCodeInfo.description Name of item/description
analisysCodeInfo_number varchar2 itgen_vnet_analisyscodeinfo_number filters on the platform, writable, analisysCodeInfo.number Number of item
cashAccount char Cash Account filters on the platform, writable, cashAccount The table > Cash account > A check box that indicates (if selected) that the account has a cash account or multiple cash accounts linked to it.
controlAccountModule varchar2 itgen_vnet_controlaccountmodule filters on the platform, writable, controlAccountModule
currency varchar2 Currency filters on the platform, writable, currency The table > Currency > Optional: This column appears only if support for multiple currencies has been activated for the system.
description varchar2 Description filters on the platform, writable, description The table > Description > An alphanumeric string of up to 30 characters that describes the account.
errorInfo varchar2 Error Message filters on the platform, writable, errorInfo
externalCode1Info_description varchar2 itgen_vnet_externalcode1info_description filters on the platform, writable, externalCode1Info.description Name of item/description
externalCode1Info_number varchar2 itgen_vnet_externalcode1info_number filters on the platform, writable, externalCode1Info.number Number of item
externalCode2Info_description varchar2 itgen_vnet_externalcode2info_description filters on the platform, writable, externalCode2Info.description Name of item/description
externalCode2Info_number varchar2 itgen_vnet_externalcode2info_number filters on the platform, writable, externalCode2Info.number Number of item
lastModifiedDateTime datetime Last Modified filters on the platform, writable, lastModifiedDateTime This information is not visible in the window. It is collected from the system.
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, metadata.totalCount
postOption varchar2 Post Option filters on the platform, writable, postOption The table > Post option > An option that defines how transactions created in other workspaces are posted to this account. Summary (default) or Detail.
publicCode1 varchar2 Public Code 1 filters on the platform, writable, publicCode1 The table > Public code 1 > The authorities valid code mapped to the account. Used for example in SAF-T and in some nationals reporting to the authorities.
subaccount_active char Sub Account Active 2 filters on the platform, writable, subaccount.active Active > The status of the identifier.
subaccount_description varchar2 Subaccount Description filters on the platform, writable, subaccount.description Description > The description of the identifier.
subaccount_errorInfo varchar2 Sub Account Error Message filters on the platform, writable, subaccount.errorInfo
subaccount_lastModifiedDateTime datetime Sub Account Last Modified filters on the platform, writable, subaccount.lastModifiedDateTime System generated information.
subaccount_metadata_maxPageSize int64 Sub Account Metadata Max Pagesize filters on the platform, writable, subaccount.metadata.maxPageSize
subaccount_metadata_totalCount int64 Sub Account Metadata Total Count filters on the platform, writable, subaccount.metadata.totalCount
subaccount_subaccountId int32 Sub Account ID filters on the platform, writable, subaccount.subaccountId SubID > The identifier of the subaccount.
subaccount_subaccountNumber varchar2 Sub Account Number filters on the platform, writable, subaccount.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
subaccount_timeStamp blob itgen_vnet_subaccount_timestamp filters on the platform, writable, subaccount.timeStamp The timestamp of the subaccount, used for concurrency control.
taxCategory varchar2 Tax Category filters on the platform, writable, taxCategory The table > VAT category > A tax category that you define for the selected account. When you create a journal transaction manually in the GL301000 window, based on this VAT category, the taxable amount will be calculated for the journal entry.
timeStamp blob Timestamp filters on the platform, writable, timeStamp
type varchar2 Type filters on the platform, writable, type The table > Type > The type of account: Asset, Liability, Income, or Expense.
useDefaultSub char itgen_vnet_usedefaultsub filters on the platform, writable, useDefaultSub The table > Use default sub > A check box that causes the system (if selected) to set the default subaccount as the Subaccount if the account is selected.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: