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 Sales Order API

The Sales Order API from Visma — 15 operation(s) for sales order.

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

Tagged areas include Sales Order. 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 17 operations across 15 paths, and defines 92 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.

17 operations 15 paths 92 schemas 2 DELETE6 GET8 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 Sales Order API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (interactiveapi) using the authorizationCode flow, exposing 5 scopes.

Paths & Operations 17

Across 15 paths, the API surfaces 17 operations — 2 DELETE, 6 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Sales Order 17
GET
/v1/salesorder/{orderNbr}deprecated
Get a specific SO Order
SalesOrder_GetByorderNbr 2 params → 200202
PUT
/v1/salesorder/{orderNbr}deprecated
Update a specific Sale Order
SalesOrder_PutByorderNbr 2 params body → 204202
GET
/v1/salesorder/{orderType}/{orderNbr}deprecated
Get a specific type of Order
SalesOrder_GetOrderByTypeByorderTypeorderNbr 3 params → 200202
GET
/v1/salesorder/{orderType}/{orderNbr}/rotrutdeprecated
Get ROT/RUT details for a specific type of order
SalesOrder_GetROTRUTByorderTypeorderNbr 3 params → 200202
GET
/v1/salesorderdeprecated
Get a range of SO Orders - ScreenId=SO301000 Request page size must be lower or…
SalesOrder_GetAllOrders 12 params → 200202
POST
/v1/salesorderdeprecated
Create a Sale Order
SalesOrder_Post 1 param body → 201202
GET
/v1/salesorder/{orderType}/{orderNbr}/commissionsdeprecated
Get Sales Order Commissions - ScreenId=SO301000, tab Commissions
SalesOrder_GetCommissionsByorderTypeorderNbr 3 params → 200202
GET
/v1/salesorder/{orderType}/{orderNumber}/printOrder
Get the print report of the Sales Order Quote
SalesOrder_PrintOrderByorderNumberorderType 3 params → 200202
POST
/v1/salesorder/{saleOrderNumber}/action/createShipment
Create shipment operation
SalesOrder_CreateShipmentActionBysaleOrderNumber 2 params body → 200202
POST
/v1/salesorder/{saleOrderNumber}/action/cancelSalesOrderdeprecated
Cancel Order action
SalesOrder_CancelSalesOrderBysaleOrderNumber 2 params body → 200202
POST
/v1/salesorder/{salesOrderNumber}/action/reopenSalesOrderdeprecated
Reopen and update a specific Sales Order.
SalesOrder_ReopenSalesOrderBysalesOrderNumber 2 params body → 200202
POST
/v1/salesorder/{orderNumber}/attachmentdeprecated
Creates an attachment and associates it with a sales order.
SalesOrder_CreateHeaderAttachmentByorderNumber 2 params → 201202
POST
/v1/salesorder/orderType/{orderType}/{orderNumber}/attachment
Creates an attachment and associates it with a sales order on a specific order…
SalesOrder_CreateHeaderAttachmentByorderNumberorderType 3 params → 201202
POST
/v1/salesorder/{orderNumber}/{lineNumber}/attachmentdeprecated
Creates an attachment and associates it with a certain sales order line.
SalesOrder_CreateLineAttachmentByorderNumberlineNumber 3 params → 201202
POST
/v1/salesorder/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment
Creates an attachment and associates it with a certain sales order line on a…
SalesOrder_CreateLineAttachmentByorderNumberorderTypelineNumber 4 params → 201202
DELETE
/v1/salesorder/{orderType}/{orderNumber}/{lineNumber}/attachment/{fileId}
Delete an attachment and remove associates it with a certain sales order line…
SalesOrder_DeleteLineAttachmentByorderNumberorderTypelineNumberfileId 5 params → 200202
DELETE
/v1/salesorder/{orderType}/{orderNumber}/attachment/{fileId}
Delete an attachment and remove associates it with a certain sales order on a…
SalesOrder_DeleteOrderAttachmentByorderNumberorderTypefileId 4 params → 200202

Schemas 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are SalesOrderDto (75 properties), saleOrderUpdateDtoInReopenSalesOrderActionDto (55 properties), SalesOrderUpdateDto (55 properties), ShipmentDto (52 properties). Each schema is shown below with its type and property counts.

subaccountInSalesOrderLineDto
object
Subaccount A subcategory of the account that carries identifying information.
3 properties
SalesOrderShipmentDto
object
10 properties
AttachmentDto
object
3 properties
SalesOrderLineDto
object
45 properties
customerInShipmentDto
object
The top part Customer The customer to whom the goods specified in the document should be shipped. (This field does not appear for transfers.)
3 properties
shipViaInShipmentDto
object
Delivery settings tab Shipping information section Ship via The carrier used for shipping the goods.
2 properties
paymentMethodInSalesOrderDto
object
Payment settings tab Payment method
2 properties
InventoryNumberDescriptionDto
object
2 properties
locationInShipmentDetailLineDto
object
Document details tab Location The location in the warehouse from which the item is shipped.
3 properties
DtoValueOfString
object
1 property
modeOfTrasportInShipmentDto
object
Delivery settings tab Intrastat section Mode of transportation The method of transportation.
2 properties
countyInShipmentAddressDto
object
County The county or province.
2 properties
shippingTermsInShipmentDto
object
Delivery settings tab Shipping information section Shipping terms The shipping terms used in relations with the customer.
2 properties
ShipmentDetailLineDto
object
30 properties
RotRutBasicDto
object
6 properties
AllocationsDto
object
This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptController. Used for getting data.
8 properties
shippingZoneInSalesOrderDto
object
Delivery settings tab Shipping information section Shipping zone
2 properties
SalesOrderDto
object
This class represents a SOOrder in SOOrderController. Used by getting data.
75 properties
soBillingAddressInSalesOrderDto
object
Financial settings tab Invoice address section
9 properties
customerVATZoneInSalesOrderDto
object
Financial settings tab Financial information section Customer VAT zone The customers VAT zone to be used to process customer sales orders, which generally is t…
6 properties
DtoValueOfNullableOfInt32
object
1 property
countryInSalesOrderAddressDto
object
Country The country.
4 properties
salesPersonInSalesOrderLineDto
object
Salesperson ID The salesperson associated with the sale of the line item.
2 properties
transactionTypeInSalesOrderDto
object
Delivery settings tab Intrastat section Transaction type
2 properties
salesPersonInSalesOrderDto
object
The Commissions tab Salesperson ID The salesperson.
2 properties
WarehouseIdDescriptionDto
object
2 properties
termsInSalesOrderDto
object
Mandatory field: Financial settings tab Financial information section Terms The credit terms used in relations with the customer. See also window CS206500.
2 properties
locationInSalesOrderDto
object
Mandatory field: The top part Location The customer location from which the goods or services have been ordered or, if the sales order is created from an oppor…
3 properties
SalesOrderContactUpdateDto
object
8 properties
ownerInSalesOrderDto
object
The Financial settings tab Financial information section Owner The user in the work group who is responsible for the sales order.
3 properties
soBillingContactInSalesOrderDto
object
The Financial settings tab The Invoice address section or on the Delivery address section
9 properties
saleOrderUpdateDtoInReopenSalesOrderActionDto
object
Mandatory
55 properties
ShipmentOrderLineDto
object
10 properties
RotRutDistributionUpdateDto
object
5 properties
locationInShipmentDto
object
Mandatory field: The top part Location The customer location to receive the shipment.
3 properties
ownerInShipmentDto
object
The top part Owner The user assigned to approve the document.
2 properties
shippingZoneInShipmentDto
object
Delivery settings tab Shipping information section Shipping zone ID The shipping zone of the customer.
2 properties
DtoValueOfNullableOfInt16
object
1 property
DtoValueOfNullableOfInventoryReplenishmentSources
object
1 property
DtoValueOfNullableOfDateTime
object
1 property
soShippingContactInSalesOrderDto
object
Delivery settings tab Delivery address contact section
9 properties
DtoValueOfSalesOrderAddressUpdateDto
object
1 property
TaxCategoryNumberDescriptionDto
object
2 properties
CreateShipmentActionResultDto
object
5 properties
countryInShipmentAddressDto
object
Country The country.
4 properties
ReopenSalesOrderActionDto
object
1 property 1 required
BranchNumberDto
object
2 properties
vatRegistrationIdInSalesOrderUpdateDto
object
Mandatory field if Customer or GLN is not specified.
1 property
deliveryContactInShipmentDto
object
Delivery settings tab Delivery address contact section
9 properties
DtoValueOfNullableOfRutRotTypes
object
1 property
SalesOrderUpdateDto
object
This class represent a Sales Order in Sales Order Controller. Used to pass data to server for creating or updating an order
55 properties 1 required
fobPointInSalesOrderDto
object
Delivery settings tab Shipping information section FOB point The point where ownership of the goods is transferred to the customer.
2 properties
SegmentUpdateDto
object
2 properties
SalesOrderLineUpdateDto
object
This class represent a Sales Order Line in Sales Order Controller. Used to pass data to server for creating or updating an order line
39 properties 1 required
SalesOrderAddressUpdateDto
object
8 properties
DtoValueOfNullableOfDecimal
object
1 property
shipViaInSalesOrderDto
object
The Delivery settings tab Shipping information section Ship via The Ship via code that represents the carrier and its service to be used for shipping the order…
2 properties
CreateShipmentActionDto
object
5 properties 3 required
glnInSalesOrderUpdateDto
object
Mandatory field if Customer or VatRegistrationId is not specified.
1 property
warehouseInShipmentDetailLineDto
object
Mandatory field: Document details tab Warehouse The warehouse from which the items is shipped.
2 properties
DtoValueOfNullableOfBoolean
object
1 property
toWarehouseInShipmentDto
object
The top part To warehouse The warehouse to which the goods should be shipped in case of a transfer.
2 properties
inventoryNumberInSalesOrderLineUpdateDto
object
Mandatory field
1 property
MetadataDto
object
2 properties
DtoValueOfSalesOrderContactUpdateDto
object
1 property
DtoValueOfNullableOfGuid
object
1 property
DtoValueOfNullableOfSalesOrderOperations
object
1 property
branchNumberInSalesOrderDto
object
Mandatory field: Document details tab Branch The branch of the company.
2 properties
DtoValueOfBoolean
object
1 property
customerInSalesOrderUpdateDto
object
Mandatory field if GLN or VatRegistrationId is not specified.
1 property
ReopenSalesOrderActionResultDto
object
3 properties
DtoValueOfNullableOfSalesOrderShipCompleteStatuses
object
1 property
fobPointInShipmentDto
object
Delivery settings tab Shipping information section FOB point The point where obligation of goods passes to the customer.
2 properties
countyInSalesOrderAddressDto
object
County The county or province.
2 properties
customerInSalesOrderDto
object
The top part Customer The customer that has ordered the goods or services.
3 properties
SOCommissionDto
object
4 properties
inventoryIdInSalesOrderLineUpdateDto
object
InventoryId is deprecated, please use InventoryNumber instead.
1 property
ShipmentDto
object
This class represents a Shipment in ShipmentController. Used by getting data.
52 properties
PackageDetailLineDto
object
14 properties
BackgroundApiAcceptedDto
object
2 properties
transactionTypeInShipmentDto
object
Delivery settings tab Intrastat section Transaction type The 1-digit code that describes the nature of the transaction (according to EU regulations for Intrast…
2 properties
preferredWarehouseInSalesOrderDto
object
The Delivery settings tab The shipping information section Preferred warehouse ID
2 properties
RotRutDistributionDto
object
This class represents a RutRot Distribution Line For RutRot in RutRotController. Used for getting data.
4 properties
RotRutUpdateDto
object
6 properties
shippingTermsInSalesOrderDto
object
Delivery settings tab Shipping information section Shipping terms
2 properties
soShippingAddressInSalesOrderDto
object
Delivery settings tab Delivery address section
9 properties
orderTypeInSalesOrderUpdateDto
object
Mandatory field
1 property
fromWarehouseInShipmentDto
object
Mandatory field: The top part Warehouse ID The warehouse from which the goods should be shipped.
2 properties
CancelSalesOrderActionDto
object
1 property 1 required
locationInAllocationsDto
object
Location The location in the warehouse.
3 properties
CancelSalesOrderActionResultDto
object
3 properties
deliveryAddressInShipmentDto
object
Delivery settings tab Delivery address section
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

visma-sales-order-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 Sales Order 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.