Visma

Visma Break Rule API

Creating or getting break rules of the company.

GitHub OpenAPI

Operations 5

GET /v1/breakrules Get break rules #
GET /v1/breakrules/{breakRuleId} Get break rule by id #
GET /v2/breakrules Get break rules #
POST /v2/breakrules Create a break rule #
GET /v2/breakrules/{breakRuleId} Get break rule by id #

Documentation

📖
Documentation
https://docs.vismasoftware.no/vismanetapi/
📖
APIReference
https://docs.vismasoftware.no/vismanetapi/api-reference/
📖
GettingStarted
https://docs.vismasoftware.no/vismanetapi/introduction/getting-started-with-visma-net-api/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/rate-limits/visma-rate-limits.yml
📖
Documentation
https://developer.vismaonline.com/docs/spiris-eaccounting-api-documentation
📖
APIReference
https://eaccountingapi.vismaonline.com/swagger/ui/index
📖
Documentation
https://developer.vismaonline.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-breakrule-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/asyncapi/visma-net-erp-webhooks.yml
🔗
Support
https://docs.vismasoftware.no/vismanetapi/support/
🔗
Deprecation
https://docs.vismasoftware.no/vismanetapi/end-of-life-notices/
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/conventions/visma-conventions.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/llms/visma-eaccounting-llms.txt
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/errors/visma-problem-types.yml
🔗
ChangeLog
https://developer.vismaonline.com/changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/visma-breakrule-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

visma-breakrule-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Visma Break Rule API
  contact:
    email: api@spiris.se
  version: '1.0'
  description: 'Operations tagged BreakRule across 2 of this provider''s published API definitions: visma-payroll-api-v1-openapi-original.json, visma-payroll-api-v2-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://vlsapi.vismaonline.com/
tags:
- name: BreakRule
  description: Creating or getting break rules of the company.
paths:
  /v1/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.
      responses:
        '200':
          description: Request successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponseOfBreakRuleApi'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonExtendedBadRequest'
      operationId: getV1Breakrules
      x-operation-id-source: derived
    servers:
    - url: https://vlsapi.vismaonline.com/
  /v1/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.
      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/BreakRuleApi'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonExtendedBadRequest'
      operationId: getV1BreakrulesByBreakRuleId
      x-operation-id-source: derived
    servers:
    - url: https://vlsapi.vismaonline.com/
  /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.
      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'
      operationId: getV2Breakrules
      x-operation-id-source: derived
    post:
      tags:
      - BreakRule
      summary: Create a break rule
      description: Create a break rule with properties specified in the request body
      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'
      operationId: postV2Breakrules
      x-operation-id-source: derived
    servers:
    - url: https://vlsapi.vismaonline.com/
  /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.
      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'
      operationId: getV2BreakrulesByBreakRuleId
      x-operation-id-source: derived
    servers:
    - url: https://vlsapi.vismaonline.com/
components:
  schemas:
    CommonPaginationMetadata:
      required:
      - CurrentPage
      - PageSize
      - ServerTimeUtc
      - TotalNumberOfPages
      - TotalNumberOfResults
      type: object
      properties:
        CurrentPage:
          type: integer
          description: The current page number
          format: int32
        PageSize:
          type: integer
          description: The number of results per page
          format: int32
        TotalNumberOfPages:
          type: integer
          description: The total number of pages available
          format: int32
        TotalNumberOfResults:
          type: integer
          description: The total number of results available for the query
          format: int32
        ServerTimeUtc:
          type: string
          description: The date-time notation as defined by RFC 3339, section 5.6  2017-07-21T17:32:28Z
          format: date-time
      additionalProperties: false
    CommonError:
      type: object
      properties:
        Field:
          type:
          - string
          - 'null'
        ErrorCode:
          type:
          - string
          - 'null'
        Message:
          type:
          - string
          - 'null'
        Key:
          type:
          - string
          - 'null'
      additionalProperties: false
    CommonExtendedBadRequest:
      type: object
      properties:
        ErrorCode:
          type: integer
          format: int32
        DeveloperErrorMessage:
          type:
          - string
          - 'null'
        ErrorId:
          type: string
          format: uuid
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonError'
      additionalProperties: false
    PaginatedResponseOfBreakRuleApi:
      required:
      - Data
      - Meta
      type: object
      properties:
        Meta:
          allOf:
          - $ref: '#/components/schemas/CommonPaginationMetadata'
        Data:
          type: array
          items:
            $ref: '#/components/schemas/BreakRuleApi'
      additionalProperties: false
    BreakRuleApi:
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier for the break rule
          format: uuid
        Name:
          type:
          - string
          - 'null'
          description: Name of the break rule
        StartTime:
          type:
          - string
          - 'null'
          description: Start time of the break period in HH:mm format
        EndTime:
          type:
          - string
          - 'null'
          description: End time of the break period in HH:mm format
        MinLengthInMinutes:
          type: integer
          description: Minimum length of the break in minutes
          format: int32
        NormalLengthInMinutes:
          type: integer
          description: Normal expected length of the break in minutes
          format: int32
        Type:
          type:
          - integer
          - 'null'
          description: 'Type of break<br/>Possible values: 0 - Lunch, 1 - FirstBreak, 2 - SecondBreak'
          format: int32
        Comment:
          type:
          - string
          - 'null'
          description: Additional comments or notes about the break rule
        CreatedUtc:
          type: string
          description: Timestamp when the break rule was created (UTC)
          format: date-time
        ModifiedUtc:
          type: string
          description: Timestamp when the break rule was last modified (UTC)
          format: date-time
        IsDeleted:
          type: boolean
          description: Indicates whether the break rule is marked as deleted
      additionalProperties: false
    CreateBreakRuleRequest:
      required:
      - EndTime
      - MinLengthInMinutes
      - Name
      - NormalLengthInMinutes
      - StartTime
      - Type
      type: object
      properties:
        Name:
          minLength: 1
          type: string
          description: Name of the break rule
        StartTime:
          minLength: 1
          type: string
          description: Start time of the break period in HH:mm format
        EndTime:
          minLength: 1
          type: string
          description: End time of the break period in HH:mm format
        MinLengthInMinutes:
          maximum: 1440
          minimum: 0
          type: integer
          description: Minimum length of the break in minutes. Must be between 0 and 1440 (24 hours)
          format: int32
        NormalLengthInMinutes:
          maximum: 1440
          minimum: 0
          type: integer
          description: Normal expected length of the break in minutes. Must be between 0 and 1440 (24 hours)
          format: int32
        Type:
          type: integer
          description: 'Type of break<br/>Possible values: 0 - Lunch, 1 - FirstBreak, 2 - SecondBreak'
          format: int32
        Comment:
          type:
          - string
          - 'null'
          description: Additional comments or notes about the break rule
      additionalProperties: false
    BreakRuleResponse:
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier for the break rule
          format: uuid
        Name:
          type:
          - string
          - 'null'
          description: Name of the break rule
        StartTime:
          type:
          - string
          - 'null'
          description: Start time of the break period in HH:mm format
        EndTime:
          type:
          - string
          - 'null'
          description: End time of the break period in HH:mm format
        MinLengthInMinutes:
          type: integer
          description: Minimum length of the break in minutes
          format: int32
        NormalLengthInMinutes:
          type: integer
          description: Normal expected length of the break in minutes
          format: int32
        Type:
          type:
          - integer
          - 'null'
          description: 'Type of break<br/>Possible values: 0 - Lunch, 1 - FirstBreak, 2 - SecondBreak'
          format: int32
        Comment:
          type:
          - string
          - 'null'
          description: Additional comments or notes about the break rule
        CreatedUtc:
          type: string
          description: Timestamp when the break rule was created (UTC)
          format: date-time
        ModifiedUtc:
          type: string
          description: Timestamp when the break rule was last modified (UTC)
          format: date-time
      additionalProperties: false
    PaginatedResponseOfBreakRuleResponse:
      required:
      - Data
      - Meta
      type: object
      properties:
        Meta:
          allOf:
          - $ref: '#/components/schemas/CommonPaginationMetadata'
        Data:
          type: array
          items:
            $ref: '#/components/schemas/BreakRuleResponse'
      additionalProperties: false
x-refined-from:
- visma-payroll-api-v1-openapi-original.json
- visma-payroll-api-v2-openapi-original.json
x-tagGroups:
- name: Sales
  tags:
  - ArticleLabels
  - Articles
  - CustomerInvoiceDrafts
  - CustomerInvoiceOffsets
  - CustomerInvoices
  - CustomerInvoiceValuationHistories
  - CustomerLabels
  - CustomerLedgerItems
  - Customers
  - DeliveryMethods
  - DeliveryTerms
  - DiscountAgreements
  - Orders
  - QuoteDrafts
  - Quotes
  - SalesPriceLists
  - TermsOfPayment
  - WebshopOrders
- name: Purchase
  tags:
  - BankAccounts
  - ForeignPaymentCodes
  - PurchaseReceiptDrafts
  - SupplierInvoiceDrafts
  - SupplierInvoices
  - SupplierInvoiceValuationHistories
  - SupplierLedgerItems
  - Suppliers
- name: Common
  tags:
  - Approval
  - AppStoreActivationStatus
  - AttachmentLinks
  - Attachments
  - AutoInvoice
  - Bank
  - Charts
  - CompanySettings
  - Company
  - Countries
  - Currencies
  - Documents
  - IdentityLookup
  - MessageThreads
  - Mobile
  - Notes
  - PartnerResourceLinks
  - SalesDocumentAttachments
  - Trials
  - Units
  - Users
  - VoTokenValidation
  - WebHooks
  - Zapier
- name: Accounting
  tags:
  - AccountBalance
  - Accounts
  - AccountTypes
  - AllocationPeriods
  - ArticleAccountCodings
  - BankTransactions
  - CostCenterItems
  - CostCenters
  - FiscalYears
  - InventoryItems
  - PaymentVoucher
  - Projects
  - SieFileImportExport
  - VatCode
  - VatReport
  - VoucherDrafts
  - Vouchers
  - VoucherWithOverunderPayment