---
title: "BranchByNumber (Visma.net Financials)"
description: "Branch by Number"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/vismanet/VismaNet.Branch.BranchByNumber
original: https://documentation.invantive.eu/en/datamodels/vismanet/VismaNet.Branch.BranchByNumber
updated: 2026-11-01T17:49:50Z
license: https://documentation.invantive.eu/en/
---

# BranchByNumber: Visma.net Financials Branch by Number

`read only` `REST`

- Catalog: `VismaNet`
- Schema: `Branch`
- Label: Branch by Number

Get a specific branch

Can only retrieve data.

## API Source

- Endpoint: `/v1/branch/{branchNumber}`
- Operation: `get /v1/branch/{branchNumber}`

## 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 |
|---|---|:---:|---|---|
| `branchNumber` | `` | [x] |  | Identifies the branch |
| `expandAddress` | `` | [ ] |  | True to get main address for branch. |
| `expandBankSettings` | `` | [ ] |  | True to get payment settings for Branch. |
| `expandContact` | `` | [ ] |  | True to get main contact for a branch. |
| `expandCurrency` | `` | [ ] |  | True to get base currency for a branch. |
| `expandDefaultCountry` | `` | [ ] |  | True to get default country for a branch. |
| `expandDeliveryAddress` | `` | [ ] |  | True to get delivery address for a branch. |
| `expandDeliveryContact` | `` | [ ] |  | True to get delivery contact for a branch. |
| `expandIndustryCode` | `` | [ ] |  | True to get industry code for a branch. |
| `expandLedger` | `` | [ ] |  | True to get ledger for a branch. |
| `expandVatZone` | `` | [ ] |  | True to get vat zone for a branch. |

## Table Columns

The columns of the table `BranchByNumber` 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 | [x] | writable | Partition code, segmenting the data. |
| `COMPANY_NAME` | `varchar2(240)` | Company Name | [x] | writable | Name of the partition. |
| `bankSettings_bankAddress1` | `varchar2` | itgen_vnet_banksettings_bankaddress1 | [ ] | filters on the platform, writable, `bankSettings.bankAddress1` | Bank address1 |
| `bankSettings_bankAddress2` | `varchar2` | itgen_vnet_banksettings_bankaddress2 | [ ] | filters on the platform, writable, `bankSettings.bankAddress2` | BankAddress2 |
| `bankSettings_bankAddress3` | `varchar2` | itgen_vnet_banksettings_bankaddress3 | [ ] | filters on the platform, writable, `bankSettings.bankAddress3` | BankAddress3 |
| `bankSettings_bankCountry` | `varchar2` | itgen_vnet_banksettings_bankcountry | [ ] | filters on the platform, writable, `bankSettings.bankCountry` | BankCountry |
| `bankSettings_bankName` | `varchar2` | itgen_vnet_banksettings_bankname | [ ] | filters on the platform, writable, `bankSettings.bankName` | Bank name |
| `bankSettings_bbaN2` | `varchar2` | itgen_vnet_banksettings_bban2 | [ ] | filters on the platform, writable, `bankSettings.bbaN2` | BBAN2 |
| `bankSettings_bbaN3` | `varchar2` | itgen_vnet_banksettings_bban3 | [ ] | filters on the platform, writable, `bankSettings.bbaN3` | BBAN3 |
| `bankSettings_bban` | `varchar2` | itgen_vnet_banksettings_bban | [ ] | filters on the platform, writable, `bankSettings.bban` | BBAN |
| `bankSettings_bic` | `varchar2` | itgen_vnet_banksettings_bic | [ ] | filters on the platform, writable, `bankSettings.bic` | BIC |
| `bankSettings_creditorId` | `varchar2` | itgen_vnet_banksettings_creditorid | [ ] | filters on the platform, writable, `bankSettings.creditorId` | CreditorId |
| `bankSettings_iban` | `varchar2` | itgen_vnet_banksettings_iban | [ ] | filters on the platform, writable, `bankSettings.iban` | IBAN |
| `branchId` | `int32` | itgen_vnet_branchid | [ ] | filters on the platform, writable, `branchId` | The top part &gt; Branch ID* &gt; The unique identifier of the Branch |
| `corporateId` | `varchar2` | Corporate ID | [ ] | filters on the platform, writable, `corporateId` | The Organisation details tab &gt; VAT registration info section &gt; Corporate ID &gt; The corporate ID of the company. |
| `currency_description` | `varchar2` | Currency Description | [ ] | filters on the platform, writable, `currency.description` | Currency description. |
| `currency_id` | `varchar2` | Currency ID | [ ] | filters on the platform, writable, `currency.id` | Currency Id. |
| `currency_symbol` | `varchar2` | itgen_vnet_currency_symbol | [ ] | filters on the platform, writable, `currency.symbol` | Currency symbol. |
| `defaultCountry_errorInfo` | `varchar2` | itgen_vnet_defaultcountry_errorinfo | [ ] | filters on the platform, writable, `defaultCountry.errorInfo` |  |
| `defaultCountry_id` | `varchar2` | Default Country ID | [ ] | filters on the platform, writable, `defaultCountry.id` | Mandatory field: Country ID* &gt; The unique two-letter country ID according to international standard ISO 3166. |
| `defaultCountry_metadata_maxPageSize` | `int64` | itgen_vnet_defaultcountry_metadata_maxpagesize | [ ] | filters on the platform, writable, `defaultCountry.metadata.maxPageSize` |  |
| `defaultCountry_metadata_totalCount` | `int64` | itgen_vnet_defaultcountry_metadata_totalcount | [ ] | filters on the platform, writable, `defaultCountry.metadata.totalCount` |  |
| `defaultCountry_name` | `varchar2` | Default Country Name | [ ] | filters on the platform, writable, `defaultCountry.name` | Mandatory field: Country name* &gt; The complete name of the country. |
| `deliveryAddress_addressId` | `int32` | Delivery Address ID | [ ] | filters on the platform, writable, `deliveryAddress.addressId` |  |
| `deliveryAddress_addressLine1` | `varchar2` | Delivery Address Line 1 | [ ] | filters on the platform, writable, `deliveryAddress.addressLine1` | Address 1 &gt; The first line of the customer's/supplier's/company's/employee's contact address. |
| `deliveryAddress_addressLine2` | `varchar2` | Delivery Address Line 2 | [ ] | filters on the platform, writable, `deliveryAddress.addressLine2` | Address 2 &gt; The second line of the address. |
| `deliveryAddress_addressLine3` | `varchar2` | Delivery Address Line 3 | [ ] | filters on the platform, writable, `deliveryAddress.addressLine3` | Address 3 &gt; The third line of the address. |
| `deliveryAddress_city` | `varchar2` | Delivery Address City | [ ] | filters on the platform, writable, `deliveryAddress.city` | City &gt; The city. |
| `deliveryAddress_country_errorInfo` | `varchar2` | itgen_vnet_deliveryaddress_country_errorinfo | [ ] | filters on the platform, writable, `deliveryAddress.country.errorInfo` |  |
| `deliveryAddress_country_id` | `varchar2` | Delivery Address Country ID | [ ] | filters on the platform, writable, `deliveryAddress.country.id` | Mandatory field: Country ID* &gt; The unique two-letter country ID according to international standard ISO 3166. |
| `deliveryAddress_country_metadata_maxPageSize` | `int64` | itgen_vnet_deliveryaddress_country_metadata_maxpagesize | [ ] | filters on the platform, writable, `deliveryAddress.country.metadata.maxPageSize` |  |
| `deliveryAddress_country_metadata_totalCount` | `int64` | itgen_vnet_deliveryaddress_country_metadata_totalcount | [ ] | filters on the platform, writable, `deliveryAddress.country.metadata.totalCount` |  |
| `deliveryAddress_country_name` | `varchar2` | Delivery Address Country Name | [ ] | filters on the platform, writable, `deliveryAddress.country.name` | Mandatory field: Country name* &gt; The complete name of the country. |
| `deliveryAddress_county_id` | `varchar2` | Delivery Address County ID | [ ] | filters on the platform, writable, `deliveryAddress.county.id` | Click the magnifier &gt; The identifier |
| `deliveryAddress_county_name` | `varchar2` | Delivery Address County Name | [ ] | filters on the platform, writable, `deliveryAddress.county.name` | Click the magnifier &gt; The displayed name |
| `deliveryAddress_postalCode` | `varchar2` | Delivery Address Postal Code | [ ] | filters on the platform, writable, `deliveryAddress.postalCode` | Postcode &gt; The postcode. |
| `deliveryContact_attention` | `varchar2` | Delivery Contact Attention | [ ] | filters on the platform, writable, `deliveryContact.attention` | Attention &gt; 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 | [ ] | filters on the platform, writable, `deliveryContact.contactId` |  |
| `deliveryContact_email` | `varchar2` | Delivery Contact Email Address | [ ] | filters on the platform, writable, `deliveryContact.email` | Email &gt; The email address of the customer/supplier/company as a business entity. |
| `deliveryContact_fax` | `varchar2` | Delivery Contact Fax | [ ] | filters on the platform, writable, `deliveryContact.fax` | Fax &gt; The fax number. |
| `deliveryContact_name` | `varchar2` | Delivery Contact Name | [ ] | filters on the platform, writable, `deliveryContact.name` | Name &gt; The legal name of to appear on the documents. |
| `deliveryContact_phone1` | `varchar2` | Delivery Contact Phone 1 | [ ] | filters on the platform, writable, `deliveryContact.phone1` | Phone 1 &gt; The default phone number. |
| `deliveryContact_phone2` | `varchar2` | Delivery Contact Phone 2 | [ ] | filters on the platform, writable, `deliveryContact.phone2` | Phone 2 &gt; An additional phone number. |
| `deliveryContact_web` | `varchar2` | Delivery Contact Website | [ ] | filters on the platform, writable, `deliveryContact.web` | Web &gt; The website of the company, if one exists. |
| `industryCode_description` | `varchar2` | Industry Code Description | [ ] | filters on the platform, writable, `industryCode.description` | Click on the magnifier. &gt; The description. |
| `industryCode_id` | `varchar2` | Industry Code ID | [ ] | filters on the platform, writable, `industryCode.id` | Click on the magnifier. &gt; The identifier. |
| `isActive` | `char` | Is Active | [ ] | filters on the platform, writable, `isActive` | The top part &gt; Is active branch. |
| `isMainBranch` | `char` | Is Main Branch | [ ] | filters on the platform, writable, `isMainBranch` | The top part &gt; Is main organisation &gt; If you want this company to be the main company of your branches, select this check box. |
| `lastModifiedDateTime` | `datetime` | Last Modified | [ ] | filters on the platform, writable, `lastModifiedDateTime` | System generated information. This information is not visible in the window. |
| `ledger_description` | `varchar2` | Ledger Description | [ ] | filters on the platform, writable, `ledger.description` | Click on the magnifier. &gt; The description. |
| `ledger_id` | `varchar2` | Ledger ID | [ ] | filters on the platform, writable, `ledger.id` | Click on the magnifier. &gt; The identifier. |
| `mainAddress_addressId` | `int32` | Main Address ID | [ ] | filters on the platform, writable, `mainAddress.addressId` |  |
| `mainAddress_addressLine1` | `varchar2` | Main Address Line 1 | [ ] | filters on the platform, writable, `mainAddress.addressLine1` | Address 1 &gt; The first line of the customer's/supplier's/company's/employee's contact address. |
| `mainAddress_addressLine2` | `varchar2` | Main Address Line 2 | [ ] | filters on the platform, writable, `mainAddress.addressLine2` | Address 2 &gt; The second line of the address. |
| `mainAddress_addressLine3` | `varchar2` | Main Address Line 3 | [ ] | filters on the platform, writable, `mainAddress.addressLine3` | Address 3 &gt; The third line of the address. |
| `mainAddress_city` | `varchar2` | Main Address City | [ ] | filters on the platform, writable, `mainAddress.city` | City &gt; The city. |
| `mainAddress_country_errorInfo` | `varchar2` | itgen_vnet_mainaddress_country_errorinfo | [ ] | filters on the platform, writable, `mainAddress.country.errorInfo` |  |
| `mainAddress_country_id` | `varchar2` | Main Address Country ID | [ ] | filters on the platform, writable, `mainAddress.country.id` | Mandatory field: Country ID* &gt; The unique two-letter country ID according to international standard ISO 3166. |
| `mainAddress_country_metadata_maxPageSize` | `int64` | itgen_vnet_mainaddress_country_metadata_maxpagesize | [ ] | filters on the platform, writable, `mainAddress.country.metadata.maxPageSize` |  |
| `mainAddress_country_metadata_totalCount` | `int64` | itgen_vnet_mainaddress_country_metadata_totalcount | [ ] | filters on the platform, writable, `mainAddress.country.metadata.totalCount` |  |
| `mainAddress_country_name` | `varchar2` | Main Address Country Name | [ ] | filters on the platform, writable, `mainAddress.country.name` | Mandatory field: Country name* &gt; The complete name of the country. |
| `mainAddress_county_id` | `varchar2` | Main Address County ID | [ ] | filters on the platform, writable, `mainAddress.county.id` | Click the magnifier &gt; The identifier |
| `mainAddress_county_name` | `varchar2` | Main Address County Name | [ ] | filters on the platform, writable, `mainAddress.county.name` | Click the magnifier &gt; The displayed name |
| `mainAddress_postalCode` | `varchar2` | Main Address Postal Code | [ ] | filters on the platform, writable, `mainAddress.postalCode` | Postcode &gt; The postcode. |
| `mainContact_attention` | `varchar2` | Main Contact Attention | [ ] | filters on the platform, writable, `mainContact.attention` | Attention &gt; 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 | [ ] | filters on the platform, writable, `mainContact.contactId` |  |
| `mainContact_email` | `varchar2` | Main Contact Email Address | [ ] | filters on the platform, writable, `mainContact.email` | Email &gt; The email address of the customer/supplier/company as a business entity. |
| `mainContact_fax` | `varchar2` | Fax | [ ] | filters on the platform, writable, `mainContact.fax` | Fax &gt; The fax number. |
| `mainContact_name` | `varchar2` | Main Contact Name | [ ] | filters on the platform, writable, `mainContact.name` | Name &gt; The legal name of to appear on the documents. |
| `mainContact_phone1` | `varchar2` | Main Contact Phone 1 | [ ] | filters on the platform, writable, `mainContact.phone1` | Phone 1 &gt; The default phone number. |
| `mainContact_phone2` | `varchar2` | Main Contact Phone 2 | [ ] | filters on the platform, writable, `mainContact.phone2` | Phone 2 &gt; An additional phone number. |
| `mainContact_web` | `varchar2` | Main Contact Website | [ ] | filters on the platform, writable, `mainContact.web` | Web &gt; The website of the company, if one exists. |
| `name` | `varchar2` | Name | [ ] | filters on the platform, writable, `name` | The top part &gt; Company name &gt; The name of the company. |
| `number` | `varchar2` | Number | [ ] | filters on the platform, writable, `number` | Mandatory field: The top part &gt; Branch CD* &gt; The branch number , which you compose according to the rules defined by the BIZACCT segmented key. |
| `organizationId` | `int32` | Organisation ID | [ ] | filters on the platform, writable, `organizationId` |  |
| `vatRegistrationId` | `varchar2` | VAT Registration ID | [ ] | filters on the platform, writable, `vatRegistrationId` | The Organisation details tab &gt; VAT registration info section &gt; VAT registration ID &gt; The company registration ID for the country’s tax authority. |
| `vatZone_description` | `varchar2` | VAT Zone Description | [ ] | filters on the platform, writable, `vatZone.description` | Click on the magnifier. &gt; The description. |
| `vatZone_id` | `varchar2` | VAT Zone ID | [ ] | filters on the platform, writable, `vatZone.id` | Click on the magnifier. &gt; The identifier. |



## Release Notes

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

- [Visma.net Financials](/en/release-notes/drivers?driver=visma-net-financials)

