Home 9 Xero Integration 9 Understanding Sync History

Understanding Sync History

The Sync History feature provides a complete audit trail of all Xero synchronization operations in LiteWork. Whether you’re tracking successful syncs, investigating errors, or monitoring your integration health, Sync History gives you the visibility you need.

What is Sync History?

Sync History records every interaction between LiteWork and Xero, including:

  • Creates: New invoices or contacts pushed to Xero
  • Imports: Documents pulled from Xero into LiteWork
  • Updates: Changes synced in either direction
  • API Requests: Background operations like fetching organization info

Each entry includes timestamps, status, and detailed information about what was synced.

Accessing Sync History

To access Sync History:

  1. Click the Settings button (gear icon) in the header
  2. Select the Sync History tab from the sidebar
  3. The Sync History dashboard will load

Statistics Dashboard

At the top of the Sync History page, you’ll see four key metrics:

Metric Description Color
Total Operations Total number of sync operations recorded Gray
Successful Operations that completed without errors Green
Errors Operations that failed or had issues Red
Success Rate Percentage of successful operations Blue

These statistics update based on your filter selections.

Understanding Log Entries

Each sync history entry contains:

Action Type

  • create: A new document was created in Xero
  • import: A document was pulled from Xero to LiteWork
  • update: An existing document was updated
  • sync: A general sync operation

Direction

  • to_xero: Data was sent from LiteWork to Xero
  • from_xero: Data was pulled from Xero to LiteWork

Status

  • success: Operation completed successfully
  • error: Operation failed
  • partial: Operation partially completed

Timestamps

Each entry shows when the operation occurred, displayed in your local timezone.

Filtering Sync History

Use the filter controls to find specific entries:

Filter by Action

Show only specific operation types (create, import, update, sync)

Filter by Direction

Show only operations going to Xero or from Xero

Filter by Status

Show only successful operations, errors, or partial completions

Filter by Date Range

Set a start and end date to view history within a specific period

Search

Search by invoice number to find sync history for a specific document

Using Filters

  1. Set your desired filter criteria
  2. Click Apply Filters to update the results
  3. Click Clear Filters to reset all filters

Pagination

Sync history is displayed 50 entries per page. Use the pagination controls at the bottom to navigate:

  • Previous: Go to the previous page
  • Next: Go to the next page
  • Page indicator: Shows current page number

Exporting to CSV

To export your sync history for external analysis:

  1. Apply any filters you want (the export respects your current filters)
  2. Click the Export CSV button
  3. A CSV file will download with all matching entries

The CSV includes all columns: timestamp, action, direction, status, document number, and details.

Using Sync History for Troubleshooting

Sync History is invaluable for diagnosing issues:

Finding Failed Syncs

  1. Filter by Status: error
  2. Review the error details for each failed entry
  3. Look for patterns (specific documents, times, etc.)

Tracking a Specific Invoice

  1. Use the search box to enter the invoice number
  2. View all sync operations for that document
  3. Check the timeline of syncs to understand its history

Monitoring Integration Health

  • Check the Success Rate metric regularly
  • A rate below 95% may indicate connection issues
  • Review recent errors to identify problems early

Common Error Types

Error Meaning Solution
Authentication failed Xero connection expired Reconnect to Xero
Rate limit exceeded Too many API requests Wait and retry
Invoice not found Invoice deleted in Xero Check Xero for status
Validation error Data doesn’t meet Xero requirements Check document data

Related Articles