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 |
|---|---|---|---|---|
branch |
`` | Identifies the branch | ||
expand |
`` | True to get main address for branch. | ||
expand |
`` | True to get payment settings for Branch. | ||
expand |
`` | True to get main contact for a branch. | ||
expand |
`` | True to get base currency for a branch. | ||
expand |
`` | True to get default country for a branch. | ||
expand |
`` | True to get delivery address for a branch. | ||
expand |
`` | True to get delivery contact for a branch. | ||
expand |
`` | True to get industry code for a branch. | ||
expand |
`` | True to get ledger for a branch. | ||
expand |
`` | 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_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
bank |
varchar2 |
itgen_vnet_banksettings_bankaddress1 | filters on the platform, writable, bank |
Bank address1 | |
bank |
varchar2 |
itgen_vnet_banksettings_bankaddress2 | filters on the platform, writable, bank |
BankAddress2 | |
bank |
varchar2 |
itgen_vnet_banksettings_bankaddress3 | filters on the platform, writable, bank |
BankAddress3 | |
bank |
varchar2 |
itgen_vnet_banksettings_bankcountry | filters on the platform, writable, bank |
BankCountry | |
bank |
varchar2 |
itgen_vnet_banksettings_bankname | filters on the platform, writable, bank |
Bank name | |
bank |
varchar2 |
itgen_vnet_banksettings_bban2 | filters on the platform, writable, bank |
BBAN2 | |
bank |
varchar2 |
itgen_vnet_banksettings_bban3 | filters on the platform, writable, bank |
BBAN3 | |
bank |
varchar2 |
itgen_vnet_banksettings_bban | filters on the platform, writable, bank |
BBAN | |
bank |
varchar2 |
itgen_vnet_banksettings_bic | filters on the platform, writable, bank |
BIC | |
bank |
varchar2 |
itgen_vnet_banksettings_creditorid | filters on the platform, writable, bank |
CreditorId | |
bank |
varchar2 |
itgen_vnet_banksettings_iban | filters on the platform, writable, bank |
IBAN | |
branch |
int32 |
itgen_vnet_branchid | filters on the platform, writable, branch |
The top part > Branch ID* > The unique identifier of the Branch | |
corporate |
varchar2 |
Corporate ID | filters on the platform, writable, corporate |
The Organisation details tab > VAT registration info section > Corporate ID > The corporate ID of the company. | |
currency_ |
varchar2 |
Currency Description | filters on the platform, writable, currency. |
Currency description. | |
currency_ |
varchar2 |
Currency ID | filters on the platform, writable, currency. |
Currency Id. | |
currency_ |
varchar2 |
itgen_vnet_currency_symbol | filters on the platform, writable, currency. |
Currency symbol. | |
default |
varchar2 |
itgen_vnet_defaultcountry_errorinfo | filters on the platform, writable, default |
||
default |
varchar2 |
Default Country ID | filters on the platform, writable, default |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. | |
default |
int64 |
itgen_vnet_defaultcountry_metadata_maxpagesize | filters on the platform, writable, default |
||
default |
int64 |
itgen_vnet_defaultcountry_metadata_totalcount | filters on the platform, writable, default |
||
default |
varchar2 |
Default Country Name | filters on the platform, writable, default |
Mandatory field: Country name* > The complete name of the country. | |
delivery |
int32 |
Delivery Address ID | filters on the platform, writable, delivery |
||
delivery |
varchar2 |
Delivery Address Line 1 | filters on the platform, writable, delivery |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. | |
delivery |
varchar2 |
Delivery Address Line 2 | filters on the platform, writable, delivery |
Address 2 > The second line of the address. | |
delivery |
varchar2 |
Delivery Address Line 3 | filters on the platform, writable, delivery |
Address 3 > The third line of the address. | |
delivery |
varchar2 |
Delivery Address City | filters on the platform, writable, delivery |
City > The city. | |
delivery |
varchar2 |
itgen_vnet_deliveryaddress_country_errorinfo | filters on the platform, writable, delivery |
||
delivery |
varchar2 |
Delivery Address Country ID | filters on the platform, writable, delivery |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. | |
delivery |
int64 |
itgen_vnet_deliveryaddress_country_metadata_maxpagesize | filters on the platform, writable, delivery |
||
delivery |
int64 |
itgen_vnet_deliveryaddress_country_metadata_totalcount | filters on the platform, writable, delivery |
||
delivery |
varchar2 |
Delivery Address Country Name | filters on the platform, writable, delivery |
Mandatory field: Country name* > The complete name of the country. | |
delivery |
varchar2 |
Delivery Address County ID | filters on the platform, writable, delivery |
Click the magnifier > The identifier | |
delivery |
varchar2 |
Delivery Address County Name | filters on the platform, writable, delivery |
Click the magnifier > The displayed name | |
delivery |
varchar2 |
Delivery Address Postal Code | filters on the platform, writable, delivery |
Postcode > The postcode. | |
delivery |
varchar2 |
Delivery Contact Attention | filters on the platform, writable, delivery |
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. | |
delivery |
int32 |
Delivery Contact ID | filters on the platform, writable, delivery |
||
delivery |
varchar2 |
Delivery Contact Email Address | filters on the platform, writable, delivery |
Email > The email address of the customer/supplier/company as a business entity. | |
delivery |
varchar2 |
Delivery Contact Fax | filters on the platform, writable, delivery |
Fax > The fax number. | |
delivery |
varchar2 |
Delivery Contact Name | filters on the platform, writable, delivery |
Name > The legal name of to appear on the documents. | |
delivery |
varchar2 |
Delivery Contact Phone 1 | filters on the platform, writable, delivery |
Phone 1 > The default phone number. | |
delivery |
varchar2 |
Delivery Contact Phone 2 | filters on the platform, writable, delivery |
Phone 2 > An additional phone number. | |
delivery |
varchar2 |
Delivery Contact Website | filters on the platform, writable, delivery |
Web > The website of the company, if one exists. | |
industry |
varchar2 |
Industry Code Description | filters on the platform, writable, industry |
Click on the magnifier. > The description. | |
industry |
varchar2 |
Industry Code ID | filters on the platform, writable, industry |
Click on the magnifier. > The identifier. | |
is |
char |
Is Active | filters on the platform, writable, is |
The top part > Is active branch. | |
is |
char |
Is Main Branch | filters on the platform, writable, is |
The top part > Is main organisation > If you want this company to be the main company of your branches, select this check box. | |
last |
datetime |
Last Modified | filters on the platform, writable, last |
System generated information. This information is not visible in the window. | |
ledger_ |
varchar2 |
Ledger Description | filters on the platform, writable, ledger. |
Click on the magnifier. > The description. | |
ledger_ |
varchar2 |
Ledger ID | filters on the platform, writable, ledger. |
Click on the magnifier. > The identifier. | |
main |
int32 |
Main Address ID | filters on the platform, writable, main |
||
main |
varchar2 |
Main Address Line 1 | filters on the platform, writable, main |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. | |
main |
varchar2 |
Main Address Line 2 | filters on the platform, writable, main |
Address 2 > The second line of the address. | |
main |
varchar2 |
Main Address Line 3 | filters on the platform, writable, main |
Address 3 > The third line of the address. | |
main |
varchar2 |
Main Address City | filters on the platform, writable, main |
City > The city. | |
main |
varchar2 |
itgen_vnet_mainaddress_country_errorinfo | filters on the platform, writable, main |
||
main |
varchar2 |
Main Address Country ID | filters on the platform, writable, main |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. | |
main |
int64 |
itgen_vnet_mainaddress_country_metadata_maxpagesize | filters on the platform, writable, main |
||
main |
int64 |
itgen_vnet_mainaddress_country_metadata_totalcount | filters on the platform, writable, main |
||
main |
varchar2 |
Main Address Country Name | filters on the platform, writable, main |
Mandatory field: Country name* > The complete name of the country. | |
main |
varchar2 |
Main Address County ID | filters on the platform, writable, main |
Click the magnifier > The identifier | |
main |
varchar2 |
Main Address County Name | filters on the platform, writable, main |
Click the magnifier > The displayed name | |
main |
varchar2 |
Main Address Postal Code | filters on the platform, writable, main |
Postcode > The postcode. | |
main |
varchar2 |
Main Contact Attention | filters on the platform, writable, main |
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. | |
main |
int32 |
Main Contact ID | filters on the platform, writable, main |
||
main |
varchar2 |
Main Contact Email Address | filters on the platform, writable, main |
Email > The email address of the customer/supplier/company as a business entity. | |
main |
varchar2 |
Fax | filters on the platform, writable, main |
Fax > The fax number. | |
main |
varchar2 |
Main Contact Name | filters on the platform, writable, main |
Name > The legal name of to appear on the documents. | |
main |
varchar2 |
Main Contact Phone 1 | filters on the platform, writable, main |
Phone 1 > The default phone number. | |
main |
varchar2 |
Main Contact Phone 2 | filters on the platform, writable, main |
Phone 2 > An additional phone number. | |
main |
varchar2 |
Main Contact Website | filters on the platform, writable, main |
Web > The website of the company, if one exists. | |
name |
varchar2 |
Name | filters on the platform, writable, name |
The top part > Company name > The name of the company. | |
number |
varchar2 |
Number | filters on the platform, writable, number |
Mandatory field: The top part > Branch CD* > The branch number , which you compose according to the rules defined by the BIZACCT segmented key. | |
organization |
int32 |
Organisation ID | filters on the platform, writable, organization |
||
vat |
varchar2 |
VAT Registration ID | filters on the platform, writable, vat |
The Organisation details tab > VAT registration info section > VAT registration ID > The company registration ID for the country’s tax authority. | |
vat |
varchar2 |
VAT Zone Description | filters on the platform, writable, vat |
Click on the magnifier. > The description. | |
vat |
varchar2 |
VAT Zone ID | filters on the platform, writable, vat |
Click on the magnifier. > The identifier. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: