invantive documentation
Invantive Support ForumsLog In / Sign Up

SupplierByCode: Visma.net Financials Supplier by Code

read only REST

  • Catalog: VismaNet
  • Schema: Supplier
  • Label: Supplier by Code

Get a specific supplier Data for a single supplier. The response headers include an ETag after a successful GET operation.

Can only retrieve data.

Summary

Data for a single supplier.

The response headers include an ETag after a successful GET operation.

API Source

  • Endpoint: /v1/supplier/{supplierCd}
  • Operation: get /v1/supplier/{supplierCd}

Performance Characteristics

Characteristic Value
Average access latency (ms) 155
Full scan rows per minute 29,100
Point query rows per minute 387

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
supplierCd `` Identifies the supplier

Table Columns

The columns of the table SupplierByCode 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 and update.

Name Data Type Label Required Marks Documentation
COMPANY_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) Company Name writable Name of the partition.
accountReference varchar2 Account Reference filters on the platform, writable, accountReference 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 varchar2 itgen_vnet_accountusedforpayment filters on the platform, writable, accountUsedForPayment Payment settings tab > Payment settings section > Account used for payment > The bank account to be used for payments to the supplier.
cashAccount varchar2 Cash Account filters on the platform, writable, cashAccount 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 varchar2 Charge Bearer filters on the platform, writable, chargeBearer Payment settings tab > Payment settings section > Charge bearer > The party that will pay possible expenses connected with the payment.
corporateId varchar2 Corporate ID filters on the platform, writable, corporateId Purchase settings tab > Default location settings section > National insurance no. > The supplier’s national insurance number associated with the location.
creditTerms_description varchar2 Credit Terms Description filters on the platform, writable, creditTerms.description Click on the magnifier. > The description.
creditTerms_id varchar2 Credit Terms ID filters on the platform, writable, creditTerms.id Click on the magnifier. > The identifier.
currencyId varchar2 Currency ID filters on the platform, writable, currencyId General information tab > Financial settings section > Currency ID > The currency that is used in operations with the supplier.
currencyOverride char itgen_vnet_currencyoverride filters on the platform, writable, currencyOverride General information tab > Financial settings section > Enable currency override
currencyRateOverride char itgen_vnet_currencyrateoverride filters on the platform, writable, currencyRateOverride General information tab > Financial settings section > Enable rate override
documentLanguage varchar2 Document Language filters on the platform, writable, documentLanguage General information tab > Financial settings section > Document language > The language of the documents to be printed to the suppliers of the class.
errorInfo varchar2 Error Message filters on the platform, writable, errorInfo
glAccounts_expenseAccountImport_description varchar2 itgen_vnet_glaccounts_expenseaccountimport_description filters on the platform, writable, glAccounts.expenseAccountImport.description Name of item/description
glAccounts_expenseAccountImport_number varchar2 itgen_vnet_glaccounts_expenseaccountimport_number filters on the platform, writable, glAccounts.expenseAccountImport.number Number of item
glAccounts_expenseAccountImport_type varchar2 itgen_vnet_glaccounts_expenseaccountimport_type filters on the platform, writable, glAccounts.expenseAccountImport.type
glAccounts_expenseAccountNonTax_description varchar2 itgen_vnet_glaccounts_expenseaccountnontax_description filters on the platform, writable, glAccounts.expenseAccountNonTax.description Name of item/description
glAccounts_expenseAccountNonTax_number varchar2 itgen_vnet_glaccounts_expenseaccountnontax_number filters on the platform, writable, glAccounts.expenseAccountNonTax.number Number of item
glAccounts_expenseAccountNonTax_type varchar2 itgen_vnet_glaccounts_expenseaccountnontax_type filters on the platform, writable, glAccounts.expenseAccountNonTax.type
glAccounts_expenseAccount_description varchar2 itgen_vnet_glaccounts_expenseaccount_description filters on the platform, writable, glAccounts.expenseAccount.description Name of item/description
glAccounts_expenseAccount_number varchar2 itgen_vnet_glaccounts_expenseaccount_number filters on the platform, writable, glAccounts.expenseAccount.number Number of item
glAccounts_expenseAccount_type varchar2 itgen_vnet_glaccounts_expenseaccount_type filters on the platform, writable, glAccounts.expenseAccount.type
glAccounts_expenseEUAccount_description varchar2 itgen_vnet_glaccounts_expenseeuaccount_description filters on the platform, writable, glAccounts.expenseEUAccount.description Name of item/description
glAccounts_expenseEUAccount_number varchar2 itgen_vnet_glaccounts_expenseeuaccount_number filters on the platform, writable, glAccounts.expenseEUAccount.number Number of item
glAccounts_expenseEUAccount_type varchar2 itgen_vnet_glaccounts_expenseeuaccount_type filters on the platform, writable, glAccounts.expenseEUAccount.type
glAccounts_expenseSubaccount_active char itgen_vnet_glaccounts_expensesubaccount_active filters on the platform, writable, glAccounts.expenseSubaccount.active
glAccounts_expenseSubaccount_description varchar2 itgen_vnet_glaccounts_expensesubaccount_description filters on the platform, writable, glAccounts.expenseSubaccount.description Click on the magnifier. > The description.
glAccounts_expenseSubaccount_id varchar2 itgen_vnet_glaccounts_expensesubaccount_id filters on the platform, writable, glAccounts.expenseSubaccount.id Click on the magnifier. > The identifier.
glAccounts_supplierAccount_description varchar2 itgen_vnet_glaccounts_supplieraccount_description filters on the platform, writable, glAccounts.supplierAccount.description Name of item/description
glAccounts_supplierAccount_number varchar2 itgen_vnet_glaccounts_supplieraccount_number filters on the platform, writable, glAccounts.supplierAccount.number Number of item
glAccounts_supplierAccount_type varchar2 itgen_vnet_glaccounts_supplieraccount_type filters on the platform, writable, glAccounts.supplierAccount.type
glAccounts_supplierSubaccount_active char itgen_vnet_glaccounts_suppliersubaccount_active filters on the platform, writable, glAccounts.supplierSubaccount.active
glAccounts_supplierSubaccount_description varchar2 itgen_vnet_glaccounts_suppliersubaccount_description filters on the platform, writable, glAccounts.supplierSubaccount.description Click on the magnifier. > The description.
glAccounts_supplierSubaccount_id varchar2 itgen_vnet_glaccounts_suppliersubaccount_id filters on the platform, writable, glAccounts.supplierSubaccount.id Click on the magnifier. > The identifier.
internalId int32 Internal ID filters on the platform, writable, internalId
landedCostSupplier char itgen_vnet_landedcostsupplier filters on the platform, writable, landedCostSupplier General information tab > SupplierProperties > Landed Cost Supplier > Indicates if the supplier is a landed cost supplier or not
lastModifiedDateTime datetime Last Modified filters on the platform, writable, lastModifiedDateTime System generated information.
location_countryId varchar2 Location Country ID filters on the platform, writable, location.countryId Location*.
location_id varchar2 Location ID filters on the platform, writable, location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, location.name Click the magnifier > The displayed name
mainAddress_addressId int32 Main Address ID filters on the platform, writable, mainAddress.addressId
mainAddress_addressLine1 varchar2 Main Address Line 1 filters on the platform, writable, mainAddress.addressLine1 Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
mainAddress_addressLine2 varchar2 Main Address Line 2 filters on the platform, writable, mainAddress.addressLine2 Address 2 > The second line of the address.
mainAddress_addressLine3 varchar2 Main Address Line 3 filters on the platform, writable, mainAddress.addressLine3 Address 3 > The third line of the address.
mainAddress_city varchar2 Main Address City filters on the platform, writable, mainAddress.city City > The city.
mainAddress_country_errorInfo varchar2 itgen_vnet_mainaddress_country_errorinfo filters on the platform, writable, mainAddress.country.errorInfo
mainAddress_country_id varchar2 Main Address Country ID filters on the platform, writable, mainAddress.country.id Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
mainAddress_country_metadata_maxPageSize int64 itgen_vnet_mainaddress_country_metadata_maxpagesize filters on the platform, writable, mainAddress.country.metadata.maxPageSize
mainAddress_country_metadata_totalCount int64 itgen_vnet_mainaddress_country_metadata_totalcount filters on the platform, writable, mainAddress.country.metadata.totalCount
mainAddress_country_name varchar2 Main Address Country Name filters on the platform, writable, mainAddress.country.name Mandatory field: Country name* > The complete name of the country.
mainAddress_county_id varchar2 Main Address County ID filters on the platform, writable, mainAddress.county.id Click the magnifier > The identifier
mainAddress_county_name varchar2 Main Address County Name filters on the platform, writable, mainAddress.county.name Click the magnifier > The displayed name
mainAddress_postalCode varchar2 Main Address Postal Code filters on the platform, writable, mainAddress.postalCode Postcode > The postcode.
mainContact_attention varchar2 Main Contact Attention filters on the platform, writable, mainContact.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 filters on the platform, writable, mainContact.contactId
mainContact_email varchar2 Main Contact Email Address filters on the platform, writable, mainContact.email Email > The email address of the customer/supplier/company as a business entity.
mainContact_fax varchar2 Fax filters on the platform, writable, mainContact.fax Fax > The fax number.
mainContact_name varchar2 Main Contact Name filters on the platform, writable, mainContact.name Name > The legal name of to appear on the documents.
mainContact_phone1 varchar2 Main Contact Phone 1 filters on the platform, writable, mainContact.phone1 Phone 1 > The default phone number.
mainContact_phone2 varchar2 Main Contact Phone 2 filters on the platform, writable, mainContact.phone2 Phone 2 > An additional phone number.
mainContact_web varchar2 Main Contact Website filters on the platform, writable, mainContact.web Web > The website of the company, if one exists.
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, metadata.totalCount
naceCode varchar2 itgen_vnet_nacecode filters on the platform, writable, naceCode General information tab > Main contact section > Industry Code ID > The supplier's NACE code
name varchar2 Name filters on the platform, writable, 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 varchar2 Note filters on the platform, writable, note
number varchar2 Number filters on the platform, writable, number Mandatory field: The top part > Supplier ID* > The ID of the supplier account.
numberOfEmployees int32 Number of Employees filters on the platform, writable, numberOfEmployees Legal requirements that all companies with more than 250 employees keep track of their business accounts
parentRecord_name varchar2 Parent Record Name filters on the platform, writable, parentRecord.name Click the magnifier. > The name.
parentRecord_number varchar2 Parent Record Number filters on the platform, writable, parentRecord.number Click the magnifier. > The identifier.
paySeparately char itgen_vnet_payseparately filters on the platform, writable, 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.
paymentBy varchar2 Payment by filters on the platform, writable, paymentBy 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 itgen_vnet_paymentleadtime filters on the platform, writable, 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 varchar2 Payment Method Description filters on the platform, writable, paymentMethod.description Click on the magnifier. > The description.
paymentMethod_id varchar2 Payment Method ID filters on the platform, writable, paymentMethod.id Click on the magnifier. > The identifier.
paymentRefDisplayMask varchar2 itgen_vnet_paymentrefdisplaymask filters on the platform, writable, 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.
remitAddress_addressId int32 itgen_vnet_remitaddress_addressid filters on the platform, writable, remitAddress.addressId
remitAddress_addressLine1 varchar2 itgen_vnet_remitaddress_addressline1 filters on the platform, writable, remitAddress.addressLine1 Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
remitAddress_addressLine2 varchar2 itgen_vnet_remitaddress_addressline2 filters on the platform, writable, remitAddress.addressLine2 Address 2 > The second line of the address.
remitAddress_addressLine3 varchar2 itgen_vnet_remitaddress_addressline3 filters on the platform, writable, remitAddress.addressLine3 Address 3 > The third line of the address.
remitAddress_city varchar2 itgen_vnet_remitaddress_city filters on the platform, writable, remitAddress.city City > The city.
remitAddress_country_errorInfo varchar2 itgen_vnet_remitaddress_country_errorinfo filters on the platform, writable, remitAddress.country.errorInfo
remitAddress_country_id varchar2 itgen_vnet_remitaddress_country_id filters on the platform, writable, remitAddress.country.id Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
remitAddress_country_metadata_maxPageSize int64 itgen_vnet_remitaddress_country_metadata_maxpagesize filters on the platform, writable, remitAddress.country.metadata.maxPageSize
remitAddress_country_metadata_totalCount int64 itgen_vnet_remitaddress_country_metadata_totalcount filters on the platform, writable, remitAddress.country.metadata.totalCount
remitAddress_country_name varchar2 itgen_vnet_remitaddress_country_name filters on the platform, writable, remitAddress.country.name Mandatory field: Country name* > The complete name of the country.
remitAddress_county_id varchar2 itgen_vnet_remitaddress_county_id filters on the platform, writable, remitAddress.county.id Click the magnifier > The identifier
remitAddress_county_name varchar2 itgen_vnet_remitaddress_county_name filters on the platform, writable, remitAddress.county.name Click the magnifier > The displayed name
remitAddress_postalCode varchar2 itgen_vnet_remitaddress_postalcode filters on the platform, writable, remitAddress.postalCode Postcode > The postcode.
remitContact_attention varchar2 itgen_vnet_remitcontact_attention filters on the platform, writable, 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 itgen_vnet_remitcontact_contactid filters on the platform, writable, remitContact.contactId
remitContact_email varchar2 itgen_vnet_remitcontact_email filters on the platform, writable, remitContact.email Email > The email address of the customer/supplier/company as a business entity.
remitContact_fax varchar2 itgen_vnet_remitcontact_fax filters on the platform, writable, remitContact.fax Fax > The fax number.
remitContact_name varchar2 itgen_vnet_remitcontact_name filters on the platform, writable, remitContact.name Name > The legal name of to appear on the documents.
remitContact_phone1 varchar2 itgen_vnet_remitcontact_phone1 filters on the platform, writable, remitContact.phone1 Phone 1 > The default phone number.
remitContact_phone2 varchar2 itgen_vnet_remitcontact_phone2 filters on the platform, writable, remitContact.phone2 Phone 2 > An additional phone number.
remitContact_web varchar2 itgen_vnet_remitcontact_web filters on the platform, writable, remitContact.web Web > The website of the company, if one exists.
retainageApply char itgen_vnet_retainageapply filters on the platform, writable, 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 varchar2 itgen_vnet_retainagecashaccountid filters on the platform, writable, 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 filters on the platform, writable, retainagePct Payment settings tab > Retainage settings section > Retainage (%) > The default percent to be retained in invoices for the supplier.
status varchar2 Status filters on the platform, writable, status Mandatory field: The top part > Status* > The status of the supplier account.
supplierAddress_addressId int32 itgen_vnet_supplieraddress_addressid filters on the platform, writable, supplierAddress.addressId
supplierAddress_addressLine1 varchar2 itgen_vnet_supplieraddress_addressline1 filters on the platform, writable, supplierAddress.addressLine1 Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
supplierAddress_addressLine2 varchar2 itgen_vnet_supplieraddress_addressline2 filters on the platform, writable, supplierAddress.addressLine2 Address 2 > The second line of the address.
supplierAddress_addressLine3 varchar2 itgen_vnet_supplieraddress_addressline3 filters on the platform, writable, supplierAddress.addressLine3 Address 3 > The third line of the address.
supplierAddress_city varchar2 itgen_vnet_supplieraddress_city filters on the platform, writable, supplierAddress.city City > The city.
supplierAddress_country_errorInfo varchar2 itgen_vnet_supplieraddress_country_errorinfo filters on the platform, writable, supplierAddress.country.errorInfo
supplierAddress_country_id varchar2 itgen_vnet_supplieraddress_country_id filters on the platform, writable, supplierAddress.country.id Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
supplierAddress_country_metadata_maxPageSize int64 itgen_vnet_supplieraddress_country_metadata_maxpagesize filters on the platform, writable, supplierAddress.country.metadata.maxPageSize
supplierAddress_country_metadata_totalCount int64 itgen_vnet_supplieraddress_country_metadata_totalcount filters on the platform, writable, supplierAddress.country.metadata.totalCount
supplierAddress_country_name varchar2 itgen_vnet_supplieraddress_country_name filters on the platform, writable, supplierAddress.country.name Mandatory field: Country name* > The complete name of the country.
supplierAddress_county_id varchar2 itgen_vnet_supplieraddress_county_id filters on the platform, writable, supplierAddress.county.id Click the magnifier > The identifier
supplierAddress_county_name varchar2 itgen_vnet_supplieraddress_county_name filters on the platform, writable, supplierAddress.county.name Click the magnifier > The displayed name
supplierAddress_postalCode varchar2 itgen_vnet_supplieraddress_postalcode filters on the platform, writable, supplierAddress.postalCode Postcode > The postcode.
supplierClass_description varchar2 Supplier Class Description filters on the platform, writable, supplierClass.description Click on the magnifier. > The description.
supplierClass_id varchar2 Supplier Class ID filters on the platform, writable, supplierClass.id Click on the magnifier. > The identifier.
supplierContact_attention varchar2 itgen_vnet_suppliercontact_attention filters on the platform, writable, 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 itgen_vnet_suppliercontact_contactid filters on the platform, writable, supplierContact.contactId
supplierContact_email varchar2 itgen_vnet_suppliercontact_email filters on the platform, writable, supplierContact.email Email > The email address of the customer/supplier/company as a business entity.
supplierContact_fax varchar2 itgen_vnet_suppliercontact_fax filters on the platform, writable, supplierContact.fax Fax > The fax number.
supplierContact_name varchar2 itgen_vnet_suppliercontact_name filters on the platform, writable, supplierContact.name Name > The legal name of to appear on the documents.
supplierContact_phone1 varchar2 itgen_vnet_suppliercontact_phone1 filters on the platform, writable, supplierContact.phone1 Phone 1 > The default phone number.
supplierContact_phone2 varchar2 itgen_vnet_suppliercontact_phone2 filters on the platform, writable, supplierContact.phone2 Phone 2 > An additional phone number.
supplierContact_web varchar2 itgen_vnet_suppliercontact_web filters on the platform, writable, supplierContact.web Web > The website of the company, if one exists.
timeStamp blob Timestamp filters on the platform, writable, 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 varchar2 VAT Registration ID filters on the platform, writable, vatRegistrationId Purchase settings tab > Default location settings section > VAT registration ID > The supplier's VAT registration ID associated with the location.
vatZone_defaultTaxCategory_description varchar2 VAT Zone Default Tax Category Description filters on the platform, writable, vatZone.defaultTaxCategory.description Name of item/description
vatZone_defaultTaxCategory_number varchar2 VAT Zone Default Tax Category Number filters on the platform, writable, vatZone.defaultTaxCategory.number Number of item
vatZone_defaultVatCategory varchar2 VAT Zone Default VAT Category filters on the platform, writable, vatZone.defaultVatCategory 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 filters on the platform, writable, vatZone.description Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.
vatZone_errorInfo varchar2 itgen_vnet_vatzone_errorinfo filters on the platform, writable, vatZone.errorInfo
vatZone_id varchar2 VAT Zone ID filters on the platform, writable, vatZone.id Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.
vatZone_metadata_maxPageSize int64 itgen_vnet_vatzone_metadata_maxpagesize filters on the platform, writable, vatZone.metadata.maxPageSize
vatZone_metadata_totalCount int64 itgen_vnet_vatzone_metadata_totalcount filters on the platform, writable, vatZone.metadata.totalCount

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: