We are introducing a number of changes to the Wisenet BI Connector as part of our upcoming Wisenet Finance update.
These changes align the BI Connector with the updated Finance data model and provide a more flexible way to represent relationships between payments, invoices and credit notes.
Some of these changes affect existing export schemas, including the removal or replacement of fields currently used by downstream reports, data warehouses and integrations.
If your organisation consumes Wisenet Finance data through the BI Connector, we recommend reviewing the changes below and preparing any required updates to your downstream integrations, or reports.
What’s changing?
The most significant change is the introduction of a new FinanceAllocation export.
Previously, relationships between invoices, payments and credit notes could be determined directly from fields within individual Finance exports.
With the updated Finance model, allocations are managed independently. The new FinanceAllocation export becomes the source of truth for determining how payments and credit notes are allocated to invoices.
This supports scenarios where:
- a payment can exist without being allocated to an invoice
- a payment can be allocated across multiple invoices
- allocations can be changed or removed
- a credit note can be allocated across invoices
As a result, several direct relationship fields have been removed from existing exports.
New FinanceAllocation export
A new FinanceAllocation export is being introduced containing:
- AllocationId
- FinanceInvoiceId
- FinancePaymentId
- FinanceCreditNoteId
- AllocationDate
- AllocationAmount
- audit fields
Where invoice allocation information is required, integrations should now use FinanceAllocation rather than deriving the relationship directly from FinancePayment, FinanceCreditNote or the previous FinanceCredit export.
Important: When a payment or credit note becomes fully unallocated, its allocation record is deleted from FinanceAllocation. Downstream synchronisation processes should account for records disappearing when allocations are removed.
FinancePayment changes
Several changes are being made to the FinancePayment export.
The following fields are being removed:
- FinanceInvoiceId
- EntryDate
- IsDeleted
Additional changes include:
- FinancePaymentStatus is now non-nullable
- PaymentMethod is now non-nullable
- CurrencyCode has been added
- deleted payments will no longer be returned
Recommended action
Update downstream processes to:
- use FinanceAllocation to determine which invoices a payment is allocated to
- use PaymentDate instead of EntryDate
- use CurrencyCode where currency information is required
- review any synchronisation logic that currently depends on IsDeleted
FinanceRefund changes
The following fields are being removed from FinanceRefund:
- LearnerId
- WorkplaceId
A refund can now relate to either a payment or a credit note.
FinancePaymentId and FinanceCreditNoteId are therefore nullable, with one of these relationships populated for each refund.
Payment method fields are also now non-nullable.
Recommended action
Where learner or workplace information is required, resolve the relationship through the associated FinancePayment or FinanceCreditNote rather than directly from FinanceRefund.
Ensure downstream logic supports refunds linked to either:
- FinancePaymentId, or
- FinanceCreditNoteId
FinanceCredit and FinanceCreditNote changes
The existing FinanceCredit export is being removed.
Any reports, integrations or data pipelines currently consuming FinanceCredit should migrate to the new FinanceAllocation export.
For FinanceCreditNote, the following fields are also being removed:
- FinanceInvoiceId
- CurrencyDescription
- CurrencySymbol
FinanceCreditNoteStatus is now non-nullable.
Recommended action
Use:
- FinanceAllocation to determine invoice relationships
- CurrencyCode instead of CurrencyDescription or CurrencySymbol
Do not assume that an invoice relationship can be determined directly from FinanceCreditNote.
FinanceInvoice changes
The following fields are being removed from FinanceInvoice:
- IsDeleted
- LastPaymentDate
- CurrencyDescription
- CurrencySymbol
FinanceInvoiceStatus is now non-nullable, and deleted invoices will no longer be returned.
Recommended action
Update downstream reporting and integration logic to:
- use FinanceAllocation where payment or credit allocation information is required
- use AllocationDate where allocation timing is required
- use CurrencyCode instead of the previous currency description or symbol fields
- review synchronisation processes that currently rely on IsDeleted
Deleted records
A broader change to several Finance exports is that deleted records will no longer be returned.
This includes deleted:
- payments
- invoices
- invoice items
If your downstream data warehouse currently uses IsDeleted to identify and remove records, you should review how records are reconciled after each BI Connector import.
The same consideration applies to FinanceAllocation: when an allocation is completely removed, the corresponding allocation record is deleted.
Other schema changes
There are several additional field and nullability changes to be aware of.
Quote
- QuoteNumber has increased from nvarchar(26) to nvarchar(4000)
- a nullable CurrencyCode field has been added
If your destination schema restricts QuoteNumber to 26 characters, increase the field capacity to prevent truncation or rejected records.
FinanceWriteOff
LearnerId and WorkplaceId have been removed.
Use FinanceInvoiceId to retrieve the associated invoice and resolve the learner or workplace from FinanceInvoice.
FinanceAccountItem
- Description has been renamed to FundingMethod
- TaxRateName is now non-nullable
Update field mappings and destination schemas accordingly.
FinanceCreditNoteItem
FeeTypeName is now non-nullable.
Update validation or destination schemas if they currently allow this field to be null.
FinanceInvoiceItem
IsDeleted has been removed and deleted invoice items will no longer be returned.
Review any downstream reconciliation logic that currently uses this field.
FinanceItemVersionPricing
Description is now non-nullable.
Ensure destination schemas and validation rules treat this field as mandatory.
Recommended migration strategy
If you consume Wisenet Finance data through the BI Connector, we recommend completing the following review.
1. Add FinanceAllocation
Add the new FinanceAllocation export to your ingestion process if your reporting or integrations require relationships between invoices, payments and credit notes.
2. Review direct invoice relationships
Remove dependencies on direct invoice relationship fields that are being retired, particularly:
- FinancePayment.FinanceInvoiceId
- FinanceCreditNote.FinanceInvoiceId
- the FinanceCredit export
Use FinanceAllocation instead.
3. Review deleted-record handling
Do not assume deleted Finance records will continue to appear with an IsDeleted flag.
Review your incremental load, reconciliation and deletion handling to ensure downstream data remains aligned with Wisenet.
4. Update renamed and removed fields
Review ETL mappings, database schemas, semantic models, reports and other downstream consumers for references to fields that have been removed or renamed.
5. Review nullability and schema validation
Some fields that previously allowed null values are now mandatory, while some Finance relationship fields can now be nullable.
Update destination schemas and validation rules accordingly.
6. Review currency handling
Where available, use CurrencyCode rather than the previous CurrencyDescription and CurrencySymbol fields.
Overall impact
The impact will depend on which Finance exports your organisation currently consumes.
Integrations are more likely to require changes if they:
- join FinancePayment directly to FinanceInvoice
- join FinanceCreditNote directly to FinanceInvoice
- consume the existing FinanceCredit export
- use IsDeleted to synchronise deleted Finance records
- use EntryDate from FinancePayment
- rely on LearnerId or WorkplaceId directly from refunds or write-offs
- use CurrencyDescription or CurrencySymbol
- enforce strict field lengths or nullability in destination schemas
Final recommendation
Customers using the BI Connector for Finance reporting should review their data ingestion and reporting models before the changes take effect.
In particular, we recommend adopting FinanceAllocation as the authoritative source for invoice, payment and credit note allocation relationships and removing dependencies on fields that are being retired.
The updated exports will only become available on release day. While you can review and prepare for the changes in advance, testing against the updated BI Connector structure will not be possible before the release.