Skip to main content

Invoice Settlement Harmonization Migration

Zuora

Invoice Settlement Harmonization Migration

Zuora will perform an automated, silent payment migration before enabling the permission for a customer for all historical payments and related refunds with payment effective >= 2023-01-01. This activity is not expected to have any impact on your regular business processes or your experience of using Zuora.

This activity is being conducted to reduce the time required to enable Invoice Settlement Harmonization, should you choose to do so.

If you want to opt out of this migration activity, contact Zuora Global Support.

The migration activity involves two separate functions:

  1. Payment migration - focuses on payments with an effective date >= 2023-01-01. It is targeted at migrating the existing payments into the system.
  2. Payment real-time migration - focuses on the newly generated payments.
  • The silent migration starts in March 2024 for all the Invoice Settlement OFF tenants from the Zuora release version 350 onwards.
  • During the payment migration, the FIFO rules will apply to the invoice line items. For more information, see Default Application Rule.

Migration environments and estimated timelines

Migration Details Payment/Refund new data Payment data migration (historical data)
Migration period March 2024 March 2024
Migration condition Enabling asynchronous migration for sandbox and production environments Payments with an effective date >= 2023-01-01
Environments
  • API Sandbox
  • NA Sandbox
  • EU Sandbox
  • NA Production
  • US Production
  • EU Production
  • API Sandbox
  • NA Sandbox
  • EU Sandbox
  • NA Production
  • US Production
  • EU Production
Target Tenants Tenants with Invoice Settlement permission OFF Tenants with Invoice Settlement permission OFF

Post-migration enhancements

When payments are migrated using the invoice settlement payments data model, the following records are generated in the backend for the migrated payments and refunds.

  • Application Group
  • Payment Application
  • Payment Application Item
  • Payment Part
  • Payment Part Item
  • Refund Application
  • Refund Application Item
  • Refund Part
  • Refund Part Item

These are only visible for non-Invoice Settlement users after enabling the Invoice Settlement Harmonization or Invoice Settlement feature. The CreatedBy and UpdatedBy fields are set to contain the original payment or refund value.

During migration, specific fields may go through changes.

  1. The Balance field of the following objects are updated properly:
    • Invoice Item
    • Invoice Tax Item
  2. The AppliedAmount field of the object Payment will be updated to reflect the portion of the payment applied to the invoice.

During the migration of Payments that align with the Invoice Settlement Payments data model, payment application records will be created at the Invoice Item level. To replicate the Payment application for historical payments, Zuora will use the default Payment application rule of 'First in, First out.'

  1. The UpdatedBy and UpdatedDate fields of the following objects are not changed:
    • Invoice Item
    • Invoice Tax Item
    • Account
    • Invoice
    • Payment
    • Refund

During the period of 2024-03-18~2024-03-20, a small subset of Legacy AR customers (Invoice Settlement Off) will notice the 'UpdatedBy' field changed to 'ScheduledJobUser' and 'UpdatedOn' date to be the migration time.