NewBaseV4 - Connector Settings
This document describes the connector-specific settings for the NewBaseV4 connector. These settings allow administrators and implementation consultants to configure how the connector interacts with the App4Sales platform, influencing data synchronization, order processing, and other key functionalities without direct code modification.
Settings are typically stored and managed through the App4Sales portal UI or specific configuration files and are applied at runtime to control the connector's behavior.
Setting | Description | Values / Defaults | Dependencies / Effects |
Newbase Owner Id | Specifies the unique identifier for the NewBase owner. | String | Required for authenticating and identifying the owner within the NewBase system. |
Newbase Company Id | Specifies the unique identifier for the company within the NewBase system. | String | Required for operations scoped to a specific company in NewBase. |
Newbase User Id | Specifies the user identifier used for authentication with NewBase. | String | Part of the credentials for accessing the NewBase webservice. |
Newbase Owner Webservice User Name | The username for accessing the NewBase webservice. | String | Used for authenticating with the NewBase webservice. |
Newbase Owner Webservice User Password | The password for accessing the NewBase webservice. This field is encrypted for security. | String | Used for authenticating with the NewBase webservice. Stored encrypted. |
Don't sync discontinued products | When enabled, products marked as discontinued in NewBase will not be synchronized to App4Sales. | Boolean (True/False) | Prevents discontinued items from appearing in the App4Sales catalog. |
Don't sync products without salesprice | When enabled, products that do not have an assigned sales price in NewBase will not be synchronized to App4Sales. | Boolean (True/False) | Ensures only salable items are visible in App4Sales. |
Productgroup description | Defines the name for the product group description field. The default value is 'Productgroep'. | String (Default: Productgroep) | Affects how product group descriptions are labeled in App4Sales. |
Automatic ordernumber prefix | A prefix to be used when generating automatic order numbers in App4Sales. | String | Order numbers generated by App4Sales will start with this prefix. |
Automatic ordernumber # of digits | Specifies the number of digits to be used for the sequential part of automatically generated order numbers. The default value is 5. | Integer (Default: 5) | Determines the length and format of the sequential part of order numbers. |
Send automatic ordernumber as Our Reference | When enabled, the automatically generated App4Sales order number will be sent to NewBase as 'Our Reference'. | Boolean (True/False) | Maps the App4Sales internal order number to the 'Our Reference' field in NewBase. |
Don't sync products with internal name prefix (comma separated) | A comma-separated list of prefixes. Products whose internal names start with any of these prefixes will not be synchronized to App4Sales. | String (Comma-separated prefixes) | Allows excluding specific product ranges from synchronization based on their internal naming convention. |
Warehouse id for stock | Specifies the ID of the warehouse in NewBase from which stock levels should be retrieved. | Integer | Ensures stock information is fetched from a designated warehouse. |
Item prefix to use for stock | Specifies a prefix to filter items for stock synchronization. Only items starting with this prefix will have their stock synchronized. | String | Filters stock synchronization to a subset of items. |
Don't sync customers with name prefix (comma separated) | A comma-separated list of prefixes. Customers whose names start with any of these prefixes will not be synchronized to App4Sales. | String (Comma-separated prefixes) | Allows excluding specific customer ranges from synchronization. |
Automatic customernumber prefix | A prefix to be used when generating automatic customer numbers in App4Sales. | String | Customer numbers generated by App4Sales will start with this prefix. |
Automatic customernumber # of digits | Specifies the number of digits to be used for the sequential part of automatically generated customer numbers. The default value is 5. | Integer (Default: 5) | Determines the length and format of the sequential part of customer numbers. |
Use product remark for free sort field | When enabled, the product remark from NewBase will be mapped to a free sort field in App4Sales. | Boolean (True/False) | Allows using product remarks for custom sorting or filtering within App4Sales. |
Don't use exact values for stock | When enabled, stock values will not be synchronized as exact quantities. This might be used for scenarios where only an indication (e.g., "in stock", "low stock") is desired. | Boolean (True/False) | Modifies how stock quantities are represented in App4Sales. |
Country code for VAT liable | Specifies the country code used to determine VAT liability for customers. | String (e.g., NL, BE) | Influences VAT calculations and display for customers from the specified country. |
Order history maximum results | Sets the maximum number of results to retrieve when fetching order history. The default value is 200. | Integer (Default: 200) | Limits the volume of historical orders synchronized or displayed. |
Item prefix to remove for stock | Specifies a prefix to be removed from item codes when synchronizing stock. | String | Useful for normalizing item codes if NewBase uses a prefix that is not relevant for stock tracking in App4Sales. |
Base price list name | Specifies the name of the base price list in NewBase to be used for synchronization. | String | Determines which price list is considered the primary one for product pricing. |
Item category field for searchdescription | Specifies which item category field from NewBase should be used for the search description in App4Sales. | String | Enhances product searchability in App4Sales by utilizing a specific category field. |
Min quantity indicated base price for Product price break | Specifies the minimum quantity at which a base price is indicated for product price breaks. | Integer | Relevant for tiered pricing structures, defining the threshold for the initial price break. |
Only use currency codes (comma separated) | A comma-separated list of currency codes. Only prices associated with these currency codes will be synchronized. | String (Comma-separated currency codes, e.g., EUR,USD) | Filters synchronized prices to only include specified currencies. |
Only sync products with subscription types ids (comma separated) | A comma-separated list of subscription type IDs. Only products associated with these subscription types will be synchronized. | String (Comma-separated IDs) | Filters product synchronization to specific subscription-based products. |
Do not sync item pictures | When enabled, item pictures from NewBase will not be synchronized to App4Sales. | Boolean (True/False) | Prevents item images from being transferred, potentially saving bandwidth or storage. |
Apply discounts during live prices call | When enabled, discounts will be applied during real-time price lookups in NewBase. | Boolean (True/False) | Ensures live price calculations reflect any applicable discounts from NewBase. |
Apply discounts during sync item prices call | When enabled, discounts will be applied during the synchronization of item prices from NewBase. | Boolean (True/False) | Ensures synchronized item prices reflect any applicable discounts from NewBase. |
Always send base price for item order lines | When enabled, the base price will always be sent for item order lines, regardless of other pricing rules. | Boolean (True/False) | Forces the use of the base price for order line items in NewBase. |
Sync only service products | When enabled, only products identified as service products in NewBase will be synchronized to App4Sales. | Boolean (True/False) | Filters product synchronization to include only service-type items. |
Calculate stocks for composition products | When enabled, stock levels for composition (bundle) products will be calculated based on their component items. | Boolean (True/False) | Enables dynamic stock calculation for product bundles. |
Select maximum price for product | When enabled, if multiple prices exist for a product, the highest price will be selected. | Boolean (True/False) | Influences which price is displayed or used when multiple pricing tiers are available. |
Add the pricelist to the customer freefields | When enabled, the assigned pricelist for a customer will be added to their free fields in App4Sales. | Boolean (True/False) | Provides visibility of the customer's pricelist assignment in their free fields. |
The customer specific discount should always be leading (including when the discount is negative) | When enabled, any customer-specific discounts (even negative ones) will override other discount calculations. | Boolean (True/False) | Prioritizes customer-specific discount agreements. |
Default payment method for paid orders | Specifies the default payment method for paid orders. Should always be a number (int) corresponding to the number value in NewBase. | String (NewBase payment method ID) | Sets the default payment method for orders marked as paid when sent to NewBase. |
Default payment terms for paid orders | Specifies the default payment terms for paid orders. Should always be a number (int) corresponding to the number value in NewBase. | String (NewBase payment terms ID) | Sets the default payment terms for orders marked as paid when sent to NewBase. |
Send the payment reference as order refence when available | When enabled, if a payment reference is available, it will be sent to NewBase as the order reference. | Boolean (True/False) | Uses the payment reference for NewBase order cross-referencing. |
Use available sales stock as available stock value | When enabled, the available sales stock quantity from NewBase will be used as the available stock value in App4Sales. | Boolean (True/False) | Ensures App4Sales reflects the sales-specific stock rather than total physical stock. |
Add organisations that are linked to debtors to the customers | When enabled, organizations linked to debtors in NewBase will also be synchronized as customers in App4Sales. | Boolean (True/False) | Expands the customer base in App4Sales to include linked organizations. |
Pricing agreement for new customers | Specifies the default pricing agreement to apply to newly created customers in NewBase. | String | Assigns a default pricing agreement to new customers. |
Customer custom fields mapping (JSON format) | Allows mapping custom customer fields from App4Sales to NewBase fields using a JSON array. The format is a JSON array of objects, where each object defines the `entityType` (Organisation, Debtor, Person, Contact), `a4sFieldName` (name of the custom field in App4Sales), `newbaseFieldName` (name of the field in NewBase API), and `isA4SEntityField` (true if the field exists directly on the App4Sales customer entity, false if it's a free field). Example: | JSON String | Enables flexible mapping of custom customer data between App4Sales and NewBase. |
Use AddressLine2 as house number | When enabled, the content of AddressLine2 from NewBase will be interpreted and used as the house number in App4Sales addresses. | Boolean (True/False) | Adapts address parsing to use a specific field for house number information. |
Use AddressesList for organisation addresses | When enabled, the connector will utilize the 'AddressesList' property in NewBase for synchronizing organization addresses. | Boolean (True/False) | Determines the source field for organization address data in NewBase. |
Use quantity on pallet as minimum order quantity | When enabled, the 'quantity on pallet' value for a product in NewBase will be used as its minimum order quantity in App4Sales. | Boolean (True/False) | Enforces minimum order quantities based on pallet configurations. |
Domain Specifics
Authentication
The connector relies on several key settings for authenticating with the NewBase webservice: Newbase Owner Id, Newbase Company Id, Newbase User Id, Newbase Owner Webservice User Name, and Newbase Owner Webservice User Password. These credentials are essential for establishing a secure connection and performing data operations.
Product Synchronization
Several settings control which products are synchronized from NewBase to App4Sales. This includes filtering based on product status (Don't sync discontinued products), pricing (Don't sync products without salesprice), internal naming conventions (Don't sync products with internal name prefix), and specific subscription types (Only sync products with subscription types ids). There's also an option to prevent the synchronization of item pictures (Do not sync item pictures) and to sync only service products (Sync only service products).
Stock Management
Stock synchronization can be configured using Warehouse id for stock to specify the source warehouse. Filters like Item prefix to use for stock and Item prefix to remove for stock allow for fine-grained control over which item stocks are synchronized and how their codes are processed. The Don't use exact values for stock setting can be used to display stock as an indication rather than precise figures, and Calculate stocks for composition products enables calculation for product bundles. Use available sales stock as available stock value allows for sales specific stock values.
Customer Management
Customer synchronization can be filtered using Don't sync customers with name prefix. Settings for automatic customer number generation include Automatic customernumber prefix and Automatic customernumber # of digits. The Customer custom fields mapping setting provides a flexible way to synchronize custom customer attributes using a JSON configuration. Add organisations that are linked to debtors to the customers setting allows for the inclusion of linked organizations as customers.
Pricing and Discounts
The connector supports detailed control over pricing and discounts. Base price list name defines the primary price list. Settings like Apply discounts during live prices call and Apply discounts during sync item prices call determine when discounts are applied during price retrieval and synchronization. Select maximum price for product influences price selection when multiple options exist. The customer specific discount should always be leading (including when the discount is negative) ensures customer-specific pricing rules are prioritized. Min quantity indicated base price for Product price break is used for tiered pricing.
Order Processing
Order processing settings include Automatic ordernumber prefix and Automatic ordernumber # of digits for generating order numbers. Send automatic ordernumber as Our Reference maps the internal order number to a reference field in NewBase. Default payment methods and terms for paid orders can be configured using Default payment method for paid orders and Default payment terms for paid orders. Send the payment reference as order refence when available allows for the use of payment references as order references.
Related Settings & Prerequisites
Most settings function independently, but authentication-related settings (Newbase Owner Id, Newbase Company Id, Newbase User Id, Newbase Owner Webservice User Name, Newbase Owner Webservice User Password) are all required to establish a connection to the NewBase system. Incorrect values for these settings will prevent the connector from functioning.
Known Limitations
The current implementation does not explicitly define default values for all string and integer settings in the code. In such cases, the system default for the respective data type (e.g., empty string for string, 0 for int) will be used if no value is configured by the administrator.