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-cashsale-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 Cash Sale API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: CashSale
paths:
/v1/cashsale/{documentNumber}:
get:
tags:
- CashSale
summary: Get a specific Cash Sale
description: 'Data for Cash Sale
The response headers include an ETag after a successful GET operation.'
operationId: CashSale_GetBydocumentNumber
parameters:
- name: documentNumber
in: path
description: Identifies the Cash Sale Document
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/CashSaleDto'
text/json:
schema:
$ref: '#/components/schemas/CashSaleDto'
'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:
- CashSale
summary: Update a specific Cash Sale
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: CashSale_PutBydocumentNumber
parameters:
- name: documentNumber
in: path
description: Identifies the Cash Sale 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 Cash Sale to update
content:
application/json:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
required: true
x-bodyName: cashSaleUpdateDto
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Cash sale 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/cashsale:
get:
tags:
- CashSale
summary: Get a range of Cash Sales - ScreenId=AR304000 Request page size must be lower…
operationId: CashSale_GetAllCashSales
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/CashSaleDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CashSaleDto'
'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:
- CashSale
summary: Create a Cash Sale
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: CashSale_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 Cash Sale to create
content:
application/json:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
application/xml:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
text/xml:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CashSaleUpdateDto'
required: true
x-bodyName: cashSaleUpdateDto
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: []
components:
schemas:
vatCodeInCashSaleLineDto:
properties:
id:
type: string
description: Click on the magnifier. > The identifier.
description:
type: string
description: Click on the magnifier. > The description.
description: VAT category > The VAT category (if applied) for the transaction. The category represents the type of goods or services.
BackgroundApiAcceptedDto:
type: object
properties:
id:
type: string
stateLocation:
type: string
invoiceAddressInCashSaleDto:
properties:
addressId:
type: integer
format: int32
addressLine1:
type: string
description: Address 1 > The first line of the customer's contact address.
addressLine2:
type: string
description: Address 2 > The second line of the address.
addressLine3:
type: string
description: Address 3 > The third line of the address.
postalCode:
type: string
description: Postcode > The postcode.
city:
type: string
description: City > The city.
country:
$ref: '#/components/schemas/countryInCustomerDocumentAddressDto'
county:
$ref: '#/components/schemas/countyInCustomerDocumentAddressDto'
overrideAddress:
type: boolean
description: Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer.
description: The Invoice address tab > The Invoice address section.
projectInCashSaleDto:
properties:
internalId:
type: integer
description: The internal identifier.
format: int32
id:
type: string
description: Click on the magnifier. > The identifier.
description:
type: string
description: Click on the magnifier. > The description.
description: The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window.
DtoValueOfDecimal:
type: object
properties:
value:
type: number
format: double
SegmentUpdateDto:
type: object
properties:
segmentId:
type: integer
format: int32
segmentValue:
type: string
postPeriodInCashSaleUpdateDto:
properties:
value:
type: string
description: The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY.
invoiceContactInCashSaleDto:
properties:
contactId:
type: integer
format: int32
businessName:
type: string
attention:
type: string
email:
type: string
phone1:
type: string
overrideContact:
type: boolean
description: The Invoice address tab > The Invoice contact section.
DtoValueOfNullableOfBoolean:
type: object
properties:
value:
type: boolean
CashSaleUpdateDto:
type: object
properties:
paymentMethodId:
$ref: '#/components/schemas/DtoValueOfString'
creditTermsId:
$ref: '#/components/schemas/DtoValueOfString'
paymentReference:
$ref: '#/components/schemas/paymentReferenceInCashSaleUpdateDto'
cashSaleLines:
type: array
items:
$ref: '#/components/schemas/CashSaleLinesUpdateDto'
referenceNumber:
$ref: '#/components/schemas/DtoValueOfString'
customerNumber:
$ref: '#/components/schemas/DtoValueOfString'
childCustomerNumber:
$ref: '#/components/schemas/DtoValueOfString'
consolidateInvoices:
$ref: '#/components/schemas/DtoValueOfNullableOfBoolean'
documentDate:
$ref: '#/components/schemas/DtoValueOfDateTime'
origInvoiceDate:
$ref: '#/components/schemas/DtoValueOfDateTime'
hold:
$ref: '#/components/schemas/DtoValueOfBoolean'
postPeriod:
$ref: '#/components/schemas/postPeriodInCashSaleUpdateDto'
financialPeriod:
$ref: '#/components/schemas/financialPeriodInCashSaleUpdateDto'
invoiceText:
$ref: '#/components/schemas/DtoValueOfString'
locationId:
$ref: '#/components/schemas/DtoValueOfString'
salesPersonID:
$ref: '#/components/schemas/salesPersonIDInCashSaleUpdateDto'
salesperson:
$ref: '#/components/schemas/salespersonInCashSaleUpdateDto'
note:
$ref: '#/components/schemas/DtoValueOfString'
branchNumber:
$ref: '#/components/schemas/DtoValueOfString'
cashAccount:
$ref: '#/components/schemas/DtoValueOfString'
dontPrint:
$ref: '#/components/schemas/DtoValueOfBoolean'
dontEmail:
$ref: '#/components/schemas/DtoValueOfBoolean'
branchNumberInCashSaleDto:
properties:
number:
type: string
description: Click the magnifier. > The identifier.
name:
type: string
description: Click the magnifier. > The name.
description: The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches.
creditTermsInCashSaleDto:
properties:
id:
type: string
description: Click on the magnifier. > The identifier.
description:
type: string
description: Click on the magnifier. > The description.
description: 'Mandatory field: The Financial details tab > Payment info section > Terms*'
ArAdjustDto:
type: object
properties:
docType:
type: string
customerCD:
type: string
refNbr:
type: string
amountPaid:
type: number
format: double
cashDiscountTaken:
type: number
format: double
balance:
type: number
format: double
pendingPPD:
type: boolean
released:
type: boolean
hold:
type: boolean
voided:
type: boolean
ppdCrMemoRefNbr:
type: string
paymentRef:
type: string
status:
type: string
applicationDate:
type: string
format: date-time
applicationPeriod:
type: string
invoiceText:
type: string
salespersonInCashSaleUpdateDto:
properties:
value:
type: string
description: The identifier of the salesperson involved.
paymentReferenceInCashSaleUpdateDto:
properties:
value:
type: string
description: Mandatory
branchNumberInCashSaleLineDto:
properties:
number:
type: string
description: Click the magnifier. > The identifier.
name:
type: string
description: Click the magnifier. > The name.
description: 'Mandatory field: Branch* > The branch that sells the line item or provides the service.'
DtoValueOfInt32:
type: object
properties:
value:
type: integer
format: int32
salesPersonInCashSaleDto:
properties:
id:
type: string
description: Click on the magnifier. > The identifier.
description:
type: string
description: Click on the magnifier. > The description.
description: The document details tab > Salesperson ID > The salesperson involved.
DtoValueOfBoolean:
type: object
properties:
value:
type: boolean
salesPersonIDInCashSaleUpdateDto:
properties:
value:
type: integer
format: int32
description: The field is deprecated for customer document endpoints, please use Salesperson instead
MetadataDto:
type: object
properties:
totalCount:
type: integer
format: int64
maxPageSize:
type: integer
format: int64
accountInCashSaleLineDto:
properties:
type:
enum:
- Asset
- Liability
- Income
- Expense
type: string
description: Account > The account number.
externalCode1:
type: string
description: Account class > The identifier of the account class.
externalCode2:
type: string
description: Account class > The name of the account class.
active:
type: boolean
number:
type: string
description: Number of item
description:
type: string
description: Name of item/description
description: 'Mandatory field: Account* > The sales account used for the transaction.'
CashSaleLinesUpdateDto:
type: object
properties:
operation:
enum:
- Insert
- Update
- Delete
type: string
inventoryNumber:
$ref: '#/components/schemas/DtoValueOfString'
lineNumber:
$ref: '#/components/schemas/DtoValueOfInt32'
description:
$ref: '#/components/schemas/DtoValueOfString'
quantity:
$ref: '#/components/schemas/DtoValueOfDecimal'
unitPriceInCurrency:
$ref: '#/components/schemas/DtoValueOfDecimal'
manualAmountInCurrency:
$ref: '#/components/schemas/DtoValueOfDecimal'
accountNumber:
$ref: '#/components/schemas/DtoValueOfString'
vatCodeId:
$ref: '#/components/schemas/DtoValueOfString'
uom:
$ref: '#/components/schemas/DtoValueOfString'
discountPercent:
$ref: '#/components/schemas/DtoValueOfDecimal'
discountAmountInCurrency:
$ref: '#/components/schemas/DtoValueOfDecimal'
manualDiscount:
$ref: '#/components/schemas/DtoValueOfBoolean'
subaccount:
type: array
items:
$ref: '#/components/schemas/SegmentUpdateDto'
salesperson:
$ref: '#/components/schemas/DtoValueOfString'
deferralSchedule:
$ref: '#/components/schemas/DtoValueOfInt32'
deferralCode:
$ref: '#/components/schemas/DtoValueOfString'
termStartDate:
$ref: '#/components/schemas/DtoValueOfDateTime'
termEndDate:
$ref: '#/components/schemas/DtoValueOfDateTime'
note:
$ref: '#/components/schemas/DtoValueOfString'
branchNumber:
$ref: '#/components/schemas/DtoValueOfString'
CashSaleDto:
type: object
properties:
creditTerms:
$ref: '#/components/schemas/creditTermsInCashSaleDto'
cashSaleLines:
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-cashsale-api-openapi.yml