latestOpenAPI 3.0.02026-08-214511046.9 MB

11a990d9390a

Integrations

Sync integration

Endpoint to import data from, or export data to, a connected accounting platform.

The work runs in the background. The endpoint responds 202 Accepted with an Async Task of type integration_sync, reading processing. Poll GET /async_tasks/{id} for the task to reach completed or error, or subscribe to the async_task_completed webhook, which fires on both.

A sync task reports status only, so results is always empty.

post/integrations/{integration}/sync

Path parameters

integrationstring required

Request body

sync'accounting_codes' | 'category' | 'department' | 'journal_entries' | 'project' required

Data to be synced with the provider: - accounting_codes: imports Accounting Codes from the provider. - journal_entries: exports Journal Entries to the provider, requires a payroll_id. - category: imports tracking categories (Xero Tracking Categories / QuickBooks Classes) as Tag Groups and Tags. - department: imports departments (QuickBooks Locations) as Tag Groups and Tags. QuickBooks only. - project: imports projects as Tag Groups and Tags. QuickBooks only.

business_entity_idstring
payroll_idstring

Response

Accepted