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 Inventory API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: Inventory
paths:
/v1/inventory/itemClass:
get:
tags:
- Inventory
summary: Get Inventory Item Classes
operationId: Inventory_GetItemClasses
parameters:
- 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/ItemClassDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemClassDto'
'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/inventory/itemclass/{itemClassNumber}:
get:
tags:
- Inventory
summary: Get Specific Inventory Item Class
operationId: Inventory_GetSpecificItemClassByitemClassNumber
parameters:
- name: itemClassNumber
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:
$ref: '#/components/schemas/ItemClassDto'
text/json:
schema:
$ref: '#/components/schemas/ItemClassDto'
'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/inventory/itemPostClass:
get:
tags:
- Inventory
summary: Get Inventory Item Post Classes
operationId: Inventory_GetItemPostClasses
parameters:
- 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/PostingClassDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/PostingClassDto'
'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/inventory/internal/{inventoryId}:
get:
tags:
- Inventory
summary: Get a specific Inventory item by its internal ID
operationId: Inventory_GetByinventoryId
parameters:
- name: inventoryId
in: path
description: Identifies the Inventory item
required: true
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:
$ref: '#/components/schemas/InventoryDto'
text/json:
schema:
$ref: '#/components/schemas/InventoryDto'
'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/inventory/{inventoryNumber}:
get:
tags:
- Inventory
summary: Get a specific Inventory item
operationId: Inventory_GetByinventoryNumber
parameters:
- name: inventoryNumber
in: path
description: Identifies the Inventory item
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/InventoryDto'
text/json:
schema:
$ref: '#/components/schemas/InventoryDto'
'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: []
put:
tags:
- Inventory
summary: Update a specific inventory item
description: Response Message has StatusCode NoContent if PUT operation succeed
operationId: Inventory_PutByinventoryNumber
parameters:
- name: inventoryNumber
in: path
description: Identifies the inventory item 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: The data to update for inventory item
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
required: true
x-bodyName: inventory
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'
security:
- interactiveapi: []
/v1/inventory:
get:
tags:
- Inventory
summary: Get a range of Inventory items - ScreenId=IN202000 and IN202500
description: Data for Inventory
operationId: Inventory_GetAll
parameters:
- 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.
MaxPageSize will be set to 5000 from 1. April 2022'
schema:
type: integer
format: int32
- name: alternateID
in: query
description: Applies for both Stock and Non-stock items. Some fields in this filter applies only for one of these.
schema:
type: string
- name: inventoryNumber
in: query
description: The Item ID.
schema:
type: string
- name: salesCategory
in: query
description: The Category ID for the sales category, found on the Attributes tab.
schema:
type: integer
format: int32
- name: addCostPriceStatistics
in: query
description: This filter can be used only for stock items, from the Price/cost information tab.
schema:
type: boolean
- name: attributes
in: query
description: " Attributes (additional information) connected to the entity.\n Examples:\n{{base}}/inventory?attributes={\"AttributeID\":\"ValueID\",\"AttributeID\":\"ValueID\"}\n{{base}}/inventory?attributes={\"AttributeID\":\"ValueID1,ValueID2\"}"
schema:
type: string
- name: description
in: query
description: A brief description of the stock item from the Top part of the window.
schema:
type: string
- name: availabilityLastModifiedDateTime
in: query
description: System retrieved information.
schema:
type: string
- name: availabilityLastModifiedDateTimeCondition
in: query
description: System retrieved information for state/condition.
schema:
type: string
- name: inventoryTypes
in: query
description: 'Filter on one or more inventory types: NonStockItem, LaborItem, ServiceItem, ChargeItem, ExpenseItem, FinishedGoodItem, ComponentPartItem or SubassemblyItem'
style: form
schema:
type: array
items:
type: string
- name: expandCrossReference
in: query
description: "These expand fields are by default set to true, but will be changed in the future. \nSet to true to retrieve information about the cross-references (item ID and suppliers/customers ID for the item connected to the item."
schema:
type: boolean
- name: expandAttachment
in: query
description: Set to true to retrieve information about the attachments connected to the item.
schema:
type: boolean
- name: expandAttribute
in: query
description: Set to true to retrieve the attribute descriptions used for the item.
schema:
type: boolean
- name: expandWarehouseDetail
in: query
description: Set to true to retrieve information about the warehouse connected to the item.
schema:
type: boolean
- name: expandAccountInformation
in: query
description: Set to true to retrieve information about the account information connected to the item.
schema:
type: boolean
- name: expandInventoryUnits
in: query
description: Set to true to retrieve information about the units of measure connected to the item.
schema:
type: boolean
- name: expandSupplierDetails
in: query
description: Set to true to retrieve details about the supplier connected to the item.
schema:
type: boolean
- name: expandSalesCategories
in: query
description: Set to true to retrieve details about the sales categories connected to the item.
schema:
type: boolean
- name: expandNote
in: query
description: Set to true to retrieve the note value connected to the item.
schema:
type: boolean
- name: attachmentLastModifiedDateTime
in: query
description: System retrieved information for last modified date and time for attachment.
schema:
type: string
- name: attachmentLastModifiedDateTimeCondition
in: query
description: System retrieved information for state/condition for attachment.
schema:
type: string
- name: status
in: query
description: The inventory item status
schema:
enum:
- Active
- NoSales
- NoPurchases
- NoRequest
- Inactive
- MarkedForDeletion
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: greaterThanValue
in: query
description: Greater than value. The item which is the object for this, varies from API to API.
schema:
type: string
- 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: createdDateTime
in: query
description: 'This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created 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:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.'
schema:
type: string
- name: createdDateTimeCondition
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:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.'
schema:
type: string
- name: pageNumber
in: query
description: Pagination parameter. Page number.
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/InventoryDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/InventoryDto'
'404':
description: NotFound
content:
application/json: {}
text/json: {}
'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: []
post:
tags:
- Inventory
summary: Create an inventory item
description: Response Message has StatusCode Created if POST operation succed
operationId: Inventory_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: Define the data for the inventory item to create
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/InventoryUpdateDto'
required: true
x-bodyName: inventory
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'
security:
- interactiveapi: []
/v1/inventory/barcode/shipment/{shipmentNbr}:
get:
tags:
- Inventory
summary: Get a range of barcodes for a specific shipment
operationId: Inventory_GetInventoryShipmentBarCodesByshipmentNbr
parameters:
- name: shipmentNbr
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:
type: array
items:
$ref: '#/components/schemas/BarCodeDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/BarCodeDto'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/BarCodeDto'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/BarCodeDto'
'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'
security:
- interactiveapi: []
/v1/inventory/barcode/salesorder/{orderNbr}:
get:
tags:
- Inventory
summary: Get a range of barcodes for a specific sales order
operationId: Inventory_GetInventorySalesOrderBarCodesByorderNbr
parameters:
- 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 detai
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-inventory-api-openapi.yml