Change to Direction values in payment documents and reports (v.25, breaking change)

As part of the introduction of the new Payment Balances view in v.25, we conducted a careful review of the domain object Payment Orders. This led to a terminology update aimed at improving clarity and consistency across the platform.

What changed?

The Direction field values in Payment Orders have been renamed to align more intuitively with business and financial terminology:

  • Old Value: Expense ➡️ New Value: Outgoing

  • Old Value: Income ➡️ New Value: Incoming

Note: These are label changes only. The underlying database values remain unchanged:

  • I (originally from Issue → Expense → Outgoing)

  • R (originally from Receipt → Income → Incoming)

⚠️ Important for integrators

This change may constitute a breaking change for external applications, as changing the Value also reflects in the Domain API Enum Value. If your integration relies on the Direction Enum labels, please update your logic to reflect the new values: Outgoing and Incoming.

Why this matters?

This update standardizes terminology across related components, helping users better interpret data and align concepts with real-world financial processes. It also prepares the ground for future enhancements to the payments module.

Affected entities

The following components have been updated to reflect the new Direction terminology:

  1. Payments.BulkPaymentOrderLines

  2. Payments.PaymentBalances (new view)

  3. Payments.PaymentOrders

  4. Payments.PaymentSlipAmounts

  5. Payments.PaymentTransactions

Please make sure to update any documentation, reports, or integrations that rely on the Direction labels accordingly.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk