Upload migration data

POSThttps://app.speybooks.com/api/v1/migration/{id}/upload

Attach standalone imports to a migration session. Each field links a confirmed import (from the contact, opening-balance, or document importers) to the migration.

All fields are optional; provide the ones you want to attach or update:

  • contactsImportId: a dimp_* id from a contact import
  • balancesImportId: a dimp_* id from an opening-balance import
  • invoicesImportId: a dimp_* id from a sales-document import
  • billsImportId: a dimp_* id from a purchase-document import

Set any field to null to detach it. After updating, the migration status is recomputed and advanced if appropriate. Returns 422 if the migration is in a terminal state.

Path parameters

idstringrequired
Migration ID (e.g. mig_1).

Body parameters

balancesImportIdstringoptional
Opening balances import ID (e.g. dimp_2) from the OBCE pipeline.
billsImportIdstringoptional
Purchase bills import ID (e.g. dimp_4) from the ODCE pipeline.
contactsImportIdstringoptional
Contacts import ID (e.g. dimp_1) from the UCI pipeline.
invoicesImportIdstringoptional
Sales invoices import ID (e.g. dimp_3) from the ODCE pipeline.

Response

200Import IDs attached. Status auto-advances if all required slots are filled.
Show response fields
balancesImportIdstring
billsImportIdstringnullable
contactsImportIdstring
idstring
invoicesImportIdstringnullable
providerstring
statusstring

Error codes

400No import IDs provided.
404Migration not found.
422Migration is in a terminal state (completed/abandoned).