Migration API

Endpoint Index

Action	Endpoint
Start Migration	POST /migration/{tenantLocator}/migrations
Start Migrations for an Existing Account	POST /migration/{tenantLocator}/migrations/accounts/{accountLocator}
Resume a Paused Migration	PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/resume
Attempt to Recover System Error Items for a Migration	PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/recover
Pause a Running Migration	PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/pause
Patch an Existing Migration Request	PATCH /migration/{tenantLocator}/migrations/{migrationLocator}
Get Migration Summary	GET /migration/{tenantLocator}/migrations/{migrationLocator}
Get Migration Mappings	GET /migration/{tenantLocator}/migrations/{migrationLocator}/mappings/list
Get Migration Mappings for Account	GET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}/mappings
Get Account Migrations	GET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}
List Account Migrations	GET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/list
Get Migration Failures	GET /migration/{tenantLocator}/migrations/{migrationLocator}/failures/list

Migration Management

Start Migration

startMigration

POST /migration/{tenantLocator}/migrations

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:AccountMigrationRequest[]
Response:MigrationResponse
Security Group:migration   Permission:write

AccountMigrationRequest

required
accountData AccountMigrationData
defaultCreatedBy uuid
disbursements DisbursementMigrationRequest[]
invoices InvoiceMigrationRequest[]
payments PaymentMigrationRequest[]
policies PolicyMigrationRequest[]

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 MigrationPreferences
createdAt datetime
createdBy uuid
staticData map<string,object>
terms TermMigrationRequest[]

optional
currency string?
timezone string?

MigrationPreferences

optional
billingPreferences MigrationBillingPreferences?
installmentPreferences MigrationInstallmentPreferences?

MigrationInstallmentPreferences

required
installmentWeights number[]

optional
installmentPlanName string?
anchorMode Enum? generateDay | termStartDay | dueDay
anchorTime datetime?
anchorType Enum? none | dayOfMonth | anchorTime | dayOfWeek | weekOfMonth
autopayLeadDays number?
cadence Enum? none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDays
dayOfMonth int?
dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sunday
dueLeadDays int?
generateLeadDays int?
maxInstallmentsPerTerm int?
weekOfMonth Enum? none | first | second | third | fourth | fifth

MigrationBillingPreferences

optional
billingPlanName string?
billingLevel Enum? account | inherit | policy

AuxDataMigrationRequest

required
settingsName string
entries AuxDataEntryMigrationRequest[]

AuxDataEntryMigrationRequest

required
key string
value string

TransactionMigrationRequest

required
issuedTime datetime
transactionType string
createdAt datetime
createdBy uuid
installments InstallmentMigrationRequest[]

optional
segment SegmentMigrationRequest?

PaymentMigrationRequest

required
id string
paymentTime datetime
paymentType string
data map<string,object>
createdBy uuid
paymentItems PaymentItemMigrationRequest[]

optional
currency string?

AccountMigrationData

required
autoRenewalPlanName string
delinquencyPlanName string
excessCreditPlanName string
shortfallTolerancePlanName string
accountType string
billingLevel Enum account | inherit | policy
id string
preferences MigrationPreferences
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>
sources CreditItemMigrationRequest[]

optional
currency string?

CreditItemMigrationRequest

required
amount number

PaymentItemMigrationRequest

required
amount number
invoiceId string

SegmentMigrationRequest

required
startTime datetime
rootElement ElementMigrationRequest
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>
charges ChargeMigrationRequest[]
coverageTerms map<string,object>
elements ElementMigrationRequest[]

ChargeMigrationRequest

required
chargeType string
rate number
referenceRate number
tag string
installmentItems InstallmentItemMigrationRequest[]

TermMigrationRequest

required
startTime datetime
endTime datetime
transactions TransactionMigrationRequest[]

MigrationResponse

required
locator string
migrationState Enum submitted | processing | paused | finished | failed | error
processedAccounts int
totalAccounts int

ErrorDetailsResponse

required
errors ValidationResult
originalId string

Start Migrations for an Existing Account

startMigrationForAccount

POST /migration/{tenantLocator}/migrations/accounts/{accountLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required

Request:MigrationRequest
Response:MigrationResponse
Security Group:migration   Permission:write

MigrationRequest

required
defaultCreatedBy uuid
disbursements DisbursementMigrationRequest[]
invoices InvoiceMigrationRequest[]
payments PaymentMigrationRequest[]
policies PolicyMigrationRequest[]

Resume a Paused Migration

resumeMigration

PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/resume

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required

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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required

Response:void
Security Group:migration   Permission:write

Pause a Running Migration

pauseMigration

PATCH /migration/{tenantLocator}/migrations/{migrationLocator}/pause

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required

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}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required

Request:PatchAccountMigrationRequest
Response:MigrationFailuresResponse
Security Group:migration   Permission:write

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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required

Response:MigrationResponse
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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseAccountMigrationIdMappings
Security Group:migration   Permissions:read,list

AccountMigrationIdMappingsListResponse

required
listCompleted boolean
items AccountMigrationIdMappingsResponse[]

ListPageResponseAccountMigrationIdMappings

required
listCompleted boolean
items AccountMigrationIdMappingsResponse[]

AccountMigrationIdMappingsResponse

required
accountLocator string
migrationLocator string
originalAccountId string
disbursements map<string,MappingObject>
invoices map<string,MappingObject>
payments map<string,MappingObject>
policies map<string,MappingObject>

MappingObject

required
migratedAt datetime
originalId string
childrenMappings map<string,object>

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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required
accountLocator	path	string	required

Response:AccountMigrationIdMappingsResponse
Security Group:migration   Permission:read

Get Account Migrations

getAccountMigrations

GET /migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required
accountLocator	path	string	required

Response:AccountMigrationResponse
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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseAccountMigrationResponse
Security Group:migration   Permissions:read,list

ListPageResponseAccountMigrationResponse

required
listCompleted boolean
items AccountMigrationResponse[]

Get Migration Failures

getMigrationFailures

GET /migration/{tenantLocator}/migrations/{migrationLocator}/failures/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
migrationLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseMigrationFailuresResponse
Security Group:migration   Permissions:read,list

ListPageResponseMigrationFailuresResponse

required
listCompleted boolean
items MigrationFailuresResponse[]