BatchSyncModel
A BatchSyncModel contains a collection of records to load into the Lockstep Platform. Data contained
in this batch will be merged with your existing data. Each record will be matched with existing data inside
the Lockstep Platform using the Identity Column rules.
Any record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing
AppEnrollmentId+ErpKey will be updated, but only if the data has changed.
A Sync process permits either a complete data file or a partial / delta data file. Lockstep recommends
using a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.
Best practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours.
Required Fields
isFullSync
True if this is a full sync, false if this is a partial sync. Defaults to false.
Optional Fields
appEnrollmentId
uuid, nullable
The optional existing app enrollment to associate with the data in this batch.
companies
CompanySyncModel[], nullable
A list of Company records to merge with your Lockstep Platform data
contacts
ContactSyncModel[], nullable
A list of Contact records to merge with your Lockstep Platform data
creditMemoApplications
CreditMemoAppliedSyncModel[], nullable
A list of CreditMemoApplied records to merge with your Lockstep Platform data
invoices
InvoiceSyncModel[], nullable
A list of Invoice records to merge with your Lockstep Platform data
invoiceLines
InvoiceLineSyncModel[], nullable
A list of InvoiceLine records to merge with your Lockstep Platform data
customFields
CustomFieldSyncModel[], nullable
A list of CustomField records to merge with your Lockstep Platform data
payments
PaymentSyncModel[], nullable
A list of Payment records to merge with your Lockstep Platform data
paymentApplications
PaymentAppliedSyncModel[], nullable
A list of PaymentApplied records to merge with your Lockstep Platform data
financialYearSettings
FinancialYearSettingSyncModel[], nullable
A list of FinancialYearSetting records to merge with your Lockstep Platform data
financialAccounts
FinancialAccountSyncModel[], nullable
A list of FinancialAccount records to merge with your Lockstep Platform data
financialAccountBalanceHistories
FinancialAccountBalanceHistorySyncModel[], nullable
A list of FinancialAccountBalanceHistory records to merge with your Lockstep Platform data
baseCurrencies
BaseCurrencySyncModel[], nullable
A list of BaseCurrency records to merge with your Lockstep Platform data
journalEntries
JournalEntrySyncModel[], nullable
A list of JournalEntry records to merge with your Lockstep Platform data
journalEntryLines
JournalEntryLineSyncModel[], nullable
A list of JournalEntryLine records to merge with your Lockstep Platform data
Updated 20 days ago