Navigation: Schema: Branch > Tables

BranchByNumber: Visma.net Financials Branch by Number

Get a specific branch

Catalog: VismaNet

Schema: Branch

Label: Branch by Number

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 BranchByNumber. 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	Documentation
branchNumber	string	☑	Identifies the branch
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.
expandAddress	boolean	☐	True to get main address for branch.
expandBankSettings	boolean	☐	True to get payment settings for Branch.
expandContact	boolean	☐	True to get main contact for a branch.
expandCurrency	boolean	☐	True to get base currency for a branch.
expandDefaultCountry	boolean	☐	True to get default country for a branch.
expandDeliveryAddress	boolean	☐	True to get delivery address for a branch.
expandDeliveryContact	boolean	☐	True to get delivery contact for a branch.
expandIndustryCode	boolean	☐	True to get industry code for a branch.
expandLedger	boolean	☐	True to get ledger for a branch.
expandVatZone	boolean	☐	True to get vat zone for a branch.

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
bankSettings_bankAddress1	string		☐	Bank address1
bankSettings_bankAddress2	string		☐	BankAddress2
bankSettings_bankAddress3	string		☐	BankAddress3
bankSettings_bankCountry	string		☐	BankCountry
bankSettings_bankName	string		☐	Bank name
bankSettings_bban	string		☐	BBAN
bankSettings_bbaN2	string		☐	BBAN2
bankSettings_bbaN3	string		☐	BBAN3
bankSettings_bic	string		☐	BIC
bankSettings_creditorId	string		☐	CreditorId
bankSettings_iban	string		☐	IBAN
branchId	int32		☐	The top part > Branch ID* > The unique identifier of the Branch
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	☐	The Organisation details tab > VAT registration info section > Corporate ID > The corporate ID of the company.
currency_description	string	Currency Description	☐	Currency description.
currency_id	string	Currency ID	☐	Currency Id.
currency_symbol	string		☐	Currency symbol.
defaultCountry_errorInfo	string		☐
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		☐
defaultCountry_metadata_totalCount	int64		☐
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		☐
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		☐
deliveryAddress_country_metadata_totalCount	int64		☐
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.
industryCode_description	string	Industry Code Description	☐	Click on the magnifier. > The description.
industryCode_id	string	Industry Code ID	☐	Click on the magnifier. > The identifier.
isActive	boolean	Is Active	☐	The top part > Is active branch.
isMainBranch	boolean	Is Main Branch	☐	The top part > Is main organisation > If you want this company to be the main company of your branches, select this check box.
lastModifiedDateTime	datetime	Last Modified	☐	System generated information. This information is not visible in the window.
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		☐
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		☐
mainAddress_country_metadata_totalCount	int64		☐
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	☐	The top part > Company name > The name of the company.
number	string	Number	☐	Mandatory field: The top part > Branch CD* > The branch number , which you compose according to the rules defined by the BIZACCT segmented key.
organizationId	int32	Organization ID	☐
vatRegistrationId	string	VAT Registration ID	☐	The Organisation details tab > VAT registration info section > VAT registration ID > The company registration ID for the country’s tax authority.
vatZone_description	string	VAT Zone Description	☐	Click on the magnifier. > The description.
vatZone_id	string	VAT Zone ID	☐	Click on the magnifier. > The identifier.

22-12-2022 21:03 Version 22.1.101-BETA+3681

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.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

BranchByNumber: Visma.net Financials Branch by Number

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information