Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Visma.net ERP Sales Order API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: Sales Order
paths:
/v1/salesorder/{orderNbr}:
get:
tags:
- Sales Order
summary: Get a specific SO Order
description: 'Data for a single Sales Order. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_GetByorderNbr
parameters:
- name: orderNbr
in: path
description: Identifies the Sales Order Number
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SalesOrderDto'
text/json:
schema:
$ref: '#/components/schemas/SalesOrderDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- interactiveapi: []
put:
tags:
- Sales Order
summary: Update a specific Sale Order
description: 'Response Message has StatusCode NoContent if PUT operation succeed. Response Message has StatusCode BadRequest if PUT operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_PutByorderNbr
parameters:
- name: orderNbr
in: path
description: Identifies the Sale Order to update
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
requestBody:
description: Defines the data for the Sale Order to update
content:
application/json:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
required: true
x-bodyName: saleOrderUpdateDto
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- interactiveapi: []
/v1/salesorder/{orderType}/{orderNbr}:
get:
tags:
- Sales Order
summary: Get a specific type of Order
description: 'Data for a single Sales Order. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_GetOrderByTypeByorderTypeorderNbr
parameters:
- name: orderType
in: path
description: Identifies the Sales Order Type
required: true
schema:
type: string
- name: orderNbr
in: path
description: Identifies the Sales Order Number
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SalesOrderDto'
text/json:
schema:
$ref: '#/components/schemas/SalesOrderDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- interactiveapi: []
/v1/salesorder/{orderType}/{orderNbr}/rotrut:
get:
tags:
- Sales Order
summary: Get ROT/RUT details for a specific type of order
description: 'OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_GetROTRUTByorderTypeorderNbr
parameters:
- name: orderType
in: path
description: ''
required: true
schema:
type: string
- name: orderNbr
in: path
description: ''
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RotRutBasicDto'
text/json:
schema:
$ref: '#/components/schemas/RotRutBasicDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- interactiveapi: []
/v1/salesorder:
get:
tags:
- Sales Order
summary: Get a range of SO Orders - ScreenId=SO301000 Request page size must be lower or…
description: 'Data for all Sales Orders. Response Message has StatusCode OK if GET operation succeed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_GetAllOrders
parameters:
- name: orderType
in: query
description: Filter by Order type.
schema:
type: string
- name: status
in: query
description: Select to filter on status on order.
schema:
enum:
- Open
- Hold
- CreditHold
- Completed
- Cancelled
- BackOrder
- Shipping
- Invoiced
- PendingApproval
- Voided
type: string
- name: greaterThanValue
in: query
description: Filter on Order no. greater than value.
schema:
type: string
- name: numberToRead
in: query
description: This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
schema:
type: integer
format: int32
- name: skipRecords
in: query
description: This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
schema:
type: integer
format: int32
- name: orderBy
in: query
description: This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.
schema:
type: string
- name: showNotes
in: query
description: Set to true to include notes.
schema:
type: boolean
- name: lastModifiedDateTime
in: query
description: 'This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.
Accepted format:
* ```yyyy-MM-dd```
* ```yyyy-MM-dd HH:mm:ss```
* ```yyyy-MM-dd HH:mm:ss.FFF```
* ```yyyy-MM-ddTHH:mm:ss```
* ```yyyy-MM-ddTHH:mm:ss.FFF```
_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.'
schema:
type: string
- name: lastModifiedDateTimeCondition
in: query
description: 'This value represents the condition to be applied when retrieving records.
Accepted values (without the single quotes):
* ''>'' for greater than
* ''<'' for less than
* ''>='' for greater than or equal
* ''<='' for less than or equal
_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.'
schema:
type: string
- name: pageNumber
in: query
description: Pagination parameter. Page number.
schema:
type: integer
format: int32
- name: pageSize
in: query
description: 'Pagination parameter. Number of items to be collected.
Please use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.
If requested page size is greater than allowed max page size, request will be limited to max page size.'
schema:
type: integer
format: int32
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SalesOrderDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/SalesOrderDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- interactiveapi: []
post:
tags:
- Sales Order
summary: Create a Sale Order
description: 'Response Message has StatusCode Created if POST operation succeed. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_Post
parameters:
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
requestBody:
description: Defines the data for the Sale Order to create
content:
application/json:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SalesOrderUpdateDto'
required: true
x-bodyName: saleOrderUpdateDto
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- interactiveapi: []
/v1/salesorder/{orderType}/{orderNbr}/commissions:
get:
tags:
- Sales Order
summary: Get Sales Order Commissions - ScreenId=SO301000, tab Commissions
description: 'Data for all Sales Order Commissions. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_GetCommissionsByorderTypeorderNbr
parameters:
- name: orderType
in: path
required: true
schema:
type: string
- name: orderNbr
in: path
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SOCommissionDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/SOCommissionDto'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/SOCommissionDto'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/SOCommissionDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
application/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- interactiveapi: []
/v1/salesorder/{orderType}/{orderNumber}/printOrder:
get:
tags:
- Sales Order
summary: Get the print report of the Sales Order Quote
description: The File is in Content of the message
operationId: SalesOrder_PrintOrderByorderNumberorderType
parameters:
- name: orderNumber
in: path
description: Identifies the order
required: true
schema:
type: string
- name: orderType
in: path
description: Identifies the Sales Order Type
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
/v1/salesorder/{saleOrderNumber}/action/createShipment:
post:
tags:
- Sales Order
summary: Create shipment operation
description: The action result dto contains information about the result of running the action
operationId: SalesOrder_CreateShipmentActionBysaleOrderNumber
parameters:
- name: saleOrderNumber
in: path
description: Reference number of the sale oreder from which the shipment will be created
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
requestBody:
description: Defines the data for the action
content:
application/json:
schema:
$ref: '#/components/schemas/CreateShipmentActionDto'
text/json:
schema:
$ref: '#/components/schemas/CreateShipmentActionDto'
application/xml:
schema:
$ref: '#/components/schemas/CreateShipmentActionDto'
text/xml:
schema:
$ref: '#/components/schemas/CreateShipmentActionDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateShipmentActionDto'
required: true
x-bodyName: createShipmentActionDto
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateShipmentActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/CreateShipmentActionResultDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
/v1/salesorder/{saleOrderNumber}/action/cancelSalesOrder:
post:
tags:
- Sales Order
summary: Cancel Order action
description: 'The action result dto contains information about the result of running the action. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html'
operationId: SalesOrder_CancelSalesOrderBysaleOrderNumber
parameters:
- name: saleOrderNumber
in: path
description: Reference number of the sale oreder that will be cancelled
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
requestBody:
description: Defines the data for the action
content:
application/json:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionDto'
text/json:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionDto'
application/xml:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionDto'
text/xml:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionDto'
required: true
x-bodyName: cancelSalesOrderActionDto
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/CancelSalesOrderActionResultDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
application/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
deprecated: true
security:
- inter
# --- truncated at 32 KB (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-sales-order-api-openapi.yml