Visma Customer API
The Customer API from Visma — 18 operation(s) for customer.
Visma Customer API is one of 193 APIs that Visma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, rate-limit docs, and a support channel.
This API exposes 21 operations across 18 paths, and defines 157 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://api.finance.visma.net.
21 operations
18 paths
157 schemas
16 GET3 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Visma Customer API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (interactiveapi) using the authorizationCode flow, exposing 5 scopes.
Paths & Operations 21
Across 18 paths, the API surfaces 21 operations — 16 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Customer 21
GET
/v1/customer/customerClass
Get Customer Classes - ScreenId=AR201000
GET
/v1/customer/customerClass/{customerClassId}
Get a specific customer class - ScreenId=AR201000
GET
/v1/customer/{customerCd}/balance
Get a specific customer's balance - ScreenId=AR303000
GET
/v1/customer/{customerCd}/directdebit
Get direct debit information for a specific customer(only for Netherlands)
GET
/v1/customer/{customerCd}/salesorder
Get a range of SO Orders of a specific customer
GET
/v1/customer/{customerCd}/salesorderbasic
Get a range of SO Orders Basic of a specific customer
GET
/v1/customer/{customerCd}/contact
Get a range of Contacts of a specific customer
GET
/v1/customer/{customerCd}/salespersons
Get a range of Sales Persons of a specific customer
GET
/v1/customer/balance
Get the balance for a range of customers
GET
/v1/customer/{customerCd}/note
Get a specific customer's note
GET
/v1/customer/internal/{internalID}
Get a specific customer by internalID
PUT
/v1/customer/internal/{internalID}
Updates a specific customer using the internalID
GET
/v1/customer/{customerCd}
Get a specific customer
PUT
/v1/customer/{customerCd}
Updates a specific customer
GET
/v1/customer
Get a range of customers - ScreenId=AR303000
POST
/v1/customer
Creates a customer
GET
/v1/customer/{customerNumber}/invoice
Get a range of invoices for a specific customer
GET
/v1/customer/{customerNumber}/cashSale
Get a range of cash sales for a specific customer
GET
/v1/customer/{customerNumber}/document
Gets a range of documents for a specific customer
POST
/v1/customer/{customer}/action/createDunningLetter
Creates dunning letters for a specific customer
POST
/v1/customer/action/changeCustomerCd/{internalId}
Updates the CustomerNr for the specified Customer
Schemas 157
The contract defines 157 schemas that model the data the API accepts and returns. The most detailed are CustomerInvoiceDto (77 properties), SalesOrderDto (75 properties), CashSaleDto (55 properties), CustomerDto (48 properties). Each schema is shown below with its type and property counts.
subaccountInSalesOrderLineDto
object
Subaccount A subcategory of the account that carries identifying information.
3 properties
SalesOrderShipmentDto
object
10 properties
CustomerClassDto
object
7 properties
customerClassInCustomerDto
object
Mandatory field: General information tab Financial settings section Customer class The class to which the customer is assigned.
2 properties
ArAdjustDto
object
16 properties
AttachmentDto
object
3 properties
SalesOrderLineDto
object
45 properties
DtoValueOfEInvoiceContractUpdateDto
object
1 property
paymentMethodInSalesOrderDto
object
Payment settings tab Payment method
2 properties
locationInCustomerDocumentDto
object
The top part Location The location of the customer related to the document. By default, it is the default location of the selected customer or, if the invoice…
3 properties
InventoryNumberDescriptionDto
object
2 properties
DtoValueOfAddressUpdateDto
object
1 property
paymentMethodInCashSaleDto
object
The Financial details tab The Payment information section Payment method The identifier for the payment method that the customer will use to pay the document.
2 properties
DtoValueOfString
object
1 property
addressInContactDto
object
The Details tab Address section
8 properties
subaccountInCashSaleLineDto
object
Mandatory field: Subaccount The corresponding subaccount used for this transaction.
9 properties
invoiceAddressInCustomerInvoiceDto
object
The Invoice address tab The Invoice address section.
9 properties
paymentMethodInCustomerDocumentDto
object
The Financial details tab The Payment information section Payment method The identifier for the payment method that the customer will use to pay the document.
2 properties
TaxDetailDto
object
This class represents a VAT Detail Line. Used for getting data.
7 properties
salesPersonInCustomerInvoiceDto
object
The document details tab Salesperson ID The salesperson involved.
2 properties
countryInAddressDto
object
Country The country.
4 properties
invoiceContactInCustomerDto
object
Invoicing setting tab Invoice contact section
8 properties
customerInCustomerDocumentDto
object
The top part Customer The customer associated with the document.
2 properties
shippingZoneInSalesOrderDto
object
Delivery settings tab Shipping information section Shipping zone
2 properties
deliveryContactInCustomerDto
object
Delivery settings tab Shipping contact section
8 properties
projectInCashSaleDto
object
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 ass…
3 properties
projectInCustomerInvoiceDto
object
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 ass…
3 properties
customerInSalesOrderBasicDto
object
The top part Customer The customer that has ordered the goods or services.
3 properties
SalesOrderDto
object
This class represents a SOOrder in SOOrderController. Used by getting data.
75 properties
CustomerUpdateDto
object
44 properties
soBillingAddressInSalesOrderDto
object
Financial settings tab Invoice address section
9 properties
customerVATZoneInSalesOrderDto
object
Financial settings tab Financial information section Customer VAT zone The customers VAT zone to be used to process customer sales orders, which generally is t…
6 properties
AccountNumberTypeDescriptionDto
object
3 properties
sellerInCashSaleLineDto
object
Salesperson ID The identifier of the salesperson involved.
2 properties
DtoValueOfNullableOfInt32
object
1 property
vatCodeInCashSaleLineDto
object
VAT category The VAT category (if applied) for the transaction. The category represents the type of goods or services.
2 properties
creditTermsInCashSaleDto
object
Mandatory field: The Financial details tab Payment info section Terms
2 properties
accountInCustomerInvoiceLineDto
object
Mandatory field: Account The sales account used for the transaction.
6 properties
invoiceContactInCashSaleDto
object
The Invoice address tab The Invoice contact section.
6 properties
CashSaleLineDto
object
27 properties
countryInSalesOrderAddressDto
object
Country The country.
4 properties
salesPersonInSalesOrderLineDto
object
Salesperson ID The salesperson associated with the sale of the line item.
2 properties
DtoValueOfCustomerStatus
object
1 property
branchInCustomerDocumentDto
object
Branch is deprecated, please use BranchNumber instead.
2 properties
CustomerPaymentMethodInfoDto
object
2 properties
transactionTypeInSalesOrderDto
object
Delivery settings tab Intrastat section Transaction type
2 properties
CashSaleDto
object
This class represents a invoice in InvoiceController. Used by getting data.
55 properties
salesPersonInSalesOrderDto
object
The Commissions tab Salesperson ID The salesperson.
2 properties
WarehouseIdDescriptionDto
object
2 properties
termsInSalesOrderDto
object
Mandatory field: Financial settings tab Financial information section Terms The credit terms used in relations with the customer. See also window CS206500.
2 properties
locationInSalesOrderDto
object
Mandatory field: The top part Location The customer location from which the goods or services have been ordered or, if the sales order is created from an oppor…
3 properties
ownerInSalesOrderDto
object
The Financial settings tab Financial information section Owner The user in the work group who is responsible for the sales order.
3 properties
soBillingContactInSalesOrderDto
object
The Financial settings tab The Invoice address section or on the Delivery address section
9 properties
mainAddressInCustomerDto
object
General information tab Main address section
8 properties
subaccountInCustomerInvoiceLineDto
object
Mandatory field: Subaccount The corresponding subaccount used for this transaction.
9 properties
invoiceContactInCustomerInvoiceDto
object
The Invoice address tab The Invoice contact section.
6 properties
SalesOrderDocumentLineDto
object
This class represents a SOOrder in SOOrderController. Used by getting data.
22 properties
CustomerDirectDebitUpdateDto
object
13 properties
invoiceAddressInCustomerDto
object
Invoicing settings tab Invoice address section
8 properties
ParentRecordDto
object
2 properties
DtoValueOfNullableOfInt16
object
1 property
accountInCashSaleDto
object
The Document details tab Account The sales account used for the transaction.
6 properties
branchNumberInCustomerInvoiceDto
object
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.
2 properties
DtoValueOfStatementTypes
object
1 property
DtoValueOfNullableOfDateTime
object
1 property
CustSalesPersonsDto
object
8 properties
soShippingContactInSalesOrderDto
object
Delivery settings tab Delivery address contact section
9 properties
CustomerDefaultPaymentMethodUpdateDto
object
2 properties
TaxCategoryNumberDescriptionDto
object
2 properties
WorkTypeDto
object
3 properties
accountInCustomerDocumentDto
object
The Document details tab Account The sales account used for the transaction.
6 properties
countryInCustomerDocumentAddressDto
object
Country The country.
4 properties
BranchNumberDto
object
2 properties
mainContactInCustomerDto
object
General information tab Main contact section
8 properties
CreateDunningLetterActionResultDto
object
3 properties
CustomerDto
object
This class represents a customer in CustomerController. Used by getting data.
48 properties
CustomerInvoiceDto
object
This class represents an invoice in InvoiceController. Used by getting data.
77 properties
customerInCustomerInvoiceDto
object
The top part Customer The customer associated with the document.
2 properties
priceClassInCustomerDto
object
Deliver settings tab Default location settings section Price class The price class assigned to the customer.
2 properties
locationInCustomerDto
object
Delivery settings tab Default location settings section Location name A description of the customer location.
3 properties
DirectDebitMandateDto
object
This class represents a Customer Mandate
3 properties
fobPointInSalesOrderDto
object
Delivery settings tab Shipping information section FOB point The point where ownership of the goods is transferred to the customer.
2 properties
salesPersonInCashSaleDto
object
The document details tab Salesperson ID The salesperson involved.
2 properties
customerInCashSaleDto
object
The top part Customer The customer associated with the document.
2 properties
SegmentUpdateDto
object
2 properties
branchNumberInCashSaleDto
object
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.
2 properties
DtoValueOfNullableOfDecimal
object
1 property
CustomerGlAccountsUpdateDto
object
15 properties
shipViaInSalesOrderDto
object
The Delivery settings tab Shipping information section Ship via The Ship via code that represents the carrier and its service to be used for shipping the order…
2 properties
CustomerInvoiceLineDto
object
41 properties
SubAccountDto
object
9 properties
DtoValueOfCreditRule
object
1 property
ProjectTaskIdDescriptionDto
object
3 properties
SegmentDto
object
4 properties
contactInCustomerInvoiceDto
object
The top part Contact The contact associated with the customer.
2 properties
SalesOrderBasicDto
object
This class represents a SOOrder in SOOrderController. Used by getting data.
31 properties
CustomerSalesPersonUpdateDto
object
5 properties
branchNumberInSalesOrderBasicDto
object
Mandatory field: Document details tab Branch The branch of the company.
2 properties
DtoValueOfNullableOfBoolean
object
1 property
projectInCustomerDocumentDto
object
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 ass…
3 properties
ChildRecordDto
object
2 properties
debtCollectionInCustomerInvoiceDto
object
Debt Collection information
4 properties
countyInCustomerDocumentAddressDto
object
County The county or province.
2 properties
MetadataDto
object
2 properties
vatCodeInCustomerInvoiceLineDto
object
VAT category The VAT category (if applied) for the transaction. The category represents the type of goods or services.
2 properties
customerVatZoneInCustomerInvoiceDto
object
The Financial details tab The VAT info section Dunning letter date
2 properties
DtoValueOfCustomerDefaultPaymentMethodUpdateDto
object
1 property
DtoValueOfCustomerGlAccountsUpdateDto
object
1 property
branchNumberInSalesOrderDto
object
Mandatory field: Document details tab Branch The branch of the company.
2 properties
DtoValueOfBoolean
object
1 property
AttributeLineUpdateDto
object
2 properties
subaccountInCustomerInvoiceDto
object
The Document details tab Subaccount The corresponding subaccount used for this transaction.
9 properties
vatIdInTaxDetailDto
object
VAT ID The ID of the specific VAT applied.
2 properties
subaccountInCashSaleDto
object
The Document details tab Subaccount The corresponding subaccount used for this transaction.
9 properties
subaccountInCustomerDocumentDto
object
The Document details tab Subaccount The corresponding subaccount used for this transaction.
9 properties
ClassAttributeDetailDto
object
2 properties
CustomerDocumentDto
object
35 properties
accountInCashSaleLineDto
object
Mandatory field: Account The sales account used for the transaction.
6 properties
creditTermsInCustomerInvoiceDto
object
Mandatory field: The top part Terms The credit terms used in relations with the customer.
2 properties
CustomerDirectDebitDto
object
12 properties
creditTermsInCustomerDto
object
General information tab Financial settings section Terms The type of credit terms used in operations with the customer.
2 properties
attributeIdInAttributeLineUpdateDto
object
The ID of the attribute on the line.
1 property
DtoValueOfContactInfoUpdateDto
object
1 property
countyInSalesOrderAddressDto
object
County The county or province.
2 properties
customerInSalesOrderDto
object
The top part Customer The customer that has ordered the goods or services.
3 properties
glAccountsInCustomerDto
object
Information collected from the system. Some accounts visible in window, some not.
15 properties
ContactInfoUpdateDto
object
7 properties
sellerInCustomerInvoiceLineDto
object
Salesperson ID The identifier of the salesperson involved.
2 properties
branchNumberInCustomerDocumentDto
object
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.
2 properties
accountInCustomerInvoiceDto
object
The Document details tab Account The sales account used for the transaction.
6 properties
invoiceAddressInCashSaleDto
object
The Invoice address tab The Invoice address section.
9 properties
locationInCashSaleDto
object
The top part Location The location of the customer related to the document. By default, it is the default location of the selected customer or, if the invoice…
3 properties
ChangeCustomerCdActionResultDto
object
3 properties
vatZoneInCustomerDto
object
Mandatory field: Delivery settings tab Default location settings section VAT Zone The VAT zone of the customer's default location.
6 properties
countyInAddressDto
object
County The county or province.
2 properties
ContactDto
object
This class represents a contact in ContactController. Used by getting data.
28 properties
DtoValueOfDecimal
object
1 property
AddressUpdateDto
object
7 properties
BackgroundApiAcceptedDto
object
2 properties
paymentMethodInCustomerInvoiceDto
object
The Financial details tab The Payment information section Payment method The identifier for the payment method that the customer will use to pay the document.
2 properties
preferredWarehouseInSalesOrderDto
object
The Delivery settings tab The shipping information section Preferred warehouse ID
2 properties
branchNumberInCashSaleLineDto
object
Mandatory field: Branch The branch that sells the line item or provides the service.
2 properties
CustomerDescriptionDto
object
3 properties
AttributeIdValueDto
object
3 properties
EInvoiceContractUpdateDto
object
2 properties
CustomerBalanceDto
object
9 properties
ChangeCustomerCdActionDto
object
1 property
shippingTermsInSalesOrderDto
object
Delivery settings tab Shipping information section Shipping terms
2 properties
ClassAttributeDto
object
7 properties
eInvoiceContractInCustomerDto
object
Other invoice settings tab.
2 properties
soShippingAddressInSalesOrderDto
object
Delivery settings tab Delivery address section
9 properties
CreateDunningLetterActionDto
object
3 properties
locationInCustomerInvoiceDto
object
The top part Location The location of the customer related to the document. By default, it is the default location of the selected customer or, if the invoice…
3 properties
locationInSalesOrderBasicDto
object
Mandatory field: The top part Location The customer location from which the goods or services have been ordered or, if the sales order is created from an oppor…
3 properties
branchNumberInCustomerInvoiceLineDto
object
Mandatory field: Branch The branch that sells the line item or provides the service.
2 properties
deliveryAddressInCustomerDto
object
Delivery settings tab Shipping address section
8 properties
NoteDto
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Visma 12
Other APIs Visma publishes across the network.
Visma Business NXT GraphQL API
Visma Account API
Visma Accounts API
Visma Agreements API
Visma Allocation Periods API
Visma Approval API
Visma App Store Activation Status API
Visma Article Account Codings API
Visma Article Labels API
Visma Articles API
Visma Attachment API
Visma Attachment Links API
#Customers
Where this information came from
This is an independent, third-party profile of Visma Customer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.