TRANXACT.AI Help

Platform · Legacy Migration

Migration Cockpit

The cutover as a numbered plan, one step at a time: where in the old system each extract comes from — with the program or query to produce it — then upload, read the rejections, and load, post, archive or post the balances.

Type REST39 operationsBase path /api/platform/migration

Download specification (OpenAPI 3.1) Screen: Migration Cockpit

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › Migration Cockpit on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

39 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/migration/statusStatus

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/status" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/completeComplete

Request body

The keys this action reads (* = required; "one of" lists the only values):

cutoverDate, note

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/complete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cutoverDate":"value","note":"value"}'
POST/api/platform/migration/reopenReopen

Request body

The keys this action reads (* = required; "one of" lists the only values):

note

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/reopen" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
POST/api/platform/migration/resetReset

Request body

The keys this action reads (* = required; "one of" lists the only values):

removeLoaded, clearMapping

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/reset" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"removeLoaded":"value","clearMapping":"value"}'
GET/api/platform/migration/planPlan

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/plan" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/objects/{id}/fieldsObjects fields

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/fields" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/objects/{id}/suggest-fieldsObjects suggest fields

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

headers, model, apply

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/suggest-fields" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"headers":"value","model":"value","apply":"value"}'
GET/api/platform/migration/guideGuide

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/guide" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/readinessReadiness

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/readiness" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/objects/{id}/aids/{code}Objects aids

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.
codestring (uuid)The record's code, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/aids/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/objects/{id}/templateObjects template

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/template" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/objects/{id}/skipObjects skip

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/skip" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/platform/migration/currencyCurrency

Request body

The keys this action reads (* = required; "one of" lists the only values):

currency

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/currency" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"currency":"value"}'
POST/api/platform/migration/objects/{id}/parallelObjects parallel

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

on, since

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parallel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"on":"value","since":"value"}'
POST/api/platform/migration/cadenceCadence

Request body

The keys this action reads (* = required; "one of" lists the only values):

cadence

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/cadence" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cadence":"value"}'
POST/api/platform/migration/approachApproach

Request body

The keys this action reads (* = required; "one of" lists the only values):

approach, asOf, from, to, cadence, parallel

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/approach" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"approach":"value","asOf":"value","from":"value","to":"value","cadence":"value","parallel":"value"}'
POST/api/platform/migration/objects/{id}/no-changesObjects no changes

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

asOf*

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/no-changes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"asOf":"value"}'
POST/api/platform/migration/objects/{id}/numberingObjects numbering

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

policy

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/numbering" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"policy":"value"}'
POST/api/platform/migration/objects/{id}/redoObjects redo

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/redo" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/objects/{id}/unskipObjects unskip

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/unskip" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/objects/{id}/stageObjects stage

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

rows*, origin, drive, sheet, fileName, contentBase64, mimeType, csv, deltaOnly, incremental, asOf, consignment

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/stage" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rows":"value","origin":"value","drive":"value","sheet":"value","fileName":"value","contentBase64":"value"}'
GET/api/platform/migration/drivesDrives

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/drives" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/drives/{driveId}/browseDrives browse

Path parameters

NameTypeDescription
driveIdstring (uuid)The record's driveId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/drives/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/browse" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/objects/{id}/upload-jobObjects upload job

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

through, deltaOnly, incremental, asOf, sheet; through one of stage|validate|load; files: [{ contentBase64, fileName, mimeType, sheet }]

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/upload-job" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"through":"value","deltaOnly":"value","incremental":"value","asOf":"value","sheet;":"value","fileName":"value"}'
POST/api/platform/migration/objects/{id}/ingestObjects ingest

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

schedule, driveId*, files, path, through, deltaOnly, incremental, asOf, sheet

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/ingest" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"schedule":"value","driveId":"value","files":"value","path":"value","through":"value","deltaOnly":"value"}'
GET/api/platform/migration/ingestsIngests

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/ingests" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/batches/{id}/mappingBatches mapping

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mapping" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/migration/batches/{id}Batches

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/batches/{id}/validateBatches validate

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/validate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/batches/{id}/loadBatches load

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

dryRun

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/load" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"dryRun":"value"}'
POST/api/platform/migration/batches/{id}/postBatches post

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/batches/{id}/settleBatches settle

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

settledOn*

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/settle" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"settledOn":"value"}'
POST/api/platform/migration/batches/{id}/archiveBatches archive

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/archive" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/historyHistory

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/history" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/batches/{id}/balancesBatches balances

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

asOf*

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/balances" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"asOf":"value"}'
POST/api/platform/migration/batches/{id}/ledger-accountsBatches ledger accounts

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/ledger-accounts" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/migration/batches/{id}/ledgerBatches ledger

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/ledger" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/tie-outTie out

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/tie-out" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/migration/batches/{id}/recordsBatches records

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/migration/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/records" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Migration Cockpit for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.