Get All Syncs

curl --request GET \
  --url https://api.rootfi.dev/sync \
  --header 'api_key: <api-key>'

{
  "data": {
    "data": [
      {
        "rootfi_id": 123456,
        "rootfi_company_id": 123456,
        "rootfi_organisation_id": 1,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_updated_at": "2021-09-28T15:00:00.000Z",
        "rootfi_created_at": "2021-09-28T15:00:00.000Z",
        "start_time": "2021-09-28T15:00:00.000Z",
        "end_time": "2021-09-28T15:00:00.000Z",
        "sync_from": null,
        "integration_type": "ZOHO_BOOKS",
        "full_sync": true,
        "sync_type": "AUTO_SYNC",
        "config_mode": "READ",
        "success_count": 20,
        "failed_count": 0,
        "running_count": 0,
        "created_count": 0,
        "data_models": [
          {
            "sync_id": "H1HJT1UYdj0qncJ",
            "data_model": "ACCOUNTS",
            "total_count": 1,
            "success_count": 1,
            "failed_count": 0,
            "running_count": 0,
            "pending_count": 0,
            "start_time": "2023-12-01T08:17:29+00:00",
            "end_time": "2023-12-01T08:17:43.047+00:00",
            "status": "SUCCESS"
          }
        ]
      }
    ],
    "total_count": 1,
    "sync_status": "IDLE",
    "connection_status": "HEALTHY"
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

GET

sync

curl --request GET \
  --url https://api.rootfi.dev/sync \
  --header 'api_key: <api-key>'

{
  "data": {
    "data": [
      {
        "rootfi_id": 123456,
        "rootfi_company_id": 123456,
        "rootfi_organisation_id": 1,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_updated_at": "2021-09-28T15:00:00.000Z",
        "rootfi_created_at": "2021-09-28T15:00:00.000Z",
        "start_time": "2021-09-28T15:00:00.000Z",
        "end_time": "2021-09-28T15:00:00.000Z",
        "sync_from": null,
        "integration_type": "ZOHO_BOOKS",
        "full_sync": true,
        "sync_type": "AUTO_SYNC",
        "config_mode": "READ",
        "success_count": 20,
        "failed_count": 0,
        "running_count": 0,
        "created_count": 0,
        "data_models": [
          {
            "sync_id": "H1HJT1UYdj0qncJ",
            "data_model": "ACCOUNTS",
            "total_count": 1,
            "success_count": 1,
            "failed_count": 0,
            "running_count": 0,
            "pending_count": 0,
            "start_time": "2023-12-01T08:17:29+00:00",
            "end_time": "2023-12-01T08:17:43.047+00:00",
            "status": "SUCCESS"
          }
        ]
      }
    ],
    "total_count": 1,
    "sync_status": "IDLE",
    "connection_status": "HEALTHY"
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

curl --request GET \
  --url https://api.rootfi.dev/sync \
  --header 'api_key: <api-key>'

Authorizations

api_key

string

header

required

Query Parameters

limit

integer | null

The number of objects you want to retrieve

offset

integer | null

The index from where you want to start retrieving objects

company_id

integer | null

The ID of the company to retrieve.

job_type

enum<string> | null

The type of job to retrieve.

Available options:

PULL,

PUSH

Response

200 - application/json

data

coreSyncALlResponsesCommonFieldsHelper · object

required

The data returned from the request

Show child attributes

data.data

coreSyncALlResponsesCommonFields · object[]

required

Show child attributes

data.data.rootfi_id

number<double> | null

The unique ID we assign for that data's information

data.data.rootfi_company_id

number<double> | null

The RootFi designated id for the company

data.data.rootfi_organisation_id

number<double> | null

The RootFi designated id for the organisation

data.data.rootfi_integration_type

enum<string> | null

The accounting platform from which the data is being retrieved

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

WAVE,

ODOO_ACCOUNTING,

NETSUITE,

WAFEQ,

MEKARI_JURNAL,

BUSY,

ROOTFI_SANDBOX,

QOYOD

data.data.rootfi_updated_at

string<date-time> | null

The latest date at which RootFi updated this data

data.data.rootfi_created_at

string<date-time> | null

The date at which RootFi first synced this data

data.data.start_time

string<date-time> | null

The time the sync started

data.data.end_time

string<date-time> | null

The time the sync ended

data.data.sync_from

string | null

The time the sync started

data.data.integration_type

enum<string> | null

The time the sync ended

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

WAVE,

ODOO_ACCOUNTING,

NETSUITE,

WAFEQ,

MEKARI_JURNAL,

BUSY,

ROOTFI_SANDBOX,

QOYOD

data.data.full_sync

boolean | null

The time the sync started

data.data.sync_type

string | null

The time the sync ended

data.data.config_mode

string | null

The time the sync started

data.data.success_count

integer | null

The time the sync ended

data.data.failed_count

integer | null

The time the sync started

data.data.running_count

integer | null

The time the sync ended

data.data.created_count

integer | null

The time the sync started

data.data.data_models

coreSyncDataModel · object[] | null

The time the sync ended

Show child attributes

data.data.data_models.sync_id

string | null

The ID of the sync

data.data.data_models.data_model

enum<string> | null

The data model

Available options:

ACCOUNTS,

BALANCE_SHEET,

BANK_ACCOUNTS,

BANK_TRANSACTIONS,

BILL_CREDIT_NOTES,

BILL_PAYMENTS,

BILLS,

CASH_FLOW_STATEMENT,

COMPANY_INFO,

CONTACTS,

CURRENCIES,

EXPENSES,

INCOME_STATEMENT,

INVOICE_CREDIT_NOTES,

INVOICE_PAYMENTS,

INVOICES,

ITEMS,

JOURNAL_ENTRIES,

PURCHASE_ORDERS,

SALES_ORDERS,

TAX_RATES,

TRACKING_CATEGORIES

data.data.data_models.total_count

integer | null

The total number of records

data.data.data_models.success_count

integer | null

The number of successful records

data.data.data_models.failed_count

integer | null

The number of failed records

data.data.data_models.running_count

integer | null

The number of running records

data.data.data_models.pending_count

integer | null

The number of pending records

data.data.data_models.start_time

string<date-time> | null

The time the sync started

data.data.data_models.end_time

string<date-time> | null

The time the sync ended

data.data.data_models.status

enum<string> | null

The status of the sync

Available options:

SUCCESS,

FAILED,

CREATED,

RUNNING

data.total_count

integer | null

The total number of records

data.sync_status

string | null

The status of the sync

data.connection_status

string | null

The status of the connection

request_timestamp

string<date-time>

required

The time at which the request was received by the server

response_timestamp

string<date-time>

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

Get One Sync Create an Sync

⌘I

General

Server Side SDKs

Core API

Unified API

Authorizations

Query Parameters

Response