Visma Purchase Receipt API
The PurchaseReceipt API from Visma — 7 operation(s) for purchasereceipt.
Visma Purchase Receipt API is one of 193 APIs that Visma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PurchaseReceipt. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, rate-limit docs, and a support channel.
This API exposes 9 operations across 7 paths, and defines 108 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://api.finance.visma.net.
9 operations
7 paths
108 schemas
3 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Visma Purchase Receipt API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (interactiveapi) using the authorizationCode flow, exposing 5 scopes.
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 3 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
PurchaseReceipt 9
GET
/v1/PurchaseReceipt/{receiptNumber}deprecated
Get a specific Purchase Receipt
PUT
/v1/PurchaseReceipt/{receiptNumber}
Update a specific Purchase Receipt
GET
/v1/PurchaseReceiptdeprecated
Get a range of Purchase Receipts - ScreenId=PO302000 Please use a page size…
POST
/v1/PurchaseReceipt
Create a Purchase Receipt
GET
/v1/PurchaseReceipt/{receiptNumber}/print
Get the print report of a Purchase Receipt
POST
/v1/PurchaseReceipt/{receiptNumber}/action/release
Release purchase receipt operation
POST
/v1/PurchaseReceipt/{receiptNumber}/action/cancelReceipt
Cancel purchase receipt operation
POST
/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder
Add purchase orders to receipt
POST
/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines
Add purchase order lines to receipt
Schemas 108
The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are PurchaseReceiptLineDto (50 properties), PurchaseReceiptLineUpdateDto (47 properties), PurchaseReceiptDto (38 properties), PurchaseReceiptUpdateDto (29 properties). Each schema is shown below with its type and property counts.
customStr4InPurchaseReceiptUpdateDto
object
A free custom colum of type string with max length 100.
1 property
actualAccountIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The accrual account to record the item amount on the purchase receipt; used for stock items and non-stock items for which a receipt is…
1 property
InventoryNumberDescriptionDto
object
2 properties
AddOrderLinesToPurchaseReceiptActionResultDto
object
3 properties
unitCostInPurchaseReceiptLineUpdateDto
object
The Document details tab The cost of a unit of the purchased item.
1 property
DtoValueOfString
object
1 property
uomInAllocationsUpdateDto
object
UoM The unit of measure for the specified quantity of the inventory item.
1 property
PurchaseReceiptOrderUpdateDto
object
This class represents a Purchase Order reference number to add to a Purchase Receipt.
3 properties
locationIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The location where the item has been received.
1 property
customStr1InPurchaseReceiptLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
customStr3InPurchaseReceiptUpdateDto
object
A free custom colum of type string with max length 100.
1 property
customDateTimeUTC1InPurchaseReceiptLineUpdateDto
object
A free custom colum of type DateTime - in UTC timezone
1 property
customDateTimeUTC1InPurchaseReceiptUpdateDto
object
A free custom colum of type DateTime - in UTC timezone
1 property
AllocationsUpdateDto
object
This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptEndpoint. Used to add/update data.
7 properties
AllocationsDto
object
This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptController. Used for getting data.
8 properties
taxCategoryInLandedCostDto
object
Landed costs tab VAT category VAT category associated with supplier's VAT zone.
2 properties
PurchaseReceiptUpdateDto
object
This class represents a Purchase Receipt in PurchaseReceiptController. Used for getting data.
29 properties
transactionDescriptionInPurchaseReceiptLineUpdateDto
object
The Document details tab The description of the receipt or return transaction.
1 property
inventoryIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The item ID of the received item.
1 property
transferOrderNbrInPurchaseReceiptLineUpdateDto
object
The Document details tab The reference number of the transfer order to which this receipt is linked.
1 property
PurchaseReceiptLineUpdateDto
object
This class represents a Purchase Order Line in PurchaseReceiptContraoller. Used for getting data.
47 properties
discountCodeIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The code of the line discount that has been applied to this line automatically.
1 property
customDec2InPurchaseReceiptUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
transferOrderTypeInPurchaseReceiptLineUpdateDto
object
The Document details tab The type of the transfer order to which this receipt is linked.
1 property
lotSerialNumberInPurchaseReceiptLineUpdateDto
object
The Document details tab The lot or serial number assigned to the received quantity of the purchased item;
1 property
amountInPurchaseReceiptLineUpdateDto
object
The Document details tab The amount calculated (after discount has been taken) for the item.
1 property
manualDiscountInPurchaseReceiptLineUpdateDto
object
The Document details tab A check box that indicates (if selected) that the discount has been applied manually.
1 property
projectTaskIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The project task with which the document is associated.
1 property
customStr2InPurchaseReceiptUpdateDto
object
A free custom colum of type string with max length 100.
1 property
branchInPurchaseReceiptLineDto
object
Branch is deprecated, please use BranchNumber instead.
2 properties
DtoValueOfCustomerDocumentTypes
object
1 property
PurchaseReceiptOrderListUpdateDto
object
This class represents a list of Purchase Orders to add to a Purchase Receipt.
1 property
completePoLineInPurchaseReceiptLineUpdateDto
object
The Document details tab A check box that indicates to the system (if selected) that the purchase order line added to this receipt line should be considered co…
1 property
taxCategoryIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The VAT category assigned to the stock item.
1 property
customStr4InPurchaseReceiptLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
DtoValueOfNullableOfSupplierDocumentType
object
1 property
uomInPurchaseReceiptLineUpdateDto
object
The Document details tab The unit of measure (UoM) used for the purchased or transferred item. By default, it is the purchase unit.
1 property
customInt2InPurchaseReceiptUpdateDto
object
A free custom colum of type int
1 property
supplierInPurchaseReceiptDto
object
Mandatory field: The top part Supplier The supplier from which the items have been received or to which they will be returned.
3 properties
customInt2InPurchaseReceiptLineUpdateDto
object
A free custom colum of type int
1 property
supplierInLandedCostDto
object
Mandatory field: Landed costs tab Supplier The landed cost supplier to whom the landed cost amount will be paid.
3 properties
customInt1InPurchaseReceiptUpdateDto
object
A free custom colum of type int
1 property
branchIdInPurchaseReceiptLineUpdateDto
object
BranchId is deprecated, please use BranchNumber instead.
1 property
customStr5InPurchaseReceiptUpdateDto
object
A free custom colum of type string with max length 100.
1 property
projectIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The project with which the document is associated.
1 property
DtoValueOfNullableOfDateTime
object
1 property
PurchaseReceiptOrderLineNbrUpdateDto
object
Represents a Purchase Order line number to add to a Purchase Receipt.
1 property
expirationDateInAllocationsUpdateDto
object
Expiration date The expiration date of the specified quantity of the stock item.
1 property
actualSubInPurchaseReceiptLineDto
object
Document details tab Accrual sub. The subaccount used to record the item amount on the purchase receipt, used for stock items and non-stock items for which a r…
3 properties
LandedCostDto
object
This class represents a Landed Cost Line for Purchase Receipt in PurchaseReceiptController. Used for getting data.
17 properties
subInPurchaseReceiptLineDto
object
Document details tab Sub ID The subaccount to be used to record the non-stock item amount on the purchase receipt (for non-stock items for which receipts are n…
3 properties
actualAccountInPurchaseReceiptLineDto
object
Document details tab Accrual account The accrual account to record the item amount on the purchase receipt; used for stock items and non-stock items for which…
3 properties
customDec1InPurchaseReceiptUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
taxCategoryInPurchaseReceiptLineDto
object
Document details tab VAT category The VAT category assigned to the stock item.
2 properties
termsInLandedCostDto
object
Landed costs tab Terms The credit terms used in relations with the landed cost supplier.
2 properties
warehouseIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The warehouse where the item has been received.
1 property
DtoValueOfPurchaseReceiptType
object
1 property
customStr1InPurchaseReceiptUpdateDto
object
A free custom colum of type string with max length 100.
1 property
accountInPurchaseReceiptLineDto
object
Document details tab Account The account used to record the item amount on the purchase receipt;
3 properties
poOrderLineNbrInPurchaseReceiptLineUpdateDto
object
This property replaced by an action please use the following sub-endpoint:/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines
1 property
customDec2InPurchaseReceiptLineUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
SegmentUpdateDto
object
2 properties
lotSerialNumberInAllocationsUpdateDto
object
Lot/Serial no. The lot or serial number of the item.
1 property
DtoValueOfNullableOfDecimal
object
1 property
branchNumberInPurchaseReceiptDto
object
Mandatory field: Document details tab Branch The branch to which the document belongs.
2 properties
customInt1InPurchaseReceiptLineUpdateDto
object
A free custom colum of type int
1 property
locationInAllocationsUpdateDto
object
Location The location in the warehouse.
1 property
extCostInPurchaseReceiptLineUpdateDto
object
The Document details tab The extended cost of the item, which is the unit price multiplied by the quantity.
1 property
projectInPurchaseReceiptLineDto
object
Document details tab Project The project with which the document is associated. If the document is based on a purchase order, the project is automatically copi…
3 properties
PurchaseReceiptOrderLinesListUpdateDto
object
This class represents a collection of Purchase Orders reference numbers and associated line numbers. Used to add Purchase Order lines to a Purchase Receipt.
1 property
warehouseInPurchaseReceiptDto
object
Mandatory field: The top part or the Documents details tab Warehouse The warehouse from which the items have been received for transfer orders.
2 properties
DtoValueOfNullableOfBoolean
object
1 property
AddOrdersToPurchaseReceiptActionResultDto
object
3 properties
lineTypeInPurchaseReceiptLineUpdateDto
object
The Document details tab The type of the purchase receipt line.
1 property
warehouseInPurchaseReceiptLineDto
object
Mandatory field: Document details tab Warehouse The warehouse where the item has been received.
2 properties
MetadataDto
object
2 properties
postPeriodInPurchaseReceiptUpdateDto
object
The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY.
1 property
customStr3InPurchaseReceiptLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
transferOrderLineNbrInPurchaseReceiptLineUpdateDto
object
The Document details tab The line number in the transfer order to which this receipt is linked.
1 property
receiptQtyInPurchaseReceiptLineUpdateDto
object
The Document details tab The quantity of the item in the specified UoM that has been received (listed on released receipts).
1 property
discountPercentInPurchaseReceiptLineUpdateDto
object
The Document details tab The automatically calculated or manually entered discount percent on the line.
1 property
locationInLandedCostDto
object
Mandatory field: Landed costs tab Location The location of the selected landed cost supplier.
3 properties
accountIdInPurchaseReceiptLineUpdateDto
object
The Document details tab The account used to record the item amount on the purchase receipt; used for non-stock items for which receipt is not required.
1 property
branchNumberInPurchaseReceiptLineDto
object
Mandatory field: Document details tab Branch The branch for which the item is purchased.
2 properties
PurchaseReceiptLineDto
object
This class represents a Purchase Order Line in PurchaseReceiptContraoller. Used for getting data.
50 properties
LandedCostUpdateDto
object
This class represents a Landed Cost Line for Purchase Receipt in PurchaseReceiptController. Used for getting data.
18 properties
customStr5InPurchaseReceiptLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
expirationDateInPurchaseReceiptLineUpdateDto
object
The Document details tab The expiration date of the received item.
1 property
locationInPurchaseReceiptDto
object
Mandatory field: The top part Location The supplier location from which the items should be received or to which they should be returned.
3 properties
poOrderTypeInPurchaseReceiptLineUpdateDto
object
The Document details tab The type of the purchase order related to this purchase receipt.
1 property
lineNbrInAllocationsUpdateDto
object
Line no. The line of the purchase order that contains the selected item.
1 property
discountCodeInPurchaseReceiptLineDto
object
Document details tab Discount code The code of the line discount that has been applied to this line automatically.
2 properties
BackgroundApiAcceptedDto
object
2 properties
branchNumberInPurchaseReceiptLineUpdateDto
object
The Document details tab The number of the branch to which the purchase receipt line belongs.
1 property
PurchaseReceiptOrderLinesUpdateDto
object
Represents a collection of Purchase Order lines belonging to a specific Purchase Order.
3 properties
projectTaskInPurchaseReceiptLineDto
object
Document details tab Project task The project task with which the document is associated.
3 properties
quantityInAllocationsUpdateDto
object
Quantity The quantity of the stock item with the same lot number. It is 1 for items with serial numbers.
1 property
lineNbrInPurchaseReceiptLineUpdateDto
object
The Document details tab The number of the purchase receipt line.
1 property
customDec1InPurchaseReceiptLineUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
DtoValueOfInt32
object
1 property
PurchaseReceiptDto
object
This class represents a Purchase Receipt in PurchaseReceiptController. Used for getting data.
38 properties
locationInPurchaseReceiptLineDto
object
Document details tab Location The location where the item has been received.
3 properties
poOrderNbrInPurchaseReceiptLineUpdateDto
object
This property replaced by an action, please use the following sub-endpoint:/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder.
1 property
customStr2InPurchaseReceiptLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
locationInAllocationsDto
object
Location The location in the warehouse.
3 properties
accountDescriptionInPurchaseReceiptLineUpdateDto
object
The Document details tab The description of this account.
1 property
ReleasePurchaseReceiptActionResultDto
object
3 properties
discountAmountInPurchaseReceiptLineUpdateDto
object
The Document details tab The automatically calculated or manually entered discount amount on the line.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Visma 12
Other APIs Visma publishes across the network.
Visma Business NXT GraphQL API
Visma Account API
Visma Accounts API
Visma Agreements API
Visma Allocation Periods API
Visma Approval API
Visma App Store Activation Status API
Visma Article Account Codings API
Visma Article Labels API
Visma Articles API
Visma Attachment API
Visma Attachment Links API
#PurchaseReceipt
Where this information came from
This is an independent, third-party profile of Visma Purchase Receipt API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.