Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/visma-purchase-order-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Visma.net ERP Purchase Order API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: Purchase Order
paths:
/v1/purchaseorder/{purchaseOrderNumber}:
get:
tags:
- Purchase Order
summary: Get a specific Purchase Order
description: 'Data for a single Purchase Order.
The response headers include an ETag after a successful GET operation.'
operationId: PurchaseOrder_GetOrderBypurchaseOrderNumber
parameters:
- name: purchaseOrderNumber
in: path
description: Identifies the Purchase Order
required: true
schema:
type: string
- name: includeCustomFreeFields
in: query
description: Optional parameter to request custom free fields.
schema:
type: boolean
- 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/PurchaseOrderDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseOrderDto'
'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:
- Purchase Order
summary: Update a Purchase Order
description: 'Response Message has StatusCode NoContent if PUT operation succeed.
Response Message has StatusCode BadRequest if PUT operation failed.
The response headers include an ETag after a successful PUT operation.'
operationId: PurchaseOrder_PutBypurchaseOrderNumber
parameters:
- name: purchaseOrderNumber
in: path
description: Identifies the Purchase 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
- name: If-Match
in: header
description: 'The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.
The If-Match header should be included in the request headers using the following syntax: If-Match: "etag_value"
* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.
* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.'
schema:
type: string
requestBody:
description: Defines the data for the Purchase Order to update
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
required: true
x-bodyName: purchaseOrderUpdateDto
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Purchase order version does not match with If-Match header
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: []
/v1/purchaseorder:
get:
tags:
- Purchase Order
summary: Get a range of Purchase Order - ScreenId=PO301000 Request page size must be…
operationId: PurchaseOrder_GetAllOrder
parameters:
- name: greaterThanValue
in: query
description: Filter on order no. and forward
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: 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: orderType
in: query
description: Select and filter on Type.
schema:
enum:
- RegularOrder
- DropShip
- Blanket
- StandardBlanket
type: string
- name: orderStatus
in: query
description: Select and filter on Status.
schema:
enum:
- Balanced
- Cancelled
- Closed
- Hold
- Open
- PendingEmail
- PendingPrint
- Printed
- Voided
type: string
- name: supplier
in: query
description: Filter on Supplier.
schema:
type: string
- name: branch
in: query
description: Filter on Branch
schema:
type: string
- name: orderDate
in: query
description: 'This value indicates the order date. Use it to retrieve all records that have the order date since that time, up to the future.
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:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: orderDateCondition
in: query
description: 'This value represents the condition to be applied to the order date 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:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: deliveryDate
in: query
description: 'This value indicates the date the document is due for delivery. Use it to retrieve all records that have the delivery date since that time, up to the future.
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:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: deliveryDateCondition
in: query
description: 'This value represents the condition to be applied to the Due Date 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:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: includeCustomFreeFields
in: query
description: Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set
schema:
type: boolean
- 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/PurchaseOrderDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/PurchaseOrderDto'
'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:
- Purchase Order
summary: Create a Purchase Order
description: 'Response Message has StatusCode Created if POST operation succeed.
Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.
The response headers include an ETag after a successful POST operation.'
operationId: PurchaseOrder_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 Purchase Order to create
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PurchaseOrderUpdateDto'
required: true
x-bodyName: purchaseOrderUpdateDto
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/purchaseorder/{purchaseorderNbr}/action/createpurchasereceipt:
post:
tags:
- Purchase Order
summary: Creates a purchase receipt from an existing purchase order
operationId: PurchaseOrder_CreatePurchaseReceiptFromPurchaseOrderBypurchaseorderNbr
parameters:
- name: purchaseorderNbr
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
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePurchaseReceiptActionDto'
text/json:
schema:
$ref: '#/components/schemas/CreatePurchaseReceiptActionDto'
application/xml:
schema:
$ref: '#/components/schemas/CreatePurchaseReceiptActionDto'
text/xml:
schema:
$ref: '#/components/schemas/CreatePurchaseReceiptActionDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreatePurchaseReceiptActionDto'
required: true
x-bodyName: createPurchaseReceiptActionDto
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: []
components:
schemas:
DtoValueOfNullableOfDateTime:
type: object
properties:
value:
type: string
format: date-time
DtoValueOfNullableOfGuid:
type: object
properties:
value:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
PurchaseOrderAddressUpdateDto:
type: object
properties:
overrideAddress:
$ref: '#/components/schemas/DtoValueOfNullableOfBoolean'
addressLine1:
$ref: '#/components/schemas/DtoValueOfString'
addressLine2:
$ref: '#/components/schemas/DtoValueOfString'
addressLine3:
$ref: '#/components/schemas/DtoValueOfString'
postalCode:
$ref: '#/components/schemas/DtoValueOfString'
city:
$ref: '#/components/schemas/DtoValueOfString'
countryId:
$ref: '#/components/schemas/DtoValueOfString'
county:
$ref: '#/components/schemas/DtoValueOfString'
DtoValueOfNullableOfPOShippingDestinationType:
type: object
properties:
value:
enum:
- CompanyLocation
- Customer
- Vendor
- Site
type: string
taxCategoryInPurchaseOrderLineDto:
properties:
number:
type: string
description: Number of item
description:
type: string
description: Name of item/description
description: VAT category > The VAT category assigned to the ordered stock item.
customDec2InPurchaseOrderLineUpdateDto:
properties:
value:
type: number
format: double
description: A free custom colum of type decimal with max 4 decimals.
glnInPurchaseOrderUpdateDto:
properties:
value:
type: string
description: Mandatory field if Supplier or VatRegistrationId is not specified.
CreatePurchaseReceiptActionDto:
required:
- orderType
type: object
properties:
orderType:
type: string
description: Mandatory field
inventoryInPurchaseOrderLineDto:
properties:
number:
type: string
description: Number of item
description:
type: string
description: Name of item/description
description: Item ID > The ID of the item.
customDec1InPurchaseOrderUpdateDto:
properties:
value:
type: number
format: double
description: A free custom colum of type decimal with max 4 decimals.
SegmentDto:
type: object
properties:
segmentId:
type: integer
description: The Segment values window > The Top part > The ID of the segment.
format: int32
segmentDescription:
type: string
description: The Segment values window > The Top part > The description of the segment.
segmentValue:
type: string
description: The Segment values window > The table > The value of the segment, alphanumeric.
segmentValueDescription:
type: string
description: The Segment values window > The table > The description of the segment value.
customStr1InPurchaseOrderLineUpdateDto:
properties:
value:
type: string
description: A free custom colum of type string with max length 100.
DtoValueOfNullableOfPoLineType:
type: object
properties:
value:
enum:
- GoodsForInventory
- GoodsForSalesOrder
- GoodsForReplenishment
- GoodsForDropShip
- NonStockForDropShip
- NonStockForSalesOrder
- NonStock
- Service
- Freight
- Description
type: string
customStr3InPurchaseOrderUpdateDto:
properties:
value:
type: string
description: A free custom colum of type string with max length 100.
customStr5InPurchaseOrderUpdateDto:
properties:
value:
type: string
description: A free custom colum of type string with max length 100.
customInt2InPurchaseOrderUpdateDto:
properties:
value:
type: integer
format: int32
description: A free custom colum of type int
projectTaskInPurchaseOrderLineDto:
properties:
internalId:
type: integer
description: The internal identifier.
format: int32
id:
type: string
description: Click on the magnifier. > The identifier.
description:
type: string
description: Click on the magnifier. > The description.
description: Project task > The project task with which this purchase order is associated.
vatRegistrationIdInPurchaseOrderUpdateDto:
properties:
value:
type: string
description: Mandatory field if Supplier or GLN is not specified.
discountCodeInPurchaseOrderLineDto:
properties:
number:
type: string
description: Number of item
description:
type: string
description: Name of item/description
description: Discount code > The code of the line discount that has been applied to this line automatically.
customDec2InPurchaseOrderUpdateDto:
properties:
value:
type: number
format: double
description: A free custom colum of type decimal with max 4 decimals.
accountInPurchaseOrderLineDto:
properties:
type:
type: string
number:
type: string
description: Number of item
description:
type: string
description: Name of item/description
description: Account > The expense account used to record the purchased non-stock item that does not require receipt (by default, the account specified for the item in the Combine COGS/expense sub. from field in the Posting classes (IN206000) window).
TaxCategoryNumberDescriptionDto:
type: object
properties:
number:
type: string
description: Number of item
description:
type: string
description: Name of item/description
TaxDetailDto:
type: object
properties:
taxId:
type: string
description: 'Mandatory field: VAT ID* > The ID of the VAT applied to the document.'
recordId:
type: integer
description: The id as stored in the database. It can be used when we want to update a VAT record.
format: int32
vatId:
$ref: '#/components/schemas/vatIdInTaxDetailDto'
vatRate:
type: number
description: VAT rate > The rate of the VAT.
format: double
taxableAmount:
type: number
description: Taxable amount > The taxable amount for the VAT, which is calculated at the document level.
format: double
vatAmount:
type: number
description: VAT > The VAT amount for the specific VAT, which is calculated at the document level.
format: double
expenseAmount:
type: number
description: Expense Amount for the VAT type that has been added.
format: double
description: This class represents a VAT Detail Line. Used for getting data.
DtoValueOfNullableOfBoolean:
type: object
properties:
value:
type: boolean
DtoValueOfPurchaseOrderAddressUpdateDto:
type: object
properties:
value:
$ref: '#/components/schemas/PurchaseOrderAddressUpdateDto'
warehouseInPurchaseOrderDto:
properties:
id:
type: string
description: Click on the magnifier. > The identifier.
description:
type: string
description: Click on the magnifier. > The description.
description: Document details tab > Warehouse > The warehouse to receive the item listed on the order.
PurchaseOrderDto:
type: object
properties:
shippingDestinationType:
enum:
- CompanyLocation
- Customer
- Vendor
- Site
type: string
description: 'Shipping instructions tab > The Delivery address section > Shipping destination type > The type of the shipping destination, which is one of the following options: Branch location (meaning a branch of your company), Customer, Supplier, and Warehouse.'
shipTo:
$ref: '#/components/schemas/shipToInPurchaseOrderDto'
shippingLocation:
$ref: '#/components/schemas/shippingLocationInPurchaseOrderDto'
warehouse:
$ref: '#/components/schemas/warehouseInPurchaseOrderDto'
shippingContact:
$ref: '#/components/schemas/shippingContactInPurchaseOrderDto'
shippingAddress:
$ref: '#/components/schemas/shippingAddressInPurchaseOrderDto'
fobPoint:
type: string
description: Delivery instructions tab > The Delivery instructions section > FOB point > The FOB point where the title of goods (listed on this purchase order) is transferred from the supplier to the company.
shipVia:
type: string
description: Delivery instructions tab > The Delivery instructions section > Ship via > The carrier selected to ship the goods for the purchase order.
shipTerms:
type: string
description: Delivery instructions tab > The Delivery instructions section > Shipping terms > The shipping terms for the purchase order.
remitContact:
$ref: '#/components/schemas/remitContactInPurchaseOrderDto'
remitAddress:
$ref: '#/components/schemas/remitAddressInPurchaseOrderDto'
terms:
$ref: '#/components/schemas/termsInPurchaseOrderDto'
supplierVatZone:
$ref: '#/components/schemas/supplierVatZoneInPurchaseOrderDto'
discountDetails:
type: array
items:
$ref: '#/components/schemas/DiscountDetailDto'
description: Discount details tab >
salesOrderType:
type: string
description: Other information tab > Sales order type > The type of the sales order associated with the purchase order.
salesOrderNbr:
type: string
description: Other information tab > Sales order no. > The ID of the sales order associated with the purchase order.
requisitionRefNbr:
type: string
description: Other information tab > Requisition ref. no. > The reference number of the requisition document associated with the purchase order, if any.
paymentRefNbr:
type: string
description: Other information tab > Prepayment ref. no. > The reference number of the prepayment request linked to this purchase order, if any.
workgroupID:
type: integer
description: Other information tab > Work group ID > The work group to which the purchase order was assigned for processing.
format: int32
dontPrint:
type: boolean
description: Other information > Do not print > A check box that indicates (if selected) that the current purchase order should not be printed.
printed:
type: boolean
description: Other information > Printed > A check box that indicates (if selected) that the current purchase order was printed.
dont
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-purchase-order-api-openapi.yml