REST API for Spiris Lon / Visma Cloud Payroll covering employees, employments, salary transactions, absences, pay periods, payslips and accounting output. Published as OpenAPI 3.0.4 in two live versions, V2 (68 paths / 88 operations) and V1 (73 paths / 63 operations), served from vlsapi.vismaonline.com and sharing the Visma Online IdentityServer with eAccounting.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/visma-payroll-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"openapi": "3.0.4",
"info": {
"title": "Spiris Lön API V2",
"description": "Visit our complete [Spiris Lön/Cloud Payroll API docs](https://developer.vismaonline.com) for how to get started, more information about authentication, error handling, query customization and more.",
"contact": {
"email": "api@spiris.se"
},
"version": "v2"
},
"servers": [
{
"url": "https://vlsapi.vismaonline.com/"
}
],
"paths": {
"/v2/agreements": {
"get": {
"tags": [
"Agreements"
],
"summary": "Get agreements",
"description": "Get all agreements or add query parameters to filter the results. The response will include a paginated list of agreements.\r\n \r\n\r\n",
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponseOfAgreementResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"post": {
"tags": [
"Agreements"
],
"summary": "Creates an agreement.",
"description": "Creates an agreement.\r\n\r\n\r\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateAgreementRequest"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/agreements/{agreementId}": {
"get": {
"tags": [
"Agreements"
],
"summary": "Get agreement by id",
"description": " Gets an agreement by specified id.\r\n\r\n",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The agreement with the specified id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/breakrules": {
"get": {
"tags": [
"BreakRule"
],
"summary": "Get break rules",
"description": "Get all break rules or add query parameters to filter the results. The response will include a paginated list of break rules.\r\n\r\n\r\n",
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponseOfBreakRuleResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"post": {
"tags": [
"BreakRule"
],
"summary": "Create a break rule",
"description": "Create a break rule with properties specified in the request body\r\n\r\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateBreakRuleRequest"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Resource created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BreakRuleResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/breakrules/{breakRuleId}": {
"get": {
"tags": [
"BreakRule"
],
"summary": "Get break rule by id",
"description": "Gets a specific break rule by ID. Query options can be applied to customize the response. The response contains the requested break rule.\r\n\r\n\r\n",
"parameters": [
{
"name": "breakRuleId",
"in": "path",
"description": "The Id of the break rule",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BreakRuleResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/shortcuts/careofsickchild": {
"post": {
"tags": [
"CareOfSickChild"
],
"summary": "Create a care of sick child shortcut",
"description": "Create a new care of sick child shortcut for an employee. The shortcut will be registered based on the specified registration method (time, hours, or percentage). If the end date is in a different month than the start date, the shortcut will be split into separate shortcuts for each month.\r\n\r\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CareOfSickChildRequest"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CareOfSickChildResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/shortcuts/careofsickchild/{shortcutId}": {
"get": {
"tags": [
"CareOfSickChild"
],
"summary": "Get a care of sick child shortcut by id",
"description": "Get a specific care of sick child shortcut by its unique identifier. Use query parameters to select specific properties in the response.\r\n\r\n",
"parameters": [
{
"name": "shortcutId",
"in": "path",
"description": "The care of sick child shortcut id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CareOfSickChildResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"put": {
"tags": [
"CareOfSickChild"
],
"summary": "Update a care of sick child shortcut",
"description": "Update an existing care of sick child shortcut by replacing its content. Only shortcuts that have not been read (imported by a payroll administrator) can be updated. The shortcut must belong to the same third-party client that created it.\r\n\r\n",
"parameters": [
{
"name": "shortcutId",
"in": "path",
"description": "The shortcut id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CareOfSickChildRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CareOfSickChildResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"delete": {
"tags": [
"CareOfSickChild"
],
"summary": "Delete a care of sick child shortcut",
"description": "Delete a care of sick child shortcut by its unique identifier. Only shortcuts that have not been read (imported by a payroll administrator) can be deleted. The shortcut must belong to the same third-party client that created it.\r\n\r\n",
"parameters": [
{
"name": "shortcutId",
"in": "path",
"description": "The shortcut id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/shortcuts/careofsickchild/{startDate}/{endDate}": {
"get": {
"tags": [
"CareOfSickChild"
],
"summary": "Get care of sick child shortcuts between dates",
"description": "Get all care of sick child shortcuts within a specified date range. Use query parameters to filter the results or include only shortcuts created by the same client.\r\n\r\n",
"parameters": [
{
"name": "startDate",
"in": "path",
"description": "Start date in format yyyy-MM-dd",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "path",
"description": "End date in format yyyy-MM-dd",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "includeOnlySameClientShortcuts",
"in": "query",
"description": "If true, only includes shortcuts created by the same client",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CareOfSickChildResponse"
}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/migration/companysettings": { },
"/v2/migration/company/completeguide": { },
"/v2/migration/company/mtmigrationguidestatuscompleted": { },
"/v2/migration/company/guidestate": { },
"/v2/migration/employees": { },
"/v2/migration/employees/{employeeId}": { },
"/v2/employees": {
"get": {
"tags": [
"Employees"
],
"summary": "Get all employees",
"description": "Retrieves a paginated list of all employees in the company. \r\nYou can use query options ($filter, $select, $orderby, $top, $skip) to customize your request.\r\nThe endpoint includes both active and draft employees but excludes deleted employees. Limited employees are also included in the results.\r\n\r\n\r\n",
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponseOfEmployeeResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create employee",
"description": "Create employee in this company.\r\n\r\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateEmployeeRequest"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Resource created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEmployeeResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/employees/{employeeId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get employee by id",
"description": "Retrieves a specific employee by their unique identifier. The response includes comprehensive employee information such as personal details, contact information, address, employment status and other associated information.\nYou can use OData query options like `$select` to retrieve only specific fields from the employee record.\n\n\r\n\r\n",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "Id of the employee",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/employees/{employeeId}/workschedules": {
"post": {
"tags": [
"Employees"
],
"summary": "Create employee work schedule",
"description": "Add a work schedule to an employee.\r\n\r\n",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "Id of employee",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AddWorkScheduleToEmployeeRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddWorkScheduleToEmployeeResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/employees/{employeeId}/agreements": {
"post": {
"tags": [
"Employees"
],
"summary": "Create employee agreement",
"description": "Add an agreement to an employee.\r\n\r\n",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "Id of employee",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AddAgreementToEmployeeRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddAgreementToEmployeeResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/externalperiods": {
"get": {
"tags": [
"ExternalPeriods"
],
"summary": "Get external periods",
"description": "Get external periods.\n\r\n\r\n",
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponseOfExternalPeriodResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"post": {
"tags": [
"ExternalPeriods"
],
"summary": "Create an external period",
"description": "Create an external period.\n\nThe request is validated as follows:\n\n- A project/cost-center distribution is required.\n- Within each of `Project`, `CostCenter1`, `CostCenter2` and `CostCenter3`, percentages must be non-negative and total at most 100%. An allocation with a percentage of 0 is kept and applied as a 0% row on the payslip; it is not discarded.\n- Referenced projects and cost center items must exist on the company, and each cost center item must belong to the cost center dimension it is supplied under.\n- For requests that carry a project/cost-center distribution, `DeviationPeriodToDate` must match the employee's payroll period settings (the last day of a month, or the company's configured payment period day).\n- The period cannot be earlier than the employee's latest locked payslip.\n\nA validation failure returns `400 Bad Request` with a message describing the failing rule.\n\r\n\r\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalPeriodRequest"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalPeriodResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/externalperiods/{externalPeriodId}": {
"get": {
"tags": [
"ExternalPeriods"
],
"summary": "Get external period by unique identifier",
"description": "Get external period by unique identifier.\n\r\n\r\n",
"parameters": [
{
"name": "externalPeriodId",
"in": "path",
"description": "The external period unique identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalPeriodResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"delete": {
"tags": [
"ExternalPeriods"
],
"summary": "Delete an external period",
"description": "Delete an external period.\n\r\n\r\n",
"parameters": [
{
"name": "externalPeriodId",
"in": "path",
"description": "The external period unique identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/externalperiods/{employeeId}/{deviationDate}": {
"get": {
"tags": [
"ExternalPeriods"
],
"summary": "Get external period by employee and deviation date",
"description": "Get external period by employee and deviation date.\n\r\n\r\n",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The unique identifier of the employee",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "deviationDate",
"in": "path",
"description": "The deviation date in format yyyy-MM-dd",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalPeriodResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/shortcuts/holiday": {
"post": {
"tags": [
"Holiday"
],
"summary": "Create a holiday shortcut",
"description": "Create a new holiday shortcut for an employee. The shortcut will be registered based on the specified registration method (time, hours or percentage).\r\n\r\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/HolidayRequest"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HolidayResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
}
},
"/v2/shortcuts/holiday/{shortcutId}": {
"get": {
"tags": [
"Holiday"
],
"summary": "Get a holiday shortcut by id",
"description": "Get a specific holiday shortcut by its unique identifier. Use query parameters to select specific properties in the response.\r\n\r\n",
"parameters": [
{
"name": "shortcutId",
"in": "path",
"description": "The holiday shortcut id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HolidayResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"put": {
"tags": [
"Holiday"
],
"summary": "Update a holiday shortcut",
"description": "Update an existing holiday shortcut by replacing its content. Only shortcuts that have not been read (imported by a payroll administrator) can be updated. The shortcut must belong to the same third-party client that created it.\r\n\r\n",
"parameters": [
{
"name": "shortcutId",
"in": "path",
"description": "The shortcut id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/HolidayRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Request successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HolidayResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonExtendedBadRequest"
}
}
}
}
}
},
"delete": {
"tags": [
"Holiday"
],
"summary": "Delete a holiday shortcut",
"description": "Delete a holiday shortcut by its unique identifier. Only shortcuts that have not been read (imported by a payroll administrator) can be deleted. The shortcut must belong to the same third-party client that created it.\r\n\r\n",
"parameters": [
{
"name": "shortcutId",
"in": "path",
"description": "The shortcut id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Request successful"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
# --- truncated at 32 KB (418 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-payroll-api-v2-openapi.json