How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Visma Customer Contract API

The Customer Contract API from Visma — 11 operation(s) for customer contract.

Visma Customer Contract API is one of 193 APIs that Visma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customer Contract. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, rate-limit docs, and a support channel.

This API exposes 13 operations across 11 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.finance.visma.net.

13 operations 11 paths 33 schemas 5 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://business.visma.net/api/graphql
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Visma Customer Contract API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (interactiveapi) using the authorizationCode flow, exposing 5 scopes.

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 5 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer Contract 13
GET
/v1/customerContract/{contractId}
Get a specific Customer Contract
CustomerContract_GetCustomerContractBycontractId 2 params → 200202
PUT
/v1/customerContract/{contractId}
Update a specific CustomerContract
CustomerContract_PutBycontractId 3 params body → 204412202
GET
/v1/customerContract
Get a range of Customer Contracts, a filter needs to be specified…
CustomerContract_GetAll 14 params → 200202
POST
/v1/customerContract
Create a CustomerContract
CustomerContract_CreateCustomerContract 1 param body → 201202
GET
/v1/customerContract/{contractId}/summary
Get a specific Customer Contract Summary
CustomerContract_GetCustomerContractSummaryBycontractId 2 params → 200202
GET
/v1/customerContract/{contractId}/details
Get a specific Customer Contract Details
CustomerContract_GetCustomerContractDetailsBycontractId 2 params → 200202
GET
/v1/customerContract/{contractId}/recurringSummary
Get a specific Customer Contract Recurring Summary
CustomerContract_GetCustomerContractRecurringSummaryBycontractId 2 params → 200202
POST
/v1/customerContract/{contractId}/action/setupContract
Setup contract operation
CustomerContract_SetupContractBycontractId 4 params → 412202
POST
/v1/customerContract/{contractId}/action/activateContract
Activate contract operation
CustomerContract_ActivateContractBycontractId 4 params → 412202
POST
/v1/customerContract/{contractId}/action/setupAndActivateContract
Setup and Activate contract operation
CustomerContract_SetupAndActivateContractBycontractId 4 params → 412202
POST
/v1/customerContract/{contractId}/action/terminateContract
Terminate contract operation
CustomerContract_TerminateContractBycontractId 4 params → 412202
POST
/v1/customerContract/{contractId}/action/upgradeContract
Upgrade contract operation
CustomerContract_UpgradeContractBycontractId 3 params → 412202
POST
/v1/customerContract/{contractId}/action/activateUpgrade
Activate upgrade contract operation
CustomerContract_ActivateUpgradeBycontractId 4 params → 412202

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are CustomerContractUpdateDto (19 properties), summaryInCustomerContractDto (18 properties), CustomerContractSummaryDto (18 properties), CustomerContractDetailsLineDto (13 properties). Each schema is shown below with its type and property counts.

detailsInCustomerContractDto
object
Details tab
10 properties
CustomerContractRecurringSummaryDto
object
This class represents the CustomerContractRecurringSummary in CustomerContractController. Used for getting data.
4 properties
LocationNameDescriptionDto
object
2 properties
CustomerContractDto
object
This class represents a CustomerContract in CustomerContractController. Used for getting data.
12 properties
attributeIdInAttributeLineUpdateDto
object
The ID of the attribute on the line.
1 property
summaryInCustomerContractDto
object
Summary tab
18 properties
DtoValueOfNullableOfInvoiceToType
object
1 property
CustomerContractUpdateDto
object
19 properties
CustomerContractDetailsLineDto
object
This class represents a CustomerContractDetailLine in CustomerContractController. Used for getting data.
13 properties
customerInCustomerContractUpdateDto
object
Mandatory for POST, not applicable for PUT.
1 property
caseCountItemInCustomerContractSummaryDto
object
Contract management section Case count item A non-stock item used for counting cases associated with the contract.
2 properties
CustomerContractSummaryDto
object
This class represents the CustomerContractSummary in CustomerContractController. Used for getting data.
18 properties
DtoValueOfString
object
1 property
CustomerContractRecurringSummaryLineDto
object
This class represents a CustomerContractRecurringSummaryLine in CustomerContractController. Used for getting data.
11 properties
CustomerContractDetailsUpdateDto
object
8 properties
DtoValueOfNullableOfDecimal
object
1 property
contractTemplateInCustomerContractDto
object
Mandatory field: The top part Contract template The contract template that is used as a base for the contract.
2 properties
CustomerContractDetailsDto
object
This class represents the CustomerContractDetails in CustomerContractController. Used for getting data.
10 properties
contractTemplateInCustomerContractUpdateDto
object
Mandatory for POST, not applicable for PUT.
1 property
BackgroundApiAcceptedDto
object
2 properties
invoiceAccountInCustomerContractSummaryDto
object
Invoice information section Account The specific account that is to be invoiced for contract services.
2 properties
PromoCodeIdDescriptionDto
object
2 properties
DtoValueOfNullableOfBoolean
object
1 property
AttributeIdValueDto
object
3 properties
DtoValueOfNullableOfDateTime
object
1 property
contractIdInCustomerContractUpdateDto
object
Mandatory for POST, not applicable for PUT.
1 property
DtoValueOfInt32
object
1 property
customerInCustomerContractDto
object
Mandatory field: The top part Customer The customer associated with the contract.
2 properties
DtoValueOfNullableOfInt32
object
1 property
ownerInCustomerContractSummaryDto
object
Contract management section Owner The owner of the contract.
3 properties
salesPersonInCustomerContractSummaryDto
object
Contract management Salesperson The salesperson associated with the contract.
2 properties
AttributeLineUpdateDto
object
2 properties
locationInCustomerContractDto
object
The top part Location The customer location associated with the contract.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

visma-customer-contract-api-openapi.yml Raw ↑

Other APIs Visma publishes across the network.

Visma Business NXT GraphQL API
Visma Account API
Visma Accounts API
Visma Agreements API
Visma Allocation Periods API
Visma Approval API
Visma App Store Activation Status API
Visma Article Account Codings API
Visma Article Labels API
Visma Articles API
Visma Attachment API
Visma Attachment Links API
Where this information came from

This is an independent, third-party profile of Visma Customer Contract API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.