Planning a new API implementation?
Please read also article Getting started with Severa API Integration.
Technical API Documentation
Documentation of Visma Severa's API can be found at: http://sync.severa.com/ApiDocs/. In the documentation there are two main sections: API interfaces and API entities:
- Severa.API Namespace describes the available interfaces that can be used to integrate to Visma Severa. Each interface contains Method list, for example ICase interface has methods to add new, update and delete Cases in Visma Severa.
- Severa.Entities.API Namespace describes the API entities. For example, when adding a new Case to Visma Severa, by using ICase.AddNewCase method, a Case entity is given as a parameter, and also as return value.
API examples & Best Practices
You can find some examples in article What others have done with API.
All code examples are listed on article API code examples.
Interfaces Overview & Terminology
Most of the interfaces listed below have insert/update/delete methods:
IAccessRights – User access right profiles
IAccount – Customers. You need to have also company in order to create a new account.
IAccountGroup – Can be used in many ways to group customers in different target groups.
IActivity – Calendar entry, can be used also in CRM for customer communication
IActivityType – Activity’s type, e.g. phone call, meeting etc.
IAddress – Customer’s address
IAPI – for API information
IBusinessUnit – Organizations unit or team. It can have users or cases.
ICase – Project, where work hours and products are inserted to and which can be invoiced.
ICaseStatus – Case’s status, e.g. waiting for a response. Differs from sales status.
ICompany – Customers. To be complete, you need to use also account.
IContact – Customer’s contact person
ICountry – Counties which exist in Severa, can’t be customized
ICurrency – Organizations currencies when using multi-currency
IDictionary – Not in use.
IEmployment – User’s work contract
IFile – For getting organization files (case, invoice)
IHourEntry – Work hour entry
IIndustry – Customer’s industry
IInvoice – Sales invoice, which is sent to customers.
IInvoiceStatus – Defines invoicing process, e.g. ready for transfer / transferred.
IItem – Can be travel, product, regular billable item or cost
ILanguage – Not in use
IOverTime – Defines over time types for work hour entries
IPhase – Divides project to multiple phases
IPhaseMember – Which users are working in each phase
IProduct – Setting for products and travel expenses, which are sold to customers.
IProductCategory – For categorizing products.
IResource – Resource for calendar entry, e.g. meeting room
IResourceAllocation – Resource allocation for a project. Resources = users.
ISalesProcess – Defines organizations sales process, which consists of sales statuses
ISalesStatus – What is current sales status for case
ISearch – Internal, do not use.
ISettings – Not in use.
ITag – Keywords, can be used to classify users, cases etc.
ITravelReimbursement – travel reimbursements
ITravelReimbursementStatus – like invoice status
IUser – Employee of a company