How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Visma Supplier Invoice API

The SupplierInvoice API from Visma — 16 operation(s) for supplierinvoice.

Visma Supplier Invoice API is one of 193 APIs that Visma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SupplierInvoice. 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 21 operations across 16 paths, and defines 65 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.

21 operations 16 paths 65 schemas 2 DELETE4 GET13 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.finance.visma.net
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Visma Supplier Invoice API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (interactiveapi) using the authorizationCode flow, exposing 5 scopes.

Paths & Operations 21

Across 16 paths, the API surfaces 21 operations — 2 DELETE, 4 GET, 13 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

SupplierInvoice 21
GET
/v1/supplierInvoice/{invoiceNumber}
GET a specific invoice.
SupplierInvoice_GetByinvoiceNumber 4 params → 200202
PUT
/v1/supplierInvoice/{invoiceNumber}
Update a specific SupplierInvoice
SupplierInvoice_PutByinvoiceNumber 3 params body → 204412202
DELETE
/v1/supplierInvoice/{invoiceNumber}
Deletes a specific Supplier Invoice
SupplierInvoice_DeleteByinvoiceNumber 2 params → 204202
GET
/v1/supplierInvoice/{documentType}/{invoiceNumber}
Get a specific Invoice, DebitAdj, CreditAdj or Prepayment
SupplierInvoice_GetByTypeBydocumentTypeinvoiceNumber 5 params → 200202
PUT
/v1/supplierInvoice/{documentType}/{invoiceNumber}
Update a specific SupplierInvoice
SupplierInvoice_PutByTypeBydocumentTypeinvoiceNumber 4 params body → 204412202
DELETE
/v1/supplierInvoice/{documentType}/{invoiceNumber}
Deletes a specific Supplier Invoice
SupplierInvoice_DeleteBydocumentTypeinvoiceNumber 3 params → 204202
GET
/v1/supplierInvoice
Get a range of Invoices - ScreenId=AP301000.
SupplierInvoice_GetAllInvoices 29 params → 200202
POST
/v1/supplierInvoice
Create an SupplierInvoice
SupplierInvoice_Post 1 param body → 201202
GET
/v1/supplierInvoice/approval
Get an invoice based on the systemId.
SupplierInvoice_GetByApprovalDocumentId 2 params → 200202
POST
/v1/supplierInvoice/{invoiceNumber}/action/release
Release invoice operation
SupplierInvoice_ReleaseInvoiceByinvoiceNumber 3 params → 412202
POST
/v1/supplierInvoice/{invoiceNumber}/action/correct
Correct invoice operation
SupplierInvoice_CorrectInvoiceByinvoiceNumber 3 params → 412202
POST
/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/reverse
Provides an action for reversing a supplier invoice/adjustment
SupplierInvoice_ReverseInvoiceBydocumentTypeinvoiceNumber 4 params → 412202
POST
/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/sendtoapproval
Send invoice to approval
SupplierInvoice_SendToApprovalBydocumentTypeinvoiceNumber 4 params → 412202
POST
/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/release
Release invoice operation
SupplierInvoice_ReleaseInvoiceByTypeBydocumentTypeinvoiceNumber 4 params → 412202
POST
/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/prebook
Pre-Book invoice operation
SupplierInvoice_PrebookInvoiceBydocumentTypeinvoiceNumber 4 params body → 412202
POST
/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/voidinvoice
Void invoice operation
SupplierInvoice_VoidInvoiceBydocumentTypeinvoiceNumber 4 params → 412202
POST
/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/writeoff
Write-off invoice operation
SupplierInvoice_WriteoffInvoiceBydocumentTypeinvoiceNumber 4 params → 200202412
POST
/v1/supplierInvoice/{invoiceNumber}/attachment
Creates an attachment and associates it with a supplier invoice.
SupplierInvoice_CreateHeaderAttachmentByinvoiceNumber 3 params → 201412202
POST
/v1/supplierInvoice/{invoiceNumber}/{lineNumber}/attachment
Creates an attachment and associates it with a certain supplier invoice line.
SupplierInvoice_CreateLineAttachmentByinvoiceNumberlineNumber 4 params → 201412202
POST
/v1/supplierInvoice/documentType/{documentType}/{invoiceNumber}/attachment
Creates an attachment and associates it with a supplier invoice.
SupplierInvoice_CreateHeaderAttachmentByTypeBydocumentTypeinvoiceNumber 4 params → 201412202
POST
/v1/supplierInvoice/documentType/{documentType}/{invoiceNumber}/{lineNumber}/attachment
Creates an attachment and associates it with a certain supplier invoice line.
SupplierInvoice_CreateLineAttachmentByTypeBydocumentTypeinvoiceNumberlineNumber 5 params → 201412202

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are SupplierInvoiceDto (65 properties), SupplierInvoiceLineDto (39 properties), SupplierInvoiceUpdateDto (38 properties), SupplierInvoiceLineUpdateDto (35 properties). Each schema is shown below with its type and property counts.

subaccountInSupplierInvoiceLineDto
object
The table Mandatory field: Subaccount The corresponding subaccount used for this invoice line.
9 properties
branchInSupplierInvoiceLineUpdateDto
object
Branch is deprecated, please use BranchNumber instead.
1 property
supplierTaxZoneInSupplierInvoiceDto
object
The Financial details tab The VAT section Supplier VAT Zone The VAT zone of the supplier, which is specified in the AP303000 window.
6 properties
AttachmentDto
object
3 properties
TaxDetailUpdateDto
object
This class represents a Tax Detail Line. Used to pass data to server for updating a tax line
4 properties
AddPOReceiptLineDto
object
5 properties
supplierInSupplierInvoiceDto
object
The Top part Supplier The identifier of the supplier referred to in the document.
3 properties
DtoValueOfNullableOfTaxCalcMode
object
1 property
prebookAccountNumberInSupplierInvoiceLineUpdateDto
object
Account used for prebooking. Note that this feature is not available for all countries.
1 property
branchNumberInSupplierInvoiceLineDto
object
The table Mandatory field: Branch The branch that purchases the line item or service. Note: The field type has been changed from string to BranchNumberDto, ple…
2 properties
vatCodeInSupplierInvoiceLineDto
object
The table VAT category The VAT category (if applied) for the transaction. Unless you specify otherwise, it is the default VAT category of the supplier location…
2 properties
DtoValueOfString
object
1 property
prebookAccountInSupplierInvoiceLineDto
object
Prebook account used on the line. Note that this feature is not available in all countries.
6 properties
amountInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Amount The amount in currency of the landed cost
1 property
projectTaskInSupplierInvoiceLineDto
object
The table Project task The project task associated with the invoice line.
3 properties
accountInSupplierInvoiceLineDto
object
The table Mandatory field: Account The purchase account used for the invoice line.
6 properties
approvalDetailsInSupplierInvoiceDto
object
The Approval details tab
2 properties
locationInSupplierInvoiceDto
object
The Top part Location The supplier location associated with the purchase.
3 properties
LinkLineDto
object
3 properties
SupplierInvoiceLandedCostUpdateDto
object
10 properties
validateLineDetailsInSupplierInvoiceUpdateDto
object
If this flag is set/true, the system will surface any line validation errors to the clients rather than silently ignoring these.
1 property
SupplierInvoiceLineDto
object
39 properties
paymentMethodInSupplierInvoiceDto
object
The Financial details tab Payment method The payment method used for the payment.
2 properties
SupplierInvoiceLandedCostDto
object
10 properties
TaxDetailDto
object
This class represents a VAT Detail Line. Used for getting data.
7 properties
SegmentUpdateDto
object
2 properties
DtoValueOfNullableOfSupplierInvoiceTypes
object
1 property
creditTermsInSupplierInvoiceDto
object
The Top part Terms The credit terms associated with the supplier (unavailable for prepayments and debit adjustments)
2 properties
DtoValueOfNullableOfDecimal
object
1 property
undoSplitLineInSupplierInvoiceLineUpdateDto
object
When set to true on an invoice line with Operation = Delete, the line is treated as an undo split-line request instead of an ordinary delete. The field only ha…
1 property
DtoValueOfDecimal
object
1 property
descriptionInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Description The description of the landed cost
1 property
accountNumberInPrebookingUpdateDto
object
Account used for prebooking.
1 property
prebookSubaccountInSupplierInvoiceLineDto
object
Prebook subaccount used on the line. Note that this feature is not available in all countries.
9 properties
lineNumberInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Number at the left indicating the line number of the table.
1 property
purchaseNumberInLinkLineDto
object
PurchaseNumber refers to either PurchaseOrder or PurchaseReceipt number depends on the value of {Visma.net.ERP.Web.Api.Model.V1.AP.LinkLineDto.PurchaseType} If…
1 property
projectInSupplierInvoiceLineDto
object
The table Project The project associated with the invoice line.
3 properties
financialPeriodInSupplierInvoiceUpdateDto
object
The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM.
1 property
BackgroundApiAcceptedDto
object
2 properties
SegmentDto
object
4 properties
locationIdInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Location The ID of the warehouse location
1 property
taxCategoryIdInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab VAT Category The ID of VAT cateogry
1 property
postPeriodInSupplierInvoiceUpdateDto
object
The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY.
1 property
DtoValueOfNullableOfBoolean
object
1 property
DtoValueOfDateTime
object
1 property
DtoValueOfNullableOfDateTime
object
1 property
DtoValueOfInt32
object
1 property
poReceiptNumberInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Purchase order receipt no. The purchase order receipt number
1 property
paySelectedInSupplierInvoiceUpdateDto
object
The Financial details tab The Default Payment Info section When set to true indicates that the document is approved for payment.
1 property
SupplierInvoiceUpdateDto
object
38 properties
DtoValueOfNullableOfInt32
object
1 property
MetadataDto
object
2 properties
siteIdInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Warehouse The ID of the warehouse
1 property
TaxCategoryNumberDescriptionDto
object
2 properties
ApprovalDetailsUpdateDto
object
2 properties
purchaseLineNbrInLinkLineDto
object
PurchaseLineNbr refers to either PurchaseOrder or PurchaseReceipt line number depends on the value of {Visma.net.ERP.Web.Api.Model.V1.AP.LinkLineDto.PurchaseTy…
1 property
SupplierInvoiceDto
object
This class represents a ApInvoice in SupplierInvoiceController. Used by getting data.
65 properties
SupplierInvoiceLineUpdateDto
object
35 properties
landedCostCodeIdInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Landed cost code The Landed Cost Code ID lf the Landed Cost Code
1 property
PrebookingUpdateDto
object
2 properties
AddPurchaseOrderDto
object
1 property
DtoValueOfBoolean
object
1 property
inventoryIdInSupplierInvoiceLandedCostUpdateDto
object
Landed Costs Tab Item ID The ID of the inventory item
1 property
vatIdInTaxDetailDto
object
VAT ID The ID of the specific VAT applied.
2 properties
BranchNumberDto
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

visma-supplierinvoice-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Visma Supplier Invoice 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.