Get Sync

GET

core

syncs

{sync_id}

curl --request GET \
  --url https://api.rootfi.dev/v3/core/syncs/{sync_id} \
  --header 'api_key: <api-key>'

{
  "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

api_key

string

header

required

Path Parameters

sync_id

string

required

The ID of the sync to retrieve

Response

200

application/json

The data of the sync endpoint

data

object

required

The data of the invite link endpoint

data.rootfi_id

integer

required

The ID of the sync

Example:

1

data.rootfi_created_at

string

required

The created time of the sync

Example:

"2024-06-21T08:07:05.750Z"

data.rootfi_updated_at

string

required

The updated time of the sync

Example:

"2024-06-21T08:07:05.750Z"

data.rootfi_company_id

integer

required

The ID of the company

Example:

8422

data.start_time

string

required

The start time of the sync

Example:

"2024-06-21T08:07:05.000Z"

data.end_time

string

required

The end time of the sync

Example:

"2024-06-21T08:07:40.382Z"

data.integration_type

enum<string>

required

The type of integration

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

ROOTFI_SANDBOX,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

NETSUITE,

WAVE,

ODOO_ACCOUNTING,

WAFEQ,

MEKARI_JURNAL,

BUSY,

QOYOD,

STRIPE,

RAZORPAY,

PAYPAL,

SHOPIFY,

BIG_COMMERCE,

WOO_COMMERCE,

HUBSPOT,

SALESFORCE,

PIPEDRIVE,

ZOHO_CRM

data.full_sync

boolean

required

Whether the sync was a full sync

Example:

true

data.sync_type

enum<string>

required

The type of sync.

Available options:

MANUAL,

AUTO_SYNC

data.config_mode

enum<string>

required

The config mode of the sync.

Available options:

CREATE,

READ,

UPDATE,

DELETE,

DOWNLOAD,

CUSTOM

data.sync_data_models

string[]

required

The sync data models of the sync.

Example:

["CUSTOM_ACCOUNT_TRANSACTIONS"]

data.sync_id

string

required

The ID of the sync

Example:

"hjmm4d2HDHB60a2"

data.total_count

integer

required

The total count of the sync

Example:

3

data.success_count

integer

required

The success count of the sync

Example:

3

data.failed_count

integer

required

The failed count of the sync

Example:

0

data.running_count

integer

required

The running count of the sync

Example:

0

data.pending_count

integer

required

The pending count of the sync

Example:

0

data.status

enum<string>

required

The status of the sync

Available options:

CREATED,

RUNNING,

SUCCESS,

FAILED

Get Syncs Get Sync Jobs

curl --request GET \
  --url https://api.rootfi.dev/v3/core/syncs/{sync_id} \
  --header 'api_key: <api-key>'

{
  "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"
  }
}

General

Server Side SDKs

Core API

Unified API

Authorizations

Path Parameters

Response