General
Server Side SDKs
Core API
- Companies
- Invite Links
- Sync
- Passthrough
- Real Time
- Webhooks
Unified API
- Accounting
- Payments
- Ecommerce
- CRM
Sync
Create Sync
Initialise a single sync
POST
/
core
/
syncs
curl --request POST \
--url https://api.rootfi.dev/v3/core/syncs \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"integration_type": "XERO",
"full_sync": true,
"data_models_to_sync": [
"ACCOUNTS",
"CONTACTS"
]
}'
{
"data": {
"rootfi_id": 1,
"rootfi_company_id": 8422,
"rootfi_updated_at": "2024-06-21T08:07:05.750Z",
"rootfi_created_at": "2024-06-21T08:07:05.750Z",
"start_time": "2024-06-21T08:07:05.000Z",
"end_time": "2024-06-21T08:07:40.382Z",
"integration_type": "ZOHO_BOOKS",
"full_sync": true,
"sync_type": "AUTO_SYNC",
"config_mode": "READ",
"sync_data_models": [
"CUSTOM_ACCOUNT_TRANSACTIONS"
],
"sync_id": "hjmm4d2HDHB60a2",
"total_count": 3,
"success_count": 3,
"failed_count": 0,
"running_count": 0,
"pending_count": 0,
"status": "SUCCESS"
}
}
Authorizations
Body
application/json
The data of the invite link endpoint
Response
200
application/json
The data of the sync endpoint
curl --request POST \
--url https://api.rootfi.dev/v3/core/syncs \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"integration_type": "XERO",
"full_sync": true,
"data_models_to_sync": [
"ACCOUNTS",
"CONTACTS"
]
}'
{
"data": {
"rootfi_id": 1,
"rootfi_company_id": 8422,
"rootfi_updated_at": "2024-06-21T08:07:05.750Z",
"rootfi_created_at": "2024-06-21T08:07:05.750Z",
"start_time": "2024-06-21T08:07:05.000Z",
"end_time": "2024-06-21T08:07:40.382Z",
"integration_type": "ZOHO_BOOKS",
"full_sync": true,
"sync_type": "AUTO_SYNC",
"config_mode": "READ",
"sync_data_models": [
"CUSTOM_ACCOUNT_TRANSACTIONS"
],
"sync_id": "hjmm4d2HDHB60a2",
"total_count": 3,
"success_count": 3,
"failed_count": 0,
"running_count": 0,
"pending_count": 0,
"status": "SUCCESS"
}
}