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

LocationsByBAccountId: Visma.net Financials Locations by Bank Account ID

Get a range of Locations for a BAccountRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page sizeData for the Locations

Catalog: VismaNet

Schema: Location

Label: Locations by Bank Account ID

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 LocationsByBAccountId. 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	Required	Documentation
bAccountId	☑	Identifies the BAccount
createdDateTime	☐	This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created 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:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.
createdDateTimeCondition	☐	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:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.
gln	☐
greaterThanValue	☐	Greater than value. The item which is the object for this, varies from API to API.
lastModifiedDateTime	☐	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	☐	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__.
locationId	☐

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
active	char	Active	☐	The top part > Active > A check box that you select if the location is active.
address_addressId	int32	Address ID	☐
address_addressLine1	varchar2	Address Line 1	☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
address_addressLine2	varchar2	Address Line 2	☐	Address 2 > The second line of the address.
address_addressLine3	varchar2	Address Line 3	☐	Address 3 > The third line of the address.
address_city	varchar2	City	☐	City > The city.
address_country_errorInfo	varchar2		☐
address_country_id	varchar2	Country ID	☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
address_country_metadata_maxPageSize	int64		☐
address_country_metadata_totalCount	int64		☐
address_country_name	varchar2	Country Name	☐	Mandatory field: Country name* > The complete name of the country.
address_county_id	varchar2	County ID	☐	Click the magnifier > The identifier
address_county_name	varchar2	County Name	☐	Click the magnifier > The displayed name
address_postalCode	varchar2	Postal Code	☐	Postcode > The postcode.
baccount_internalId	int32		☐
baccount_name	varchar2		☐	The name of the particular destination of the selected type.
baccount_number	varchar2		☐	The identifier of the particular destination of the selected type.
COMPANY_CODE	varchar2(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	varchar2(240)	Company Name	☑	Name of the partition.
contact_attention	varchar2		☐	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.
contact_contactId	int32	Contact ID	☐
contact_email	varchar2	Contact Email	☐	Email > The email address of the customer/supplier/company as a business entity.
contact_fax	varchar2	Contact Fax	☐	Fax > The fax number.
contact_name	varchar2	Contact Name	☐	Name > The legal name of to appear on the documents.
contact_phone1	varchar2	Contact Phone 1	☐	Phone 1 > The default phone number.
contact_phone2	varchar2	Contact Phone 2	☐	Phone 2 > An additional phone number.
contact_web	varchar2	Contact Website	☐	Web > The website of the company, if one exists.
corporateId	varchar2	Corporate ID	☐	General information tab > Location address section > Corporate ID > The corporate ID associated with the customer location.
ediCode	varchar2	EDI Code	☐	General information tab > Location address section > EDI code > The EDI code to be used for the customer location.
errorInfo	varchar2	Error Message	☐
gln	varchar2	GLN	☐	General information tab > Location address section > GLN > The GLN to be used for the customer location.
internalId	int32	Internal ID	☐
lastModifiedDateTime	datetime	Last Modified	☐	System generation information
locationId	varchar2	Location ID	☐	Mandatory field: The top part > Location ID* > The identifier of the location. Click the magnifier.
locationName	varchar2	Location Name	☐	The top part > Location name > A descriptive name to help users recognize the location.
metadata_maxPageSize	int64	Metadata Max Pagesize	☐
metadata_totalCount	int64	Total Count	☐
peppolScheme_endpoint	varchar2		☐	Seller electronic address identification scheme identifier.The identification scheme identifier of the seller electronic address.
peppolScheme_partyIdentification	varchar2		☐	Buyer identifier identification scheme identifier.The identification scheme identifier of the Buyer identifier.
peppolScheme_partyLegal	varchar2		☐	Seller legal registration identifier identification scheme identifier.The identification scheme identifier of the Seller legal registration identifier.
vatRegistrationId	varchar2	VAT Registration ID	☐	General information tab > Location address section > VAT registration ID > The optional VAT registration ID associated with the location.
vatZone_defaultTaxCategory_description	varchar2	VAT Zone Default Tax Category Description	☐	Name of item/description
vatZone_defaultTaxCategory_number	varchar2	VAT Zone Default Tax Category Number	☐	Number of item
vatZone_defaultVatCategory	varchar2	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	varchar2	VAT Zone Description	☐	Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.
vatZone_errorInfo	varchar2		☐
vatZone_id	varchar2	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		☐

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

LocationsByBAccountId: Visma.net Financials Locations by Bank Account ID

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information