Migration API

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

Start MigrationstartMigration

POST/migration/{tenantLocator}/migrations

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`X-Idempotency-Key`	header	`string?`	No

Request:AccountMigrationRequest[]

Response:MigrationResponse

Security Group:migration

Permission:

write

See the migration feature guide for more information on idempotency keys.

AccountMigrationRequest

Required properties

Property	Type	Description
`accountData`	`AccountMigrationData`
`accounting`	`AccountingMigrationRequest`
`defaultCreatedBy`	`uuid`
`disbursements`	`DisbursementMigrationRequest[]`
`invoices`	`InvoiceMigrationRequest[]`
`payments`	`PaymentMigrationRequest[]`
`policies`	`PolicyMigrationRequest[]`

PolicyMigrationRequest

Required properties

Property	Type	Description
`productName`	`string`
`durationBasis`	`Enum years \| months \| weeks \| days \| hours`
`id`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`
`staticData`	`map<string, object>`
`terms`	`TermMigrationRequest[]`

Optional properties

Property	Type	Description
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`currency`	`string?`
`timezone`	`string?`
`auxData`	`AuxDataMigrationRequest?`
`billingLevel`	`Enum? account \| inherit \| policy`
`preferences`	`MigrationPreferences?`Deprecated

MigrationPreferences

Properties

Property	Type	Description
`installmentPreferences`	`MigrationInstallmentPreferences?`

MigrationInstallmentPreferences

Required properties

Property	Type	Description
`installmentWeights`	`number[]`

Optional properties

Property	Type	Description
`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`	`integer?`
`dayOfWeek`	`Enum? monday \| tuesday \| wednesday \| thursday \| friday \| saturday \| sunday`
`dueLeadDays`	`integer?`
`generateLeadDays`	`integer?`
`maxInstallmentsPerTerm`	`integer?`
`weekOfMonth`	`Enum? none \| first \| second \| third \| fourth \| fifth`

AuxDataMigrationRequest

Required properties

Property	Type	Description
`settingsName`	`string`
`entries`	`AuxDataEntryMigrationRequest[]`

AuxDataEntryMigrationRequest

Required properties

Property	Type	Description
`key`	`string`
`value`	`string`

TransactionMigrationRequest

Required properties

Property	Type	Description
`issuedTime`	`datetime`
`transactionType`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`
`installments`	`InstallmentMigrationRequest[]`

Optional properties

Property	Type	Description
`preferences`	`MigrationPreferences?`
`segment`	`SegmentMigrationRequest?`

PaymentMigrationRequest

Required properties

Property	Type	Description
`id`	`string`
`paymentTime`	`datetime`
`paymentType`	`string`
`data`	`map<string, object>`
`paymentItems`	`PaymentItemMigrationRequest[]`

Optional properties

Property	Type	Description
`currency`	`string?`
`createdBy`	`uuid?`

AccountMigrationData

Required properties

Property	Type	Description
`accountType`	`string`
`id`	`string`
`data`	`map<string, object>`
`createdAt`	`datetime`

Optional properties

Property	Type	Description
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`excessCreditPlanName`	`string?`
`shortfallTolerancePlanName`	`string?`
`billingLevel`	`Enum? account \| inherit \| policy`
`preferences`	`MigrationPreferences?`
`createdBy`	`uuid?`

AccountingMigrationRequest

Required properties

Property	Type	Description
`originalAccountBalances`	`map<string, number>`	Key is a currency code (e.g. USD)

InvoiceMigrationRequest

Required properties

Property	Type	Description
`startTime`	`datetime`
`endTime`	`datetime`
`dueTime`	`datetime`
`generateTime`	`datetime`
`id`	`string`

Optional properties

Property	Type	Description
`currency`	`string?`
`timezone`	`string?`
`invoiceState`	`Enum? open \| settled \| discarded`

DisbursementMigrationRequest

Required properties

Property	Type	Description
`disbursementTime`	`datetime`
`disbursementType`	`string`
`id`	`string`
`data`	`map<string, object>`
`sources`	`CreditItemMigrationRequest[]`

Optional properties

Property	Type	Description
`currency`	`string?`

CreditItemMigrationRequest

Required properties

Property	Type	Description
`amount`	`number`

PaymentItemMigrationRequest

Required properties

Property	Type	Description
`amount`	`number`
`invoiceId`	`string`

SegmentMigrationRequest

Required properties

Property	Type	Description
`startTime`	`datetime`
`rootElement`	`ElementMigrationRequest`
`segmentType`	`Enum coverage \| gap`

InstallmentMigrationRequest

Required properties

Property	Type	Description
`startTime`	`datetime`
`dueTime`	`datetime`
`generateTime`	`datetime`
`id`	`string`
`invoiceId`	`string`

InstallmentItemMigrationRequest

Required properties

Property	Type	Description
`amount`	`number`
`id`	`string`
`installmentNumber`	`integer`

ElementMigrationRequest

Required properties

Property	Type	Description
`elementType`	`string`
`id`	`string`
`data`	`map<string, object>`
`charges`	`ChargeMigrationRequest[]`
`coverageTerms`	`map<string, object>`
`elements`	`ElementMigrationRequest[]`

ChargeMigrationRequest

Required properties

Property	Type	Description
`chargeType`	`string`
`rate`	`number`
`referenceRate`	`number`
`tag`	`string`
`installmentItems`	`InstallmentItemMigrationRequest[]`

TermMigrationRequest

Required properties

Property	Type	Description
`startTime`	`datetime`
`endTime`	`datetime`
`transactions`	`TransactionMigrationRequest[]`

MigrationResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`migrationState`	`Enum submitted \| processing \| paused \| finished \| failed \| error`
`processedAccounts`	`integer`
`totalAccounts`	`integer`

ErrorDetailsResponse

Required properties

Property	Type	Description
`errors`	`ValidationResult`
`originalId`	`string`

Start Migrations for an Existing Account

Start Migrations for an Existing AccountstartMigrationForAccount

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`X-Idempotency-Key`	header	`string?`	No

Request:MigrationRequest

Response:MigrationResponse

Security Group:migration

Permission:

write

MigrationRequest

Required properties

Property	Type	Description
`defaultCreatedBy`	`uuid`
`disbursements`	`DisbursementMigrationRequest[]`
`invoices`	`InvoiceMigrationRequest[]`
`payments`	`PaymentMigrationRequest[]`
`policies`	`PolicyMigrationRequest[]`

Resume a Paused Migration

Resume a Paused MigrationresumeMigration

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes

Response:void

Security Group:migration

Permission:

write

Attempt to Recover System Error Items for a Migration

Attempt to Recover System Error Items for a MigrationrecoverMigration

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes

Response:void

Security Group:migration

Permission:

write

Pause a Running Migration

Pause a Running MigrationpauseMigration

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes

Response:void

Security Group:migration

Permission:

write

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

Patch an Existing Migration Request

Patch an Existing Migration RequestpatchMigration

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes

Request:PatchAccountMigrationRequest

Response:MigrationFailuresResponse

Security Group:migration

Permission:

write

PatchAccountMigrationRequest

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`defaultCreatedBy`	`uuid`
`disbursements`	`map<string, DisbursementMigrationRequest>`
`invoices`	`map<string, InvoiceMigrationRequest>`
`payments`	`map<string, PaymentMigrationRequest>`
`policies`	`map<string, PolicyMigrationRequest>`

Optional properties

Property	Type	Description
`accountData`	`AccountMigrationData?`

MigrationFailuresResponse

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`accountOriginalId`	`string`
`disbursements`	`map<string, ErrorDetailsResponse>`
`invoices`	`map<string, ErrorDetailsResponse>`
`payments`	`map<string, ErrorDetailsResponse>`
`policies`	`map<string, ErrorDetailsResponse>`

Optional properties

Property	Type	Description
`accountError`	`ErrorDetailsResponse?`

Migration Information

Get Migration Summary

Get Migration SummarygetMigrationSummary

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes

Response:MigrationResponse

Security Group:migration

Permission:

read

Get Migration Mappings

Get Migration MappingsgetMigrationMappings

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

Returns per-account mappings of system locators to original IDs

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseAccountMigrationIdMappings

Security Group:migration

Permissions:

read,list

AccountMigrationIdMappingsListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`AccountMigrationIdMappingsResponse[]`

ListPageResponseAccountMigrationIdMappings

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`AccountMigrationIdMappingsResponse[]`

AccountMigrationIdMappingsResponse

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`migrationLocator`	`ulid`
`originalAccountId`	`string`
`disbursements`	`map<string, MappingObject>`
`invoices`	`map<string, MappingObject>`
`payments`	`map<string, MappingObject>`
`policies`	`map<string, MappingObject>`

MappingObject

Required properties

Property	Type	Description
`migratedAt`	`datetime`
`originalId`	`string`
`childrenMappings`	`map<string, object>`

Get Migration Mappings for Account

Get Migration Mappings for AccountgetMigrationMappingsForAccount

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

Fetches mappings of original IDs to system locators for an account

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes
`accountLocator`	path	`ulid`	Yes

Response:AccountMigrationIdMappingsResponse

Security Group:migration

Permission:

read

Get Account Migrations

Get Account MigrationsgetAccountMigrations

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes
`accountLocator`	path	`ulid`	Yes

Response:AccountMigrationResponse

Security Group:migration

Permission:

read

AccountMigrationResponse

Required properties

Property	Type	Description
`accountMigrationState`	`Enum pending \| processing \| error \| failed \| completed`
`errorItems`	`integer`
`lastUpdated`	`datetime`
`processedItems`	`integer`
`totalItems`	`integer`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`

List Account Migrations

List Account MigrationslistAccountMigrations

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseAccountMigrationResponse

Security Group:migration

Permissions:

read,list

ListPageResponseAccountMigrationResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`AccountMigrationResponse[]`

Get Migration Failures

Get Migration FailuresgetMigrationFailures

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`migrationLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseMigrationFailuresResponse

Security Group:migration

Permissions:

read,list

ListPageResponseMigrationFailuresResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`MigrationFailuresResponse[]`

Migration API

On this page