Invoice Settlement Guiding Agent
The Invoice Settlement Guiding Agent leads you through a phased enablement process, including a one-time migration path decision between Full Migration and the Forward Compatibility (Lazy Migration) approach.
When enabling Invoice Settlement (IS) for your organization, the IS Guiding Agent walks you through a phased enablement process. This process includes a critical decision point where you select your migration path. There are various enablement phases.
Phase 1: Check IS status
The agent detects your tenant's current state, including whether Invoice Settlement is already enabled and what the IS_FORWARD_COMPATIBILITY flag is currently set to (or if it's empty/uncommitted).
Phase 2: Show migration benefits
The agent educates your organization on the benefits of migrating to Credit Memos and Debit Memos as the primary adjustment mechanism, explaining improved financial reporting, better audit trails, and enhanced settlement tracking.
Phase 3: Migration type selection
This phase appears only when IS_FORWARD_COMPATIBILITY is empty (your organization has not committed to a path yet). The agent presents two mutually exclusive migration options:
Migration type | Historical objects migrated | Data approach | API integration |
|---|---|---|---|
| Full Migration | Negative Invoices, Credit Balance on Account, Unapplied Payments | Clean data model; all legacy objects converted to IS objects | Requires API integration updates |
| Lazy Migration (Forward Compatibility Path) | Credit Balance Adjustments (CBA), Unapplied Payments | Legacy and IS objects coexist; gradual adoption | Zero API changes needed upfront |
Choose Full Migration if your organization is ready to fully transition to Invoice Settlement. This approach:
Migrates all legacy objects (Negative Invoices, Account-level Credit Balances, Unapplied Payments) to the CM/DM model
Provides a clean, unified data model focused on Invoice Settlement objects
Requires integration code updates to use new IS endpoints
Results in legacy adjustment APIs becoming read-only after enablement
Choose the Forward Compatibility Path (Lazy Migration) if your organization needs a gradual adoption approach. This approach:
Migrates Credit Balance Adjustments (CBA) and Unapplied Payments into CM/DM model
Keeps legacy adjustment APIs (CBA, IA, IIA) fully operational with original request/response formats
Requires zero API integration changes upfront
Enables gradual transition to Invoice Settlement over time
Maintains legacy object and IS object coexistence
Phase 4: Commit and proceed
Once you select a migration path, the agent writes the IS_FORWARD_COMPATIBILITY flag to either FULL_IS (Full Migration) or SINGLE_WRITE (Forward Compatibility Path). This commitment is irreversible. After commitment, the agent directs you to the enablement workbench for the execution stage.
Why the migration selection is one-way
The migration path selection cannot be changed after commitment because the two approaches migrate different historical objects. Once the IS_FORWARD_COMPATIBILITY flag is set, data has already been processed along that migration path. There is no rollback capability.
Full Migration commits to converting all legacy objects; reverting would require data restoration
Forward Compatibility commits to coexistence of legacy and IS objects; switching would require data realignment
Historical data has been processed and stored according to the selected path; reverting is not operationally feasible