Navigation: Schema: Warehouse > Tables

WarehouseBywarehouseID: Visma.net Financials Warehouse by Warehouse ID

Get a specific Warehouse

Catalog: VismaNet

Schema: Warehouse

Label: Warehouse by Warehouse ID

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 WarehouseBywarehouseID. 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
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.
warehouseID	string	☑	Identifies the Warehouse

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
active	boolean	Active	☐	The top part > Active > This check box indicates (if selected) that the warehouse is active.
address_addressId	int32	Address ID	☐	Information retrieved from the system.
address_addressLine1	string	Address Line 1	☐	Address ! > The first line in the address of the warehouse.
address_addressLine2	string	Address Line 2	☐	Address 2 > The second line in the warehouse address.
address_addressType	string	Address Type	☐	Information retrieved from the system.
address_city	string	City	☐	City > The city of the warehouse address.
address_country_errorInfo	string		☐
address_country_id	string	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	string	Country Name	☐	Mandatory field: Country name* > The complete name of the country.
address_county_id	string	County ID	☐	Click the magnifier > The identifier
address_county_name	string	County Name	☐	Click the magnifier > The displayed name
address_postalCode	string	Postal Code	☐	Postcode > The postcode relevant for the warehouse address.
address_validated	boolean	Address Validated	☐	Information retrieved from the system.
avgDefaultCost	string		☐	The top part > Avg. default return cost > For items with the Average valuation method, the option that defines which of costs should be used for returns and receipts.
branch_name	string	Branch Name	☐	Click the magnifier. > The name.
branch_number	string	Branch Number	☐	Click the magnifier. > The identifier.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
contact_attention	string		☐	Attention > The department or person to be noted on the attention line, if this line is used by your company.
contact_companyName	string		☐	Company name > The legal business name of the warehouse to appear on the documents.
contact_contactId	int32	Contact ID	☐	Information retrieved from the system.
contact_email	string	Contact Email	☐	Email > The email address of the contact person assigned to this warehouse.
contact_fax	string	Contact Fax	☐	Fax > The fax number of the contact person assigned to this warehouse.
contact_phone1	string	Contact Phone 1	☐	Phone 1 > The primary phone number of the contact person assigned to this warehouse.
contact_phone2	string	Contact Phone 2	☐	Phone 2 > A secondary phone number of the contact person assigned to this warehouse.
contact_web	string	Contact Website	☐	Web > The URL of the web page where information about the warehouse is published.
description	string	Description	☐	The top part > Description > A brief description of the warehouse.
dropShipLocation_description	string		☐	Click on the magnifier. > The description.
dropShipLocation_id	string		☐	Click on the magnifier. > The identifier.
fifoDefaultCost	string		☐	The top part > FIFO default returns cost > For items with the FIFO valuation method, the option that defines which of costs should be used for returns and receipts.
locationEntry	string	Location Entry	☐	The top part > Location entry > An option indicating whether warehouse locations can be added directly on any inventory document or only by using this window.
lockSitePICountEntry	boolean		☐	The top part > Freeze the inventory when the stocktaking is in data entry state > This check box indicates (if selected) that the inventory in the warehouse will be frozen during the stocktaking and data entry stages of stocktaking.
receiptLocation_description	string		☐	Click on the magnifier. > The description.
receiptLocation_id	string		☐	Click on the magnifier. > The identifier.
replenishmentClass_description	string		☐	Click on the magnifier. > The description.
replenishmentClass_id	string		☐	Click on the magnifier. > The identifier.
returnLocation_description	string	Return Location Description	☐	Click on the magnifier. > The description.
returnLocation_id	string	Return Location ID	☐	Click on the magnifier. > The identifier.
shipLocation_description	string	Ship Location Description	☐	Click on the magnifier. > The description.
shipLocation_id	string	Ship Location ID	☐	Click on the magnifier. > The identifier.
warehouseID	string	Warehouse ID	☐	Mandatory field: The top part > Warehouse ID* > The unique ID of the warehouse.

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

WarehouseBywarehouseID: Visma.net Financials Warehouse by Warehouse ID

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information