Data Mart API - 2026-11-03
In this release:
- APHistoricalData: open prepayment balance: new fields
endingPrepaymentBalanceandendingPrepaymentBalanceInCurrency. detailDeletedremoved from APHistoricalData: the field is no longer part of the type.- Supplier payment-line descriptions: clarified currencies, dates and voids.
- New query:
customerClasses: customer classes and the defaults they set for their customers, disabled in Production while testing is in progress.
APHistoricalData and CustomerClasses are disabled in Production while testing is in progress. The changes below apply to the schema in every environment.
APHistoricalData: open prepayment balance
APHistoricalData exposes endingPrepaymentBalance (base currency) and endingPrepaymentBalanceInCurrency (the currency identified by currencyId): the open prepayments to the supplier at the end of the period. Visma.net ERP keeps these outside endingBalance, so the supplier balance shown by ERP reports such as AP630500 is endingBalance - endingPrepaymentBalance.
History rows exist only for periods with activity. To read a balance for a period, take the latest row at or before that period with the same company, branch, account, subaccount, currency and supplier. See Historic payables data for details.
detailDeleted removed from APHistoricalData
The detailDeleted field is removed from APHistoricalData. Visma.net ERP never sets it for AP history, so it was always false. AP history rows are not deleted; they are updated in place. APHistoricalData has not been available in Production, so no Production integration is affected. If you test against APHistoricalData, remove detailDeleted from your queries. ARHistoricalData is unchanged.
Supplier payment-line descriptions
The descriptions of SupplierPaymentLine (and the deprecated APPaymentLine type) now state the currency and meaning of each field. No field or type changes. amountApplied, cashDiscountApplied, withholdingTaxApplied and rgolAmt are in base currency; the ...InCurrency amounts are in the currency of the document the payment is applied to; amountPaid is in the payment currency. date is the application date, and applicationPeriod and postPeriodId are its financial period. After a payment is voided and the voiding application is released, both the original and the voiding line are released and voided; on the voiding line, voidAdjNbr holds the adjNbr of the original application.
New query: customerClasses
CustomerClasses is disabled in Production while testing is in progress. The query and type are documented for reference; the CustomerClasses ETL is not available for Production use.
The customerClasses query and the CustomerClass type return customer classes from Visma.net ERP:
- Key:
companyId+customerClassId. A customer belongs to the class whosecompanyIdandcustomerClassIdboth match the customer'scompanyIdandcustomerClassId. - Class fields:
description,vatZoneId,requireVatZone,paymentMethodId,termsId,currencyId,documentLanguage,invoiceOrdersSeparatelyandlastModifiedDateTime. - Standard fields:
id,deletedDatabaseRecord,createdInDataMartDateTimeandupdatedInDataMartDateTime.
The query takes the same arguments as supplierClasses: lastId, updatedInDataMart, updatedInDataMartTo, pageSize and includeDeleted (default false). It requires the reference data read scope.
vatZoneId, paymentMethodId and termsId are codes. Use the vatZones, paymentMethods and terms queries for their descriptions. The data comes from the Customer Classes ETL (CUSTOMER_CLASSES); see the ETL release notes.