SupplierByCode: Visma.net Financials Supplier by Code |
Get a specific supplierData for a single supplier. The response headers include an ETag after a successful GET operation.
Catalog: VismaNet
Schema: Supplier
Label: Supplier by Code
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 SupplierByCode. 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 |
---|---|---|---|---|
supplierCd |
string |
☑ |
|
Identifies the supplier |
Columns of Table Function
The columns of the table function SupplierByCode are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
accountReference |
string |
Account Reference |
☐ |
General information tab > Main contact section > Account ref. > An optional text field that can contain a reference to your company's account number in the supplier's system. |
accountUsedForPayment |
string |
{res:itgen_vnet_accountusedforpayment} |
☐ |
Payment settings tab > Payment settings section > Account used for payment > The bank account to be used for payments to the supplier. |
cashAccount |
string |
Cash Account |
☐ |
Payment settings tab > Payment settings section > Cash account > The cash account to be used for operations with the supplier. You must select a cash account. |
chargeBearer |
string |
Charge Bearer |
☐ |
Payment settings tab > Payment settings section > Charge bearer > The party that will pay possible expenses connected with the payment. |
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 |
☐ |
Purchase settings tab > Default location settings section > National insurance no. > The supplier’s national insurance number associated with the location. |
creditTerms_description |
string |
Credit Terms Description |
☐ |
Click on the magnifier. > The description. |
creditTerms_id |
string |
Credit Terms ID |
☐ |
Click on the magnifier. > The identifier. |
currencyId |
string |
Currency ID |
☐ |
General information tab > Financial settings section > Currency ID > The currency that is used in operations with the supplier. |
currencyOverride |
boolean |
{res:itgen_vnet_currencyoverride} |
☐ |
General information tab > Financial settings section > Enable currency override |
currencyRateOverride |
boolean |
{res:itgen_vnet_currencyrateoverride} |
☐ |
General information tab > Financial settings section > Enable rate override |
documentLanguage |
string |
Document Language |
☐ |
General information tab > Financial settings section > Document language > The language of the documents to be printed to the suppliers of the class. |
errorInfo |
string |
Error Message |
☐ |
|
glAccounts_expenseAccount_description |
string |
{res:itgen_vnet_glaccounts_expenseaccount_description} |
☐ |
Name of item/description |
glAccounts_expenseAccount_number |
string |
{res:itgen_vnet_glaccounts_expenseaccount_number} |
☐ |
Number of item |
glAccounts_expenseAccount_type |
string |
{res:itgen_vnet_glaccounts_expenseaccount_type} |
☐ |
|
glAccounts_expenseAccountImport_description |
string |
{res:itgen_vnet_glaccounts_expenseaccountimport_description} |
☐ |
Name of item/description |
glAccounts_expenseAccountImport_number |
string |
{res:itgen_vnet_glaccounts_expenseaccountimport_number} |
☐ |
Number of item |
glAccounts_expenseAccountImport_type |
string |
{res:itgen_vnet_glaccounts_expenseaccountimport_type} |
☐ |
|
glAccounts_expenseAccountNonTax_description |
string |
{res:itgen_vnet_glaccounts_expenseaccountnontax_description} |
☐ |
Name of item/description |
glAccounts_expenseAccountNonTax_number |
string |
{res:itgen_vnet_glaccounts_expenseaccountnontax_number} |
☐ |
Number of item |
glAccounts_expenseAccountNonTax_type |
string |
{res:itgen_vnet_glaccounts_expenseaccountnontax_type} |
☐ |
|
glAccounts_expenseEUAccount_description |
string |
{res:itgen_vnet_glaccounts_expenseeuaccount_description} |
☐ |
Name of item/description |
glAccounts_expenseEUAccount_number |
string |
{res:itgen_vnet_glaccounts_expenseeuaccount_number} |
☐ |
Number of item |
glAccounts_expenseEUAccount_type |
string |
{res:itgen_vnet_glaccounts_expenseeuaccount_type} |
☐ |
|
glAccounts_expenseSubaccount_active |
boolean |
{res:itgen_vnet_glaccounts_expensesubaccount_active} |
☐ |
|
glAccounts_expenseSubaccount_description |
string |
{res:itgen_vnet_glaccounts_expensesubaccount_description} |
☐ |
Click on the magnifier. > The description. |
glAccounts_expenseSubaccount_id |
string |
{res:itgen_vnet_glaccounts_expensesubaccount_id} |
☐ |
Click on the magnifier. > The identifier. |
glAccounts_supplierAccount_description |
string |
{res:itgen_vnet_glaccounts_supplieraccount_description} |
☐ |
Name of item/description |
glAccounts_supplierAccount_number |
string |
{res:itgen_vnet_glaccounts_supplieraccount_number} |
☐ |
Number of item |
glAccounts_supplierAccount_type |
string |
{res:itgen_vnet_glaccounts_supplieraccount_type} |
☐ |
|
glAccounts_supplierSubaccount_active |
boolean |
{res:itgen_vnet_glaccounts_suppliersubaccount_active} |
☐ |
|
glAccounts_supplierSubaccount_description |
string |
{res:itgen_vnet_glaccounts_suppliersubaccount_description} |
☐ |
Click on the magnifier. > The description. |
glAccounts_supplierSubaccount_id |
string |
{res:itgen_vnet_glaccounts_suppliersubaccount_id} |
☐ |
Click on the magnifier. > The identifier. |
internalId |
int32 |
Internal ID |
☐ |
|
landedCostSupplier |
boolean |
{res:itgen_vnet_landedcostsupplier} |
☐ |
General information tab > SupplierProperties > Landed Cost Supplier > Indicates if the supplier is a landed cost supplier or not |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
location_countryId |
string |
Location Country ID |
☐ |
Location*. |
location_id |
string |
Location ID |
☐ |
Click the magnifier > The identifier |
location_name |
string |
Location Name |
☐ |
Click the magnifier > The displayed name |
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 |
{res:itgen_vnet_mainaddress_country_errorinfo} |
☐ |
|
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 |
{res:itgen_vnet_mainaddress_country_metadata_maxpagesize} |
☐ |
|
mainAddress_country_metadata_totalCount |
int64 |
{res:itgen_vnet_mainaddress_country_metadata_totalcount} |
☐ |
|
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. |
metadata_maxPageSize |
int64 |
Metadata Max Pagesize |
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
naceCode |
string |
{res:itgen_vnet_nacecode} |
☐ |
General information tab > Main contact section > Industry Code ID > The supplier's NACE code |
name |
string |
Name |
☐ |
Mandatory field: The top part > Supplier name* > The name of the supplier to appear in the system, which may be a trade name or a doing-business-as (DBA) name. |
note |
string |
Note |
☐ |
|
number |
string |
Number |
☐ |
Mandatory field: The top part > Supplier ID* > The ID of the supplier account. |
numberOfEmployees |
int32 |
Number of Employees |
☐ |
Legal requirements that all companies with more than 250 employees keep track of their business accounts |
parentRecord_name |
string |
Parent Record Name |
☐ |
Click the magnifier. > The name. |
parentRecord_number |
string |
Parent Record Number |
☐ |
Click the magnifier. > The identifier. |
paymentBy |
string |
Payment by |
☐ |
Payment settings tab > Payment settings section > Payment by > An option that defines how to calculate the date when this supplier should be paid. |
paymentLeadTime |
int32 |
{res:itgen_vnet_paymentleadtime} |
☐ |
Payment settings tab > Payment settings section > Payment lead time (days) > The number of days required for the payment to be delivered to the supplier's location. |
paymentMethod_description |
string |
Payment Method Description |
☐ |
Click on the magnifier. > The description. |
paymentMethod_id |
string |
Payment Method ID |
☐ |
Click on the magnifier. > The identifier. |
paymentRefDisplayMask |
string |
{res:itgen_vnet_paymentrefdisplaymask} |
☐ |
Payment settings tab > Payment settings section > Payment ref. display mask > This is a rule (mask) for how the payment reference number will be displayed. |
paySeparately |
boolean |
{res:itgen_vnet_payseparately} |
☐ |
Payment settings tab > Payment settings section > Pay separately > A check box that indicates (if selected) that each supplier document should be paid by a separate payment. |
remitAddress_addressId |
int32 |
{res:itgen_vnet_remitaddress_addressid} |
☐ |
|
remitAddress_addressLine1 |
string |
{res:itgen_vnet_remitaddress_addressline1} |
☐ |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. |
remitAddress_addressLine2 |
string |
{res:itgen_vnet_remitaddress_addressline2} |
☐ |
Address 2 > The second line of the address. |
remitAddress_addressLine3 |
string |
{res:itgen_vnet_remitaddress_addressline3} |
☐ |
Address 3 > The third line of the address. |
remitAddress_city |
string |
{res:itgen_vnet_remitaddress_city} |
☐ |
City > The city. |
remitAddress_country_errorInfo |
string |
{res:itgen_vnet_remitaddress_country_errorinfo} |
☐ |
|
remitAddress_country_id |
string |
{res:itgen_vnet_remitaddress_country_id} |
☐ |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. |
remitAddress_country_metadata_maxPageSize |
int64 |
{res:itgen_vnet_remitaddress_country_metadata_maxpagesize} |
☐ |
|
remitAddress_country_metadata_totalCount |
int64 |
{res:itgen_vnet_remitaddress_country_metadata_totalcount} |
☐ |
|
remitAddress_country_name |
string |
{res:itgen_vnet_remitaddress_country_name} |
☐ |
Mandatory field: Country name* > The complete name of the country. |
remitAddress_county_id |
string |
{res:itgen_vnet_remitaddress_county_id} |
☐ |
Click the magnifier > The identifier |
remitAddress_county_name |
string |
{res:itgen_vnet_remitaddress_county_name} |
☐ |
Click the magnifier > The displayed name |
remitAddress_postalCode |
string |
{res:itgen_vnet_remitaddress_postalcode} |
☐ |
Postcode > The postcode. |
remitContact_attention |
string |
{res:itgen_vnet_remitcontact_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. |
remitContact_contactId |
int32 |
{res:itgen_vnet_remitcontact_contactid} |
☐ |
|
remitContact_email |
string |
{res:itgen_vnet_remitcontact_email} |
☐ |
Email > The email address of the customer/supplier/company as a business entity. |
remitContact_fax |
string |
{res:itgen_vnet_remitcontact_fax} |
☐ |
Fax > The fax number. |
remitContact_name |
string |
{res:itgen_vnet_remitcontact_name} |
☐ |
Name > The legal name of to appear on the documents. |
remitContact_phone1 |
string |
{res:itgen_vnet_remitcontact_phone1} |
☐ |
Phone 1 > The default phone number. |
remitContact_phone2 |
string |
{res:itgen_vnet_remitcontact_phone2} |
☐ |
Phone 2 > An additional phone number. |
remitContact_web |
string |
{res:itgen_vnet_remitcontact_web} |
☐ |
Web > The website of the company, if one exists. |
retainageApply |
boolean |
{res:itgen_vnet_retainageapply} |
☐ |
Payment settings tab > Retainage settings section > Apply retainage > A check box that indicates (if selected) that by default, invoices with retainage are created for the supplier in the Purchase invoices window. |
retainageCashAccountID |
string |
{res:itgen_vnet_retainagecashaccountid} |
☐ |
Payment settings tab > Retainage settings section > Retainage cash account > The cash account to be used to record retainages for this supplier. |
retainagePct |
double |
Retainage Percentage |
☐ |
Payment settings tab > Retainage settings section > Retainage (%) > The default percent to be retained in invoices for the supplier. |
status |
string |
Status |
☐ |
Mandatory field: The top part > Status* > The status of the supplier account. |
supplierAddress_addressId |
int32 |
{res:itgen_vnet_supplieraddress_addressid} |
☐ |
|
supplierAddress_addressLine1 |
string |
{res:itgen_vnet_supplieraddress_addressline1} |
☐ |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. |
supplierAddress_addressLine2 |
string |
{res:itgen_vnet_supplieraddress_addressline2} |
☐ |
Address 2 > The second line of the address. |
supplierAddress_addressLine3 |
string |
{res:itgen_vnet_supplieraddress_addressline3} |
☐ |
Address 3 > The third line of the address. |
supplierAddress_city |
string |
{res:itgen_vnet_supplieraddress_city} |
☐ |
City > The city. |
supplierAddress_country_errorInfo |
string |
{res:itgen_vnet_supplieraddress_country_errorinfo} |
☐ |
|
supplierAddress_country_id |
string |
{res:itgen_vnet_supplieraddress_country_id} |
☐ |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. |
supplierAddress_country_metadata_maxPageSize |
int64 |
{res:itgen_vnet_supplieraddress_country_metadata_maxpagesize} |
☐ |
|
supplierAddress_country_metadata_totalCount |
int64 |
{res:itgen_vnet_supplieraddress_country_metadata_totalcount} |
☐ |
|
supplierAddress_country_name |
string |
{res:itgen_vnet_supplieraddress_country_name} |
☐ |
Mandatory field: Country name* > The complete name of the country. |
supplierAddress_county_id |
string |
{res:itgen_vnet_supplieraddress_county_id} |
☐ |
Click the magnifier > The identifier |
supplierAddress_county_name |
string |
{res:itgen_vnet_supplieraddress_county_name} |
☐ |
Click the magnifier > The displayed name |
supplierAddress_postalCode |
string |
{res:itgen_vnet_supplieraddress_postalcode} |
☐ |
Postcode > The postcode. |
supplierClass_description |
string |
Supplier Class Description |
☐ |
Click on the magnifier. > The description. |
supplierClass_id |
string |
Supplier Class ID |
☐ |
Click on the magnifier. > The identifier. |
supplierContact_attention |
string |
{res:itgen_vnet_suppliercontact_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. |
supplierContact_contactId |
int32 |
{res:itgen_vnet_suppliercontact_contactid} |
☐ |
|
supplierContact_email |
string |
{res:itgen_vnet_suppliercontact_email} |
☐ |
Email > The email address of the customer/supplier/company as a business entity. |
supplierContact_fax |
string |
{res:itgen_vnet_suppliercontact_fax} |
☐ |
Fax > The fax number. |
supplierContact_name |
string |
{res:itgen_vnet_suppliercontact_name} |
☐ |
Name > The legal name of to appear on the documents. |
supplierContact_phone1 |
string |
{res:itgen_vnet_suppliercontact_phone1} |
☐ |
Phone 1 > The default phone number. |
supplierContact_phone2 |
string |
{res:itgen_vnet_suppliercontact_phone2} |
☐ |
Phone 2 > An additional phone number. |
supplierContact_web |
string |
{res:itgen_vnet_suppliercontact_web} |
☐ |
Web > The website of the company, if one exists. |
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 |
☐ |
Purchase settings tab > Default location settings section > VAT registration ID > The supplier's 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