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 Basic API

The SalesOrderBasic API from Visma — 10 operation(s) for salesorderbasic.

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

Tagged areas include SalesOrderBasic. 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 12 operations across 10 paths, and defines 50 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.

12 operations 10 paths 50 schemas 2 DELETE3 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 12

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

SalesOrderBasic 12
GET
/v1/salesorderbasic/{orderNbr}deprecated
Get a specific SO Order
SalesOrderBasic_GetByorderNbr 2 params → 200202
PUT
/v1/salesorderbasic/{orderNbr}deprecated
Update a specific Sale Order
SalesOrderBasic_PutByorderNbr 2 params body → 204202
GET
/v1/salesorderbasic/{orderType}/{orderNbr}deprecated
Get a specific type of Order
SalesOrderBasic_GetOrderByTypeByorderTypeorderNbr 3 params → 200202
GET
/v1/salesorderbasicdeprecated
Get a range of Sale Orders - ScreenId=SO301000 Request page size must be lower…
SalesOrderBasic_GetAllOrders 12 params → 200202
POST
/v1/salesorderbasicdeprecated
Create a Sale Order
SalesOrderBasic_Post 1 param body → 201202
POST
/v1/salesorderbasic/{saleOrderNumber}/action/createShipment
Crete shipment operation
SalesOrderBasic_CreateShipmentActionBysaleOrderNumber 2 params body → 200202
POST
/v1/salesorderbasic/{orderNumber}/attachmentdeprecated
Creates an attachment and associates it with a sales order.
SalesOrderBasic_CreateHeaderAttachmentByorderNumber 2 params → 201202
POST
/v1/salesorderbasic/orderType/{orderType}/{orderNumber}/attachment
Creates an attachment and associates it with a sales order on a specific order…
SalesOrderBasic_CreateHeaderAttachmentByorderNumberorderType 3 params → 201202
POST
/v1/salesorderbasic/{orderNumber}/{lineNumber}/attachmentdeprecated
Creates an attachment and associates it with a certain sales order line.
SalesOrderBasic_CreateLineAttachmentByorderNumberlineNumber 3 params → 201202
POST
/v1/salesorderbasic/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment
Creates an attachment and associates it with a certain sales order line on a…
SalesOrderBasic_CreateLineAttachmentByorderNumberorderTypelineNumber 4 params → 201202
DELETE
/v1/salesorderbasic/{orderType}/{orderNumber}/{lineNumber}/attachment/{fileId}
Delete an attachment and remove associates it with a certain sales order line…
SalesOrderBasic_DeleteLineAttachmentByorderNumberorderTypelineNumberfileId 5 params → 200202
DELETE
/v1/salesorderbasic/{orderType}/{orderNumber}/attachment/{fileId}
Delete an attachment and remove associates it with a certain sales order on a…
SalesOrderBasic_DeleteOrderAttachmentByorderNumberorderTypefileId 4 params → 200202

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are ShipmentDto (52 properties), SalesOrderBasicDto (31 properties), ShipmentDetailLineDto (30 properties), SalesOrderDocumentLineDto (22 properties). Each schema is shown below with its type and property counts.

inventoryIdInSalesOrderBasicLineUpdateDto
object
InventoryId is deprecated, please use InventoryNumber instead.
1 property
WarehouseIdDescriptionDto
object
2 properties
AttachmentDto
object
3 properties
deliveryContactInShipmentDto
object
Delivery settings tab Delivery address contact section
9 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
ShipmentOrderLineDto
object
10 properties
customerInSalesOrderBasicUpdateDto
object
Mandatory field if GLN or VatRegistrationId is not specified.
1 property
fobPointInShipmentDto
object
Delivery settings tab Shipping information section FOB point The point where obligation of goods passes to the customer.
2 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
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
SalesOrderDocumentLineDto
object
This class represents a SOOrder in SOOrderController. Used by getting data.
22 properties
glnInSalesOrderBasicUpdateDto
object
Mandatory field if Customer or VatRegistrationId is not specified.
1 property
BranchNumberDto
object
2 properties
inventoryNumberInSalesOrderBasicLineUpdateDto
object
Mandatory field
1 property
DtoValueOfNullableOfDecimal
object
1 property
modeOfTrasportInShipmentDto
object
Delivery settings tab Intrastat section Mode of transportation The method of transportation.
2 properties
orderTypeInSalesOrderBasicUpdateDto
object
Mandatory field
1 property
CreateShipmentActionDto
object
5 properties 3 required
ShipmentDto
object
This class represents a Shipment in ShipmentController. Used by getting data.
52 properties
countyInShipmentAddressDto
object
County The county or province.
2 properties
PackageDetailLineDto
object
14 properties
shippingTermsInShipmentDto
object
Delivery settings tab Shipping information section Shipping terms The shipping terms used in relations with the customer.
2 properties
warehouseInShipmentDetailLineDto
object
Mandatory field: Document details tab Warehouse The warehouse from which the items is shipped.
2 properties
shippingZoneInShipmentDto
object
Delivery settings tab Shipping information section Shipping zone ID The shipping zone of the customer.
2 properties
ShipmentDetailLineDto
object
30 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
AllocationsDto
object
This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptController. Used for getting data.
8 properties
SalesOrderBasicUpdateDto
object
This class represent a Sales Order in Sales Order Controller. Used to pass data to server for creating or updating an order
19 properties 1 required
SalesOrderBasicDto
object
This class represents a SOOrder in SOOrderController. Used by getting data.
31 properties
customerInSalesOrderBasicDto
object
The top part Customer The customer that has ordered the goods or services.
3 properties
branchNumberInSalesOrderBasicDto
object
Mandatory field: Document details tab Branch The branch of the company.
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
DtoValueOfNullableOfDateTime
object
1 property
SalesOrderBasicLineUpdateDto
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
17 properties 1 required
vatRegistrationIdInSalesOrderBasicUpdateDto
object
Mandatory field if Customer or GLN is not specified.
1 property
DtoValueOfNullableOfInt32
object
1 property
MetadataDto
object
2 properties
CreateShipmentActionResultDto
object
5 properties
fromWarehouseInShipmentDto
object
Mandatory field: The top part Warehouse ID The warehouse from which the goods should be shipped.
2 properties
locationInAllocationsDto
object
Location The location in the warehouse.
3 properties
locationInSalesOrderBasicDto
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
countryInShipmentAddressDto
object
Country The country.
4 properties
DtoValueOfBoolean
object
1 property
deliveryAddressInShipmentDto
object
Delivery settings tab Delivery address section
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

visma-salesorderbasic-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 Basic 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.