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 Supplier Invoice API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: SupplierInvoice
paths:
/v1/supplierInvoice/{invoiceNumber}:
get:
tags:
- SupplierInvoice
summary: GET a specific invoice.
description: 'Data for a single invoice.
The response headers include an ETag after a successful GET operation.'
operationId: SupplierInvoice_GetByinvoiceNumber
parameters:
- name: invoiceNumber
in: path
description: Identifies the Invoice
required: true
schema:
type: string
- name: expandLinePrebookAccounts
in: query
description: Expland line-level pre-booking account and sub-account information.
schema:
type: boolean
- name: expandLandedCosts
in: query
description: Expland landed costs information.
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/SupplierInvoiceDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceDto'
'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:
- SupplierInvoice
summary: Update a specific SupplierInvoice
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: SupplierInvoice_PutByinvoiceNumber
parameters:
- name: invoiceNumber
in: path
description: Identifies the SupplierInvoice 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 Invoice to update
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
required: true
x-bodyName: supplierInvoice
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Supplier invoice 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: []
delete:
tags:
- SupplierInvoice
summary: Deletes a specific Supplier Invoice
description: Response Message has StatusCode NoContent if DELETE operation succeed
operationId: SupplierInvoice_DeleteByinvoiceNumber
parameters:
- name: invoiceNumber
in: path
description: Identifies the Supplier Invoice to delete
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:
'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/supplierInvoice/{documentType}/{invoiceNumber}:
get:
tags:
- SupplierInvoice
summary: Get a specific Invoice, DebitAdj, CreditAdj or Prepayment
description: 'Data for a single invoice.
The response headers include an ETag after a successful GET operation.'
operationId: SupplierInvoice_GetByTypeBydocumentTypeinvoiceNumber
parameters:
- name: documentType
in: path
description: Identifies the Invoice
required: true
schema:
type: string
- name: invoiceNumber
in: path
description: Identifies the Invoice
required: true
schema:
type: string
- name: expandLinePrebookAccounts
in: query
description: Expland line-level pre-booking account and sub-account information.
schema:
type: boolean
- name: expandLandedCosts
in: query
description: Expland landed costs information.
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/SupplierInvoiceDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceDto'
'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:
- SupplierInvoice
summary: Update a specific SupplierInvoice
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: SupplierInvoice_PutByTypeBydocumentTypeinvoiceNumber
parameters:
- name: documentType
in: path
description: Identifies the SupplierInvoice to update
required: true
schema:
type: string
- name: invoiceNumber
in: path
description: Identifies the SupplierInvoice 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 Invoice to update
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
required: true
x-bodyName: supplierInvoice
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Supplier invoice 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: []
delete:
tags:
- SupplierInvoice
summary: Deletes a specific Supplier Invoice
description: Response Message has StatusCode NoContent if DELETE operation succeed
operationId: SupplierInvoice_DeleteBydocumentTypeinvoiceNumber
parameters:
- name: documentType
in: path
description: Identifies the docType of Supplier Invoice to delete
required: true
schema:
enum:
- Invoice
- CreditAdj
- DebitAdj
- Prepayment
- Refund
- Payment
type: string
- name: invoiceNumber
in: path
description: Identifies the Supplier Invoice to delete
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:
'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/supplierInvoice:
get:
tags:
- SupplierInvoice
summary: Get a range of Invoices - ScreenId=AP301000.
operationId: SupplierInvoice_GetAllInvoices
parameters:
- name: supplier
in: query
description: Filter by Supplier
schema:
type: string
- name: expandAttachment
in: query
description: Set to true if you want to see all attachments regarding this document.
schema:
type: boolean
- name: expandLandedCosts
in: query
description: Expland landed cost lines
schema:
type: boolean
- name: documentType
in: query
description: By type of document.
schema:
enum:
- Invoice
- CreditAdj
- DebitAdj
- Prepayment
- Refund
- Payment
type: string
- name: released
in: query
description: Parameter for showing if invoice has been released or not.
schema:
type: integer
format: int32
- name: project
in: query
description: Filter by the project with which the document is associated.
schema:
type: string
- name: expandApproval
in: query
description: Set to true to include approval information.
schema:
type: boolean
- name: expandNote
in: query
description: Set to true to include description.
schema:
type: boolean
- 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: status
in: query
description: The status of the document
schema:
enum:
- Hold
- Balanced
- Voided
- Scheduled
- Open
- Closed
- Printed
- Prebooked
- Reserved
type: string
- name: expandLinePrebookAccounts
in: query
description: Expland line-level pre-booking account and sub-account information.
schema:
type: boolean
- name: branch
in: query
description: Filter by Branch
schema:
type: string
- name: financialPeriod
in: query
description: Filter by Financial Period, format YYYYPP
schema:
type: string
- name: dueDate
in: query
description: 'This value indicates the date the document is due for payment. 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```
* ```yyyy-MM-dd```
* ```yyyy-MM-dd```
* ```yyyy-MM-dd```
_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.'
schema:
type: string
format: date-time
- 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: docDate
in: query
description: 'This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.
Accepted format:
* ```yyyy-MM-dd```
* ```yyyy-MM-dd```
* ```yyyy-MM-dd```
* ```yyyy-MM-dd```
* ```yyyy-MM-dd```
_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.'
schema:
type: string
format: date-time
- name: docDateCondition
in: query
description: 'This value represents the condition to be applied to the Document 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:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.'
schema:
type: string
- name: item
in: query
description: Filter by Item used into the document lines
schema:
type: string
- name: balance
in: query
description: 'This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.
_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.'
schema:
type: number
format: double
- name: balanceCondition
in: query
description: 'This value represents the condition to be applied to the Balance 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:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.'
schema:
type: string
- 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: 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/SupplierInvoiceDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/SupplierInvoiceDto'
'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:
- SupplierInvoice
summary: Create an SupplierInvoice
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: SupplierInvoice_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 SupplierInvoice to create
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/SupplierInvoiceUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Supp
# --- truncated at 32 KB (128 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-supplierinvoice-api-openapi.yml