Severa Public Rest API Documentation
The API uses OAuth2 client creadentials flow. To get the Bearer token for the resources you have to request the token by using route '/token', found from Authentication controller. You need to provide a Client_Id, client_secret and scope needed. The client_id and client_secret can be obtained from Severa UI Rest Api settings section. After authentication, calls need to use the Bearer token as authorization header (Bearer {accessToken}). The calls also need to have Client_Id header. The access token can be refreshed from '/refreshtoken' route using the refresh token which was obtained from the authentication.
Base URL:
Auth: unknown
Endpoints: 228
Reachable: unknown
CORS: unknown
https://api.severa.visma.com/rest-apiAuth: unknown
Endpoints: 228
Reachable: unknown
CORS: unknown
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
GET |
/heartbeat/authorized | Returns http status code 204 for successful authentication. | — | — | — |
GET |
/heartbeat/database | Can be used to check the status of the database. | — | — | — |
GET |
/heartbeat/server | Can be used to check the status of the REST Api. | — | — | — |
GET |
/v1/activities | Get all activities of an organization | — | — | — |
GET |
/v1/activities/{activityGuid}/activityparticipants | Get participants for an activity | — | — | — |
GET |
/v1/activities/{guid} | Get activity by ID | — | — | — |
GET |
/v1/activityparticipants/{guid} | Get activity participant | — | — | — |
GET |
/v1/activitytypes | Get the Activity Types | — | — | — |
GET |
/v1/activitytypes/{guid} | Get Activity Type by ID | — | — | — |
GET |
/v1/addresses | Get the addresses. | — | — | — |
GET |
/v1/addresses/{guid} | Get address by ID. | — | — | — |
GET |
/v1/bankaccounts | Get all bank accounts for current organization. | — | — | — |
GET |
/v1/bankaccounts/{guid} | Get bank account by ID. | — | — | — |
GET |
/v1/businessunits | Get all the BusinessUnits | — | — | — |
GET |
/v1/businessunits/{guid} | Get businessUnit by ID. | — | — | — |
GET |
/v1/communicationtypes | Get all communication types. | — | — | — |
GET |
/v1/communicationtypes/{guid} | Get communication type by ID. | — | — | — |
GET |
/v1/contactcommunications | Get all contact communications. | — | — | — |
GET |
/v1/contactcommunications/{guid} | Get contact communication by ID. | — | — | — |
GET |
/v1/contactpersons | Get all the contact persons. | — | — | — |
GET |
/v1/contactpersons/{contactGuid}/addresses | Get contact person's address | — | — | — |
GET |
/v1/contactpersons/{guid} | Get contact by ID. | — | — | — |
GET |
/v1/contactroles | Get contact roles. | — | — | — |
GET |
/v1/contactroles/{guid} | Get contact role by ID. | — | — | — |
GET |
/v1/contacts/{contactGuid}/contactcommunications | Get all communications for a contact. | — | — | — |
GET |
/v1/contacts/{contactGuid}/keywords | Get all the keywords for contact. | — | — | — |
GET |
/v1/costaccounts | Get cost accounts. | — | — | — |
GET |
/v1/costaccounts/{guid} | Get cost account by Guid. | — | — | — |
GET |
/v1/costcenters | Get cost centers. | — | — | — |
GET |
/v1/costcenters/{guid} | Get cost center by ID. | — | — | — |
GET |
/v1/currencies | Get all the Currencies | — | — | — |
GET |
/v1/currencies/{guid} | Get currency by ID. | — | — | — |
GET |
/v1/customermarketsegments | Get all Customer Market Segments. | — | — | — |
GET |
/v1/customermarketsegments/{guid} | Get the customer market segment. | — | — | — |
GET |
/v1/customers | Get all the customers | — | — | — |
GET |
/v1/customers/customproperties | Get the customer custom properties. | — | — | — |
GET |
/v1/customers/customproperties/customercustompropertyselectionitems/{guid} | Get customer custom property selection item by ID. | — | — | — |
GET |
/v1/customers/customproperties/{customPropertyGuid}/customercustompropertyselectionitems | Get the customer custom properties. | — | — | — |
GET |
/v1/customers/customproperties/{guid} | Get customer custom property by ID. | — | — | — |
GET |
/v1/customers/customvalues/{guid} | Get customer custom value by ID. | — | — | — |
GET |
/v1/customers/{customerGuid}/addresses | Get customer's addresses | — | — | — |
GET |
/v1/customers/{customerGuid}/contactpersons | Get the contact persons for a customer. | — | — | — |
GET |
/v1/customers/{customerGuid}/customercountrysettings | Get all the country settings for a customer. | — | — | — |
GET |
/v1/customers/{customerGuid}/customermarketsegments | Get the Market Segments for a customer. | — | — | — |
GET |
/v1/customers/{customerGuid}/customersalesnotes | Get the customer sales notes. | — | — | — |
GET |
/v1/customers/{customerGuid}/customvalues | Get the customer custom values. | — | — | — |
GET |
/v1/customers/{customerGuid}/projects | Get customer's projects | — | — | — |
GET |
/v1/customers/{customerGuid}/salesnotes | Get the sales notes by customer guid. | — | — | — |
GET |
/v1/customers/{guid} | Get customer by GUID. | — | — | — |
GET |
/v1/customersalesnotes/{guid} | Get customer sales note by ID. | — | — | — |
GET |
/v1/deletedphasemembers | Get all deleted phase members | — | — | — |
GET |
/v1/deletedprojectfees | Get the deleted project fees. | — | — | — |
GET |
/v1/deletedprojecttravelexpenses | Get the deleted project travel expenses. | — | — | — |
GET |
/v1/deletedworkhours | Get the deleted work hours. | — | — | — |
GET |
/v1/files/{fileGuid}/keywords | Get all the keywords for file. | — | — | — |
GET |
/v1/files/{guid} | Get file by ID. | — | — | — |
GET |
/v1/files/{guid}/filedata | Get file data by ID. | — | — | — |
GET |
/v1/flatrates | Get all flat rates | — | — | — |
GET |
/v1/flatrates/{guid} | Get flat rate. | — | — | — |
GET |
/v1/flextimeadjustments/{guid} | Get Flextime Adjustment by ID. | — | — | — |
GET |
/v1/holidays | Get holidays. | — | — | — |
GET |
/v1/holidaysbytimeperiod | Get holidays with start and end date. | — | — | — |
GET |
/v1/industries | Get all the industries. | — | — | — |
GET |
/v1/industries/{guid} | Get industry by ID. | — | — | — |
GET |
/v1/integrations/vismafinancials/companyinformation | Get Visma.net Financials integration company information. | — | — | — |
GET |
/v1/invoicefiles/{guid} | Get invoice file by ID. | — | — | — |
GET |
/v1/invoicerows | Get invoice rows | — | — | — |
GET |
/v1/invoicerows/{guid} | Get invoice row by ID | — | — | — |
GET |
/v1/invoicerows/{invoiceRowGuid}/projectfees | Get all the project fees on an invoice row | — | — | — |
GET |
/v1/invoicerows/{invoiceRowGuid}/projecttravelexpenses | Get all the project travel expenses on an invoice row | — | — | — |
GET |
/v1/invoicerows/{invoiceRowGuid}/reimbursedprojectfees | Get all the project fees on an invoice row | — | — | — |
GET |
/v1/invoicerows/{invoiceRowGuid}/reimbursedprojecttravelexpenses | Get all the project travel expenses on an invoice row. | — | — | — |
GET |
/v1/invoicerows/{invoiceRowGuid}/reimbursedworkhours | Get all reimbursed hours on an invoice row. | — | — | — |
GET |
/v1/invoicerows/{invoiceRowGuid}/workhours | Get all the work hours on an invoice row | — | — | — |
GET |
/v1/invoicestatuses | Get invoice statuses. | — | — | — |
GET |
/v1/invoicestatuses/{guid} | Get Invoice status by ID. | — | — | — |
GET |
/v1/invoicestatuses/{invoiceStatusGuid}/finvoices | — | — | — | — |
GET |
/v1/invoicetemplates | Get invoice templates. | — | — | — |
GET |
/v1/invoicetemplates/{guid} | Get invoice template by ID. | — | — | — |
GET |
/v1/keywords | Get all the keywords. | — | — | — |
GET |
/v1/keywords/{guid} | Get keyword by ID. | — | — | — |
GET |
/v1/kpiformulas | Get saved KPI formulas. | — | — | — |
GET |
/v1/leadsources | Get the lead sources. | — | — | — |
GET |
/v1/leadsources/{guid} | Get lead source by ID. | — | — | — |
GET |
/v1/localization/countries | Get all the Countries. | — | — | — |
GET |
/v1/localization/countries/{code2} | Get a country by ISO Alpha-2 code | — | — | — |
GET |
/v1/localization/countries/{code3} | Get a country by ISO Alpha-3 code | — | — | — |
GET |
/v1/localization/countries/{countryGuid}/countryregions | Get all the Country regions for a country. | — | — | — |
GET |
/v1/localization/countries/{countryName} | Get a country by name | — | — | — |
GET |
/v1/localization/countries/{guid} | Get country by ID. | — | — | — |
GET |
/v1/localization/countryregions/{guid} | Get country region by ID. | — | — | — |
GET |
/v1/localization/formattingcultures | Get all the Formatting Cultures | — | — | — |
GET |
/v1/localization/formattingcultures/{guid} | Get formatting culture by ID. | — | — | — |
GET |
/v1/localization/languages | Get all the languages | — | — | — |
GET |
/v1/localization/languages/{guid} | Get language by ID | — | — | — |
GET |
/v1/localization/timezones | Get all the timezones. | — | — | — |
GET |
/v1/localization/timezones/{guid} | Get timezone by ID. | — | — | — |
GET |
/v1/marketsegments | Get the Market Segments. | — | — | — |
GET |
/v1/marketsegments/{guid} | Get Market Segment by ID. | — | — | — |
GET |
/v1/organizationdetails | Get the details of organization. | — | — | — |
GET |
/v1/organizationsettings | Get the settings of organization. | — | — | — |
GET |
/v1/overtimeprices/{guid} | Get overtime price by ID. | — | — | — |
GET |
/v1/overtimes | Get overtime definitions. | — | — | — |
GET |
/v1/overtimes/{guid} | Get overtime definition by ID. | — | — | — |
GET |
/v1/permissionprofiles | Get the Permission Profiles. | — | — | — |
GET |
/v1/permissionprofiles/{guid} | Get Permission Profile by ID. | — | — | — |
GET |
/v1/phasemembers | Get all active phase members | — | — | — |
GET |
/v1/phases | Get the phases. | — | — | — |
GET |
/v1/phases/{guid} | Get phase by ID | — | — | — |
GET |
/v1/phases/{phaseGuid}/phasemembers | Get phase members | — | — | — |
GET |
/v1/phases/{phaseGuid}/resourceallocations/allocations | Get resource allocations for a phase with required filters (startDate and endDate or changedSince, max 30 days to be fetched at once) | — | — | — |
GET |
/v1/phases/{phaseGuid}/worktypes | Get all work types that are available for a phase (for work hour entry) | — | — | — |
GET |
/v1/phasestatustypes | Get phase status types | — | — | — |
GET |
/v1/phasestatustypes/{guid} | Get phase status type by GUID | — | — | — |
GET |
/v1/pricelists | Get all price lists. | — | — | — |
GET |
/v1/pricelists/{guid} | Get price list by GUID. | — | — | — |
GET |
/v1/pricelists/{pricelistGuid}/pricelistversions | Get all price list versions of a price list. | — | — | — |
GET |
/v1/pricelistversions/{guid} | Get a price list version by guid. | — | — | — |
GET |
/v1/pricelistversions/{pricelistVersionGuid}/overtimeprices | Get all the overtime prices for a price list version. | — | — | — |
GET |
/v1/pricelistversions/{pricelistVersionGuid}/productprices | Get all the product prices for a price list version. | — | — | — |
GET |
/v1/pricelistversions/{pricelistVersionGuid}/travelprices | Get all the travel prices for a price list version. | — | — | — |
GET |
/v1/pricelistversions/{pricelistVersionGuid}/workhourprices | Get all the workHourPrices for a price list version. | — | — | — |
GET |
/v1/productcategories | Get product categories. | — | — | — |
GET |
/v1/productcategories/{guid} | Get product category by ID. | — | — | — |
GET |
/v1/productprices/{guid} | Get product price by ID. | — | — | — |
GET |
/v1/products | Get all the Products | — | — | — |
GET |
/v1/products/{guid} | Get product by ID. | — | — | — |
GET |
/v1/products/{productGuid}/productcountrysettings | Get all the country settings for a product | — | — | — |
GET |
/v1/projectbillingcustomers/{guid} | Get a project billing customer. | — | — | — |
GET |
/v1/projectfees | Get the project fees. | — | — | — |
GET |
/v1/projectfees/{guid} | Get projectFee by ID. | — | — | — |
GET |
/v1/projectfiles/{guid} | Get project file by ID. | — | — | — |
GET |
/v1/projectforecasts/{guid} | Get project forecast by ID | — | — | — |
GET |
/v1/projectinvoicesettings/{guid} | Get project invoice settings by ID. | — | — | — |
GET |
/v1/projectmembercostexceptions/{guid} | Get project member cost exception by ID. | — | — | — |
GET |
/v1/projectrecurringfeerules | Get the recurring fee rules. | — | — | — |
GET |
/v1/projectrecurringfeerules/{guid} | Get project's RecurringFeeRule by ID. | — | — | — |
GET |
/v1/projects | Get all the projects | — | — | — |
GET |
/v1/projects/customproperties | Get the project custom properties. | — | — | — |
GET |
/v1/projects/customproperties/projectcustompropertyselectionitems/{guid} | Get project custom property selection item by ID. | — | — | — |
GET |
/v1/projects/customproperties/{customPropertyGuid}/projectcustompropertyselectionitems | Get the project custom properties. | — | — | — |
GET |
/v1/projects/customproperties/{guid} | Get project custom property by ID. | — | — | — |
GET |
/v1/projects/customvalues/{guid} | Get project custom value by ID. | — | — | — |
GET |
/v1/projects/{guid} | Get project by ID | — | — | — |
GET |
/v1/projects/{guid}/phaseswithhierarchy | Get project's phases as flat list | — | — | — |
GET |
/v1/projects/{projectGuid}/customvalues | Get the project custom values. | — | — | — |
GET |
/v1/projects/{projectGuid}/files | Get all files of a project by its id. | — | — | — |
GET |
/v1/projects/{projectGuid}/flatrates | Get project's flat rates. | — | — | — |
GET |
/v1/projects/{projectGuid}/keywords | Get all the keywords for project. | — | — | — |
GET |
/v1/projects/{projectGuid}/overtimeprices | Get all the overtimePrices for a project. | — | — | — |
GET |
/v1/projects/{projectGuid}/productprices | Get all the productPrices for a project. | — | — | — |
GET |
/v1/projects/{projectGuid}/productsforproject | Gets available products for the given project where price information comes from projects price list | — | — | — |
GET |
/v1/projects/{projectGuid}/projectbillingcustomers | Get all the billing customers for a project | — | — | — |
GET |
/v1/projects/{projectGuid}/projectfees | Get all the project fees for a project | — | — | — |
GET |
/v1/projects/{projectGuid}/projectforecasts | Get the project forecasts | — | — | — |
GET |
/v1/projects/{projectGuid}/projectinvoicesettings | Get project invoice settings by project ID. | — | — | — |
GET |
/v1/projects/{projectGuid}/projectmembercostexceptions | Get all cost exceptions of project members for a project. | — | — | — |
GET |
/v1/projects/{projectGuid}/projectproducts | Get project products | — | — | — |
GET |
/v1/projects/{projectGuid}/projectrecurringfeerules | Get all the Recurring Fee Rules for a project | — | — | — |
GET |
/v1/projects/{projectGuid}/projectsalesnotes | Get the sales notes of a case. | — | — | — |
GET |
/v1/projects/{projectGuid}/projecttravelexpenses | Get all the project travel expenses for a project | — | — | — |
GET |
/v1/projects/{projectGuid}/projectworkhourprices | Get all the work hour prices for a project | — | — | — |
GET |
/v1/projects/{projectGuid}/projectworktypes | Get project work types. | — | — | — |
GET |
/v1/projects/{projectGuid}/proposals | Get all the proposals for a project | — | — | — |
GET |
/v1/projects/{projectGuid}/resourceallocations/allocations | Get resource allocations for a project with required filters (startDate and endDate or changedSince, max 30 days to be fetched at once) | — | — | — |
GET |
/v1/projects/{projectGuid}/salesstatushistory | Get the sales status history for a project | — | — | — |
GET |
/v1/projects/{projectGuid}/teamproductivity | Get team productivity of a project. | — | — | — |
GET |
/v1/projects/{projectGuid}/travelexpensetypes | Search active travel expense types of project by part of the name or code. | — | — | — |
GET |
/v1/projects/{projectGuid}/travelprices | Get all the travel prices for a project. | — | — | — |
GET |
/v1/projects/{projectGuid}/workhours | Get all the work hours for phases of a project for invoicing | — | — | — |
GET |
/v1/projects/{projectGuid}/worktypesforproject | Search active work types by part of the name or code. | — | — | — |
GET |
/v1/projectsalesnotes/{guid} | Get project sales note by ID. | — | — | — |
GET |
/v1/projectstatustypes | Get all the ProjectStatusTypes | — | — | — |
GET |
/v1/projectstatustypes/{guid} | Get projectStatusType by ID | — | — | — |
GET |
/v1/projecttaskstatuses | Get the project task statuses. | — | — | — |
GET |
/v1/projecttaskstatuses/{guid} | Get Project task status by ID. | — | — | — |
GET |
/v1/projecttravelexpensefiles/{guid} | Get travel expense file by ID. | — | — | — |
GET |
/v1/projecttravelexpenses | Get the project travel expenses. | — | — | — |
GET |
/v1/projecttravelexpenses/{guid} | Get project travel expense by ID. | — | — | — |
GET |
/v1/projecttravelexpenses/{projectTravelExpenseGuid}/files | Get all files of a travel expense by its id. | — | — | — |
GET |
/v1/projectworkhourprices/{guid} | Get project work hour price by ID | — | — | — |
GET |
/v1/proposalfeerows | Get the proposal fee rows. | — | — | — |
GET |
/v1/proposalfeerows/{guid} | Get the proposal fee rows by guid | — | — | — |
GET |
/v1/proposals | Get all the proposals | — | — | — |
GET |
/v1/proposals/{guid} | Get Proposal by ID | — | — | — |
GET |
/v1/proposals/{guid}/proposalsettings | Get settings for a proposal | — | — | — |
GET |
/v1/proposals/{proposalGuid}/proposalfeerows | Get all the proposal fee rows for a proposal | — | — | — |
GET |
/v1/proposals/{proposalGuid}/proposalsubtotals | Get all the proposal subtotals for a proposal | — | — | — |
GET |
/v1/proposals/{proposalGuid}/proposalworkrows | Get all the proposal work rows. | — | — | — |
GET |
/v1/proposalstatuses | Get all the proposal statuses | — | — | — |
GET |
/v1/proposalstatuses/{guid} | Get Proposal status by ID | — | — | — |
GET |
/v1/proposalstatuses/{guid}/usage | Get usage for an proposal status. | — | — | — |
GET |
/v1/proposalsubtotals | Get the proposal subtotals. | — | — | — |
GET |
/v1/proposalsubtotals/{guid} | Get Proposal subtotal by ID | — | — | — |
GET |
/v1/proposalworkrows | Get the proposal work rows. | — | — | — |
GET |
/v1/proposalworkrows/{guid} | Get the proposal work row by guid. | — | — | — |
GET |
/v1/resourceallocations | Get resource allocations | — | — | — |
GET |
/v1/resourceallocations/{guid} | Get resource allocation by ID | — | — | — |
GET |
/v1/roleallocations | Get role allocations. | — | — | — |
GET |
/v1/roleallocations/{guid} | Get role allocation by GUID. | — | — | — |
GET |
/v1/rootphaseswithhierarchy | Get a list of root phases with information about hierarchy. | — | — | — |
GET |
/v1/salesaccounts | Get sales accounts. | — | — | — |
GET |
/v1/salesaccounts/{guid} | Get sales account by ID. | — | — | — |
GET |
/v1/salescases | Gets the sales cases (sales status is in progress) | — | — | — |
GET |
/v1/salesstatustypes | Get all the sales status types | — | — | — |
GET |
/v1/salesstatustypes/{guid} | Get sales status type by ID | — | — | — |
GET |
/v1/timeentries | Get the time entries. | — | — | — |
GET |
/v1/timeentries/{guid} | Get time entry by ID. | — | — | — |
GET |
/v1/timeentrytypes | Get all time entry types. | — | — | — |
GET |
/v1/timeentrytypes/{guid} | Get time entry type by ID. | — | — | — |
GET |
/v1/travelexpensetypes | Get all the travel expense types. | — | — | — |
GET |
/v1/travelexpensetypes/{guid} | Get travel expense type by guid. | — | — | — |
GET |
/v1/travelexpensetypes/{travelExpenseTypeGuid}/travelexpensetypecountrysettings | Get all country settings for a travel expense type | — | — | — |
GET |
/v1/travelprices/{guid} | Get travel price by ID. | — | — | — |
GET |
/v1/travelreimbursements | Get travel reimbursements. | — | — | — |
GET |
/v1/travelreimbursements/{guid} | Get travel reimbursement by ID | — | — | — |
GET |
/v1/travelreimbursements/{guid}/pdf | Get a travel reimbursement PDF. | — | — | — |
GET |
/v1/travelreimbursements/{travelReimbursementGuid}/projecttravelexpenses | Get all the project travel expenses for a travel reimbursement | — | — | — |
GET |
/v1/travelreimbursementstatuses | Get the travel reimbursement statuses. | — | — | — |
GET |
/v1/travelreimbursementstatuses/{guid} | Get the travel reimbursement statuses by guid. | — | — | — |
GET |
/v1/vatrates | Get all organization vat rates | — | — | — |
GET |
/v1/vatrates/{guid} | Get a vat rate by GUID | — | — | — |
GET |
/v1/workcontracts/{guid} | Get work contract by ID. | — | — | — |
GET |
/v1/workhourprices/{guid} | Get work hour price by ID. | — | — | — |
GET |
/v1/workhours | Get the work hours. | — | — | — |
GET |
/v1/workhours/{guid} | Get work hour by ID | — | — | — |
GET |
/v1/worktypes | Get all work types. | — | — | — |
GET |
/v1/worktypes/{guid} | Get work type by ID. | — | — | — |