WarehouseLocationsByWarehouseID: Visma.net Financials Warehouse Locations by Warehouse ID |
Get a specific Warehouse
Catalog: VismaNet
Schema: Warehouse
Label: Warehouse Locations 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 WarehouseLocationsByWarehouseID. 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 |
Default Value |
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 WarehouseLocationsByWarehouseID are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
active_1 |
boolean |
|
☐ |
The top part > Active > This check box indicates (if selected) that the warehouse is active. |
active |
boolean |
Active |
☐ |
Active > This check box indicates whether this location 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. |
assemblyValid |
boolean |
|
☐ |
Assembly allowed > You select this check box if assembly operations are allowed at this location. |
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_1 |
string |
|
☐ |
The top part > Description > A brief description of the warehouse. |
description |
string |
Description |
☐ |
Description > A brief description of the warehouse location. |
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. |
inclQtyAvail |
boolean |
|
☐ |
Include in qty. available > You select this check box if the quantities of goods available at this location will be included in the quantities of available goods and used in inventory transactions, such as issues and transfers. |
isCosted |
boolean |
|
☐ |
Cost separately > You select this check box if the costs for goods available at this location will be calculated separately from costs calculated at the system-level; that is, for FIFO and specific valuation methods, separate cost layers will be created for this location. |
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. |
locationId |
string |
Location ID |
☐ |
Location ID > The unique ID of the warehouse location. |
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. |
primaryItem_description |
string |
|
☐ |
Name of item/description |
primaryItem_number |
string |
|
☐ |
Number of item |
primaryItemClass_description |
string |
|
☐ |
Click on the magnifier. > The description. |
primaryItemClass_id |
string |
|
☐ |
Click on the magnifier. > The identifier. |
primaryItemClass_type |
string |
|
☐ |
|
primaryItemValid |
string |
|
☐ |
Primary item validation > An option indicating whether the operations with the primary item should be validated for this location and how. |
project_description |
string |
Project Description |
☐ |
Click on the magnifier. > The description. |
project_id |
string |
Project ID |
☐ |
Click on the magnifier. > The identifier. |
projectTask_description |
string |
Project Task Description |
☐ |
Click on the magnifier. > The description. |
projectTask_id |
string |
Project Task ID |
☐ |
Click on the magnifier. > The identifier. |
receiptLocation_description |
string |
|
☐ |
Click on the magnifier. > The description. |
receiptLocation_id |
string |
|
☐ |
Click on the magnifier. > The identifier. |
receiptsValid |
boolean |
|
☐ |
Receipts allowed > You select this check box if receipts are allowed at this location. |
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. |
salesValid |
boolean |
|
☐ |
Sales allowed > You select this check box if sales are allowed from this location. |
shipLocation_description |
string |
Ship Location Description |
☐ |
Click on the magnifier. > The description. |
shipLocation_id |
string |
Ship Location ID |
☐ |
Click on the magnifier. > The identifier. |
transfersValid |
boolean |
|
☐ |
Transfers allowed > You select this check box if transfers are allowed for this location. |
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