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 Customer Credit Note API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: CustomerCreditNote
paths:
/v1/customerCreditNote/{creditNoteNumber}:
get:
tags:
- CustomerCreditNote
summary: Get a specific Customer Credit Note
description: 'Data for Customer Credit Note
The response headers include an ETag after a successful GET operation.'
operationId: CustomerCreditNote_GetBycreditNoteNumber
parameters:
- name: creditNoteNumber
in: path
description: Identifies the Customer Credit Note
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/CustomerCreditNoteDto'
text/json:
schema:
$ref: '#/components/schemas/CustomerCreditNoteDto'
'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:
- CustomerCreditNote
summary: Update a specific Credit Note
description: 'Response Message has StatusCode NoContent if PUT operation succeed
Response Message has StatusCode BadRequest if PUT operation failed
In this endpoint, If-Match can be checked against resource current version when calling with ''erp-api-background'' HTTP header.'
operationId: CustomerCreditNote_UpdateBycreditNoteNumber
parameters:
- name: creditNoteNumber
in: path
description: Identifies the Credit Note 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 Credit Note to update
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
required: true
x-bodyName: creditNote
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Customer credit note 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:
- CustomerCreditNote
summary: Deletes a specific Customer Credit Note
description: Response Message has StatusCode NoContent if DELETE operation succeed
operationId: CustomerCreditNote_DeleteBycreditNoteNumber
parameters:
- name: creditNoteNumber
in: path
description: Identifies the Customer Credit Note 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/customerCreditNote:
get:
tags:
- CustomerCreditNote
summary: Get a range of Customer Credit Notes - ScreenId=AR301000 Request page size must…
description: Data for Customer Credit Note
operationId: CustomerCreditNote_GetAll
parameters:
- name: documentType
in: query
description: The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.
schema:
enum:
- Invoice
- DebitNote
- CreditNote
- Payment
- VoidPayment
- Prepayment
- Refund
- FinCharge
- SmallBalanceWo
- SmallCreditWo
- CashSale
- CashReturn
- Undefined
- NoUpdate
type: string
- name: released
in: query
description: Parameter for showing if invoice has been released or not.
schema:
type: integer
format: int32
- name: dunningLevel
in: query
description: The dunning level of the document.
schema:
type: integer
format: int32
- name: closedFinancialPeriod
in: query
description: The date of the closing of the financial period.
schema:
type: string
- name: dunningLetterDateTime
in: query
description: The date and time for when the document last released a dunning letter.
schema:
type: string
- name: dunningLetterDateTimeCondition
in: query
description: Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.
schema:
type: string
- name: project
in: query
description: The project with which the document is associated.
schema:
type: string
- name: expandApplications
in: query
description: True if you want to see all dunning information regarding this document.
schema:
type: boolean
- name: expandDunningInformation
in: query
schema:
type: boolean
- name: expandAttachments
in: query
description: True if you want to see all attachments regarding this document.
schema:
type: boolean
- name: expandTaxDetails
in: query
description: True if you want to see all VAT details regarding this document.
schema:
type: boolean
- name: expandInvoiceAddress
in: query
description: True if you want to see all information regarding the invoice address for this document.
schema:
type: boolean
- name: financialPeriod
in: query
description: The financial period to which the transactions recorded in the document is posted. Format YYYYMM.
schema:
type: string
- name: documentDueDate
in: query
description: The date when payment for the document is due, in accordance with the credit terms.
schema:
type: string
format: date-time
- name: documentDueDateCondition
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'
schema:
type: string
- name: status
in: query
description: The status of the document. Use the dropdown to select status.
schema:
enum:
- Hold
- Balanced
- Voided
- Scheduled
- Open
- Closed
- PendingPrint
- PendingEmail
- CreditHold
- CcHold
- Reserved
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: externalReference
in: query
description: The top part > External reference > The external reference used in AutoInvoice.
schema:
type: string
- name: paymentReference
in: query
description: The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..
schema:
type: string
- name: customerRefNumber
in: query
description: The top part > External reference > The external reference used in AutoInvoice.
schema:
type: string
- name: customer
in: query
description: Filter by Customer
schema:
type: string
- name: branch
in: query
description: Filter by Branch
schema:
type: string
- name: documentDate
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:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.'
schema:
type: string
format: date-time
- name: documentDateCondition
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: 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/CustomerCreditNoteDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomerCreditNoteDto'
'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:
- CustomerCreditNote
summary: Create a Credit Note.
description: Response Message has StatusCode Created if POST operation succeed
operationId: CustomerCreditNote_Create
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 Credit Note to create
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomerCreditNoteUpdateDto'
required: true
x-bodyName: creditNote
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'
deprecated: true
security:
- interactiveapi: []
/v1/customerCreditNote/{creditNoteNumber}/print:
get:
tags:
- CustomerCreditNote
summary: Get the print report of a Customer Credit Note
description: The File is in Content of the message
operationId: CustomerCreditNote_PrintBycreditNoteNumber
parameters:
- name: creditNoteNumber
in: path
description: Identifies the customer credit note
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/customerCreditNote/{creditNoteNumber}/action/release:
post:
tags:
- CustomerCreditNote
summary: Release credit note 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: CustomerCreditNote_ReleaseDocumentBycreditNoteNumber
parameters:
- name: creditNoteNumber
in: path
description: Reference number of the credit note 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
responses:
'412':
description: Customer credit note version does not match with If-Match header
content:
application/json: {}
text/json: {}
'200':
description: If invoked without header erp-api-background set, operation starts in the background and 200-OK is returned with a reference. No notification is sent when action is done.
content:
application/json:
schema:
$ref: '#/components/schemas/ReleaseCustomerCreditNoteActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/ReleaseCustomerCreditNoteActionResultDto'
'202':
description: If invoked with header erp-api-background set, operation starts in the background, 202-Accepted will be returned and a webhook will be posted upon action done event.
content:
application/json: {}
text/json: {}
security:
- interactiveapi: []
/v1/customerCreditNote/{creditNoteNumber}/action/sendToAutoInvoice:
post:
tags:
- CustomerCreditNote
summary: SendToAutoInvoice credit note 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: CustomerCreditNote_SendToAutoInvoiceBycreditNoteNumber
parameters:
- name: creditNoteNumber
in: path
description: Reference number of the credit note to be send to AutoInvoice
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: str
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-customercreditnote-api-openapi.yml