Migration API

Endpoint Index

ActionEndpoint
Start MigrationPOST /migration/{tenantLocator}/migrations
Start Migrations for an Existing AccountPOST /migration/{tenantLocator}/migrations/accounts/{accountLocator}
Resume a Paused MigrationPATCH /migration/{tenantLocator}/migrations/{migrationLocator}/resume
Attempt to Recover System Error Items for a MigrationPATCH /migration/{tenantLocator}/migrations/{migrationLocator}/recover
Pause a Running MigrationPATCH /migration/{tenantLocator}/migrations/{migrationLocator}/pause
Patch an Existing Migration RequestPATCH /migration/{tenantLocator}/migrations/{migrationLocator}
Get Migration SummaryGET /migration/{tenantLocator}/migrations/{migrationLocator}
Get Migration MappingsGET /migration/{tenantLocator}/migrations/{migrationLocator}/mappings/list
Get Migration Mappings for AccountGET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}/mappings
Get Account MigrationsGET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}
List Account MigrationsGET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/list
Get Migration FailuresGET /migration/{tenantLocator}/migrations/{migrationLocator}/failures/list

Migration Management

Start Migration
startMigration
POST /migration/{tenantLocator}/migrations
AccountMigrationRequest
required
defaultCreatedBy uuid
PolicyMigrationRequest
required
productName string
autoRenewalPlanName string
delinquencyPlanName string
durationBasis Enum years | months | weeks | days | hours
auxData AuxDataMigrationRequest
billingLevel Enum account | inherit | policy
id string
preferences PreferencesResponse
createdAt datetime
createdBy uuid
staticData map<string,object>

optional
currency string?
timezone string?
TransactionMigrationRequest
required
issuedTime datetime
transactionType string
createdAt datetime
createdBy uuid

optional
PaymentMigrationRequest
required
id string
paymentTime datetime
paymentType string
data map<string,object>
createdBy uuid

optional
currency string?
AccountMigrationData
required
autoRenewalPlanName string
delinquencyPlanName string
excessCreditPlanName string
shortfallTolerancePlanName string
accountType string
billingLevel Enum account | inherit | policy
id string
preferences PreferencesResponse
data map<string,object>
createdAt datetime
createdBy uuid
InvoiceMigrationRequest
required
startTime datetime
endTime datetime
dueTime datetime
generateTime datetime
id string

optional
currency string?
timezone string?
DisbursementMigrationRequest
required
disbursementTime datetime
disbursementType string
id string
data map<string,object>

optional
currency string?
CreditItemMigrationRequest
required
amount number
PaymentItemMigrationRequest
required
amount number
invoiceId string
SegmentMigrationRequest
required
startTime datetime
segmentType Enum coverage | gap
InstallmentMigrationRequest
required
startTime datetime
dueTime datetime
generateTime datetime
id string
invoiceId string
InstallmentItemMigrationRequest
required
amount number
id string
installmentNumber int
ElementMigrationRequest
required
elementType string
id string
data map<string,object>
coverageTerms map<string,string>
ChargeMigrationRequest
required
chargeType string
rate number
referenceRate number
tag string
TermMigrationRequest
required
startTime datetime
endTime datetime
MigrationResponse
required
locator string
migrationState Enum submitted | processing | paused | finished | failed | error
migrationType Enum fullMigration | addAccountItems
processedAccounts int
totalAccounts int
ErrorDetailsResponse
required
originalId string
Start Migrations for an Existing Account
startMigrationForAccount
POST /migration/{tenantLocator}/migrations/accounts/{accountLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountLocatorpathstringrequired
    Security Group:migration   Permission:write
MigrationRequest
required
defaultCreatedBy uuid
Resume a Paused Migration
resumeMigration
PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/resume
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    Response:void
    Security Group:migration   Permission:write
Attempt to Recover System Error Items for a Migration
recoverMigration
PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/recover
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    Response:void
    Security Group:migration   Permission:write
Pause a Running Migration
pauseMigration
PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/pause
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    Response:void
    Security Group:migration   Permission:write

Note

In-flight transactions will be completed before the migration pauses.

Patch an Existing Migration Request
patchMigration
PATCH /migration/{tenantLocator}/migrations/{migrationLocator}
PatchAccountMigrationRequest
required
accountLocator string
defaultCreatedBy uuid
disbursements map<string,DisbursementMigrationRequest>
invoices map<string,InvoiceMigrationRequest>
payments map<string,PaymentMigrationRequest>
policies map<string,PolicyMigrationRequest>

optional
accountData AccountMigrationData?
MigrationFailuresResponse
required
accountLocator string
accountOriginalId string
disbursements map<string,ErrorDetailsResponse>
invoices map<string,ErrorDetailsResponse>
payments map<string,ErrorDetailsResponse>
policies map<string,ErrorDetailsResponse>

optional
accountError ErrorDetailsResponse?

Migration Information

Get Migration Summary
getMigrationSummary
GET /migration/{tenantLocator}/migrations/{migrationLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    Security Group:migration   Permission:read
Get Migration Mappings
getMigrationMappings
Returns per-account mappings of system locators to original IDs
GET /migration/{tenantLocator}/migrations/{migrationLocator}/mappings/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:migration   Permissions:read,list
AccountMigrationIdMappingsListResponse
required
listCompleted boolean
ListPageResponseAccountMigrationIdMappings
required
listCompleted boolean
AccountMigrationIdMappingsResponse
required
accountLocator string
migrationLocator string
originalAccountId string
disbursements map<string,MappingObject>
invoices map<string,MappingObject>
payments map<string,MappingObject>
policies map<string,MappingObject>
Get Migration Mappings for Account
getMigrationMappingsForAccount
Fetches mappings of original IDs to system locators for an account
GET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}/mappings
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    accountLocatorpathstringrequired
    Security Group:migration   Permission:read
Get Account Migrations
getAccountMigrations
GET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    accountLocatorpathstringrequired
    Security Group:migration   Permission:read
AccountMigrationResponse
required
accountMigrationState Enum pending | processing | error | failed | completed
errorItems int
lastUpdated datetime
processedItems int
totalItems int

optional
accountLocator string?
List Account Migrations
listAccountMigrations
GET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:migration   Permissions:read,list
ListPageResponseAccountMigrationResponse
required
listCompleted boolean
Get Migration Failures
getMigrationFailures
GET /migration/{tenantLocator}/migrations/{migrationLocator}/failures/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    migrationLocatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:migration   Permissions:read,list
ListPageResponseMigrationFailuresResponse
required
listCompleted boolean