SupplierLocations |
Get a range of Locations - List screen=AP3030P1, Entry screen=AP303010Request 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: SupplierLocation
Label: {res:itgen_vnet_supplierlocations_plural}
Retrieve: true
Insert: true
Update: false
Delete: false
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function SupplierLocations. 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 |
---|---|---|---|---|
gln |
string |
☐ |
|
|
lastModifiedDateTime |
string |
☐ |
|
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 |
string |
☐ |
|
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 |
string |
☐ |
|
|
Columns of Table Function
The columns of the table function SupplierLocations 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.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
active |
boolean |
Active |
☐ |
The top part > Active > A check box that you select if the location is active. |
address_addressId |
int32 |
Address ID |
☐ |
|
address_addressLine1 |
string |
Address Line 1 |
☐ |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. |
address_addressLine2 |
string |
Address Line 2 |
☐ |
Address 2 > The second line of the address. |
address_addressLine3 |
string |
Address Line 3 |
☐ |
Address 3 > The third line of the address. |
address_city |
string |
City |
☐ |
City > The city. |
address_country_errorInfo |
string |
{res:itgen_vnet_address_country_errorinfo} |
☐ |
|
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 |
{res:itgen_vnet_address_country_metadata_maxpagesize} |
☐ |
|
address_country_metadata_totalCount |
int64 |
{res:itgen_vnet_address_country_metadata_totalcount} |
☐ |
|
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. |
baccount_internalId |
int32 |
{res:itgen_vnet_baccount_internalid} |
☐ |
|
baccount_name |
string |
{res:itgen_vnet_baccount_name} |
☐ |
The name of the particular destination of the selected type. |
baccount_number |
string |
{res:itgen_vnet_baccount_number} |
☐ |
The identifier of the particular destination of the selected type. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
contact_attention |
string |
{res:itgen_vnet_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. |
contact_contactId |
int32 |
Contact ID |
☐ |
|
contact_email |
string |
Contact Email |
☐ |
Email > The email address of the customer/supplier/company as a business entity. |
contact_fax |
string |
Contact Fax |
☐ |
Fax > The fax number. |
contact_name |
string |
Contact Name |
☐ |
Name > The legal name of to appear on the documents. |
contact_phone1 |
string |
Contact Phone 1 |
☐ |
Phone 1 > The default phone number. |
contact_phone2 |
string |
Contact Phone 2 |
☐ |
Phone 2 > An additional phone number. |
contact_web |
string |
Contact Website |
☐ |
Web > The website of the company, if one exists. |
corporateId |
string |
Corporate ID |
☐ |
General information tab > Location address section > Corporate ID > The corporate ID associated with the customer location. |
ediCode |
string |
EDI Code |
☐ |
General information tab > Location address section > EDI code > The EDI code to be used for the customer location. |
errorInfo |
string |
Error Message |
☐ |
|
gln |
string |
GLN |
☐ |
General information tab > Location address section > GLN > The GLN to be used for the customer location. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generation information |
locationId |
string |
Location ID |
☐ |
Mandatory field: The top part > Location ID* > The identifier of the location. Click the magnifier. |
locationName |
string |
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 |
☐ |
|
timeStamp |
byte[] |
Timestamp |
☐ |
Identifier that represents a specific version of the resource.It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers) |
vatRegistrationId |
string |
VAT Registration ID |
☐ |
General information tab > Location address section > VAT registration ID > The optional VAT registration ID associated with the location. |
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 |
{res:itgen_vnet_vatzone_errorinfo} |
☐ |
|
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 |
{res:itgen_vnet_vatzone_metadata_maxpagesize} |
☐ |
|
vatZone_metadata_totalCount |
int64 |
{res:itgen_vnet_vatzone_metadata_totalcount} |
☐ |
|
23-06-2025 19:16 Version 24.1.116-BETA+5455