Web Services General

Version history

Version

Date

Change target / Explanation

16.3.3

14.7.2022

Added text: The interfaces do not support multiple currencies, only EUR currency is supported.

Added information about the batch processing invoice interface.

1 Operating procedure

The WS interface of the external system sends a parameterized request to the NetBaron system.
NetBaron performs identification and verifies that the module in the request exists and is authorized for the organization and method in question.
NetBaron decodes the information contained in the request and functions according to them.
After this, a return message is generated within the system, which is forwarded in response to the request to the sending service.

Please note:

Each NetBaron WS module is an self-contained entity, and they are implemented separately. For example having access to Feedback module won’t allow connection to other modules.
Error handling must be built into the interfaces integration in case of connection interruptions.
The interfaces do not support multiple currencies. Only EUR currency is supported.

1.1 Authentication & methods

Authentication:

Whitelisted IP-addresses.

Organization and the organization-specific Web Services password.

The character set used:

UTF-8

Methods in use:

GET / PUT/ POST / DELETE

Methods vary between modules.

Each module has independent authentication information, such as allowed IP-address space and WS-password.

Allowed IP-address space can be defined for each module separately.
A unique password is given for each WS module. If the organization uses multiple services that use the same module, such as feedback form on several pages, then it is possible to create separate passwords for each service.

Modules have specific methods (DELETE / GET / POST / PUT):

Only methods required by the organization are allowed for each module. Unnecessary methods and parameters can be left inaccessible for security.
Example: If the purpose is only to show calendar information on the homepage, then only the GET method is allowed. In case of misuse, the calendar information therefore cannot be changed, deleted and no new events can be added.

Method	Use
DELETE	Delete data
GET	Retrieve data
POST	Update data
PUT	Add new data

2 Available modules

WS-module	NetBaron application	Intended use
Customer register	Registers	The module can be used for searching specified customer information from the customer register and updating customer information. Search for customer address information Update customer address information Link customers as extra addresses Create new customers to register Mark customer as deleted from register
Service	Service	The module can be used to search and update service work information. Search for service work with the given work number Search for service work based on product number and serial number Add/update service work Features for additional fees: Customer allocation based on external customer ID Creating new service work based on customer-specific number series
Calendar	Calendar	The module can be used to search for other than personal calendar information, create, edit and delete events. Search for events in the given time period from given calendar Add events Update events Delete events
Time	Time	The module can be used to record working hours in NetBaron. Search for In-stamps and Out-stamps included in work time tracking Search for the organization's list of personnel Record working hours for personnel
Economy	Economy	The module can be used to search for information about accounting based on the search criteria. Search for accounting periods Search for cost center information Search for receipts for the accounting period Search for the chart of accounts in use Search for account-specific balance information Search for job number information Search for company’s place of business information
Billing	Billing & Economy	The module can be used to search for invoice information and create invoices. Search for invoices with the given identification information Add invoices
Batch selling bill	Economy	The module can be used to search for batch selling bill information and create and edit the rows of batch selling bills Search for the ID and receiver of batch selling bill Search for the rows of batch selling bill based on batch selling bill ID Add rows to batch selling bill Edit rows of batch selling bill Delete rows of batch selling bill
Sales order	Order	The module can be used to search for sales order information and create sales orders. Search for orders with given identification information Search orders by customer Search for customer backorders in online store Search for orders in different statuses Search for orders by time range Add orders
Purchase invoicing	Economy	The module can be used to search for invoice information and create invoices. Search for purchase invoices with the given identification information Search for all purchase invoices with given filters Add purchase invoices
Purchase order	Order	The module can be used to search for purchase order information and create purchase orders. Search for orders with the given identification information Add orders
Feedback	Feedback	Enables the use of NetBaron's feedback and messaging systems from external services. Enables sending feedback from forms embedded on homepages to NetBaron. Enables sending messages through NetBaron messaging system
Salary	Salary	The module can be used to add new salary entries and search for salary entries with different search criteria. In addition, a list of payment groups in use and salary entry statuses is available. Search for salary entries by time range Search for salary entries with the employee's information Search for salary entries by salary entry status Add new salary entries
Product register	Registers	The module can be used to search the product register for the specific product information, add new products and update product information. Search for product prices Search for product stock information Update product prices Make product consumptions Add new products
Reservation calendar	Calendar	Enables the use of NetBaron's calendar system from external services. Entries will be updated to NetBaron calendar from the booking calendar by desired time range