Please enable JavaScript to view this site.

Made in EU
Visma.net Financials Forums

Visma.net Financials API Data Model

Navigation: Catalog: VismaNet > Schemas > Schema: Organization > Tables

OrganizationByOrganization

Get organisation information by organization number.Data for a single organization. The response headers include an ETag after a successful GET operation.

Catalog: VismaNet

Schema: Organization

Label: {res:itgen_vnet_organizationbyorganization_plural}

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL 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 OrganizationByOrganization. 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

expandBankSettings

boolean

☐

 

True to expand payment settings for organization.

expandBranches

boolean

☐

 

True to expand all Branches related to this Organization.

greaterThanValue

string

☐

 

Greater than value. The item which is the object for this, varies from API to API.

lastModifiedDateTime

string

☐

 

This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd HH:mm:ss```* ```yyyy-MM-dd HH:mm:ss.FFF```* ```yyyy-MM-ddTHH:mm:ss```* ```yyyy-MM-ddTHH:mm:ss.FFF```_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.

lastModifiedDateTimeCondition

string

☐

 

This value represents the condition to be applied when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.

organizationNumber

string

☑

 

The organisation code.

 

Columns of Table Function

The columns of the table function OrganizationByOrganization are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

bankSettings_bankAddress1

string

{res:itgen_vnet_banksettings_bankaddress1}

☐

Bank address1

bankSettings_bankAddress2

string

{res:itgen_vnet_banksettings_bankaddress2}

☐

BankAddress2

bankSettings_bankAddress3

string

{res:itgen_vnet_banksettings_bankaddress3}

☐

BankAddress3

bankSettings_bankCountry

string

{res:itgen_vnet_banksettings_bankcountry}

☐

BankCountry

bankSettings_bankName

string

{res:itgen_vnet_banksettings_bankname}

☐

Bank name

bankSettings_bban

string

{res:itgen_vnet_banksettings_bban}

☐

BBAN

bankSettings_bbaN2

string

{res:itgen_vnet_banksettings_bban2}

☐

BBAN2

bankSettings_bbaN3

string

{res:itgen_vnet_banksettings_bban3}

☐

BBAN3

bankSettings_bic

string

{res:itgen_vnet_banksettings_bic}

☐

BIC

bankSettings_creditorId

string

{res:itgen_vnet_banksettings_creditorid}

☐

CreditorId

bankSettings_iban

string

{res:itgen_vnet_banksettings_iban}

☐

IBAN

baseCurrency

string

{res:itgen_vnet_basecurrency}

☐

Base Currency

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

corporateId

string

Corporate ID

☐

CorporateId

currency_decimalPrecision

int32

{res:itgen_vnet_currency_decimalprecision}

☐

Decimal precision.

currency_description

string

Currency Description

☐

Currency description.

currency_id

string

Currency ID

☐

Currency Id.

currency_isBaseCurrency

boolean

{res:itgen_vnet_currency_isbasecurrency}

☐

Identify if the currency is the base currency.

currency_isUsedForAccounting

boolean

{res:itgen_vnet_currency_isusedforaccounting}

☐

Identify if is used for accounting.

currency_symbol

string

{res:itgen_vnet_currency_symbol}

☐

Currency symbol.

defaultCountry_errorInfo

string

{res:itgen_vnet_defaultcountry_errorinfo}

☐

 

defaultCountry_id

string

Default Country ID

☐

Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.

defaultCountry_metadata_maxPageSize

int64

{res:itgen_vnet_defaultcountry_metadata_maxpagesize}

☐

 

defaultCountry_metadata_totalCount

int64

{res:itgen_vnet_defaultcountry_metadata_totalcount}

☐

 

defaultCountry_name

string

Default Country Name

☐

Mandatory field: Country name* > The complete name of the country.

deliveryAddress_addressId

int32

Delivery Address ID

☐

 

deliveryAddress_addressLine1

string

Delivery Address Line 1

☐

Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.

deliveryAddress_addressLine2

string

Delivery Address Line 2

☐

Address 2 > The second line of the address.

deliveryAddress_addressLine3

string

Delivery Address Line 3

☐

Address 3 > The third line of the address.

deliveryAddress_city

string

Delivery Address City

☐

City > The city.

deliveryAddress_country_errorInfo

string

{res:itgen_vnet_deliveryaddress_country_errorinfo}

☐

 

deliveryAddress_country_id

string

Delivery Address Country ID

☐

Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.

deliveryAddress_country_metadata_maxPageSize

int64

{res:itgen_vnet_deliveryaddress_country_metadata_maxpagesize}

☐

 

deliveryAddress_country_metadata_totalCount

int64

{res:itgen_vnet_deliveryaddress_country_metadata_totalcount}

☐

 

deliveryAddress_country_name

string

Delivery Address Country Name

☐

Mandatory field: Country name* > The complete name of the country.

deliveryAddress_county_id

string

Delivery Address County ID

☐

Click the magnifier > The identifier

deliveryAddress_county_name

string

Delivery Address County Name

☐

Click the magnifier > The displayed name

deliveryAddress_postalCode

string

Delivery Address Postal Code

☐

Postcode > The postcode.

deliveryContact_attention

string

Delivery Contact Attention

☐

Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person.

deliveryContact_contactId

int32

Delivery Contact ID

☐

 

deliveryContact_email

string

Delivery Contact Email Address

☐

Email > The email address of the customer/supplier/company as a business entity.

deliveryContact_fax

string

Delivery Contact Fax

☐

Fax > The fax number.

deliveryContact_name

string

Delivery Contact Name

☐

Name > The legal name of to appear on the documents.

deliveryContact_phone1

string

Delivery Contact Phone 1

☐

Phone 1 > The default phone number.

deliveryContact_phone2

string

Delivery Contact Phone 2

☐

Phone 2 > An additional phone number.

deliveryContact_web

string

Delivery Contact Website

☐

Web > The website of the company, if one exists.

fileTaxByBranches

boolean

{res:itgen_vnet_filetaxbybranches}

☐

File Tax By Branches

industryCode_description

string

Industry Code Description

☐

Click on the magnifier. > The description.

industryCode_id

string

Industry Code ID

☐

Click on the magnifier. > The identifier.

lastModifiedDateTime

datetime

Last Modified

☐

LastModifiedDateTime

ledger_description

string

Ledger Description

☐

Click on the magnifier. > The description.

ledger_id

string

Ledger ID

☐

Click on the magnifier. > The identifier.

mainAddress_addressId

int32

Main Address ID

☐

 

mainAddress_addressLine1

string

Main Address Line 1

☐

Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.

mainAddress_addressLine2

string

Main Address Line 2

☐

Address 2 > The second line of the address.

mainAddress_addressLine3

string

Main Address Line 3

☐

Address 3 > The third line of the address.

mainAddress_city

string

Main Address City

☐

City > The city.

mainAddress_country_errorInfo

string

{res:itgen_vnet_mainaddress_country_errorinfo}

☐

 

mainAddress_country_id

string

Main Address Country ID

☐

Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.

mainAddress_country_metadata_maxPageSize

int64

{res:itgen_vnet_mainaddress_country_metadata_maxpagesize}

☐

 

mainAddress_country_metadata_totalCount

int64

{res:itgen_vnet_mainaddress_country_metadata_totalcount}

☐

 

mainAddress_country_name

string

Main Address Country Name

☐

Mandatory field: Country name* > The complete name of the country.

mainAddress_county_id

string

Main Address County ID

☐

Click the magnifier > The identifier

mainAddress_county_name

string

Main Address County Name

☐

Click the magnifier > The displayed name

mainAddress_postalCode

string

Main Address Postal Code

☐

Postcode > The postcode.

mainContact_attention

string

Main Contact Attention

☐

Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person.

mainContact_contactId

int32

Main Contact ID

☐

 

mainContact_email

string

Main Contact Email Address

☐

Email > The email address of the customer/supplier/company as a business entity.

mainContact_fax

string

Fax

☐

Fax > The fax number.

mainContact_name

string

Main Contact Name

☐

Name > The legal name of to appear on the documents.

mainContact_phone1

string

Main Contact Phone 1

☐

Phone 1 > The default phone number.

mainContact_phone2

string

Main Contact Phone 2

☐

Phone 2 > An additional phone number.

mainContact_web

string

Main Contact Website

☐

Web > The website of the company, if one exists.

name

string

Name

☐

Name

organizationCd

string

{res:itgen_vnet_organizationcd}

☐

Organization Cd

organizationType

string

{res:itgen_vnet_organizationtype}

☐

Organization Type

timeStamp

byte[]

Timestamp

☐

Identifier that represents a specific version of the resource.It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)

vatRegistrationId

string

VAT Registration ID

☐

VatRegistrationId

vatZone_defaultTaxCategory_description

string

VAT Zone Default Tax Category Description

☐

Name of item/description

vatZone_defaultTaxCategory_number

string

VAT Zone Default Tax Category Number

☐

Number of item

vatZone_defaultVatCategory

string

VAT Zone Default VAT Category

☐

Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window.

vatZone_description

string

VAT Zone Description

☐

Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.

vatZone_errorInfo

string

{res:itgen_vnet_vatzone_errorinfo}

☐

 

vatZone_id

string

VAT Zone ID

☐

Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.

vatZone_metadata_maxPageSize

int64

{res:itgen_vnet_vatzone_metadata_maxpagesize}

☐

 

vatZone_metadata_totalCount

int64

{res:itgen_vnet_vatzone_metadata_totalcount}

☐

 

 

23-06-2025 19:16 Version 24.1.116-BETA+5455

X

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.
  
Disclaimer