itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet 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.
Select Visma.net Financials API URL: /controller/api/v1/branch/{branchNumber}
Insert Visma.net Financials API URL: /controller/api/v1/branch/{branchNumber}
Update Visma.net Financials API URL: /controller/api/v1/branch/{branchNumber}
Delete Visma.net Financials API URL: /controller/api/v1/branch/{branchNumber}
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/branch/{branchNumber}
Table Function Parameters
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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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 |
|---|---|---|---|---|
branchNumber |
string |
☑ |
|
Identifies the branch |
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
expandBankSettings |
boolean |
☐ |
|
True to get payment settings for Branch. |
greaterThanValue |
string |
☐ |
|
Filter by branch ID greater than. |
lastModifiedDateTime |
string |
☐ |
|
System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present. |
lastModifiedDateTimeCondition |
string |
☐ |
|
System retrieved information for state/condition. |
numberToRead |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. |
orderBy |
string |
☐ |
|
Order by Branch ID |
skipRecords |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. |
Table Function Columns
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 |
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 |
☐ |
Click on the magnifier. > The description. |
currency_id |
string |
Currency ID |
☐ |
Click on the magnifier. > The identifier. |
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. |
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 > Organisation ID* > The unique identifier of the company, 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_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 |
|
☐ |
|
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 |
|
☐ |
|
vatZone_metadata_totalCount |
int64 |
|
☐ |
|
06-04-2021 14:55 Version 20.1.393-BETA+3152
