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 Purchase Receipt API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: PurchaseReceipt
paths:
/v1/PurchaseReceipt/{receiptNumber}:
get:
tags:
- PurchaseReceipt
summary: Get a specific Purchase Receipt
description: 'Data for a single Purchase Receipt.
The response headers include an ETag after a successful GET operation.This method will be removed starting 15th September 2026. Please use GET api/v2/PurchaseReceipt instead.'
operationId: PurchaseReceipt_GetPurchaseReceiptBasicByreceiptNumber
parameters:
- name: receiptNumber
in: path
description: Identifies the Purchase Receipt
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/PurchaseReceiptDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptDto'
'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:
- PurchaseReceipt
summary: Update a specific Purchase Receipt
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: PurchaseReceipt_PutByreceiptNumber
parameters:
- name: receiptNumber
in: path
description: Identifies the Purchase Receipt 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 Receipt to update
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
required: true
x-bodyName: poReceiptUpdateDto
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Purchase receipt 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/PurchaseReceipt:
get:
tags:
- PurchaseReceipt
summary: Get a range of Purchase Receipts - ScreenId=PO302000 Please use a page size…
description: This method will be removed starting 15th September 2026. Please use GET api/v2/PurchaseReceipt instead.
operationId: PurchaseReceipt_GetAllReceiptBasic
parameters:
- name: receiptType
in: query
schema:
enum:
- PoReceipt
- PoReturn
- TransferReceipt
type: string
- name: status
in: query
schema:
enum:
- Hold
- Balanced
- Released
- Cancelled
type: string
- name: greaterThanValue
in: query
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: supplier
in: query
schema:
type: string
- name: poOrderNbr
in: query
schema:
type: string
- name: branch
in: query
schema:
type: string
- name: finPeriod
in: query
description: Filter by financial period, format YYYYPP
schema:
type: string
- name: receiptDate
in: query
description: 'This value indicates the receipt date. Use it to retrieve all records that have the receipt 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:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: receiptDateCondition
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:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: dueDate
in: query
description: 'This value indicates the date the document is due. Use it to retrieve all records that have the due 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:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: dueDateCondition
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:_ __DueDate__ and __DueDateCondition__ 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
Works only with PurchaseRecieptBasic and v2 of PurchaseReceipts.'
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/PurchaseReceiptDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/PurchaseReceiptDto'
'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:
- PurchaseReceipt
summary: Create a Purchase Receipt
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: PurchaseReceipt_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 Receipt to create
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PurchaseReceiptUpdateDto'
required: true
x-bodyName: poReceiptUpdateDto
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/PurchaseReceipt/{receiptNumber}/print:
get:
tags:
- PurchaseReceipt
summary: Get the print report of a Purchase Receipt
operationId: PurchaseReceipt_PrintPurchaseReceiptByreceiptNumber
parameters:
- name: receiptNumber
in: path
description: Identifies the receipt
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/PurchaseReceipt/{receiptNumber}/action/release:
post:
tags:
- PurchaseReceipt
summary: Release purchase receipt operation
description: The action result dto contains information about the result of running the action
operationId: PurchaseReceipt_ReleaseReceiptByreceiptNumber
parameters:
- name: receiptNumber
in: path
description: Reference number of the receipt to be released
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/ReleasePurchaseReceiptActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/ReleasePurchaseReceiptActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/ReleasePurchaseReceiptActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/ReleasePurchaseReceiptActionResultDto'
'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/PurchaseReceipt/{receiptNumber}/action/cancelReceipt:
post:
tags:
- PurchaseReceipt
summary: Cancel purchase receipt operation
operationId: PurchaseReceipt_CancelReceiptByreceiptNumber
parameters:
- name: receiptNumber
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: 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/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder:
post:
tags:
- PurchaseReceipt
summary: Add purchase orders to receipt
description: The action result DTO contains information about the result of running the action
operationId: PurchaseReceipt_AddPurchaseOrdersByreceiptNumber
parameters:
- name: receiptNumber
in: path
description: Reference number of the receipt to which to add the orders
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: Object containing an array of reference numbers of the orders to be added to the receipt
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderListUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderListUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderListUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderListUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderListUpdateDto'
required: true
x-bodyName: purchaseOrders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto'
'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/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines:
post:
tags:
- PurchaseReceipt
summary: Add purchase order lines to receipt
description: The action result dto contains information about the result of running the action
operationId: PurchaseReceipt_AddPurchaseOrderLinesByreceiptNumber
parameters:
- name: receiptNumber
in: path
description: Reference number of the receipt to which to add the orders
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: Object containing an array of reference numbers of the orders to be added to the receipt
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto'
required: true
x-bodyName: purchaseOrderLinesList
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto'
'202':
description: Server accepted and queued the request for background execution.
conten
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-purchasereceipt-api-openapi.yml