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-supplierpayment-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 Supplier Payment API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: SupplierPayment
paths:
/v1/supplierPayment/{paymentNumber}:
get:
tags:
- SupplierPayment
summary: Get a specific SupplierPayment
description: 'Data for a single supplier payment.
The response headers include an ETag after a successful GET operation.'
operationId: SupplierPayment_GetBypaymentNumber
parameters:
- name: paymentNumber
in: path
description: Identifies the SupplierPayment
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/SupplierPaymentDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierPaymentDto'
'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:
- SupplierPayment
summary: Update a specific SupplierPayment
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: SupplierPayment_PutBypaymentNumber
parameters:
- name: paymentNumber
in: path
description: Identifies the Payment 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 Payment to update
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
required: true
x-bodyName: payment
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Supplier payment 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/supplierPayment/{paymentType}/{paymentNumber}:
get:
tags:
- SupplierPayment
summary: Get a specific SupplierPayment by type and number
description: 'Data for a single supplier payment.
The response headers include an ETag after a successful GET operation.'
operationId: SupplierPayment_GetByTypeBypaymentTypepaymentNumber
parameters:
- name: paymentType
in: path
description: Identifies the Supplier document type
required: true
schema:
type: string
- name: paymentNumber
in: path
description: Identifies the Supplier document number
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/SupplierPaymentDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierPaymentDto'
'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/supplierPayment:
get:
tags:
- SupplierPayment
summary: Get all SupplierPayments.
operationId: SupplierPayment_GetAllPayments
parameters:
- name: invoiceRefNbr
in: query
schema:
type: string
- name: paymentType
in: query
description: 'The top part > Type >The type of supplier ledger payment document. The following types are available: Payment, PUrchase credit note, Prepayment, Supplier refund, Voided payment.'
schema:
enum:
- Payment
- DebitAdj
- Prepayment
- Refund
- VoidPayment
- VoidRefund
type: string
- name: greaterThanValue
in: query
description: Enter the from-value for Ref. no.
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: supplier
in: query
description: Filter by Supplier
schema:
type: string
- name: branch
in: query
description: Filter by Branch
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:_ __DocDate__ 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:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.'
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: financialPeriod
in: query
description: Filter by financial period, format YYYYPP
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: status
in: query
description: Filter by document status
schema:
enum:
- Hold
- Balanced
- Voided
- Scheduled
- Open
- Closed
- Printed
- Prebooked
- PendingApproval
- Rejected
- Reserved
- PendingPrint
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/SupplierPaymentDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/SupplierPaymentDto'
'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:
- SupplierPayment
summary: Create a SupplierPayment
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: SupplierPayment_CreateSupplierPayment
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 SupplierPayment to create
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SupplierPaymentUpdateDto'
required: true
x-bodyName: payment
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/supplierPayment/{paymentNumber}/action/release:
post:
tags:
- SupplierPayment
summary: Release payment operation
description: 'The action result dto contains information about the result of running the action.
Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.
In this endpoint, If-Match can be checked against resource current version when calling with ''erp-api-background'' HTTP header.'
operationId: SupplierPayment_ReleasePaymentBypaymentNumber
parameters:
- name: paymentNumber
in: path
description: Reference number of the payment 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
- 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 POST operation is successful, the server responds with 200 OK 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: Contains the type of the payment
content:
application/json:
schema:
$ref: '#/components/schemas/ReleaseSupplierPaymentActionDto'
text/json:
schema:
$ref: '#/components/schemas/ReleaseSupplierPaymentActionDto'
application/xml:
schema:
$ref: '#/components/schemas/ReleaseSupplierPaymentActionDto'
text/xml:
schema:
$ref: '#/components/schemas/ReleaseSupplierPaymentActionDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ReleaseSupplierPaymentActionDto'
required: true
x-bodyName: releaseActionDto
responses:
'412':
description: Supplier payment version does not match with If-Match header
content:
application/json: {}
text/json: {}
application/xml: {}
text/xml: {}
'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/supplierPayment/{paymentType}/{paymentNumber}/action/writeoff:
post:
tags:
- SupplierPayment
summary: Write-off payment operation
description: 'The action result dto contains information about the result of running the action.
Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.
In this endpoint, If-Match can be checked against resource current version when calling with ''erp-api-background'' HTTP header.'
operationId: SupplierPayment_WriteoffPaymentBypaymentTypepaymentNumber
parameters:
- name: paymentType
in: path
description: The type of the payment to be written off
required: true
schema:
type: string
- name: paymentNumber
in: path
description: Reference number of the payment to be written off
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 POST operation is successful, the server responds with 200 OK 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
responses:
'200':
description: Operation accepted
content:
application/json:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/WriteoffPaymentActionResultDto'
'412':
description: Supplier payment version does not match with If-Match header
content:
application/json: {}
text/json: {}
application/xml: {}
text/xml: {}
security:
- interactiveapi: []
components:
schemas:
BackgroundApiAcceptedDto:
type: object
properties:
id:
type: string
stateLocation:
type: string
currencyInSupplierPaymentDto:
properties:
id:
type: string
description: Currency Id.
description:
type: string
description: Currency description.
symbol:
type: string
description: Currency symbol.
isBaseCurrency:
type: boolean
description: Identify if the currency is the base currency.
decimalPrecision:
type: integer
description: Decimal precision.
format: int32
isUsedForAccounting:
type: boolean
description: Identify if is used for accounting.
description: The top part > Currency > The currency of the payment; by default, it is the currency associated with the cash account.
DtoValueOfDecimal:
type: object
properties:
value:
type: number
format: double
DtoValueOfNullableOfSupplierInvoiceTypes:
type: object
properties:
value:
enum:
- Invoice
- CreditAdj
- DebitAdj
- Prepayment
- Refund
- Payment
type: string
supplierInSupplierPaymentDto:
properties:
internalId:
type: integer
format: int32
number:
type: string
description: The identifier of the particular destination of the selected type.
name:
type: string
description: The name of the particular destination of the selected type.
description: 'Mandatory field: The top part > Supplier* > The supplier.'
SupplierPaymentUpdateDto:
type: object
properties:
type:
$ref: '#/components/schemas/typeInSupplierPaymentUpdateDto'
referenceNumber:
$ref: '#/components/schemas/DtoValueOfString'
hold:
$ref: '#/components/schemas/DtoValueOfBoolean'
applicationDate:
$ref: '#/components/schemas/DtoValueOfDateTime'
applicationPeriod:
$ref: '#/components/schemas/DtoValueOfString'
paymentRef:
$ref: '#/components/schemas/DtoValueOfString'
supplier:
$ref: '#/components/schemas/DtoValueOfString'
location:
$ref: '#/components/schemas/DtoValueOfString'
paymentMethod:
$ref: '#/components/schemas/DtoValueOfString'
cashAccount:
$ref: '#/components/schemas/DtoValueOfString'
currency:
$ref: '#/components/schemas/DtoValueOfString'
description:
$ref: '#/components/schemas/DtoValueOfString'
paymentAmount:
$ref: '#/components/schemas/DtoValueOfNullableOfDecimal'
branch:
$ref: '#/components/schemas/DtoValueOfString'
paymentLines:
type: array
items:
$ref: '#/components/schemas/SupplierPaymentAdjustmentUpdateDto'
overrideNumberSeries:
$ref: '#/components/schemas/DtoValueOfBoolean'
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-supplierpayment-api-openapi.yml